Start free →

API reference

SCIM provisioning

Create, update and remove users and groups from your identity provider, with the workspace’s SCIM token.

All of the API reference

Route summaries and field names are written in English, here and in the file.

/api/scim/v2

GET /api/scim/v2/Users

SCIM: list users (filter, paginate)

Authentication
The workspace’s SCIM token
Parameters
filter · startIndex · count
Answers
200 · 401 · 503

POST /api/scim/v2/Users

SCIM: create + provision a user

Authentication
The workspace’s SCIM token
Body
application/scim+json
Answers
201 · 401 · 409

GET /api/scim/v2/Users/{id}

SCIM: get a user

Authentication
The workspace’s SCIM token
Parameters
id (required)
Answers
200 · 401 · 404

PUT /api/scim/v2/Users/{id}

SCIM: replace a user

Authentication
The workspace’s SCIM token
Parameters
id (required)
Body
application/scim+json
Answers
200 · 401 · 404

PATCH /api/scim/v2/Users/{id}

SCIM: patch a user (e.g. deactivate via active=false)

Authentication
The workspace’s SCIM token
Parameters
id (required)
Body
application/scim+json
Answers
200 · 401 · 404

DELETE /api/scim/v2/Users/{id}

SCIM: delete (deprovision) a user

Authentication
The workspace’s SCIM token
Parameters
id (required)
Answers
204 · 401 · 404

GET /api/scim/v2/Groups

SCIM: list groups

Authentication
The workspace’s SCIM token
Parameters
filter · startIndex · count
Answers
200 · 401

POST /api/scim/v2/Groups

SCIM: create a group

Authentication
The workspace’s SCIM token
Body
application/scim+json
Answers
201 · 401

GET /api/scim/v2/Groups/{id}

SCIM: get a group

Authentication
The workspace’s SCIM token
Parameters
id (required)
Answers
200 · 401 · 404

PATCH /api/scim/v2/Groups/{id}

SCIM: patch a group (membership changes)

Authentication
The workspace’s SCIM token
Parameters
id (required)
Body
application/scim+json
Answers
200 · 401 · 404

DELETE /api/scim/v2/Groups/{id}

SCIM: delete a group

Authentication
The workspace’s SCIM token
Parameters
id (required)
Answers
204 · 401 · 404

GET /api/scim/v2/ServiceProviderConfig

SCIM: service provider configuration (RFC 7643 §5)

Authentication
The workspace’s SCIM token
Answers
200 · 401

GET /api/scim/v2/ResourceTypes

SCIM: supported resource types

Authentication
The workspace’s SCIM token
Answers
200 · 401

GET /api/scim/v2/ResourceTypes/{id}

SCIM: a single resource type

Authentication
The workspace’s SCIM token
Parameters
id (required)
Answers
200 · 401 · 404

GET /api/scim/v2/Schemas

SCIM: supported schemas

Authentication
The workspace’s SCIM token
Answers
200 · 401

GET /api/scim/v2/Schemas/{id}

SCIM: a single schema definition

Authentication
The workspace’s SCIM token
Parameters
id (required)
Answers
200 · 401 · 404