Back to API overview

SCIM

SCIM 2.0

SCIM 2.0 provisioning for automated user and group sync from your identity provider. Base path: /api/os/scim/v2 on your app domain.

SCIM 2.0 provisioning for automated user and group sync from your identity provider. Base path: /api/os/scim/v2 on your app domain.

SCIM requests use a bearer token configured in the dashboard — not an API key. Send Authorization: Bearer scim-token with Content-Type: application/scim+json.
GET
/Users

List provisioned users (SCIM 2.0 Users resource).

Request Headers

ParamTypeRequiredDescription
AuthorizationstringYesSCIM bearer token from the dashboard
Content-TypestringNoUse application/scim+json for SCIM requests

Query Parameters

ParamTypeRequiredDescription
filterstringNoSCIM filter expression, e.g. userName eq "[email protected]"
POST
/Users

Provision a new user via SCIM.

Request Headers

ParamTypeRequiredDescription
AuthorizationstringYesSCIM bearer token from the dashboard
Content-TypestringNoUse application/scim+json for SCIM requests

Request Body

ParamTypeRequiredDescription
userNamestringYesUser email address
displayNamestringNoDisplay name
activebooleanNoWhether the user is active
GET
/Groups

List provisioned groups (SCIM 2.0 Groups resource).

Request Headers

ParamTypeRequiredDescription
AuthorizationstringYesSCIM bearer token from the dashboard
Content-TypestringNoUse application/scim+json for SCIM requests
POST
/Groups

Create a group via SCIM.

Request Headers

ParamTypeRequiredDescription
AuthorizationstringYesSCIM bearer token from the dashboard
Content-TypestringNoUse application/scim+json for SCIM requests

Full SCIM 2.0 paths are relative to your provisioned endpoint URL shown in the dashboard:

https://your-app.com/api/os/scim/v2/Users