Prerequisite
Please see our SSO with OneLogin help article to set up your app in OneLogin before proceeding with these steps.
Before getting started, please generate your API token using our API Key Management page.
Setting Up SCIM Provisioning
Navigate to the “Configuration” tab for your Application in OneLogin. Under the “API Connection” section, enter the WorkRamp API token in the SCIM Bearer Token field.
In the SCIM JSON Template, enter the following:
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"userName": "{$parameters.scimusername}",
"active": "{$user.status}",
"externalId": "{$user.external_id}",
"displayName": "{$user.display_name}",
"managerName": "{$user.manager_firstname} {$user.manager_lastname}"
}
Feel free to remove any of the above fields that you don’t want synced to WorkRamp, with the exception of “schemas” and “userName” as those are our required fields.
If you are a customer in the US instance, please use:
SCIM Base URL: https://app.workramp.com/scim/v2
If you are a customer in the EU instance, please use:
SCIM Base URL: https://app.eu.workramp.com/scim/v2
You can check whether you are an EU instance customer by looking at your WorkRamp URL. If it contains "app.eu.workramp.com" you are on the EU instance.
Save your changes by clicking the “Save” button in the top right corner.
Now, click on the “Parameters” tab in the left sidebar of your OneLogin Application. On the “Parameters” page, click on the “SCIM Username” row in the table:
This will pull up an Edit pop-up window. The “Value” for this field should be a User’s e-mail address. Select “Email” from the dropdown and click “Save."
Click on the “Provisioning” tab in the left sidebar of your application in OneLogin. On the “Provisioning” page, configure your provisioning settings as you see fit for your use case. Here is an example:
Navigate to the “Configuration” tab, to click the “Enable” button to enable SCIM provisioning with WorkRamp. Once complete, your API Status should look like this:
Your SCIM application is now connected to WorkRamp! You should be able to assign this application to OneLogin users and see their accounts provisioned in WorkRamp.