Tutorial: Configure Holmes Cloud for automatic user provisioning
This tutorial describes the steps you need to perform in both Holmes Cloud and Azure Active Directory (Azure AD) to configure automatic user provisioning. When configured, Azure AD automatically provisions and de-provisions users and groups to Holmes Cloud using the Azure AD 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 Azure Active Directory.
- Create users in Holmes Cloud.
- Remove users in Holmes Cloud when they do not require access anymore.
- Keep user attributes synchronized between Azure AD and Holmes Cloud.
- Provision groups and group memberships in Holmes Cloud.
- Single sign-on to Holmes Cloud (recommended).
The scenario outlined in this tutorial assumes that you already have the following prerequisites:
- An Azure AD tenant.
- A user account in Azure AD with permission to configure provisioning (for example, Application Administrator, Cloud Application administrator, Application Owner, or Global Administrator).
- A Holmes Cloud tenant.
- A user account in Holmes Cloud with Admin permissions.
- A Holmes Cloud subscription where single sign-on and user provisioning service are enabled.
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 Azure AD and Holmes Cloud.
Step 2. Configure Holmes Cloud to support provisioning with Azure AD
- You will receive your Holmes Cloud tenant URL from Holmes Cloud Support firstname.lastname@example.org team after purchasing the subscription.
- You can find the required information(endpoint URL, token, etc.) to set up the provisioning service in the Company Settings page as long as you subscribe single sign-on and user provisioning service.
- Login to Holmes Cloud account with your Holmes Cloud credentials.
- Select "会社設定 (Company Settings)" menu and then select the hat shaped icon.
- See the information including API token on the card menu titled "アカウントプロビジョニング (Account Provisioning)".
- For token regeneration, select the link "APIキーを発行する (Issue API key)".
Step 3. Add Holmes Cloud from the Azure AD application gallery
Add Holmes Cloud from the Azure AD application gallery to start managing provisioning to Holmes Cloud. If you have previously setup Holmes Cloud 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 Azure AD 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 Holmes Cloud
This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users and/or groups in Holmes Cloud based on user and/or group assignments in Azure AD.
To configure automatic user provisioning for Holmes Cloud in Azure AD:
Sign in to the Azure portal. Select Enterprise Applications, then select All applications.
In the applications list, select Holmes Cloud.
Select the Provisioning tab.
Set the Provisioning Mode to Automatic.
In the Admin Credentials section, input your Holmes Cloud Tenant URL and Secret Token. Click Test Connection to ensure Azure AD can connect to Holmes Cloud. If the connection fails , ensure your Holmes Cloud 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.
In the Mappings section, select Synchronize Azure Active Directory Users to Holmes Cloud.
Review the user attributes that are synchronized from Azure AD to Holmes Cloud in the Attribute-Mapping section. The attributes selected as Matching properties are used to match the user accounts in Holmes Cloud for update operations. If you choose to change the matching target attribute, you will need to ensure that the Holmes Cloud API supports filtering users based on that attribute. Select the Save button to commit any changes.
Attribute Type Supported for filtering userName String ✓ active Boolean displayName String externalId String
Under the Mappings section, select Synchronize Azure Active Directory Groups to Holmes Cloud.
Review the group attributes that are synchronized from Azure AD to Holmes Cloud in the Attribute-Mapping section. The attributes selected as Matching properties are used to match the groups in Holmes Cloud for update operations. Select the Save button to commit any changes.
Attribute Type Supported for filtering displayName String ✓ members Reference externalId String
To configure scoping filters, refer to the following instructions provided in the Scoping filter tutorial.
To enable the Azure AD provisioning service for Holmes Cloud, change the Provisioning Status to On in the Settings section.
Define the users and/or groups that you would like to provision to Holmes Cloud 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 Azure AD 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.
- Managing user account provisioning for Enterprise Apps
- What is application access and single sign-on with Azure Active Directory?