Tutorial: Configure Envoy for automatic user provisioning
This tutorial describes the steps you need to perform in both Envoy and Azure Active Directory (Azure AD) to configure automatic user provisioning. When configured, Azure AD automatically provisions and de-provisions users and groups to Envoy 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 Envoy
- Remove users in Envoy when they do not require access anymore
- Keep user attributes synchronized between Azure AD and Envoy
- Provision groups and group memberships in Envoy
- Single sign-on to Envoy (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 (e.g. Application Administrator, Cloud Application administrator, Application Owner, or Global Administrator).
- An Envoy tenant.
- A user account in Envoy with Admin permissions.
This integration is also available to use from Azure AD US Government Cloud environment. You can find this application in the Azure AD US Government Cloud Application Gallery and configure it in the same way as you do from public cloud.
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 Envoy.
Step 2. Configure Envoy to support provisioning with Azure AD
Sign in to your Envoy Admin Console. Click on Integrations.
Click on Install for the Microsoft Azure SCIM integration.
Click on Save for Sync all users.
Copy the OAUTH BEARER TOKEN. This value will be entered in the Secret Token field in the provisioning tab of your Envoy application in the Azure portal.
Step 3. Add Envoy from the Azure AD application gallery
Add Envoy from the Azure AD application gallery to start managing provisioning to Envoy. If you have previously setup Envoy 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 Envoy
This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users and/or groups in TestApp based on user and/or group assignments in Azure AD.
To configure automatic user provisioning for Envoy in Azure AD:
Sign in to the Azure portal. Select Enterprise Applications, then select All applications.
In the applications list, select Envoy.
Select the Provisioning tab.
Set the Provisioning Mode to Automatic.
Under the Admin Credentials section, input
https://app.envoy.com/scim/v2in Tenant URL. Input the OAUTH BEARER TOKEN value retrieved earlier in Secret Token. Click Test Connection to ensure Azure AD can connect to Envoy. If the connection fails, ensure your Envoy 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.
Under the Mappings section, select Synchronize Azure Active Directory Users to Envoy.
Review the user attributes that are synchronized from Azure AD to Envoy in the Attribute-Mapping section. The attributes selected as Matching properties are used to match the user accounts in Envoy for update operations. If you choose to change the matching target attribute, you will need to ensure that the Envoy API supports filtering users based on that attribute. Select the Save button to commit any changes.
Attribute Type userName String externalId String displayName String title String emails[type eq "work"].value String preferredLanguage String department String addresses[type eq "work"].country String addresses[type eq "work"].locality String addresses[type eq "work"].region String addresses[type eq "work"].postalCode String addresses[type eq "work"].formatted String addresses[type eq "work"].streetAddress String name.givenName String name.familyName String name.formatted String phoneNumbers[type eq "mobile"].value String phoneNumbers[type eq "work"].value String locale String
Under the Mappings section, select Synchronize Azure Active Directory Groups to Envoy.
Review the group attributes that are synchronized from Azure AD to Envoy in the Attribute-Mapping section. The attributes selected as Matching properties are used to match the groups in Envoy for update operations. Select the Save button to commit any changes.
Attribute Type displayName String externalId String members Reference
To configure scoping filters, refer to the following instructions provided in the Scoping filter tutorial.
To enable the Azure AD provisioning service for Envoy, change the Provisioning Status to On in the Settings section.
Define the users and/or groups that you would like to provision to Envoy 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?
Submit and view feedback for