How to provision users to Code42 from Okta
This article applies to Cloud.
Available in:
Overview
Provisioning automatically adds and deactivates users in your Code42 environment as well as assigns users roles and permissions. This article explains how to connect Okta provisioning and Code42. Once configured, Code42 automatically adds, updates, and removes users based on syncs from Okta to Code42.
This article assumes you are familiar with the concept of provisioning. To learn more, see our introduction to provisioning. If you want to add Okta as an authentication provider, see Configuring Okta for SSO in your Code42 cloud environment.
Considerations
- To enable Okta's provisioning in Code42, your Okta environment must be licensed for the Lifecycle Management feature. If you are not licensed for the feature, you can still use Okta for authentication.
- Configure your private network, Internet, and VPN settings to allow client devices to communicate with your identity provider on ports 80 and 443. Test client connectivity to the identity provider before you proceed.
- Local users cannot be created, updated, or deleted from the provisioning provider. These users can only be managed in the administration console.
Known issue with Okta provisioning
When pushing new groups, the groups may be created in the Code42 administration console without users, and an error appears in the Okta dashboard.
For help resolving this issue, contact your Customer Success Manager (CSM) for enterprise support at csmsupport@code42.com.
User Provisioning
The following user provisioning features are available in the Code42 Okta app in the cloud. For more information on these provisioning features, see Okta's documentation.
Supported
- Create Users: New users created in Okta are also created in Code42
- Deactivate users: Deactivating the user in Okta deactivates the user in Code42
Note: For the Code42 app, deactivating a user means removing the user's account and placing the user's data into cold storage. Learn more about deactivating a user. By default, there is a 15 minute delay before Code42 deactivates a user. - Push groups: Adds groups and users from Okta to Code42
- Update user attributes: Okta updates users' profiles. Okta profile values overwrite any changes made in Code42.
Not Supported
- Import users from Code42 to Okta
- Password sync
Block, deauthorize, and deactivate users
There are a few special considerations when blocking, deauthorizing, and deactivating users.
- Blocking is a non-destructive action that prevents access to the Code42 app. A blocked user or device cannot sign in.
- Deauthorizing is a non-destructive action that simply signs a user out of a specific device. Users can sign in again at any time.
- Deactivating is a destructive action that removes a user from your Code42 environment. An active user can sign in again to a deactivated device, but a deactivated user cannot sign in. The user's archives on destinations are placed into cold storage for the configured cold storage period. Once the cold storage period has passed, the archive is permanently deleted.
Users on legal hold cannot be deactivated
If you place users under legal hold, the identity provider cannot deactivate them. Their data is retained for the legal hold process. Users are blocked instead of deactivated. Once your release users from legal hold, they are automatically deactivated.
Deactivation delay
When a provisioning provider sends an update to deactivate a user, Code42 waits 15 minutes before deactivating the user. This helps protect against moving users backup archives into cold storage if the users are accidently deactivated in the identity provider. You can adjust the delay time in the administration console. Note that the delay only applies when deactivating users using provisioning. When you manually deactivate users in the administration console, there is no delay.
Okta suspended state
You can suspend users via Okta. Suspended users cannot sign in to the administration console or Code42 apps on their devices. However, suspending users does not deauthorize them (sign them out of the Code42 app) if they are currently signed in. When you suspend users in Okta, you must go to the administration console and manually block those users. Blocking users signs them out, and prevents them from signing back in to the Code42 apps on their devices.
Before you begin
Determine how you want to map users from the provisioning provider to Code42 organizations. To learn more, see our introduction to provisioning article. There are 4 ways to map users to a Code42 organization:
Map all users to a Code42 organization
Assigns all users to the same Code42 organization. If you choose this option, create organizations in the administration console before you begin.
Example use case
Use this option if you manage users in the administration console. For example, all users that are provisioned from the provisioning provider are added to the same organization. You can then move the users from that single organization to additional organizations in the administration console.
Map all users to organizations based on the provider's "c42OrgName" attribute
Creates new organizations or assigns users to existing organizations based on the value for the user attribute c42OrgName. This value becomes the name for the Code42 org. This attribute is managed on the provisioning provider.
Example use case
Use this method if you wish to manage users in the provisioning provider (and not in the administration console). Whatever is the value for this attribute becomes the name for the Code42 org. Code42 creates new organizations or assigns users to existing organizations based on the value.
Map all users to organizations based on an existing provider SCIM attribute
Creates new organizations or assigns users to existing organizations based on the value for the chosen user attribute. For example, if you want to set up your Code42 organizations by office location, create an office attribute from the provisioning provider user profile. The value of the attribute becomes the name of the organization.
Example use case
Use this method if you already have an attribute included in the provisioning provider user profile that you wish to use for organization mapping. For example, say you want to set up your Code42 organizations by office location. You create an office attribute. Whatever is the value of the office attribute becomes the name of the organization.
Map users to organizations using SCIM groups
Assigns users to Code42 organizations based on their SCIM group. If you choose this option, create organizations in the administration console before you begin.
Example use case
Use this mapping if your users are already assigned to SCIM groups. For example, a user is part of a two different SCIM groups: an executive group and a UK group. You want this user's backup policies to match the other executives in your company, so this user should be assigned to the same Code42 organization as the other executives. In the administration console, you can choose the executive group to take priority over the UK group. This way you can place all of the executives in your company in the same organization and ensure they have the same backup policies.
Compare methods
| Automatically creates organizations in Code42 | Requires you to create Code42 organizations before you begin | Requires your provider to send SCIM groups to Code42 | |
|---|---|---|---|
| Map all users to a Code42 organization | x | ||
| Map all users to organizations based on the provider's "c42OrgName" attribute | x | ||
| Map all users to organizations based on an existing provider SCIM attribute | x | ||
| Map users to organizations using SCIM groups | x | x |
Step 1: Create Code42 organizations
This step is only required if you choose to use the Single Organization or Custom SCIM mapping methods. The "c42OrgName" attribute and Custom attribute methods create Code42 organizations automatically.
- Sign in to the administration console.
- Click Organizations, and choose Active.
- Select the Add an organization icon
and enter a name.
This method adds the organization under the default organization. - To add a child organization
- Select the organization.
- Click the action menu
in the upper-right corner. - Choose Add a child organization.
- Repeat until you have added all of your organizations.
Step 2: Add a provisioning provider in the Code42 administration console
- In the administration console, navigate to Settings.
- Choose Identity Management.
- Select the Provisioning tab.
- Click Add Provisioning Provider.
- Enter a display name and click Next.
- The Add SCIM Provisioning message appears. Leave this message open. You need this information for the next step in the provisioning provider setup.
Step 3: Add the Okta application for Code42
- Sign in to your Okta dashboard.
- Add the Code42 application.
Note: There are two Code42 apps on Okta's website. Add the Code42 app, which is used for cloud Code42 environments. The Code42 Single Tenant app is used in Code42 environments with on-premises authority server and in single-tenant cloud environments.
- Configure the general settings, and click Next.
Do not assign people to Okta's Code42 app yet. First complete the organization mapping (Step 7) and role mapping (Step 8). If you assign people to the Code42 app before you configure mapping, Okta cannot automatically map users to Code42 organizations and roles.
Step 4: Configure Okta's provisioning tab
- In the Okta dashboard, select the Provisioning tab of the Code42 app.
- Click Configure API Integration.
- Select Enable API Integration.
- Enter the Base URL, Username, and Password generated from the Code42 administration console (Step 2).
- Click Test API Credentials.
A success message appears. - Click Save.
- Under Settings, click To App.
- Select Edit.
- Enable the following settings:
- Create Users
- Update User Attributes
- Deactivate Users
- Click Save.
(Optional) Step 5: Edit deactivation delay
The deactivation delay determines how long Code42 waits to deactivate a user after syncing with the provisioning provider. Although Code42 may be configured to wait, Code42 does immediately block a user once they receive deactivation update from from the provisioning provider. Blocking a user means they can no longer sign in to the Code42 app, but their devices continue to back up. The delay helps prevent accidently deactivating a user and removing their backup archive. Learn more about deactivating a user. In the administration console, view the provisioning provider details. Edit the deactivation delay.
Step 6: Push user groups from Okta to Code42
From the Okta dashboard, push user groups from Okta to Code42. See Okta's documentation for more details. If you are not using groups, continue to Step 7.
Complete the organization mapping (Step 7) and role mapping (Step 8). Otherwise, Code42 cannot automatically map provisioned users to organizations and roles.
Step 7: Choose an organization mapping method
The mapping method determines how Code42 assigns users to organizations. Organizations are used to set backup policies and permissions for users in your Code42 environment. To change the method, go to Organization Mapping, and click Add Organization Mapping or the edit icon.
The Edit Organization Mapping Method dialog is displayed.
In the Edit Organization Mapping Method dialog, choose one of the following mapping methods:
Map all users to a Code42 organization
Assigns all users to the same Code42 organization.
- In Edit Organization Mapping Method, choose Single Organization.
- Select an existing organization to map all users to.
Map users to organizations based on the provider's "c42OrgName" attribute
Creates new organizations or assigns users to existing organizations based on the value for the user attribute c42OrgName.
- In Edit Organization Mapping Method, choose "c42OrgName" attribute.
- Choose an organization where unmapped users will be assigned. Unmapped users are users who do not have the c42OrgName attribute.
Map users to organizations based on an existing provider SCIM attribute
Creates new organizations or assigns users to existing organizations based on the value for the chosen user attribute.
- In Edit Organization Mapping Method, choose Custom attribute.
- In Enter a SCIM attribute, enter name for an attribute that exists in your provisioning provider's user profiles.
- Choose an organization where unmapped users will be assigned. Unmapped users are user who do not have the custom attribute.
Map users to organizations using SCIM groups
Assigns users to Code42 organizations based on their SCIM group. You can also choose the priority of which organization a user is mapped to if they belong to two or more groups.
- In Edit Organization Mapping Method, choose Custom SCIM mapping.
- Choose an organization where unmapped users will be assigned. Unmapped users are users who either do not belong to a group or their group is not mapped.
- Click Save.
The group mapping appears. - Click Add Mapping.
- Select one or more SCIM groups.
- From Select a Code42 organization, choose an organization from the menu.
- Click Save.
The mapping appears on the Provisioning Provider details page. - Repeat until all of your SCIM groups have been mapped to Code42 organizations.
The message All SCIM groups are mapped appears.
- (Optional) Adjust the priority of each mapping. This is useful for users who belong to more than one SCIM group.
There are no SCIM groups available
This message appears if SCIM groups have not been synced with the administration console. Push groups to the administration console to begin organization mapping.
Do not assign people to the Code42 app in the provisioning provider yet. Wait until after you have completed the organization mapping and role mapping. If you assign people to the Code42 app before you configure mapping, the users are not automatically mapped to Code42 organizations and roles.
Step 8: Configure role mapping
Role mapping allows you to automatically assign Code42 roles and permissions to provisioned users based on their SCIM group. Learn more about Code42 roles and permissions. Users who are not mapped inherit the default roles for their organization.
Role Mapping is only available if you are using SCIM groups.
- Click Add Role Mapping.
- Select a SCIM group from the dropdown.
Only groups that have not been mapped appear in the dropdown.
- Choose one or more roles from the list to apply to this SCIM group. Learn more about Code42 roles and permissions.
We recommend including the roles Desktop User and PROe User for all users who are backing up their computers to Code42. These roles allow users to sign in to the Code42 app and administration console. If you are giving external groups access to your Code42 environment (for example, outside legal council) they do not need these roles.
- Click Add.
The role mapping appears under the provisioning provider detail. - Repeat until all of your SCIM groups have been mapped to Code42 organizations.
The message All SCIM groups are mapped appears.
There are no SCIM groups available
This message appears if SCIM groups have not been synced with the administration console. Push groups to the administration console to begin role mapping.
Do not assign people to the Code42 app in the provisioning provider yet. Wait until after you have completed the organization mapping and role mapping. If you assign people to the Code42 app before you configure mapping, the users are not automatically mapped to Code42 organizations and roles.
Step 9: Assign the Code42 app to users or groups in Okta
Users will not appear in Code42 until you assign them the Code42 app in Okta. We recommend creating a test user in Okta, and assigning the Code42 app to the test user before assigning the app to all users or groups. Once you assign the Code42 app to a user or group, Okta immediately syncs with Code42 and provisions the users.
See Okta's documentation for more information on assigning users and groups to applications.
Troubleshooting
Recommendations for troubleshooting provisioning:
- Once provisioning is configured in Code42, you should make all user changes in Okta. Code42 does not sync changes back to Okta, so any changes you make on the Code42 side causes the two apps to become out-of-sync.
- Updating the Code42 administration console does not start a sync between Okta and Code42. Only changes made in Okta can start a sync.
- To view more information about provisioning changes and logs, see the Sync Log in the Code42 administration console. It gives details of all of the users that have been created, updated, or deleted due to provisioning.
Contact our Customer Champions for Code42 for Enterprise support.
External resources
- Okta: Using group push
- Okta: Provisioning concepts and methods
- Okta: Manage user profiles