Update SCIM settings

PUT /api/system_settings/scim

Interactive request editor loads with JavaScript.

Authorization

X-API-KEY<token>

In: header

Request Body

application/json

enable_scim?boolean

Enable or disable the SCIM endpoint for provisioning and user management.

Response Body

`application/json`

curl -X PUT "$API_BASE_URL/api/system_settings/scim" \  -H "Content-Type: application/json" \  -d '{}'

Successfully retrieved the SCIM provisioning settings.

{
  "value": {
    "enable_scim": true,
    "scim_encrypt_key": "example-scim-encrypt-key",
    "scim_key_salt": "example-scim-key-salt"
  }
}

Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.

{
  "value": {},
  "error_msg": "error message"
}

Complete operation details and schema variants

PUT /api/system_settings/scim

Update SCIM settings

Update SCIM provisioning settings used for automated identity and user lifecycle synchronization. Changes here affect how external identity providers integrate with organization users.

Required IAM Permission: Action iam:UpdateSCIMProvisioning, Resource arn:api7:iam:organization/*

Parameters

Request body

Content type: application/json

allOf variant 1
enable_scim (boolean, optional): Enable or disable the SCIM endpoint for provisioning and user management.

Responses

200: Successfully retrieved the SCIM provisioning settings.
allOf variant 1
value (object, optional): The specific resource.
allOf variant 2
value (object, optional):
allOf variant 1
value.enable_scim (boolean, optional): Enable or disable the SCIM endpoint for provisioning and user management.
allOf variant 2
value.scim_encrypt_key (string, optional): Base64-encoded encryption key used to secure sensitive SCIM data.
value.scim_key_salt (string, optional): Salt value used with the encryption key to strengthen data protection.
400: Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.
value (object, optional): The specific resource.
error_msg (string, optional): The error message.

cURL

curl -X PUT '$API_BASE_URL/api/system_settings/scim'

Update SCIM settings

200application/json

400application/json

`application/json`

`application/json`