Log out a branded guest session

POST /v1/developer/guest-auth/session/logout

Operation ID: logoutDeveloperGuestSession

Idempotently revokes the BFF-held Kismet refresh token after re-authorizing the Developer installation, same-origin CSRF proof, and branded host. The public response is identical when the session is already absent, expired, or revoked so callers can always clear their sealed same-origin cookie.

Contract status

Field	Value
Maturity	`beta`
Required capability	`guest_auth.write`
Freshness class	`authenticated-state`
Quota cost	`1`

All operations require a Kismet Developer Bearer credential. Collection and resource authority is resolved from the credential’s installation grants; identifiers in the URL never grant access.

Request parameters

Name	In	Type	Required	Description
`x-kismet-csrf`	header	string	yes	Opaque CSRF proof validated by the same-origin host BFF before it calls Kismet. Never a Kismet credential.
`origin`	header	string	no	Original branded browser origin forwarded by the same-origin BFF. Must match Collection.authorizedDomains.
`x-forwarded-host`	header	string	no	Original branded host fallback for server route handlers that do not forward Origin. Must match Collection.authorizedDomains.

Request body

The request body is JSON. The canonical schema is:

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "refreshToken"
  ],
  "properties": {
    "refreshToken": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    }
  }
}

Minimal example:

{
  "refreshToken": "BFF_HELD_REFRESH_TOKEN"
}

cURL

Set KISMET_API_ORIGIN=https://api.ksmt.app and configure KISMET_DEVELOPER_API_KEY in your environment. Run server-credential requests from your backend, not browser code.

Guest access tokens come from the signed-in guest session held by your backend. Forward a CSRF proof only after your same-origin backend validates it. If shown, KISMET_SITE_ORIGIN is the authorized origin of your site. Do not substitute a guest ID or an invented token.

curl --request POST \
  "$KISMET_API_ORIGIN/v1/developer/guest-auth/session/logout" \
  --header "Authorization: Bearer $KISMET_DEVELOPER_API_KEY" \
  --header "Accept: application/json" \
  --header "x-kismet-csrf: $VALIDATED_CSRF_TOKEN" \
  --header "origin: $KISMET_SITE_ORIGIN" \
  --header "Content-Type: application/json" \
  --data '{"refreshToken":"BFF_HELD_REFRESH_TOKEN"}'

Responses

Status	Meaning
200	Success.
400	Invalid request parameters or body.
401	Missing, invalid, expired, or inappropriate credential/session.
403	Credential lacks the required grant/capability, or an origin/CSRF check failed.
429	Rate limit or quota exceeded; inspect response metadata before retrying.
503	A required Kismet dependency is temporarily unavailable.

200 response example

{
  "success": true
}

200 response schema

Content type: application/json. Required fields, nullable values, and nested structures are defined below.

View complete response schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "success"
  ],
  "properties": {
    "success": {
      "type": "boolean",
      "enum": [
        true
      ]
    }
  }
}