Merge branch 'master' into 4me

Author: v-bhgad

articles/active-directory/saas-apps/envoy-provisioning-tutorial.md

@@ -0,0 +1,169 @@
+---
+title: 'Tutorial: Configure Envoy for automatic user provisioning with Azure Active Directory | Microsoft Docs'
+description: Learn how to configure Azure Active Directory to automatically provision and de-provision user accounts to Envoy.
+services: active-directory
+documentationcenter: ''
+author: zchia
+writer: zchia
+manager: beatrizd
+
+ms.assetid: na
+ms.service: active-directory
+ms.component: saas-app-tutorial
+ms.workload: identity
+ms.tgt_pltfrm: na
+ms.devlang: na
+ms.topic: article
+ms.date: 06/3/2019
+ms.author: zchia
+---
+
+# 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.
+
+> [!NOTE]
+> 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](../manage-apps/user-provisioning.md).
+>
+> This connector is currently in Public Preview. For more information on the general Microsoft Azure terms of use for Preview features, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
+
+## Prerequisites
+
+The scenario outlined in this tutorial assumes that you already have the following prerequisites:
+
+* An Azure AD tenant
+* [An Envoy tenant](https://envoy.com/pricing/)
+* 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:**
+
+1. In the **[Azure portal](https://portal.azure.com)**, in the left navigation panel, select **Azure Active Directory**.
+
+	![The Azure Active Directory button](common/select-azuread.png)
+
+2. Go to **Enterprise applications**, and then select **All applications**.
+
+	![The Enterprise applications blade](common/enterprise-applications.png)
+
+3. To add a new application, select the **New application** button at the top of the pane.
+
+	![The New application button](common/add-new-app.png)
+
+4. In the search box, enter **Envoy**, select **Envoy** in the results panel, and then click the **Add** button to add the application.
+
+	![Envoy in the results list](common/search-new-app.png)
+
+## 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:
+
+* [Assign a user or group to an enterprise app](../manage-apps/assign-user-or-group-access-portal.md)
+
+### 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.
+
+> [!TIP]
+> You may also choose to enable SAML-based single sign-on for Envoy, following the instructions provided in the [Envoy single sign-on tutorial](envoy-tutorial.md). 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:
+
+1. Sign in to the [Azure portal](https://portal.azure.com). Select **Enterprise Applications**, then select **All applications**.
+
+	![Enterprise applications blade](common/enterprise-applications.png)
+
+2. In the applications list, select **Envoy**.
+
+	![The Envoy link in the Applications list](common/all-applications.png)
+
+3. Select the **Provisioning** tab.
+
+	![Provisioning tab](common/provisioning.png)
+
+4. Set the **Provisioning Mode** to **Automatic**.
+
+	![Provisioning tab](common/provisioning-automatic.png)
+
+5. Under the **Admin Credentials** section, input `https://app.envoy.com/scim/v2` in **Tenant URL**. To retrieve the **Secret Token** of your Envoy account, follow the walkthrough as described in Step 6.
+
+6. Sign in to your [Envoy Admin Console](https://dashboard.envoy.com/login). Click on **Integrations**.
+
+	![Envoy Integrations](media/envoy-provisioning-tutorial/envoy01.png)
+
+	Click on **Install** for the **Microsoft Azure SCIM integration**.
+
+	![Envoy Install](media/envoy-provisioning-tutorial/envoy02.png)
+
+	Click on **Save** for **Sync all users**. 
+
+	![Envoy Save](media/envoy-provisioning-tutorial/envoy03.png)
+
+	Retrieve the Secret Token populated.
+	
+	![Envoy OAUTH](media/envoy-provisioning-tutorial/envoy04.png)
+
+7. 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.
+
+	![Token](common/provisioning-testconnection-tenanturltoken.png)
+
+8. 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**.
+
+	![Notification Email](common/provisioning-notification-email.png)
+
+9. Click **Save**.
+
+10. Under the **Mappings** section, select **Synchronize Azure Active Directory Users to Envoy**.
+	
+	![Envoy User Attributes](media/envoy-provisioning-tutorial/envoy-user-mappings.png)
+	
+11. 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.
+
+	![Envoy User Attributes](media/envoy-provisioning-tutorial/envoy-user-attribute.png)
+
+12. Under the **Mappings** section, select **Synchronize Azure Active Directory Groups to Envoy**.
+
+	![Envoy User Mappings](media/envoy-provisioning-tutorial/envoy-group-mapping.png)
+
+13. 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.
+
+	![Envoy User Mappings](media/envoy-provisioning-tutorial/envoy-group-attributes.png)
+	
+14. To configure scoping filters, refer to the following instructions provided in the [Scoping filter tutorial](../manage-apps/define-conditional-rules-for-provisioning-user-accounts.md).
+
+15. To enable the Azure AD provisioning service for Envoy, change the **Provisioning Status** to **On** in the **Settings** section.
+
+	![Provisioning Status Toggled On](common/provisioning-toggle-on.png)
+
+16. 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.
+
+	![Provisioning Scope](common/provisioning-scope.png)
+
+17. When you are ready to provision, click **Save**.
+
+	![Saving Provisioning Configuration](common/provisioning-configuration-save.png)
+
+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](../manage-apps/check-status-user-account-provisioning.md).
+
+## Additional resources
+
+* [Managing user account provisioning for Enterprise Apps](../manage-apps/configure-automatic-user-provisioning-portal.md)
+* [What is application access and single sign-on with Azure Active Directory?](../manage-apps/what-is-single-sign-on.md)
+
+## Next steps
+
+* [Learn how to review logs and get reports on provisioning activity](../manage-apps/check-status-user-account-provisioning.md)
+