SCIM

Written for: ＋ Written for
Deprecated: ＋ Deprecated
Applies to: ＋ Applies to

AdminUpdated Sep 12, 2026

GEThttps://{apiHost}/scim/v2/Users

List provisioned users, filterable by userName eq and index-paginated.

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/scim/v2/Users"

POSThttps://{apiHost}/scim/v2/Users

Provision a user and seat them in the token organization directory.

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/scim/v2/Users"

GEThttps://{apiHost}/scim/v2/Users/{id}

Fetch one provisioned user by id. Non-members are 404.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/scim/v2/Users/{id}"

PUThttps://{apiHost}/scim/v2/Users/{id}

Replace a provisioned user, including its active (deprovision) state.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PUT "https://{apiHost}/scim/v2/Users/{id}"

DELETEhttps://{apiHost}/scim/v2/Users/{id}

Deprovision a user: revoke sessions and remove the directory membership.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/scim/v2/Users/{id}"

PATCHhttps://{apiHost}/scim/v2/Users/{id}

PatchOp a user; active:false deprovisions and revokes every session.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/scim/v2/Users/{id}"

GEThttps://{apiHost}/scim/v2/Groups

List directory groups, filterable by displayName eq and index-paginated.

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/scim/v2/Groups"

POSThttps://{apiHost}/scim/v2/Groups

Create a directory group with an optional initial member set.

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X POST "https://{apiHost}/scim/v2/Groups"

GEThttps://{apiHost}/scim/v2/Groups/{id}

Fetch one directory group with its member references.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/scim/v2/Groups/{id}"

PUThttps://{apiHost}/scim/v2/Groups/{id}

Replace a group displayName and its full membership set.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PUT "https://{apiHost}/scim/v2/Groups/{id}"

DELETEhttps://{apiHost}/scim/v2/Groups/{id}

Delete a directory group. Membership rows cascade with it.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X DELETE "https://{apiHost}/scim/v2/Groups/{id}"

PATCHhttps://{apiHost}/scim/v2/Groups/{id}

PatchOp a group: add or remove members, or rename it.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X PATCH "https://{apiHost}/scim/v2/Groups/{id}"

GEThttps://{apiHost}/scim/v2/ServiceProviderConfig

SCIM discovery: the features and authentication scheme this server supports.

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/scim/v2/ServiceProviderConfig"

GEThttps://{apiHost}/scim/v2/ResourceTypes

SCIM discovery: the User and Group resource types this server exposes.

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/scim/v2/ResourceTypes"

GEThttps://{apiHost}/scim/v2/Schemas

SCIM discovery: the core User and Group schema definitions.

Responses

200 Success

400 Validation failed

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

401 Unauthenticated

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

403 Forbidden or missing scope

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

404 Not found

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

429 Rate limited

{
  "errors": [
    {
      "code": "VALIDATION_FAILED",
      "message": "string",
      "param": "string",
      "meta": {}
    }
  ]
}

Example request

curl -X GET "https://{apiHost}/scim/v2/Schemas"

Was this page helpful?