Tutorial: Configure Envoy for automatic user provisioning
The objective of this tutorial is to demonstrate the steps to be performed in Envoy and Azure Active Directory (Azure AD) to configure Azure AD to automatically provision and de-provision users and/or groups to Envoy.
This tutorial describes a connector built on top of the Azure AD User 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.
The scenario outlined in this tutorial assumes that you already have the following prerequisites:
- An Azure AD tenant
- An Envoy tenant
- A user account in Envoy with Admin permissions.
Add Envoy from the gallery
Before configuring Envoy for automatic user provisioning with Azure AD, you need to add Envoy from the Azure AD application gallery to your list of managed SaaS applications.
To add Envoy from the Azure AD application gallery, perform the following steps:
In the Azure portal, in the left navigation panel, select Azure Active Directory.
Go to Enterprise applications, and then select All applications.
To add a new application, select the New application button at the top of the pane.
In the search box, enter Envoy, select Envoy in the results panel, and then click the Add button to add the application.
Assigning users to Envoy
Azure Active Directory uses a concept called assignments to determine which users should receive access to selected apps. In the context of automatic user provisioning, only the users and/or groups that have been assigned to an application in Azure AD are synchronized.
Before configuring and enabling automatic user provisioning, you should decide which users and/or groups in Azure AD need access to Envoy. Once decided, you can assign these users and/or groups to Envoy by following the instructions here:
Important tips for assigning users to Envoy
It is recommended that a single Azure AD user is assigned to Envoy to test the automatic user provisioning configuration. Additional users and/or groups may be assigned later.
When assigning a user to Envoy, you must select any valid application-specific role (if available) in the assignment dialog. Users with the Default Access role are excluded from provisioning.
Configuring 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 Envoy based on user and/or group assignments in Azure AD.
You may also choose to enable SAML-based single sign-on for Envoy, following the instructions provided in the Envoy single sign-on tutorial. Single sign-on can be configured independently of automatic user provisioning, though these two features compliment each other.
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. To retrieve the Secret Token of your Envoy account, follow the walkthrough as described in Step 6.
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.
Retrieve the Secret Token populated.
Upon populating the fields shown in Step 5, 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 check the checkbox - Send an email notification when a failure occurs.
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. Select the Save button to commit any changes.
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.
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 of all users and/or groups defined in Scope in the Settings section. The initial sync takes longer to perform than subsequent syncs, which occur approximately every 40 minutes as long as the Azure AD provisioning service is running. You can use the Synchronization Details section to monitor progress and follow links to provisioning activity report, which describes all actions performed by the Azure AD provisioning service on Envoy.
For more information on how to read the Azure AD provisioning logs, see Reporting on automatic user account provisioning.
- Managing user account provisioning for Enterprise Apps
- What is application access and single sign-on with Azure Active Directory?