Get cache mode reference

GET

/api/admin/settings/cache-mode/info

Code sample: Shell / cURL

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

Returns available cache modes, TTL behavior, resolution hierarchy, and operational guidance.

Authorizations

• adminBearer
• adminSessionCookie

Responses

200

Successful JSON response.

Media type application/json

object

modes

Available cache modes and TTL behavior.

object

key

additional properties

default_mode

string

hierarchy

Cache mode resolution order.

object

key

additional properties

kv_key_version

string

note

string

key

additional properties

Example

{
  "modes": {
    "maintenance": {
      "description": "Short TTL (30s) for development and client setting changes",
      "ttl_config": {
        "clientMetadata": 30,
        "redirectUris": 30,
        "grantTypes": 30,
        "scopes": 30,
        "jwks": 30,
        "clientSecret": 30,
        "tenant": 30,
        "policy": 30
      },
      "use_cases": [
        "Testing redirect URI changes"
      ]
    },
    "fixed": {
      "description": "Long TTL for production use",
      "ttl_config": {
        "clientMetadata": 300,
        "redirectUris": 300,
        "grantTypes": 300,
        "scopes": 300,
        "jwks": 300,
        "clientSecret": 300,
        "tenant": 300,
        "policy": 300
      },
      "use_cases": [
        "Stable production environment"
      ]
    }
  },
  "default_mode": "fixed",
  "hierarchy": {
    "description": "Cache mode is determined in the following order",
    "order": [
      "1. Client-specific mode (v1:cache-mode:client:{clientId})",
      "2. Platform-level mode (v1:cache-mode:platform)",
      "3. Default mode (fixed)"
    ]
  },
  "kv_key_version": "v1",
  "note": "Use maintenance mode during active development, then switch to fixed mode for production."
}

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