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

Find users

get

Fetches users based on provided criteria

Authorizations

Query parameters

attributesstringoptional

excludedAttributesstringoptional

filterstringoptional

startIndexinteger · int32optional

countinteger · int32optional

sortBystringoptional

sortOrderstringoptional

domainstringoptional

Responses

application/jsonapplication/scim+json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/scim/v2/Users' \
  --header 'Authorization: Bearer JWT'

200

429

200

application/json

application/scim+json

application/json

text

Returns list of requested users

Gets a user by id

get

Gets a user based on provided id

Authorizations

Path parameters

idstringrequired

Query parameters

attributesstringoptional

excludedAttributesstringoptional

Responses

application/jsonapplication/scim+json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/scim/v2/Users/{id}' \
  --header 'Authorization: Bearer JWT'

200

429

200

application/json

application/scim+json

application/json

text

Returns requested user data

Creates a user

post

Creates a user based on provided data.

Authorizations

Query parameters

attributesstringoptional

excludedAttributesstringoptional

Body

application/jsonapplication/scim+json

stringoptional

Responses

application/jsonapplication/scim+json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/scim/v2/Users' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '"text"'

application/jsonapplication/scim+json

200

429

200

application/json

application/scim+json

application/json

text

Returns created user data

Updates a user

put

Updates a user based on provided id and data

Authorizations

Path parameters

idstringrequired

Query parameters

attributesstringoptional

excludedAttributesstringoptional

Body

application/jsonapplication/scim+json

stringoptional

Responses

application/jsonapplication/scim+json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.getcortexapp.com/scim/v2/Users/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '"text"'

application/jsonapplication/scim+json

200

429

200

application/json

application/scim+json

application/json

text

Returns updated user data

Patches a user

patch

Replaces user details based on provided id and data

Authorizations

Path parameters

idstringrequired

Query parameters

attributesstringoptional

excludedAttributesstringoptional

Body

application/jsonapplication/scim+json

stringoptional

Responses

application/jsonapplication/scim+json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.getcortexapp.com/scim/v2/Users/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '"text"'

application/jsonapplication/scim+json

200

429

200

application/json

application/scim+json

application/json

text

Returns patched user data

Deletes a user

delete

Deletes a user based on provided id

Authorizations

Path parameters

idstringrequired

Responses

application/jsonapplication/scim+json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.getcortexapp.com/scim/v2/Users/{id}' \
  --header 'Authorization: Bearer JWT'

200

429

200

application/json

application/scim+json

application/json

text

Returns deleted user data