1. Code42 Support
  2. Incydr
  3. Incydr administration
  4. Configuring
  5. SCIM provisioning

How to configure SCIM provisioning

Updated

Overview

SCIM provisioning allows you to automatically manage users in your cloud Code42 environment. Once enabled, Code42 creates new users, removes deactivated users, and updates user roles and permissions based on syncs with your provisioning provider. This article explains how to configure SCIM provisioning. 

The steps in this article give an overview of how to configure a SCIM provider that supports the SCIM 2.0 protocol. For directions specific to our supported provisioning providers, see:

To learn more about provisioning concepts, see Introduction to SCIM provisioning.

Code42 User Directory Sync
Code42 User Directory Sync is another option for automating user management, similar to SCIM provisioning. However, User Directory Sync has different requirements and a different setup process. For more information, see Configure Code42 User Directory Sync. 

Considerations

  • To use this functionality, you must be assigned the Identity Management Administrator role. 

  • The Code42 provisioning feature requires you to connect a third-party provisioning provider to Code42. The following are the basic requirements that your provider and your Code42 environment need to meet to integrate correctly:
    • Cloud Code42 environment: Provisioning is only available in cloud Code42 environments.
    • SCIM 2.0: Code42 requires a provisioning provider to use the SCIM 2.0 protocol. 
    • SCIM groups: The custom SCIM mapping and role mapping require that your provider uses SCIM groups. Other provisioning features are available without SCIM groups.

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 several ways to map users to a Code42 organization: 

Create new users in a Code42 organization

Assigns all users to the same Code42 organization. New users are moved to this organization. Users that are subsequently moved outside of this organization remain in their new organization. 

Example use case
Use this option if you use a single organization to manage users in the Code42 console.

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. 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 Code42 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 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 Code42 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 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 Code42 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
Create new users in a Code42 organization   x  
Map all users to organizations based on the provider's "c42OrgName" 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.

  1. Sign in to the Code42 console.
  2. Select Administration > Environment > Organizations.
  3. Click Create organization.
  4. Enter a descriptive name for the organization.
    Names must contain at least 3 characters, to a maximum of 220 characters.
  5. To automatically assign the new organization to a parent organization, select an existing organization from the Parent organization list.
    By default, new organizations are created as children of your top-level organization, but you can select a different parent organization if needed. When you add a child organization using the Actions menu on the organization detail screen, the new organization is automatically created as a child of that existing organization and this list is not available. 
  6. Click Create to add the new organization.
  7. Repeat until you have added all of your organizations.
Organization inheritance
Child organizations inherit the settings of their parent organization by default. To edit the settings for a child organization, go to the organization details and change the Inherit settings from parent organization setting as needed.

Step 2: Add a provisioning provider in the Code42 console

  1. In the Code42 console, navigate to Administration > Integrations > Identity Management.
  2. Select the Provisioning tab.
    Add provisioning provider
  3. Click Add Provisioning Provider and select Add SCIM Provider from the menu.
  4. Enter a display name and select the Authentication Credential Type:
    • API credentials (default)
      Generates a password.
    • OAuth token
      Generates a token for use with SCIM providers who accept OAuth tokens for credentials.
  5. Click Next. 
  6. The SCIM Provider Created message appears. Leave this message open. You need this information for the next step in the provisioning provider setup.
    After you have used the information here for provisioning provider setup, click Done.

    SCIM Provider Created message

Step 3: Configure your provisioning provider

The steps for configuration vary by provisioning provider. See your provider's documentation for more details. When finished obtaining the information from the Add SCIM Provisioning dialog, click Done. The provisioning provider details appear. 

Provisioning_provider

(Optional) Step 4: Edit deactivation delay

In the Code42 console, view the provisioning provider details and select Deactivation Delay. 

The deactivation delay determines how long Code42 waits to deactivate a user after syncing with the provisioning provider. To learn more about user deactivation, see Deactivate and reactivate users and devices.

Backup agent only: Although Code42 may be configured to wait, Code42 does immediately block a user once they receive deactivation update from the provisioning provider. Blocking a user means they can no longer sign in to Code42 agents, but their devices continue to back up. The delay helps prevent accidentally deactivating a user and removing their backup archive. If you need to cancel a pending user deactivation during the delay period, unblock the user.

Deactivation of users on legal hold

Backup agent only

If users who are custodians under a legal hold are subsequently selected for deactivation (for example, from the Code42 console, a provisioning provider, or API), they are not deactivated immediately because their data must be retained for legal hold purposes. Instead, they are blocked. Once these blocked users are released from legal hold, they are deactivated automatically. 

Step 5: Push SCIM groups to Code42

Groups pushed to Code42 are used to map users to organizations, roles, and watchlists. To push SCIM groups from the provisioning provider to Code42, see your provider's documentation. If you are not using groups, continue to the next step.

