SCIM

Last updated 2 months ago

Was this helpful?

Find users

get

Fetches users based on provided criteria

Authorizations

Query parameters

attributesstringOptional

excludedAttributesstringOptional

filterstringOptional

startIndexinteger · int32Optional

countinteger · int32Optional

sortBystringOptional

sortOrderstringOptional

domainstringOptional

Responses

200

Returns list of requested users

Responsestring

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

get

GET /scim/v2/Users HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

text

Gets a user by id

get

Gets a user based on provided id

Authorizations

Path parameters

idstringRequired

Query parameters

attributesstringOptional

excludedAttributesstringOptional

Responses

200

Returns requested user data

Responsestring

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

get

GET /scim/v2/Users/{id} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

text

Deletes a user

delete

Deletes a user based on provided id

Authorizations

Path parameters

idstringRequired

Responses

200

Returns deleted user data

Responsestring

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

delete

DELETE /scim/v2/Users/{id} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

text

Creates a user

post

Creates a user based on provided data.

Authorizations

Query parameters

attributesstringOptional

excludedAttributesstringOptional

Body

stringOptional

Responses

200

Returns created user data

Responsestring

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

post

POST /scim/v2/Users HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

text

Updates a user

put

Updates a user based on provided id and data

Authorizations

Path parameters

idstringRequired

Query parameters

attributesstringOptional

excludedAttributesstringOptional

Body

stringOptional

Responses

200

Returns updated user data

Responsestring

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

put

PUT /scim/v2/Users/{id} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

text

Patches a user

patch

Replaces user details based on provided id and data

Authorizations

Path parameters

idstringRequired

Query parameters

attributesstringOptional

excludedAttributesstringOptional

Body

stringOptional

Responses

200

Returns patched user data

Responsestring

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

patch

PATCH /scim/v2/Users/{id} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

text

SCIM

SCIM

Required permissions

Operations

Required permissions

Operations

Find users

Gets a user by id

Deletes a user

Creates a user

Updates a user

Patches a user