Tenant Settings API (v1)

API for managing tenant configuration groups and settings

tenant-settings

getConfigGroups

Get all configuration groups

Responses

Response samples

Content type
application/json
{
  • "settingGroups": [
    ],
  • "totalRecords": 2
}

getGroupSettings

Get settings for a specific configuration group

path Parameters
groupId
required
string
Example: audit.authority

Configuration group ID

Responses

Response samples

Content type
application/json
{
  • "settings": [
    ],
  • "totalRecords": 3
}

updateGroupSetting

Update a specific setting in a configuration group

path Parameters
groupId
required
string
Example: audit.authority

Configuration group ID

key
required
string
Example: enabled

Setting key

Request Body schema: application/json
required
value
object

Value of the setting (type depends on the type field)

description
string

Description of what the setting controls

Responses

Request samples

Content type
application/json
{
  • "value": true,
  • "description": "Defines if the authority audit is enabled"
}

Response samples

Content type
application/json
{
  • "key": "enabled",
  • "value": true,
  • "type": "BOOLEAN",
  • "description": "Defines if the authority audit is enabled",
  • "groupId": "audit.authority",
  • "metadata": {
    }
}