|
| 1 | +--- |
| 2 | +title: 'Tutorial: Configure Cleanmail Swiss for automatic user provisioning with Azure Active Directory' |
| 3 | +description: Learn how to automatically provision and deprovision user accounts from Azure AD to Cleanmail Swiss. |
| 4 | +services: active-directory |
| 5 | +author: twimmers |
| 6 | +writer: twimmers |
| 7 | +manager: jeedes |
| 8 | +ms.assetid: 1281f790-7f6d-4558-bb31-015f92ae579d |
| 9 | +ms.service: active-directory |
| 10 | +ms.subservice: saas-app-tutorial |
| 11 | +ms.workload: identity |
| 12 | +ms.topic: tutorial |
| 13 | +ms.date: 07/10/2023 |
| 14 | +ms.author: thwimmer |
| 15 | +--- |
| 16 | + |
| 17 | +# Tutorial: Configure Cleanmail Swiss for automatic user provisioning |
| 18 | + |
| 19 | +This tutorial describes the steps you need to do in both Cleanmail Swiss and Azure Active Directory (Azure AD) to configure automatic user provisioning. When configured, Azure AD automatically provisions and deprovisions users and groups to [Cleanmail](https://www.alinto.com/fr) 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 | +## Capabilities supported |
| 23 | +> [!div class="checklist"] |
| 24 | +> * Create users in Cleanmail |
| 25 | +> * Remove users in Cleanmail Swiss when they do not require access anymore |
| 26 | +> * Keep user attributes synchronized between Azure AD and Cleanmail |
| 27 | +> * [Single sign-on](../manage-apps/add-application-portal-setup-oidc-sso.md) to Cleanmail Swiss (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 | +* A user account in Cleanmail Swiss with Admin permission |
| 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 Cleanmail](../app-provisioning/customize-application-attributes.md). |
| 41 | + |
| 42 | +## Step 2. Configure Cleanmail Swiss to support provisioning with Azure AD |
| 43 | + |
| 44 | +Contact [Cleanmail Swiss Support](https://www.alinto.com/contact-email-provider/) to configure Cleanmail Swiss to support provisioning with Azure AD. |
| 45 | + |
| 46 | +## Step 3. Add Cleanmail Swiss from the Azure AD application gallery |
| 47 | + |
| 48 | +Add Cleanmail Swiss from the Azure AD application gallery to start managing provisioning to Cleanmail. If you have previously setup Cleanmail Swiss for SSO, you can use the same application. However it's recommended 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). |
| 49 | + |
| 50 | +## Step 4. Define who will be in scope for provisioning |
| 51 | + |
| 52 | +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 and group. 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 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](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md). |
| 53 | + |
| 54 | +* 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](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md). |
| 55 | + |
| 56 | +* 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. |
| 57 | + |
| 58 | + |
| 59 | +## Step 5. Configure automatic user provisioning to Cleanmail Swiss |
| 60 | + |
| 61 | +This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users and groups in Cleanmail Swiss based on user and group assignments in Azure AD. |
| 62 | + |
| 63 | +### To configure automatic user provisioning for Cleanmail Swiss in Azure AD: |
| 64 | + |
| 65 | +1. Sign in to the [Azure portal](https://portal.azure.com). Select **Enterprise Applications**, then select **All applications**. |
| 66 | + |
| 67 | +  |
| 68 | + |
| 69 | +1. In the applications list, select **Cleanmail**. |
| 70 | + |
| 71 | +  |
| 72 | + |
| 73 | +1. Select the **Provisioning** tab. |
| 74 | + |
| 75 | +  |
| 76 | + |
| 77 | +1. Set the **Provisioning Mode** to **Automatic**. |
| 78 | + |
| 79 | +  |
| 80 | + |
| 81 | +1. In the **Admin Credentials** section, input your Cleanmail Swiss Tenant URL as `https://cloud.cleanmail.ch/api/v3/scim2` and corresponding Secret Token obtained from Step 2. Click **Test Connection** to ensure Azure AD can connect to Cleanmail. If the connection fails, ensure your Cleanmail Swiss account has Admin permissions and try again. |
| 82 | + |
| 83 | +  |
| 84 | + |
| 85 | +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. |
| 86 | + |
| 87 | +  |
| 88 | + |
| 89 | +1. Select **Save**. |
| 90 | + |
| 91 | +1. In the **Mappings** section, select **Synchronize Azure Active Directory Users to Cleanmail**. |
| 92 | + |
| 93 | +1. Review the user attributes that are synchronized from Azure AD to Cleanmail Swiss in the **Attribute-Mapping** section. The attributes selected as **Matching** properties are used to match the user accounts in Cleanmail Swiss for update operations. If you choose to change the [matching target attribute](../app-provisioning/customize-application-attributes.md), you need to ensure that the Cleanmail Swiss API supports filtering users based on that attribute. Select the **Save** button to commit any changes. |
| 94 | + |
| 95 | + |Attribute|Type|Supported for filtering|Required by Cleanmail| |
| 96 | + |---|---|---|---| |
| 97 | + |userName|String|✓|✓ |
| 98 | + |active|Boolean||✓ |
| 99 | + |name.givenName|String|| |
| 100 | + |name.familyName|String|| |
| 101 | + |externalId|String|| |
| 102 | + |
| 103 | +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). |
| 104 | + |
| 105 | +1. To enable the Azure AD provisioning service for Cleanmail, change the **Provisioning Status** to **On** in the **Settings** section. |
| 106 | + |
| 107 | +  |
| 108 | + |
| 109 | +1. Define the users and groups that you would like to provision to Cleanmail Swiss by choosing the desired values in **Scope** in the **Settings** section. |
| 110 | + |
| 111 | +  |
| 112 | + |
| 113 | +1. When you're ready to provision, click **Save**. |
| 114 | + |
| 115 | +  |
| 116 | + |
| 117 | +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 complete than next cycles, which occur approximately every 40 minutes as long as the Azure AD provisioning service is running. |
| 118 | + |
| 119 | +## Step 6. Monitor your deployment |
| 120 | +Once you've configured provisioning, use the following resources to monitor your deployment: |
| 121 | + |
| 122 | +* Use the [provisioning logs](../reports-monitoring/concept-provisioning-logs.md) to determine which users have been provisioned successfully or unsuccessfully |
| 123 | +* 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 |
| 124 | +* 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). |
| 125 | + |
| 126 | +## More resources |
| 127 | + |
| 128 | +* [Managing user account provisioning for Enterprise Apps](../app-provisioning/configure-automatic-user-provisioning-portal.md) |
| 129 | +* [What is application access and single sign-on with Azure Active Directory?](../manage-apps/what-is-single-sign-on.md) |
| 130 | + |
| 131 | +## Next steps |
| 132 | + |
| 133 | +* [Learn how to review logs and get reports on provisioning activity](../app-provisioning/check-status-user-account-provisioning.md) |
0 commit comments