For more information about pushing groups to Code42, see our instructions for:

SCIM groups are not supported for PingOne.

Apply changes after mapping SCIM groups

If you want to map SCIM groups to Code42 organizations in Step 6 or roles in Step 7, you must first push or provision SCIM groups and their users to Code42 so they are available in the Code42 console. 

However, this means that initially the users are provisioned in the default organization and are assigned default roles rather than the ones you want to map them to. To move these users to the desired organizations and roles, ensure that you map SCIM groups to organizations (Step 6) and roles (Step 7) and then apply the mappings using the Apply Org and Role Settings action.  

Step 6: 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. 

provisioning_provider

The Edit Organization Mapping Method dialog is displayed.
Edit organization mapping

In the Edit Organization Mapping Method dialog, choose one of the following mapping methods:

Create new users in an organization

Assigns all users to the same Code42 organization.

  1. In Edit Organization Mapping Method, choose Create new users in the organization below. 
  2. 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.

  1. In Edit Organization Mapping Method, choose Map users to organization based on the provider's "c42OrgName" attribute. 
  2. Choose an organization where unmapped users will be assigned. Unmapped users are users who do not have the c42OrgName 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.

  1. In Edit Organization Mapping Method, choose Map users to organizations using SCIM groups. 
  2. 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. 
  3. Click Save. 
    The group mapping appears. 
  4. Click Add Mapping.
  5. Select one or more SCIM groups.
    Add mapping
  6. From Select a Code42 organization, choose an organization from the menu. 
  7. Click Save. 
    The mapping appears on the Provisioning Provider details page. 
  8. Repeat until all of your SCIM groups have been mapped to Code42 organizations. 
    The message All SCIM groups are mapped appears.
    All SCIM Groups are mapped
  9. (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 Code42 console. Push groups to the Code42 console to begin organization mapping. 

Wait to assign people or groups to the Code42 application in the provisioning provider
Do not assign people to the Code42 application in the provisioning provider yet. Wait until after you have completed the organization mapping and role mapping. If you assign people to the Code42 application before you configure mapping, the users are not automatically mapped to Code42 organizations and roles.  

Step 7: 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. 

SCIM Groups
Role Mapping is only available if you are using SCIM groups. 
  1. Click Add Role Mapping. 
  2. Select a SCIM group from the dropdown. 
    Only groups that have not been mapped appear in the dropdown.
    Add role mapping
  3. Choose one or more roles from the list to apply to this SCIM group. Learn more about Code42 roles and permissions.
Basic roles
  • If the insider risk agent is deployed to users in this group, include the Agent User role.
  • If the backup agent is deployed to users in this group, include the Desktop User and PROe User roles. These roles allow users to sign in to the Code42 agent and Code42 console to manage their backups and restore their files. If you are giving external groups access to your Code42 environment (for example, outside legal council) they do not need these roles.
  1. Click Add. 
    The role mapping appears under the provisioning provider detail. 
  2. 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 Code42 console. Push groups to the Code42 console to begin role mapping. 

Wait to assign people or groups to the Code42 application in the provisioning provider
Do not assign people to the Code42 application in the provisioning provider yet. Wait until after you have completed the organization mapping and role mapping. If you assign people to the Code42 application before you configure mapping, the users are not automatically mapped to Code42 organizations and roles.  

Step 8: Assign the Code42 app users or groups in the provisioning provider

Users will not appear in Code42 until you assign them to the Code42 application in your SCIM provisioning provider. Create a test user and assign the Code42 application to the test user before assigning the app to all of the groups. Once you assign the Code42 application to a group or user, the SCIM provisioning provider immediately syncs with Code42 and provisions the users.

See your SCIM provider's documentation for more information about assigning apps to users and groups. 

Configure directory sync email frequency (optional)

By default, Incydr emails a daily summary of recent directory sync activity to all users with the Customer Cloud Admin role. To change this frequency:

  1. Go to Administration > Integrations > Identity Management.
  2. Click Settings.
  3. Choose how often to send emails:
    • Daily
    • Only when there are directory sync errors
    • Never
  4. Click Save.

The selected frequency applies to all provisioning providers and Customer Cloud Admin users in your environment.

Troubleshooting

Tips for troubleshooting SCIM provisioning: 

  • Once SCIM provisioning is configured in Code42, you should make all user changes in the SCIM provisioning provider. Code42 does not make changes to the provisioning provider, so any changes made on the Code42 side causes the two apps to become out-of-sync. 
  • Updating the Code42 console does not start a sync between the SCIM provisioning provider and Code42. Only changes made in the provisioning provider can start a sync. 
  • To view more information about provisioning changes and logs, see the Sync Log in the Code42 console. This gives details of all of the users that have been created, updated, or deleted due to provisioning. 
Need more help?
Contact our Technical Support Engineers​.