Get settings metadata for a category.

GET

/api/admin/settings/meta/{category}

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/settings/meta/example \
  --header 'Authorization: Bearer <token>'

Return the metadata definition for one settings category, including the setting descriptors used by Admin UI forms.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

category

required

string

Header Parameters

X-Tenant-Id

string

Tenant selector for multi-tenant admin requests.

Responses

200

Settings metadata category detail.

Media type application/json

object

category

required

string

label

required

string

description

required

string

settings

required

object

key

additional properties

key

additional properties

Example

{
  "category": "oauth",
  "label": "OAuth",
  "description": "OAuth and OIDC runtime settings.",
  "settings": {
    "oauth.require_pkce": {
      "label": "Require PKCE",
      "type": "boolean",
      "default": true
    }
  }
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}