Skip to main content
ZStack
Identity & Access/ZIAM

ZiamLogout

Idempotently clears ziam_session and ziam_login_tx, revokes the current access token jti when provided, and revokes the user's refresh tokens.

POST/api/logout

Operation ID

ZiamLogout

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • status
    String

    Status for this resource

    Example: ok

  • data
    Object

    Response payload data

    Example: (nested object)

    • loggedOut
      Boolean

      Whether logout completed successfully

      Example: true