Microsoft Entra ID Auth Module
The Microsoft Entra ID authentication module lets users log in to IDE Services with their Microsoft Entra ID accounts.
When setting up Microsoft Entra ID authentication, you can configure custom or common tenants. With a custom tenant, you define a specific tenant ID, limiting logins to users in your Microsoft Entra ID instance. Without a specified tenant ID, the authentication module allows logins from any Microsoft Entra ID tenant, regardless of organization membership.
To learn how to set up a new tenant, please refer to the Microsoft Entra ID documentation.
To create the Microsoft Entra ID module:
In the Administration menu, select .
Click New Module.
The Select an identity provider dialog opens.
In the Select an identity provider dialog, select Microsoft Entra ID.
The Configure Login with Entra ID wizard opens.
To continue with a custom tenant setup, specify the value from the Tenant ID field in Microsoft Entra ID.
To continue with a common tenant setup, leave the Tenant ID field empty.
Click Next.
Copy the generated redirect URI.
Follow the instructions provided in the wizard to register the IDE Services app in Microsoft Entra ID and configure the redirect URI. This gives you access to the client ID and secret that you need to enable the Microsoft Entra ID authentication module.
Copy the Application (client) ID and Client secret from Microsoft Entra ID and paste them into the Client ID and Client Secret fields in Hub correspondingly.
Click Finish.
The Auth Modules page displays the settings for a new Microsoft Entra ID authentication module.
To learn how to register Hub in Microsoft Entra ID, please follow the instructions in the product documentation for Microsoft Entra ID.
The following table lists the key configuration options in Microsoft Entra ID that are required for this authentication module:
Setting | Description |
|---|---|
Supported account types | This determines who can use the application, sometimes called its sign-in audience. For this setup, choose the Accounts in this organizational directory only (Single tenant) option. |
Redirect URI | Paste the redirect URI from Hub into the input field. For the type, select the Web option. |
Application (client) ID | This value is automatically generated when you register the application in Microsoft Entra ID. Use the value from this field as the Client ID setting in Hub. |
Client secret | Value | This value is generated in the Certificates & secrets section of the App registration experience. Once you have added a client secret for the application, use the value for the client secret as the Client secret in Hub. |
API permissions | To map existing group memberships from the Microsoft Entra ID service to groups in Hub, grant the application the following Delegated type permissions for working with the Microsoft Graph API:
If you want to set up synchronization between Microsoft Entra ID and Hub, the following Application type permissions are required as well:
The complete list of permissions that are currently available to your app is listed on the API permissions page. |
Once you have the values that are required to connect with the authorization service, you can enable the Microsoft Entra ID auth module.
To enable the Microsoft Entra ID auth module:
If necessary, configure the optional settings for the authentication module. For more information, see Additional Settings.
Click the Save button at the bottom of the page.
Click the Enable button in the header.
The Microsoft Entra ID authentication module is enabled.
The icon stored in the Button image setting is added to the login dialog window. Users can click this icon to log in to IDE Services with their Microsoft accounts.
Settings
In the header of the settings page, you can find the general information about the authentication module, including its name and tenant ID.
Setting | Description |
|---|---|
Name | Stores the name of the authentication module. Use this setting to distinguish this module from other authentication modules in the Auth Modules list. You can change the name of the authentication module using the Rename action. For more details, refer to Actions. |
Button image | Displays the image used for the button that a user clicks to log in to Hub with their account in the connected authorization service. You can change the button image for the authentication module using the Rename action. For more details, refer to Actions. You can upload a JPG, GIF, or PNG file. The image is resized to 48 x 48 pixels automatically. |
Tenant | Stores the ID of the custom tenant in the Microsoft Entra ID service. For auth modules that are connected to a common tenant, this field is empty. |
User accounts in IDE Services | Displays the number of users in IDE Services. |
User accouts found in Entra ID | Displays the number of user accounts that Hub has found in Microsoft Entra ID. |
Last sync | Displays the last time when Hub synchronized user accounts and groups between IDE Services and Entra ID. |
On the General tab, you find the general settings for the authentication module, including the redirect URI that you use to register Hub in the authorization service, and the input fields that store the Client ID and Client Secret.
Setting | Description |
|---|---|
Redirect URI | Displays the authorized redirect URI used to register the connection to Hub in the authorization service. |
Client ID | Stores the identifier that the authorization service uses to validate a login request. You generate this value in the authorization service when you configure the authorization settings for a web application and enter an authorized redirect URI. |
Client Secret | Stores the secret or password used to validate the client ID. You generate this value in the authorization service together with the client ID. |
Default | Sets the current authentication module as the default. |
Users & Groups
The settings on the Users & Groups tab let you set up synchronization of user account and group data between Hub and Microsoft Entra ID.
When synchronization is enabled, changes applied to Microsoft Entra ID profiles are synchronized with Hub and IDE Services. This synchronization is performed in addition to the synchronization requests that are automatically sent when users log in to IDE Services using their Microsoft account credentials.
Setting | Description |
|---|---|
Select groups | Allows you to select user groups from Entra ID that will be synchronized with IDE Services. |
All groups | Enables synchronization of all groups found in Entra ID with IDE Services. |
Keep users and groups synchronized | Determines the frequency with which user attributes and group memberships are synchronized with Microsoft Entra ID. If the setting is enabled, you can choose from one of three predefined intervals:
You can also launch the synchronization manually at any time by clicking the Sync users and groups now button in the header. If the setting is disabled, group memberships are still synchronized on a per-user basis during login. The synchronization feature is only active when the authentication module is Enabled. |
Group Mappings
In case the necessary API permissions are not granted in Entra ID, you can provide the names of Entra ID groups to use in IDE Services manually.
The Microsoft Entra ID module automatically maps the attribute that stores Microsoft Entra ID group memberships to the field that stores membership records in the Hub database. All you need to do is map the groups in the Microsoft Entra ID service to their counterparts in Hub.
When group mappings are configured, Hub checks for Microsoft Entra ID group memberships when users log in with accounts that are managed in the directory service. Hub performs the following operations for each Microsoft Entra ID group that is mapped to a Hub group:
Users who are members of a mapped Microsoft Entra ID group and are not members of the mapped Hub group are added to the group in Hub.
Users who are not members of a mapped Microsoft Entra ID group and are members of the mapped Hub group are removed from the group in Hub.
Changes to group memberships in the authorization service are only applied in Hub when users log in using their Microsoft Entra ID accounts.
To map a group from Microsoft Entra ID to a group in Hub:
Open your Microsoft Entra ID auth module.
Select the Users & Groups tab.
Click the Add group by name button.
Enter the name of the Microsoft Entra ID group in the designated field.
Click the Save button.
The specified group is added to Hub.
Clicking the group name redirects you to the page
Additional Settings
The settings on the Additional settings tab let you manage Hub account creation and group membership and reduce the loss of processing resources consumed by idle connections.
Option | Description |
|---|---|
Account status | Determines whether accounts are banned in Hub when an account with corresponding credentials is deleted or deactivated in the Microsoft identity platform.
|
User creation | Enables creation of Hub accounts for unregistered users who log in with an account that is stored in the connected authorization service. Hub uses the email address to determine whether the user has an existing account. |
Auto-join groups | Adds users to a group when they log in with an account that is stored in the connected authentication service. You can select one or more groups. New users that auto-join a group inherit all the permissions assigned to this group. We recommend that you add users to at least one group. Otherwise, a new user is only granted the permissions that are currently assigned to the All Users group. |
Connection timeout | Sets the period of time to wait to establish a connection to the authorization service. The default setting is 5000 milliseconds (5 seconds). |
Read timeout | Sets the period of time to wait to read and retrieve user profile data from the authorization service. The default setting is 5000 milliseconds (5 seconds). |
Changes made to Entra ID | Links to the Audit Events page in Hub. There, you can view a list of changes that were applied to this authentication module. |
Field Mapping
If you've added custom attributes to user profiles, these attributes can also be mapped to attributes that are stored in the authorization service. Each custom attribute is listed by name with an input field for storing the name of the corresponding field in the authorization service.
Attribute names are case-sensitive. If the Microsoft attribute synced is written in camelCase, the attribute field name entered in Hub must match.
Custom attributes in Hub are created with a specific type. The corresponding value from the Azure field must match the field type specified in Hub.
Hub supports attributes retrievable directly from the authentication service user accounts. Attributes like Manager or Sponsors that require querying a separate resource are not supported.
To learn more about custom attributes in user profiles, refer to Manage Custom Attributes.
When Microsoft Entra ID returns a user profile as a response object, values from the specified field paths are copied to the user profile in Hub. Use the following settings to define the endpoint that locates profile data for the authenticated user and map fields that are stored in the authorization service user profiles to the corresponding user accounts in Hub.
To specify paths to fields inside nested objects, enter a sequence of segments separated by the slash character (
/).To reference values that may be stored in more than one location, use the "Elvis operator" (
?:) as a delimiter for multiple paths. With this option, Hub uses the first non-empty value it encounters in the specified field.
Actions
The following actions are available in the header:
Action | Description |
|---|---|
Enable | Enables the authentication module. This option is only shown when the authentication module is currently disabled. |
Disable | Disables the authentication module. This option is only shown when the authentication module is currently enabled. |
Test login | Lets you enter a username and password to test the connection with the authentication service. |
Sync users and groups now | Launches the synchronization of users and groups between Hub and IDE Services. You can configure which Entra ID groups to use in IDE Services on the Users & Groups tab. |
Rename | Lets you update the existing authentication module name and change its default icon. You can find this action in the Actions (...) menu. |
Delete | Removes the authentication module from Hub. Use only when you have configured additional authentication modules that let users log into your Hub installation. You can find this action in the Actions (...) menu. |