Get client-scoped settings for a category.

GET

/api/admin/clients/{clientId}/settings/{category}

Code sample: Shell / cURL

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

Returns all settings in a category at client scope after checking that the category supports client overrides, the admin can view that category, and the client belongs to an accessible tenant.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

clientId

required

string

Client identifier.

category

required

string

Settings category name that supports client scope.

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"
}

400

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"
}

401

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"
}

403

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"
}

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"
}

500

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"
}