Get logout configuration

GET

/api/admin/settings/logout

Code sample: Shell / cURL

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

Returns back-channel logout, front-channel logout, and session management settings from SETTINGS KV or defaults.

Authorizations

• adminBearer
• adminSessionCookie

Responses

200

Logout protocol configuration.

Media type application/json

object

config

object

key

additional properties

source

string

defaults

object

key

additional properties

key

additional properties

Example

{
  "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
    }
  },
  "source": "kv",
  "defaults": {
    "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
    }
  }
}

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