Get platform-scoped settings for a category.

GET

/api/admin/platform/settings/{category}

Code sample: Shell / cURL

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

Get Setting settings in the Admin Miscellaneous area. Use this operation to retrieve setting data without mutating tenant state.

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 v2 read response.

Media type application/json

Settings v2 category read result returned by the settings manager. Includes category values, inheritance metadata, and version information when available.

object

key

additional properties

Example

{
  "category": "oauth",
  "scope": {
    "type": "tenant",
    "id": "tenant_123"
  },
  "values": {
    "oauth.require_pkce": true
  },
  "version": "v1"
}