SCIM Setup Guide

Overview

You can provision user accounts in the Common Room application through SCIM. SCIM supports the following features:

• Creating Users
• Updating User Attributes
• Deactivating Users - User will not be able to log into Common Room
• Custom Role Assignment - Users can be assigned Admin, Editor, Viewer roles

Common Room does not update any user attributes in Okta.

Requirements

An enterprise plan is required to enable this feature, details can be found here. Please contact us to learn more.

SCIM Setup

Once ‘SCIM provisioning’ is enabled on the General tab in Okta, navigate to the Provisioning tab.

To obtain the Authorization token, a user who is assigned a Common Room Admin profile will need to follow the steps below:

1. Login to https://app.commonroom.io
2. Navigate to Settings.
3. Select "API Tokens."
4. Choose "Add another account" and select "create a new token." Copy the token that is created.
5. In Okta, navigate to the "Provisioning" tab.
   

   

6. Select "Configure API Integration."
7. Check the box to enable API integration, as shown below. In the section for the API token, paste the token that was generated in step 4.
   

   

8. Test API Credentials. This should display the following result:
   

   

9. Save the integration.
10. The authorization setup is now complete. Navigate to the ‘To App’ section in Okta.
11. Select the following 3 options:
    • Create Users
    • Update User Attributes
    • Deactivate users
      

      

12. Save the settings. In the "Sign On" tab, ensure that "Email" is selected for the "Application Username Format" field.

Assigning Users

Users can be assigned to the application via the "Assignments" tab. The custom attribute "Common Room Role" is available when assigning any user to the application.

FAQ

Is updating a user’s email attribute currently supported?

No, this will result in the creation of a new account for the user in Common Room.