Tenant Settings

Tenant settings configure Alution Cloud itself. They are not integration-owned provider definitions; use Provider Settings for configuration belonging to an external provider.

Tenant settings versus provider settings

Only explicitly API-enabled groups can be resolved. Current groups are bpnt, flexible-field, lucia-ai, personalization, provider, transfer, ticket, microsoft-graph, mail, and team-viewer. Unknown and non-enabled groups return the same 404 response.

A setting resource contains key, its typed value, and validate rules. Keys hidden from the API are not returned, and locked keys cannot be changed.

GET/api/v1/settings/{group}

List a settings group

Returns visible fields for an API-enabled group. Required scope: settings:read and permission to view tenant settings.

[
  {
    "key": "example_key",
    "value": true,
    "validate": ["boolean"]
  }
]

GET/api/v1/settings/{group}/{key}

Get a setting

Returns one visible setting and its validation rules. Required scope: settings:read.

PATCH/api/v1/settings/{group}/{key}

Update a setting

Required scope: settings:write. Send { "value": ... }; the required type and constraints come from the resource's validate value. A locked field rejects value, and hidden or unknown fields return 404.