Tutorial: Configure Cleanmail Swiss for automatic user provisioning
This tutorial describes the steps you need to do in both Cleanmail Swiss and Microsoft Entra ID to configure automatic user provisioning. When configured, Microsoft Entra ID automatically provisions and deprovisions users to Cleanmail using the Microsoft Entra 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 Microsoft Entra ID.
Capabilities supported
- Create users in Cleanmail
- Remove users in Cleanmail Swiss when they do not require access anymore
- Keep user attributes synchronized between Microsoft Entra ID and Cleanmail
- Single sign-on to Cleanmail Swiss (recommended).
Prerequisites
The scenario outlined in this tutorial assumes that you already have the following prerequisites:
- A Microsoft Entra tenant
- One of the following roles: Application Administrator, Cloud Application Administrator, or Application Owner.
- A user account in Cleanmail Swiss with Admin permission
Step 1: Plan your provisioning deployment
- Learn about how the provisioning service works.
- Determine who is in scope for provisioning.
- Determine what data to map between Microsoft Entra ID and Cleanmail.
Step 2: Configure Cleanmail Swiss to support provisioning with Microsoft Entra ID
Contact Cleanmail Swiss Support to configure Cleanmail Swiss to support provisioning with Microsoft Entra ID.
Step 3: Add Cleanmail Swiss from the Microsoft Entra application gallery
Add Cleanmail Swiss from the Microsoft Entra 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.
Step 4: Define who is in scope for provisioning
The Microsoft Entra provisioning service allows you to scope who is provisioned based on assignment to the application and or based on attributes of the user. If you choose to scope who is provisioned to your app based on assignment, you can use the following steps to assign users to the application. If you choose to scope who is provisioned based solely on attributes of the user, you can use a scoping filter as described here.
Start small. Test with a small set of users before rolling out to everyone. When the scope for provisioning is set to assigned users, you can control this by assigning one or two users to the app instance. When scope is set to all users, you can specify an attribute based scoping filter.
If you need more roles, you can update the application manifest to add new roles.
Step 5: Configure automatic user provisioning to Cleanmail Swiss
This section guides you through the steps to configure the Microsoft Entra provisioning service to create, update, and disable users in Cleanmail Swiss based on user assignments in Microsoft Entra ID.
To configure automatic user provisioning for Cleanmail Swiss in Microsoft Entra ID:
Sign in to the Microsoft Entra admin center as at least a Cloud Application Administrator.
Browse to Identity > Applications > Enterprise applications
In the applications list, select Cleanmail.
Select the Provisioning tab.
Set the Provisioning Mode to Automatic.
In the Admin Credentials section, input your Cleanmail Swiss Tenant URL as
https://cloud.cleanmail.ch/api/v3/scim2and corresponding Secret Token obtained from Step 2. Click Test Connection to ensure Microsoft Entra ID can connect to Cleanmail. If the connection fails, ensure your Cleanmail Swiss 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.
Select Save.
In the Mappings section, select Synchronize Microsoft Entra users to Cleanmail.
Review the user attributes that are synchronized from Microsoft Entra ID 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, you need to ensure that the Cleanmail Swiss API supports filtering users based on that attribute. Select the Save button to commit any changes.
Attribute Type Supported for filtering Required by Cleanmail userName String ✓ ✓ active Boolean ✓ name.givenName String name.familyName String externalId String To configure scoping filters, refer to the following instructions provided in the Scoping filter tutorial.
To enable the Microsoft Entra provisioning service for Cleanmail, change the Provisioning Status to On in the Settings section.
Define the users that you would like to provision to Cleanmail Swiss by choosing the desired values in Scope in the Settings section.
When you're ready to provision, click Save.
This operation starts the initial synchronization cycle of all users 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 Microsoft Entra 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's to completion
- If the provisioning configuration seems to be in an unhealthy state, the application goes into quarantine. Learn more about quarantine states here.
More resources
- Managing user account provisioning for Enterprise Apps
- What is application access and single sign-on with Microsoft Entra ID?