Get client cache mode.

GET

/api/admin/clients/{clientId}/cache-mode

Code sample: Shell / cURL

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

Returns the client-specific token/cache behavior override and the effective mode after applying the platform default.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

clientId

required

string

Client identifier.

Responses

200

Client cache mode response.

Media type application/json

object

client_id

required

string

mode

required

string | null

Allowed values: maintenance fixed

effective

required

string

Allowed values: maintenance fixed

uses_platform_default

required

boolean

key

additional properties

Example

{
  "client_id": "client_123",
  "mode": null,
  "effective": "maintenance",
  "uses_platform_default": true
}

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

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

503

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