WorkOS Docs Homepage
Integrations

SCIM

Learn about syncing your user list with a generic SCIM provider.

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 to authenticate its endpoint requests.

Both of these are available in your Endpoint’s Settings in the WorkOS Dashboard.

Login to your WorkOS dashboard and select “Organizations” from the left hand Navigation bar.

Select the Organization you’d like to enable a SCIM Directory Sync connection for.

On the Organization’s page click “Add Directory”.

Select “Generic SCIM v2.0” as the directory type, and then input the Company Name. You may use “Generic SCIM v1.1” if your identity provider doesn’t support SCIM v2.0.

Click the “Create Directory” button.

The Directory Sync Connection will now display the Endpoint for the SCIM server to send requests to, and the Bearer Token.

We have support for custom labeled URLs for Directory Sync endpoints. Contact us for more info!

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.

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