Directory Sync

Configuring SCIM v2.0

Learn about syncing your user list with a generic SCIM v2.0 server

This guide outlines how to synchronize your application's user and group directories using SCIM v2.0.

To synchronize an Enterprise's users and groups provisioned for your application, you'll need to provide the Enterprise with two pieces of information:

  • An Endpoint that the SCIM server will make requests to.
  • A Bearer token for the SCIM server to authenticate its endpoint requests.

Both of these are available in your Endpoint's Settings in the Developer Dashboard.

Note: Steps 2 and 3 below will need to be carried out by the Enterprise when configuring your application in their SCIM server.

Step 1. Set up your directory sync endpoint

Click "Add new endpoint".

Input your Enterprise's name, and select "Generic SCIM v2.0" from the dropdown.

Then, click "Create endpoint."

Note: We have support for white-labeled URLs for Directory Sync endpoints. Contact us for more info!

Step 2. Configure the SCIM server integration

WorkOS provides you with all of the relevant information for an Enterprise customer to plug and play SCIM functionality for your application.

Provide your Enterprise customer with:

Once the Enterprise has used these values to configure your application within their SCIM server, then your application is ready to synchronize users and groups.

Assign users and groups to your application

Now, whenever your Enterprise customer assigns users or groups to your application, you'll receive realtime Dashboard updates based on changes in their directory.