Skip to content

Update legacy tenant settings.

Deprecated
PUT
/api/admin/settings
Code sample: Shell / cURL
curl --request PUT \
--url https://auth.example.com/api/admin/settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "settings": { "additionalProperty": "example" } }'

Replace Setting in the Admin Miscellaneous area. The request body is JSON unless the detailed schema for this operation states otherwise.

X-Tenant-Id
string

Tenant selector for multi-tenant admin requests.

Media type application/json
object
settings
required
object
key
additional properties
key
additional properties
Example generated
{
"settings": {
"additionalProperty": "example"
}
}

Legacy settings update response.

Media type application/json
object
success
required
boolean
message
required
string
settings
required
object
key
additional properties
key
additional properties
Example
{
"success": true,
"message": "Settings updated successfully",
"settings": {
"general": {
"siteName": "Authrim"
}
}
}