Get SCIM settings

GET /api/system_settings/scim

Interactive request editor loads with JavaScript.

Authorization

X-API-KEY<token>

In: header

curl -X GET "$API_BASE_URL/api/system_settings/scim"

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

Get SCIM settings

Retrieve the current SCIM provisioning configuration for the organization. Use this to validate synchronization endpoints and provisioning status.

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

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 -X GET '$API_BASE_URL/api/system_settings/scim'