Tutorial: Configure Gtmhub for automatic user provisioning
This tutorial describes the steps you need to perform in both Gtmhub and Microsoft Entra ID to configure automatic user provisioning. When configured, Microsoft Entra ID automatically provisions and de-provisions users and groups to Gtmhub using the Microsoft Entra provisioning service. For important details on what this service does, how it works, and frequently asked questions, see Automate user provisioning and deprovisioning to SaaS applications with Microsoft Entra ID.
Note
Currently, when automatic user provisioning is configured, Microsoft Entra-only automatically de-provisions users and groups to Gtmhub as well as map users to their respective teams using the Microsoft Entra provisioning service.But in 2021 once SSO is enabled with Gtmhub,users will be automatically provisioned when they log in through SSO and will be assigned to their respective team.
Capabilities Supported
- Remove users in Gtmhub when they do not require access anymore.
- Keep user attributes synchronized between Microsoft Entra ID and Gtmhub.
- Map users into their teams automatically and align them.
Prerequisites
The scenario outlined in this tutorial assumes that you already have the following prerequisites:
- A Microsoft Entra tenant.
- A user account in Microsoft Entra ID with permission to configure provisioning (for example, Application Administrator, Cloud Application administrator, Application Owner, or Global Administrator).
- An Enterprise Gtmhub account.
Step 1: Plan your provisioning deployment
- Learn about how the provisioning service works.
- Determine who will be in scope for provisioning.
- Determine what data to map between Microsoft Entra ID and Gtmhub.
Step 2: Configure Gtmhub to support team mapping and user de-provisioning with Microsoft Entra ID
In order to connect your provisioning application to your Gtmhub account you will need to issue a SCIM token and compile the tenant URL.
To issue a new SCIM token:
Sign in to your Gtmhub account. Navigate to Settings > Configuration > API Tokens.
Click on Issue Token and select SCIM. Enter a name for the token and click the Generate API Token button.
Once the token is generated you can copy and use it in your Microsoft Entra provisioning application.
To compile the tenant URL:
Your tenant URL has to be in the following format:
https://app.gtmhub.com/api/v1/scim/azure/{account_id}If your Gtmhub account is located in the US data center you will also have to add the data center to the URL:
https://app.us.gtmhub.com/api/v1/scim/azure/{account_id}To get the account ID go to Settings then select the API Tokens tab and copy the account ID:
Step 3: Add Gtmhub from the Microsoft Entra application gallery
Add Gtmhub from the Microsoft Entra application gallery to start managing provisioning to Gtmhub. If you have previously setup Gtmhub for SSO you can use the same application. However it is recommended that you create a separate app when testing out the integration initially. Learn more about adding an application from the gallery here.
Step 4: Define who will be in scope for provisioning
The Microsoft Entra provisioning service allows you to scope who will be provisioned based on assignment to the application and or based on attributes of the user / group. If you choose to scope who will be provisioned to your app based on assignment, you can use the following steps to assign users and groups to the application. If you choose to scope who will be provisioned based solely on attributes of the user or group, you can use a scoping filter as described here.
Start small. Test with a small set of users and groups before rolling out to everyone. When scope for provisioning is set to assigned users and groups, you can control this by assigning one or two users or groups to the app. When scope is set to all users and groups, you can specify an attribute based scoping filter.
If you need additional roles, you can update the application manifest to add new roles.
Step 5: Configure automatic user provisioning to Gtmhub
This section guides you through the steps to configure the Microsoft Entra provisioning service to create, update, and disable users and/or groups in TestApp based on user and/or group assignments in Microsoft Entra ID.
To configure automatic user provisioning for Gtmhub in Microsoft Entra ID:
Sign in to the Microsoft Entra admin center as at least a Cloud Application Administrator.
Browse to Identity > Applications > Enterprise applications
In the applications list, select Gtmhub.
Select the Provisioning tab.
Set the Provisioning Mode to Automatic.
Under the Admin Credentials section, input your Gtmhub Tenant URL and Secret Token. Click Test Connection to ensure Microsoft Entra ID can connect to Gtmhub. If the connection fails, ensure your Gtmhub account has Admin permissions and try again.
In the Notification Email field, enter the email address of a person or group who should receive the provisioning error notifications and select the Send an email notification when a failure occurs check box.
Select Save.
Under the Mappings section, select Synchronize Microsoft Entra users to Gtmhub.
Review the user attributes that are synchronized from Microsoft Entra ID to Gtmhub in the Attribute-Mapping section. The attributes selected as Matching properties are used to match the user accounts in Gtmhub for update operations. If you choose to change the matching target attribute, you will need to ensure that the Gtmhub API supports filtering users based on that attribute. Select the Save button to commit any changes.
Attribute Type Supported for filtering userName String ✓ externalId String ✓ urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager Reference To configure scoping filters, refer to the following instructions provided in the Scoping filter tutorial.
To enable the Microsoft Entra provisioning service for Gtmhub, change the Provisioning Status to On in the Settings section.
Define the users and/or groups that you would like to provision to Gtmhub by choosing the desired values in Scope in the Settings section.
When you are ready to provision, click Save.
This operation starts the initial synchronization cycle of all users and groups defined in Scope in the Settings section. The initial cycle takes longer to perform than subsequent cycles, which occur approximately every 40 minutes as long as the Microsoft Entra provisioning service is running.
Step 6: Monitor your deployment
Once you've configured provisioning, use the following resources to monitor your deployment:
- Use the provisioning logs to determine which users have been provisioned successfully or unsuccessfully
- Check the progress bar to see the status of the provisioning cycle and how close it is to completion
- If the provisioning configuration seems to be in an unhealthy state, the application will go into quarantine. Learn more about quarantine states here.
Additional resources
- Managing user account provisioning for Enterprise Apps
- What is application access and single sign-on with Microsoft Entra ID?
Next steps
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for