Patch client-scoped settings for a category.

PATCH

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

Code sample: Shell / cURL

curl --request PATCH \
  --url https://auth.example.com/api/admin/clients/example/settings/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "ifMatch": "v1", "changes": { "oauth.require_pkce": true } }'

Partially updates client-scoped settings in a category. The request must include ifMatch; version conflicts return the current version.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

clientId

required

string

Client identifier.

category

required

string

Settings category name that supports client scope.

Request Body ^required

Media type application/json

object

ifMatch

required

Expected settings version for optimistic concurrency.

string

changes

object

key

additional properties

clear

Array<string>

disable

Array<string>

key

additional properties

Example

{
  "ifMatch": "v1",
  "changes": {
    "oauth.require_pkce": true
  }
}

Responses

200

Settings v2 patch response.

Media type application/json

Settings v2 patch result. Includes applied, cleared, disabled, rejected, and version metadata from the settings manager.

object

key

additional properties

Example

{
  "applied": [
    "oauth.require_pkce"
  ],
  "cleared": [],
  "disabled": [],
  "rejected": {},
  "version": "v2"
}

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