|
| 1 | +--- |
| 2 | +title: 'Tutorial: Configure Connecter for automatic user provisioning with Azure Active Directory' |
| 3 | +description: Learn how to automatically provision and de-provision user accounts from Azure AD to Connecter. |
| 4 | +services: active-directory |
| 5 | +author: twimmers |
| 6 | +writer: twimmers |
| 7 | +manager: beatrizd |
| 8 | +ms.assetid: 6e60505a-f8c8-46f6-8e6f-525e7c8416b7 |
| 9 | +ms.service: active-directory |
| 10 | +ms.subservice: saas-app-tutorial |
| 11 | +ms.workload: identity |
| 12 | +ms.topic: tutorial |
| 13 | +ms.date: 03/24/2023 |
| 14 | +ms.author: thwimmer |
| 15 | +--- |
| 16 | + |
| 17 | +# Tutorial: Configure Connecter for automatic user provisioning |
| 18 | + |
| 19 | +This tutorial describes the steps you need to perform in both Connecter and Azure Active Directory (Azure AD) to configure automatic user provisioning. When configured, Azure AD automatically provisions and de-provisions users to [Connecter](https://www.designconnected.com/) 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](../app-provisioning/user-provisioning.md). |
| 20 | + |
| 21 | + |
| 22 | +## Supported capabilities |
| 23 | +> [!div class="checklist"] |
| 24 | +> * Create users in Connecter. |
| 25 | +> * Remove users in Connecter when they do not require access anymore. |
| 26 | +> * Keep user attributes synchronized between Azure AD and Connecter. |
| 27 | +> * [Single sign-on](../manage-apps/add-application-portal-setup-oidc-sso.md) to Connecter (recommended). |
| 28 | +
|
| 29 | +## Prerequisites |
| 30 | + |
| 31 | +The scenario outlined in this tutorial assumes that you already have the following prerequisites: |
| 32 | + |
| 33 | +* [An Azure AD tenant](../develop/quickstart-create-new-tenant.md) |
| 34 | +* A user account in Azure AD with [permission](../roles/permissions-reference.md) to configure provisioning (for example, Application Administrator, Cloud Application administrator, Application Owner, or Global Administrator). |
| 35 | +* An admin account for Connecter Server's [Team Portal](https://teamwork.connecterapp.com/) |
| 36 | + |
| 37 | +## Step 1. Plan your provisioning deployment |
| 38 | +1. Learn about [how the provisioning service works](../app-provisioning/user-provisioning.md). |
| 39 | +1. Determine who will be in [scope for provisioning](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md). |
| 40 | +1. Determine what data to [map between Azure AD and Connecter](../app-provisioning/customize-application-attributes.md). |
| 41 | + |
| 42 | +## Step 2. Configure Connecter to support provisioning with Azure AD |
| 43 | + |
| 44 | +### Roles |
| 45 | + |
| 46 | +There are two main roles involved in the configuration: |
| 47 | + |
| 48 | +1. **Team Portal admin** - the sole administrator of everything connected with user and permissions management in Connecter Server. Can be changed by the Connecter Server Subscription owner from here. |
| 49 | +1. Azure AD admin - a person that has full access to the administrative backend of Azure AD and can install new services. |
| 50 | + |
| 51 | +### Step-by-step guide |
| 52 | +#### Actions that must be done by the Team Portal admin: |
| 53 | +1. Log in to Connecter's [Team Portal](https://teamwork.connecterapp.com/). |
| 54 | +1. Select your team. |
| 55 | +1. Click on the **Features tab**. |
| 56 | + |
| 57 | +  |
| 58 | + |
| 59 | +6. *Optional*: If you would like to select a workspace that your team members will be automatically added to when they are synchronized from Azure AD select the **Workspace configuration** action and select the workspace and the permissions. |
| 60 | + |
| 61 | +  |
| 62 | + |
| 63 | +7. Click on the **Authenticate** button. This will open the sign-in page. Sign in with your **Azure AD admin** account to add Connecter to your enterprise applications. |
| 64 | + |
| 65 | +  |
| 66 | + |
| 67 | + |
| 68 | +8. Click on **Get SCIM token**. |
| 69 | +9. Use the button to copy the token to your clipboard and save it for future purpose. |
| 70 | + |
| 71 | +## Step 3. Add Connecter from the Azure AD application gallery |
| 72 | + |
| 73 | +Add Connecter from the Azure AD application gallery to start managing provisioning to Connecter. If you have previously setup Connecter 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](../manage-apps/add-application-portal.md). |
| 74 | + |
| 75 | +## Step 4. Define who will be in scope for provisioning |
| 76 | + |
| 77 | +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. If you choose to scope who will be provisioned to your app based on assignment, you can use the following [steps](../manage-apps/assign-user-or-group-access-portal.md) 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](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md). |
| 78 | + |
| 79 | +* 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](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md). |
| 80 | + |
| 81 | +* If you need more roles, you can [update the application manifest](../develop/howto-add-app-roles-in-azure-ad-apps.md) to add new roles. |
| 82 | + |
| 83 | + |
| 84 | +## Step 5. Configure automatic user provisioning to Connecter |
| 85 | + |
| 86 | +This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users in TestApp based on user and/or group assignments in Azure AD. |
| 87 | + |
| 88 | +### To configure automatic user provisioning for Connecter in Azure AD: |
| 89 | + |
| 90 | +1. Sign in to the [Azure portal](https://portal.azure.com). Select **Enterprise Applications**, then select **All applications**. |
| 91 | + |
| 92 | +  |
| 93 | + |
| 94 | +1. In the applications list, select **Connecter**. |
| 95 | + |
| 96 | +  |
| 97 | + |
| 98 | +1. Select the **Provisioning** tab. |
| 99 | + |
| 100 | +  |
| 101 | + |
| 102 | +1. Set the **Provisioning Mode** to **Automatic**. |
| 103 | + |
| 104 | +  |
| 105 | + |
| 106 | +1. Under the **Admin Credentials** section, input your Connecter Tenant URL as `https://teamwork.connecterapp.com/scim/v2` and corresponding Secret Token obtained from step 2. Click **Test Connection** to ensure Azure AD can connect to Connecter. If the connection fails, ensure your Connecter account has Admin permissions and try again. |
| 107 | + |
| 108 | +  |
| 109 | + |
| 110 | +1. 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. |
| 111 | + |
| 112 | +  |
| 113 | + |
| 114 | +1. Select **Save**. |
| 115 | + |
| 116 | +1. Under the **Mappings** section, select **Synchronize Azure Active Directory Users to Connecter**. |
| 117 | + |
| 118 | +1. Review the user attributes that are synchronized from Azure AD to Connecter in the **Attribute-Mapping** section. The attributes selected as **Matching** properties are used to match the user accounts in Connecter for update operations. If you choose to change the [matching target attribute](../app-provisioning/customize-application-attributes.md), you'll need to ensure that the Connecter API supports filtering users based on that attribute. Select the **Save** button to commit any changes. |
| 119 | + |
| 120 | + |Attribute|Type|Supported for filtering|Required by Connecter| |
| 121 | + |---|---|---|---| |
| 122 | + |userName|String|✓|✓ |
| 123 | + |active|Boolean|| |
| 124 | + |displayName|String||✓ |
| 125 | + |externalId|String|| |
| 126 | + |
| 127 | +1. To configure scoping filters, refer to the following instructions provided in the [Scoping filter tutorial](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md). |
| 128 | + |
| 129 | +1. To enable the Azure AD provisioning service for Connecter, change the **Provisioning Status** to **On** in the **Settings** section. |
| 130 | + |
| 131 | +  |
| 132 | + |
| 133 | +1. Define the users that you would like to provision to Connecter by choosing the desired values in **Scope** in the **Settings** section. |
| 134 | + |
| 135 | +  |
| 136 | + |
| 137 | +1. When you're ready to provision, click **Save**. |
| 138 | + |
| 139 | +  |
| 140 | + |
| 141 | +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 Azure AD provisioning service is running. |
| 142 | + |
| 143 | +## Step 6. Monitor your deployment |
| 144 | +Once you've configured provisioning, use the following resources to monitor your deployment: |
| 145 | + |
| 146 | +* Use the [provisioning logs](../reports-monitoring/concept-provisioning-logs.md) to determine which users have been provisioned successfully or unsuccessfully |
| 147 | +* Check the [progress bar](../app-provisioning/application-provisioning-when-will-provisioning-finish-specific-user.md) to see the status of the provisioning cycle and how close it's to completion |
| 148 | +* If the provisioning configuration seems to be in an unhealthy state, the application goes into quarantine. Learn more about quarantine states [here](../app-provisioning/application-provisioning-quarantine-status.md). |
| 149 | + |
| 150 | +## More resources |
| 151 | + |
| 152 | +* [Managing user account provisioning for Enterprise Apps](../app-provisioning/configure-automatic-user-provisioning-portal.md) |
| 153 | +* [What is application access and single sign-on with Azure Active Directory?](../manage-apps/what-is-single-sign-on.md) |
| 154 | + |
| 155 | +## Next steps |
| 156 | + |
| 157 | +* [Learn how to review logs and get reports on provisioning activity](../app-provisioning/check-status-user-account-provisioning.md) |
0 commit comments