Hub
 
2024.3
You are viewing the documentation for an earlier version of Hub.
  1. Access Management
  2. Auth Modules
  3. Microsoft Entra ID Auth Module

Microsoft Entra ID Auth Module

Last modified: 18 October 2024

The Microsoft Entra ID authentication module is a pre-configured auth module that lets users log in to Hub and any connected services with their Microsoft Entra ID accounts.

note

When a user created manually in Hub logs on with Microsoft Entra ID for the first time, Hub ties the Microsoft Entra ID user to the existing Hub user if a matching email address or username is found. If no match is found, a new account for the Microsoft Entra ID user is created in Hub.

Custom Tenant Setup

When you follow this setup, logins are restricted to users whose accounts are stored in your Microsoft Entra ID instance. If you want to accept login requests from any Azure Active Directory (AD) tenant, follow the instructions for a common tenant.

When you create a Microsoft Entra ID module for a custom tenant, you provide the tenant ID of the custom tenant when you create the auth module. This automatically adds your Azure Tenant ID to the authorization and token endpoints that are used by the auth module.

To learn how to set up a new tenant, please refer to the Microsoft Azure documentation.

To create the Microsoft Entra ID module:

tip

Requires permissions: Low-level Admin Write

  1. In the Access Management section of the Administration menu, select Auth Modules.

  2. From the New Module drop-down list, select Microsoft Entra ID.

    • The New Microsoft Entra ID Module dialog opens.

      New Microsoft Entra ID Module dialog for a custom tenant setup.

  3. Enter a name for the module in the Name field.

  4. Paste the value from the Tenant ID field in Microsoft Azure into the Tenant field.

  5. Click the Create button in the dialog.

    • The Auth Modules page displays the settings for a new Microsoft Entra ID authentication module.

    • Hub generates a redirect URI for you to use in the authorization service.

      The redirect UI for connecting with the Microsoft Entra ID service.

  6. If the feature is supported by your browser, use the Copy button to copy the redirect URI to your clipboard.

The next step is to register the authorized redirect URI for Hub in the Microsoft Azure portal. This gives you access to the client ID and secret that you need to enable the Microsoft Entra ID authentication module.

To learn how to perform this setup, please follow the instructions in the product documentation for Microsoft Azure.

The following table lists the key configuration options 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 the Azure portal.

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, you must grant the application the following Delegated type permissions for working with the Microsoft Graph API:

  • GroupMember.Read.All

  • User.Read

If you want to set up synchronization between Microsoft Entra ID and Hub, the following Application type permissions are required as well:

  • Group.Read.All

  • GroupMember.Read.All

  • User.ReadAll

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:

  1. Copy the Application (client) ID from Microsoft Azure and paste it into the Client ID input field in the Hub auth module.

  2. Copy the value for the Client secret from Microsoft Azure and paste it into the Client secret input field in Hub.

  3. Configure the optional settings for the authentication module. For more information, see Additional Settings.

  4. Click the Save button at the bottom of the page.

  5. Click the Enable module 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 Hub with their Microsoft accounts.

Common Tenant Setup

A Microsoft Entra ID module that uses the endpoint for common tenants follows the standard setup for an OAuth 2.0 auth module. This setup accepts login requests from any Azure Active Directory (AD) tenant, including users who are not members of your organization. If you want to restrict logins to users who are registered in your company's Microsoft Entra ID instance, follow the instructions for a custom tenant.

Your first step is to create an auth module and generate a redirect URI in Hub.

To generate a redirect URI in Hub:

tip

Requires permissions: Low-level Admin Write

  1. In the Access Management section of the Administration menu, select Auth Modules.

  2. From the New module drop-down list, select Microsoft Entra ID.

    • The New Microsoft Entra ID Module dialog opens.

      The New Microsoft Entra ID Module dialog for a comment tenant setup.

  3. Enter a name for the module in the Name field.

  4. Leave the Tenant ID field empty.

  5. Click the Create button in the dialog.

    • The Auth Modules page displays the settings for a new Microsoft Entra ID authentication module.

    • Hub generates a redirect URI for you to use in the authorization service.

      The redirect URI for connecting with the Microsoft Entra ID service.

  6. If the feature is supported by your browser, use the Copy button to copy the redirect URI to your clipboard.

