WorkOS Docs Homepage
Integrations

OneLogin SCIM v2.0

Learn about syncing your user list with OneLogin SCIM v2.0.

This guide outlines how to synchronize your application’s OneLogin 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 OneLogin will make requests to.
  • A Bearer Token for OneLogin to authenticate its endpoint requests.

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

Steps 2, 3, and 4 below will need to be carried out by the Enterprise when configuring your application in their OneLogin instance.

Login to your WorkOS Dashboard and select “Organizations” from the left hand navigation bar.

Select the Organization you’ll be configuring a new Directory Sync for.

Click “Add Directory”.

A screenshot showing where to find “Add Directory” in the WorkOS Dashboard.

Select “OneLogin SCIM v2.0” from the dropdown, and input your Enterprise’s Name.

Then, click “Create Directory.”

A screenshot showing "Create Directory" details in the WorkOS Dashboard.

Your OneLogin SCIM v.2.0 directory sync has now been created successfully with an Endpoint and Bearer Token.

A screenshot showing where to find the "Endpoint" and "Bearer Token" for an organization in the WorkOS Dashboard.

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

Log in to the OneLogin admin dashboard, select the “Applications” tab at the top. If the application has already been created, select it and move to step 3. Otherwise, select “Add App”.

A screenshot showing where to select "Add App" in OneLogin

Search for “scim” in the text field and select the Application with type “SCIM Provisioner with SAML (SCIM V2 Enterprise)”.

A screenshot showing where to search for “scim” and select the application “SCIM Provisioner with SAML (SCIM V2 Enterprise)”

Give your Application a descriptive Display Name and hit “Save”.

A screenshot showing where to add a "Display Name" to your App in OneLogin

Within the SCIM Application, select the “Configuration” tab on the left.

Copy and paste the Endpoint from your WorkOS Dashboard into the “SCIM Base URL” field.

Then, copy and paste the Bearer Token from your WorkOS Dashboard into the “SCIM Bearer Token” field.

Hit “Enable” under “API Status” and then hit “Save”.

A screenshot showing where to select the "Configure" tab and input your "SCIM Base URl" and "SCIM Bearer Token" in your SCIM App in OneLogin

Select the “Provisioning” tab on the left. Check the “Enable provisioning” box and hit “Save”.

A screenshot showing where to select "Provisioning" tab select "Enable Provisioning" in OneLogin

Select the “Parameters” tab on the left. Then select “Groups”.

A screenshot showing where to select the "Parameters" then select the "Groups" in OneLogin SCIM App

In the modal that pops up, check the box next to “Include in User Provisioning” and hit “Save”.

A screenshot showing how to select "Include in User Provisioning" in the "Parameters" tab in OneLogin

In order for your users and groups to be synced, you will need to assign them to your OneLogin Application. Select “Users” from the top navigation menu.

Next, find a user you’d like to provision to the SCIM app. Within that user profile, select the “Applications” tab on the left. Then, click the “+” symbol.

A screenshot showing where to select "+" in the "Applications" tab in OneLogin

Select the appropriate app and hit “Continue”.

A screenshot showing how to select SCIM App to assign OneLogin User

Select “Save” in the next modal to confirm the change.

A screenshot showing how to save User Assignment in OneLogin

There are many ways to provision groups in OneLogin. Below is one method that we recommend, but other methods can be used.

In the top navigation, Select “Users” and then “Roles” from the dropdown. Select “New Role”.

A screenshot showing how to create a "New Role" in OneLogin

Give the Role a name (this will be the name of the group), select the appropriate SCIM application, and hit “Save”.

A screenshot showing how to configure and save the "Role" in OneLogin

Click the “Users” tab for the role. Search for any users you’d like to assign to that role and hit “Add To Role”. Then hit “Save”.

A screenshot showing how to add Users to "Role" in OneLogin

Click “Save” in the next modal to confirm.

A screenshot showing where to click "Save" assignments to "Role" in OneLogin

Navigate back to your SCIM app and click on the “Rules” tab on the left. Then, hit “Add Rule”.

A screenshot showing the "Rule" tab where you can then click "Add Rule" in OneLogin

Give your Rule a name. Under “Actions”, select “Set Groups in your-app-name”. Then, set it to “For each role with value that matches your-role-name”. Hit “Save”.

A screenshot showing how to configure a "New Mapping" in OneLogin

Within your SCIM app under the "Users" tab, you may then need to click on any “Pending” notifications to confirm the update for users.

A screenshot showing how to confirm updates for Users under the "Users" tab in OneLogin

Begin provisioning users and groups and witness realtime changes in your WorkOS Dashboard.

A screenshot showing a linked Directory in the WorkOS Dashboard