Update logout configuration

PUT

/api/admin/settings/logout

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/settings/logout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "backchannel": { "enabled": true, "timeout_seconds": 5, "retry": { "enabled": true, "max_attempts": 3, "backoff_seconds": 10 } }, "frontchannel": { "enabled": true }, "session_management": { "enabled": true, "iframe_check_interval_seconds": 5 } }'

Deep-merges partial logout configuration into SETTINGS KV after validating back-channel settings.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Media type application/json

object

key

additional properties

Example

{
  "backchannel": {
    "enabled": true,
    "timeout_seconds": 5,
    "retry": {
      "enabled": true,
      "max_attempts": 3,
      "backoff_seconds": 10
    }
  },
  "frontchannel": {
    "enabled": true
  },
  "session_management": {
    "enabled": true,
    "iframe_check_interval_seconds": 5
  }
}

Responses

200

Logout settings mutation result.

Media type application/json

object

success

boolean

config

object

key

additional properties

note

string

key

additional properties

Example

{
  "success": true,
  "config": {
    "backchannel": {
      "enabled": true,
      "timeout_seconds": 5,
      "retry": {
        "enabled": true,
        "max_attempts": 3,
        "backoff_seconds": 10
      }
    },
    "frontchannel": {
      "enabled": true
    },
    "session_management": {
      "enabled": true,
      "iframe_check_interval_seconds": 5
    }
  },
  "note": "Logout configuration updated. Changes take effect immediately."
}

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