Admin API: Settings
Operations on settings in the Odudu admin API, one section each. Every request carries a bearer token; the index says which audience it needs and how a refusal is shaped.
GET /admin/tenants/{tenant}/settings
Requires the "manage-tenant" capability.
Path parameters
| Name | Type | Required | Details |
|---|---|---|---|
tenant | string | yes | The tenant being administered, addressed by name. |
Responses
200 OK
Body: application/json
| Field | Type | Required | Details |
|---|---|---|---|
(body) | object | yes | Every tenant setting by name with its current value: lifetimes, password and lockout rules, which sign-in features are on, retention. |
401 RFC 9457 problem details
Body: application/problem+json, an RFC 9457 problem document described under problem details.
403 RFC 9457 problem details
Body: application/problem+json, an RFC 9457 problem document described under problem details.
PATCH /admin/tenants/{tenant}/settings
Requires the "manage-tenant" capability.
display_name is trimmed, and a blank one is stored as none (null). enabled: false ends every live session in the tenant, after the change has committed and in batches, as PATCH /admin/tenants/{tenant} does.
Path parameters
| Name | Type | Required | Details |
|---|---|---|---|
tenant | string | yes | The tenant being administered, addressed by name. |
Request body
Body: application/json
| Field | Type | Required | Details |
|---|---|---|---|
(body) | object | yes | The settings to change, by name, each with its new value. A name the tenant does not have, or a value outside its range, is refused naming it. |
{
"password_min_length": 12,
"registration_allowed": true
}
Responses
200 OK
Body: application/json
| Field | Type | Required | Details |
|---|---|---|---|
(body) | object | yes | Every tenant setting by name with its current value: lifetimes, password and lockout rules, which sign-in features are on, retention. |
401 RFC 9457 problem details
Body: application/problem+json, an RFC 9457 problem document described under problem details.
403 RFC 9457 problem details
Body: application/problem+json, an RFC 9457 problem document described under problem details.
Documentation coverage: 0 of 0 fields described (100%).