Make sure to update the Redirect URI in the authorization service when you change the base URL of your Hub instance. For example, after changing proxy settings.

The next step is to register the authorized redirect URI for Hub in the Microsoft Azure portal. This gives you access to the client ID and secret that you need to enable the Microsoft Entra ID authentication module.

To learn how to perform this setup, please follow the instructions in the product documentation for Microsoft Azure.

The following table lists the key configuration options 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.

Choose whichever option best matches your intended audience for Hub.

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 the Azure portal.

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, you must grant the application the following Delegated type permissions for working with the Microsoft Graph API:

  • GroupMember.Read.All

  • User.Read

If you want to set up synchronization between Microsoft Entra ID and Hub, the following Application type permissions are required as well:

  • Group.Read.All

  • GroupMember.Read.All

  • User.ReadAll

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:

  1. Copy the Application (client) ID from Microsoft Azure and paste it into the Client ID input field in Hub.

  2. Copy the value for the Client secret from Microsoft Azure and paste it into the Client secret input field in Hub.

  3. Configure the optional settings for the authentication module. For more information, see Additional Settings.

  4. Click the Save button at the bottom of the page.

  5. Click the Enable module 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 Hub with their Microsoft accounts.

Settings

The first section of the settings page displays the general settings for the authentication module. Here, you also find 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 that are generated in the authorization service.

Setting

Description

Type

Displays the type of authorization service that is enabled for third-party authentication in Hub.

Name

Stores the name of the authentication module. Use this setting to distinguish this module from other authentication modules in the Auth Modules list.

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 upload a JPG, GIF, or PNG file. The image is resized to 48 x 48 pixels automatically.

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.

Tenant ID

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.

Synchronization Settings

The settings in this section let you set up synchronization of user account data between Hub and Microsoft Entra ID.

When synchronization is enabled, changes applied to Microsoft Entra ID profiles are synchronized with Hub on a set schedule. This synchronization is performed in addition to the synchronization requests that are automatically sent when users log in to Hub or a connected service using their Microsoft account credentials.

Values for the Full Name, Username, and Email that are stored in the Hub profile are populated when the user account is first created, which is usually when a new user logs in to Hub using their Microsoft Entra ID account. Later changes to these attributes in Microsoft Entra ID profiles are not synced with the Hub profile. These changes are synced with the corresponding attributes that are associated with their Microsoft Entra ID credentials. This information is displayed in the Credentials section of the Account Security tab in the Hub profile.

This synchronization applies to the attributes that are configured in the Field Mapping settings and group memberships as configured on the Group Mappings tab. For details, see Field Mapping and Group Mappings.

Setting

Description

Account status

This setting determines whether accounts are banned in Hub when an account with corresponding credentials is deleted or deactivated in the Microsoft identity platform.

  • When set to Ignore, changes to the account status in the Microsoft identity platform are not applied to accounts in Hub.

  • When set to Forward, accounts that are deleted or deactivated in the Microsoft identity platform are banned in Hub.

Schedule

Determines the frequency with which user attributes and group memberships are synchronized with the directory service. You can choose from one of three predefined intervals:

  • Hourly

  • Every 3 hours

  • Daily at 9 AM

You can also manually synchronize the Hub database at any time by clicking the Synchronize now button.

When synchronization is Off, group memberships are still synchronized on a per-user basis during login. To learn more about this feature, see Group Mappings.

The synchronization feature is only active when the authentication module is Enabled.

Field Mapping

note

Availability

Before beginning the sync, add all custom user attribute fields in your Hub installation. The field mapping settings for the Microsoft Entra ID authentication module are only displayed when your Hub installation has at least one custom user attribute. Standard user attributes are mapped automatically.

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.

Field mapping settings for a Microsoft Entra ID authentication module.

To learn more about custom attributes in user profiles, see 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.

Additional Settings

The following options are located at the bottom of the page. These settings let you define the request scope and choose how to authenticate with the service.

Other options in this section let you manage Hub account creation and group membership and reduce the loss of processing resources consumed by idle connections.

Option

Description

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 authorization 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).

Audit

