Skip to main content

SCIM with Okta

R
Written by Rafaela Oliveira
Updated over a month ago

SCIM (system for cross-domain identity management) allows your application to communicate on a recurring basis with your organization's IDP.

SCIM Setup helps you use SCIM without integrating your product directly with Okta. You will instead integrate with SCIM Setup, which will communicate with Okta on your behalf.

Connecting SCIM Setup to your Okta implementation requires that you share two pieces of information with Okta, both of which you’ll find in SCIM Setup:

  1. A base url that Okta will perform operations on (e.g. via HTTP PATCH)

  2. A bearer token that Okta will include with its requests

However, configuring Okta can involve a few more steps. This guide therefore starts by focusing briefly on SCIM Setup and subsequently focuses on Okta configuration.

Configuring SCIM Setup

To create a SCIM Directory within SCIM Setup, you’ll first need to create an Environment and an Organization. SCIM Directories belong to Organizations. You can create a SCIM Directory for an Organization by navigating to the Organization in SCIM Setup and selecting Create SCIM directory.

Creating a SCIM Directory in SCIM Setup

From there, you can find the base URL and generate the bearer token you’ll need. Hold onto these.

SCIM Setup does not store bearer tokens. You will not be able to access the bearer token in SCIM Setup again. You may at any time, however, replace the existing bearer token with a new one. When you create a new bearer token, you simultaneously invalidate the previous bearer token.

Before you continue, ensure that you have set the SCIM directory primary field to Yes - you can make this change by clicking on the Edit button.

Capturing the base URL and bearer token from SCIM Setup

Setting SCIM directory to Primary

Once you have created a SCIM Directory in SCIM Setup and taken note of both the base URL and the bearer token, you have finished with SCIM Setup configuration.

Configuring Okta

Once there’s a SCIM Directory in SCIM Setup, you can connect that SCIM Directory to your Okta instance.

Start by navigating to the relevant application in Okta.

Visiting an Application in Okta

Make sure you’re on the General tab and press Edit on the App Settings card.

Editing app settings

Make sure the Provisioning box shows a checkmark. By default, Okta leaves this box unchecked.

Checking the Enable SCIM provisioning field

Press Save in the lower right corner.

Pressing save

Navigate to the Provisioning tab for the Application.

Navigating to the Provisioning tab

On the Provisioning tab, click the Edit button toward the top right of the card.

Clicking the Edit button

Look for a field marked SCIM connector base URL. This will be the base URL from the SCIM Setup configuration. Paste the base URL from SCIM Setup.

Inserting the SCIM connector base URL

Next, look for a field marked Unique identifier field for users. We need this to say “email” exactly. SCIM Setup relies on users’ emails as a unique identifier.

Entering 'email' as the unique identifier field

Look for a series of checkboxes labeled Supported provisioning actions. You will see five checkboxes. Set your configuration to match the following:

  • Import New Users and Profile Updates

  • Push New Users

  • Push Profile Updates

  • Push Groups

Ensure that Import Groups remains unchecked. The SCIM Connection will fail otherwise.

Editing the 'Supported provisioning actions'

Now look for a dropdown menu labeled Authentication Mode. This must change from its default value to HTTP Header.

Changing the 'Authentication Mode' to 'HTTP Header'

Now paste the bearer token from SCIM Setup in the field marked Authorization.

Pasting the bearer token from SCIM Setup

Then once more hit Save in the lower right.

Saving edits to the SCIM connection

Now look in the sidebar to the left and find the item marked To App. Click this.

Navigating to the setting for provisioning to the app

You’ll see four checkboxes. Set them to match the following:

  • Create Users

  • Update User Attributes

  • Deactivate Users

Ensure that Sync Password remains unchecked.

Then press Save in the lower right.

Saving edits to the SCIM connection

Now navigate to the Assignments tab.

Navigating to the 'Assignments' settings

Using the Assign dropdown, choose to assign the relevant People (i.e. users) or Groups. This guide uses People.

Assigning People to the Application

You’ll now see a list of People. For each that you wish to assign to the Application, press the Assign button to the right.

Starting the assignment flow for a person

You’ll have the opportunity to edit this person’s attributes, but it’s usually fine just to scroll down and press Save and Go Back.

Pressing 'Save and Go Back

Unless you wish to add other People to the Application, you can now press Done.

Finishing assignment to the Application

Within a few moments, the user will sync in SCIM Setup. You can see any changes by navigating back to the SCIM Directory’s page in SCIM Setup.

Note: If you assigned users to the Application before setting up the SCIM Connection, you may need to instruct Okta to force sync. You can read more here.

Did this answer your question?