Setup SCIM access for organization

Initially configure SCIM access for organization

POST /api/org/setupSCIMAccessForOrg

Setup SCIM access for organization

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/org/setupSCIMAccessForOrg \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'

200

{
  "scimAccessAlreadySetupFailure": true,
  "token": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request object for setting up SCIM access for organization.

addUsersOnRoleMismatch · boolean | null

Whether to add users on role mismatch

Example:

false

rhombusKeyAppSettings · object

Show child attributes

sendWelcomeEmailToNewRhombusKeyUsers · boolean | null

Whether to send welcome email to new Rhombus Key users

Example:

true

sendWelcomeEmailToNewUsers · boolean | null

Whether to send welcome email to new users

Example:

true

Response

200 - application/json

OK

Response object for setting up SCIM access for organization.

scimAccessAlreadySetupFailure · boolean | null

token · string | null