Tutorial: Configure Code42 for automatic user provisioning
This tutorial describes the steps you need to perform in both Code42 and Azure Active Directory (Azure AD) to configure automatic user provisioning. When configured, Azure AD automatically provisions and de-provisions users and groups to Code42 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.
- Create users in Code42
- Remove users in Code42 when they do not require access anymore
- Keep user attributes synchronized between Azure AD and Code42
- Provision groups and group memberships in Code42
- Single sign-on to Code42 (recommended)
The scenario outlined in this tutorial assumes that you already have the following prerequisites:
- An Azure AD tenant
- A user account in Azure AD with permission to configure provisioning (for example, Application Administrator, Cloud Application administrator, Application Owner, or Global Administrator).
- A Code42 tenant with Identity Management enabled.
- A Code42 user account with Customer Cloud Admin permission.
This integration is also available to use from Azure AD US Government Cloud environment. You can find this application in the Azure AD US Government Cloud Application Gallery and configure it in the same way as you do from public cloud.
Step 1. Plan your provisioning deployment
- Learn about how the provisioning service works.
- Determine who will be in scope for provisioning.
- Determine what data to map between Azure AD and Code42.
Step 2. Configure Code42 to support provisioning with Azure AD
This section guides you through the steps to configure Azure AD as a provisioning provider in the Identity Management section of Code42's console. Doing so will enable Code42 to securely receive provisioning requests from Azure AD. It is recommended to review Code42's support documentation before provisioning with Azure AD.
To create a provisioning provider in Code42's console:
- Sign in to your Code42 console. Select Administration to expand the navigation menu. Select Settings then Identity Management.
- Select the Provisioning tab. Then expand the Add provisioning provider menu and select Add SCIM provider.
- In the Display name field, enter a unique name for the provisioning provider. Set the Authentication credential type to OAuth token. Select Next to generate credentials.
- Keep this window open until prompted for the Base URL and Token required in the next steps.
- Alternatively, copy this information to a temporary location for future reference.
Step 3. Add Code42 from the Azure AD application gallery
Add Code42 from the Azure AD application gallery to start managing provisioning to Code42. If you have previously setup Code42 for SSO, you can use the same application. However it is recommended that 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 will be in scope for provisioning
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 / group. If you choose to scope who will be provisioned to your app based on assignment, you can use the following steps 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.
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.
If you need additional roles, you can update the application manifest to add new roles.
Step 5. Configure automatic user provisioning to Code42
This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users and/or groups in TestApp based on user and/or group assignments in Azure AD.
To configure automatic user provisioning for Code42 in Azure AD:
Sign in to the Azure portal. Select Enterprise Applications, then select All applications.
In the applications list, select Code42.
Select the Provisioning tab.
Set the Provisioning Mode to Automatic.
Under the Admin Credentials section, input the SCIM 2.0 base URL and Access Token values retrieved earlier from Code42 in Tenant URL and Secret Token respectively. Click Test Connection to ensure Azure AD can connect to Code42. If the connection fails, ensure your Code42 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.
Under the Mappings section, select Synchronize Azure Active Directory Users to Code42.
Review the user attributes that are synchronized from Azure AD to Code42 in the Attribute-Mapping section. The attributes selected as Matching properties are used to match the user accounts in Code42 for update operations. If you choose to change the matching target attribute, you will need to ensure that the Code42 API supports filtering users based on that attribute. Select the Save button to commit any changes.
Attribute Type userName String active Boolean title String emails[type eq "work"].value String name.givenName String name.familyName String addresses[type eq "work"].locality String addresses[type eq "work"].region String addresses[type eq "work"].country String externalId String userType String urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department String urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division String urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager Reference
Under the Mappings section, select Synchronize Azure Active Directory Groups to Code42.
Review the group attributes that are synchronized from Azure AD to Code42 in the Attribute-Mapping section. The attributes selected as Matching properties are used to match the groups in Code42 for update operations. Select the Save button to commit any changes.
Attribute Type displayName String externalId String members Reference
To configure scoping filters, refer to the following instructions provided in the Scoping filter tutorial.
To enable the Azure AD provisioning service for Code42, change the Provisioning Status to On in the Settings section.
Define the users and/or groups that you would like to provision to Code42 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 cycle of all users and groups 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.
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 is to completion
- If the provisioning configuration seems to be in an unhealthy state, the application will go into quarantine. Learn more about quarantine states here.
- Managing user account provisioning for Enterprise Apps
- What is application access and single sign-on with Azure Active Directory?
- Configure organization assignments based on SCIM groups in Code42
- Configure role assignments based on SCIM groups in Code42
Submit and view feedback for