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
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: */*
textGets 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: */*
textCreates 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"textUpdates 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"textReplaces 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"textDeletes 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: */*
textLast updated
Was this helpful?