Links to the Audit Events page in Hub. There, you can view a list of changes that were applied to this authentication module.

Group Mappings

On the Group Mappings tab, you can map existing groups in the authorization service to the groups in Hub.

Group mappings for Microsoft Entra ID accounts.

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.

You can map multiple Microsoft Entra ID groups to a single target group in Hub. You can't map Microsoft Entra ID groups to more than one Hub group.

To map a group from Microsoft Entra ID to a group in Hub:

tip

Requires permissions: Low-level Admin Write

  1. Open your Microsoft Entra ID auth module.

  2. Select the Group Mappings tab.

  3. Click the Add mapping button.

    • The Add Mapping dialog opens.

    Dialog for adding group mappings.

  4. Enter the name of the Microsoft Entra ID group in the OAuth group name field.

  5. Select a group from the Target group list.

  6. Click the Add button.

    • The mapping is added to the list.

Actions

The following actions are available in the header:

Action

Description

Set default

Designates the authentication module as the default for your installation. Only one authentication module can be set as the default at any time. If another module is currently set as the default, that state is cleared.

This option is only shown when the current authentication module is not designated as the default.

Clear default

Removes the authentication module as the default for your installation.

If none of the available authentication modules are designated as the default, unauthenticated users are always directed to the Hub login page.

This option is only shown when the current authentication module is designated as the default.

Disable module

Disables the authentication module.

This option is only shown when the authentication module is currently enabled.

Enable module

Enables the authentication module.

This option is only shown when the authentication module is currently disabled.

Delete module

Removes the authentication module from Hub. Use only when you have configured additional authentication modules that let users log into your Hub installation.

Migration from the Azure AD 2.0 Auth Module

The Azure AD authentication module included in Hub versions earlier than 2022.2 doesn't support the ability to map and sync memberships between groups in the Microsoft Entra ID service and groups in Hub. If you want to use this feature, you need to migrate to the updated version of the authentication module.

To perform this migration:

  1. Delete the existing Azure AD 2.0 authentication module. You can distinguish the older module because it is assigned the OAuth 2.0 type in the list.

  2. Set up a new Microsoft Entra ID authentication module as described on this page.

You can also copy the existing client ID and client secret that are stored in the deactivated module to the new authentication module and register the redirect URI for the new module in Microsoft Azure.

To register the redirect URI for the new module:

  1. From the Administration menu, select Access Management > Auth Modules.

  2. Select the deactivated Azure AD 2.0 authentication module from the list.

  3. Open the Auth Modules page in a separate window or browser tab.

  4. From the New module drop-down list, select Microsoft Entra ID.

    • The New Microsoft Entra ID Module dialog opens.

      New azure auth common tenant

  5. Enter a name for the module in the Name field.

  6. If you're working with a custom tenant setup, copy the value for the Tenant ID from the deactivated module and paste it into the input field for the new module. If working with a common tenant setup, leave the Tenant ID field empty.

  7. Click the Create button in the dialog.

    • The Auth Modules page displays the settings for a new Microsoft Entra ID authentication module.

    • Hub generates a redirect URI for you to use in the authorization service.

      Azure auth common tenant redirect uri

  8. If the feature is supported by your browser, use the Copy button to copy the new redirect URI to your clipboard.

  9. Navigate to your existing application in the Microsoft Azure portal.

  10. Add the new redirect URI to the list of redirect URIs that are registered for the application. If you want to remove the redirect URI for the deactivated module, it's safe to do so now as well.

  11. Switch back to the Azure AD 2.0 auth module in Hub.

  12. Copy the value stored as the Client ID, switch to the new authentication module, then paste this value in to the Client ID field there.

  13. Switch back to the old module and copy the value stored as the Client secret. Switch back to the new authentication module and paste this value in to the Client secret field there.

  14. Click the Save button at the bottom of the page.

  15. Click the Enable module button in the header.

    • The new 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 Hub with their Microsoft accounts.

  16. Click the Auth Modules link to return to the list of authentication modules.

  17. Select the Azure AD 2.0 module from the list.

  18. Click the Delete button in the toolbar.

    Option to delete the selected authentication module.

  19. Click the Delete button in the confirmation dialog.