SCIM

Use these operations to interact with SCIM-provisioned users in Cortex.

Required permissions

Your API key must have the Configure Open ID Connector & SCIM permission.

Operations

For the filter string in the Find users operation, use a value of userName eq "<email>" to return a result based on an email value.

Find users

get

Fetches users based on provided criteria

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Query parameters

attributesstringOptional

excludedAttributesstringOptional

filterstringOptional

startIndexinteger · int32Optional

countinteger · int32Optional

sortBystringOptional

sortOrderstringOptional

domainstringOptional

Responses

200

Returns list of requested users

application/jsonapplication/scim+json

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

/scim/v2/Users

HTTPcURLJavaScriptPython

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

text

Gets a user by id

get

Gets a user based on provided id

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

idstringRequired

Query parameters

attributesstringOptional

excludedAttributesstringOptional

Responses

200

Returns requested user data

application/jsonapplication/scim+json

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

/scim/v2/Users/{id}

HTTPcURLJavaScriptPython

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

text

Creates a user

post

Creates a user based on provided data.

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Query parameters

attributesstringOptional

excludedAttributesstringOptional

Body

application/jsonapplication/scim+json

stringOptional

Responses

200

Returns created user data

application/jsonapplication/scim+json

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

/scim/v2/Users

HTTPcURLJavaScriptPython

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

"text"

application/jsonapplication/scim+json

text

Updates a user

put

Updates a user based on provided id and data

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

idstringRequired

Query parameters

attributesstringOptional

excludedAttributesstringOptional

Body

application/jsonapplication/scim+json

stringOptional

Responses

200

Returns updated user data

application/jsonapplication/scim+json

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

/scim/v2/Users/{id}

HTTPcURLJavaScriptPython

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

"text"

application/jsonapplication/scim+json

text

Patches a user

patch

Replaces user details based on provided id and data

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

idstringRequired

Query parameters

attributesstringOptional

excludedAttributesstringOptional

Body

application/jsonapplication/scim+json

stringOptional

Responses

200

Returns patched user data

application/jsonapplication/scim+json

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

/scim/v2/Users/{id}

HTTPcURLJavaScriptPython

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

"text"

application/jsonapplication/scim+json

text

Deletes a user

delete

Deletes a user based on provided id

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

idstringRequired

Responses

200

Returns deleted user data

application/jsonapplication/scim+json

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

/scim/v2/Users/{id}

HTTPcURLJavaScriptPython

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

text