title | description | author | manager | ms.service | ms.subservice | ms.topic | ms.date | ms.author |
---|---|---|---|---|---|---|---|---|
Tutorial: Configure Vault Platform for automatic user provisioning with Microsoft Entra ID |
Learn how to automatically provision and de-provision user accounts from Microsoft Entra ID to Vault Platform. |
thomasakelo |
jeedes |
entra-id |
saas-apps |
tutorial |
03/25/2024 |
thomasakelo |
This tutorial describes the steps you need to perform in both Vault Platform and Microsoft Entra ID to configure automatic user provisioning. When configured, Microsoft Entra ID automatically provisions and de-provisions users to Vault Platform 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.
[!div class="checklist"]
- Create users in Vault Platform.
- Remove users in Vault Platform when they do not require access anymore.
- Keep user attributes synchronized between Microsoft Entra ID and Vault Platform.
- Single sign-on to Vault Platform (recommended).
The scenario outlined in this tutorial assumes that you already have the following prerequisites:
- A Microsoft Entra tenant
- One of the following roles: Application Administrator, Cloud Application Administrator, or Application Owner.
- An administrator account with Vault Platform.
- 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 Vault Platform.
Contact Vault Platform support to configure Vault Platform to support provisioning with Microsoft Entra ID.
Go to the Vault Platform, login with your email and password (initial login method), then head to the Administration > Authentication page.
There, first change the login method dropdown to Identity Provider - Azure - SAML
Using the details in the SAML setup instructions page, enter the information:
- Issuer URI must be set to
vaultplatform
- SSO URL must be set to the value of Login URL
- Download the Certificate (Base64) file, open it in a text editor and copy its contents (including the
-----BEGIN/END CERTIFICATE-----
markers) into the Certificate text field
Next go to Administration > Data Integration inside Vault Platform
- For Data Integration select
Azure
. - For Method of providing SCIM secret location set
bearer
. - For Secret set a complex string, similar to a strong password. Keep this string secure as it will be used later on at Step 5
- Toggle Set as active SCIM Provider to be active.
Add Vault Platform from the Microsoft Entra application gallery to start managing provisioning to Vault Platform. If you have previously setup Vault Platform for SSO you can use the same application. However it's recommended that you create a separate app when testing out the integration initially. Learn more about adding an application from the gallery here.
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. If you choose to scope who will be provisioned to your app based on assignment, you can use the following steps to assign users 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 before rolling out to everyone. When scope for provisioning is set to assigned users, you can control this by assigning one or two users to the app. When scope is set to all users, you can specify an attribute based scoping filter.
-
If you need more roles, you can update the application manifest to add new roles.
This section guides you through the steps to configure the Microsoft Entra provisioning service to create, update, and disable users in TestApp based on user and/or group assignments 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 Vault Platform.
-
Select the Provisioning tab.
-
Set the Provisioning Mode to Automatic.
-
Under the Admin Credentials section, input your Vault Platform Tenant URL (URL with structure
https://app.vaultplatform.com/api/scim/${organization-slug}
) and Secret Token (from Step 2.2). Click Test Connection to ensure Microsoft Entra ID can connect to Vault Platform. If the connection fails, ensure your Vault Platform 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 Vault Platform.
-
Review the user attributes that are synchronized from Microsoft Entra ID to Vault Platform in the Attribute-Mapping section. The attributes selected as Matching properties are used to match the user accounts in Vault Platform for update operations. If you choose to change the matching target attribute, you'll need to ensure that the Vault Platform API supports filtering users based on that attribute. Select the Save button to commit any changes.
Attribute Type Supported for filtering Required by Vault Platform userName String ✓ ✓ externalId String ✓ ✓ active Boolean ✓ displayName String title String ✓ emails[type eq "work"].value String ✓ name.givenName String ✓ name.familyName String ✓ addresses[type eq "work"].locality String ✓ addresses[type eq "work"].country String ✓ urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber String ✓ urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department String ✓ urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager String -
To configure scoping filters, refer to the following instructions provided in the Scoping filter tutorial.
-
To enable the Microsoft Entra provisioning service for Vault Platform, change the Provisioning Status to On in the Settings section.
-
Define the users that you would like to provision to Vault Platform by choosing the desired values in Scope in the Settings section.
-
When you're ready to provision, click Save.
This operation starts the initial synchronization cycle of all users 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.
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's to completion
- If the provisioning configuration seems to be in an unhealthy state, the application goes into quarantine. Learn more about quarantine states here.