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
Query parameters
attributesstringOptional
excludedAttributesstringOptional
filterstringOptional
startIndexinteger · int32Optional
countinteger · int32Optional
sortBystringOptional
sortOrderstringOptional
domainstringOptional
Responses
200

Returns list of requested users

Responsestring
get
/scim/v2/Users
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
Path parameters
idstringRequired
Query parameters
attributesstringOptional
excludedAttributesstringOptional
Responses
200

Returns requested user data

Responsestring
get
/scim/v2/Users/{id}
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
Query parameters
attributesstringOptional
excludedAttributesstringOptional
Body
stringOptional
Responses
200

Returns created user data

Responsestring
post
/scim/v2/Users
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"
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
put
/scim/v2/Users/{id}
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"
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
patch
/scim/v2/Users/{id}
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"
text

Deletes a user

delete

Deletes a user based on provided id

Authorizations
Path parameters
idstringRequired
Responses
200

Returns deleted user data

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

Last updated

Was this helpful?