Enable SCIM API extension

📘

Note:

To use Oneflow's SCIM API, you need to have a Oneflow account with an Enterprise plan. If you're new to Oneflow, go to the Oneflow application and create a trial account.

Enabling the SCIM API extension in Oneflow will generate a SCIM API token required for running calls:

1. Log in to Oneflow.

2. Go to Admin > Account > Extensions page and enable the SCIM extension

3. When enabled, the system will automatically generate a SCIM token for you.

4. Copy the token and securely save it for future use.

🚧

Note:

The token is shown only once.

Authentication

• The SCIM API uses bearer token authentication.
• Each API request needs to contain the SCIM API token within the request header.

In the following example, replace "[TOKEN]" with your SCIM API token.

curl --request GET \
     --url 'https://api.oneflow.com/scim/v1/Users?sortBy=displayName&sortOrder=ascending&startIndex=1&count=100' \
     --header 'accept: application/scim+json' \
     --header 'authorization: Bearer [TOKEN]'

import requests

url = 'https://api.oneflow.com/scim/v1/Users?sortBy=displayName&sortOrder=ascending&startIndex=1&count=100'
headers = {
    'accept': 'application/scim+json',
    'authorization': 'Bearer [TOKEN]'
}
response = requests.get(url, headers=headers)

print(response.status_code)
print(response.text)

📘

Note:

Please read the Authentication and authorization section and look at the available endpoints in the API Reference documentation.

Next steps

Now you are ready to start building your automation workflow!