Sign Out

Revokes refresh tokens and terminates the user session. Requires a valid access token in the Authorization header.

Headers

X-Correlation-Id
Type: string

Optional caller-provided correlation ID; echoed in responses when present.
Authorization
Type: string
required

Used to authorize the request with access_token. It should be supplied as Bearer ACCESS_TOKEN_GOES_HERE.

Body

application/json

access_token
Type: string

Required. Added to the blacklisted token list.
client
Type: string

OAuth client ID provided by the business. Required to identify the client application for token revocation. The OAuth application must have the Advance Auth scope enabled.
refresh_token
Type: string

Required. Specifically revokes this token.

Responses

application/json
application/json
application/json
application/json
application/json
application/json
application/json

post/api2/signout

curl https://SERVER_NAME_GOES_HERE/api2/signout \
  --request POST \
  --header 'Authorization: ' \
  --header 'Content-Type: application/json' \
  --data '{
  "client": "CLIENT_GOES_HERE",
  "access_token": "ACCESS_TOKEN_GOES_HERE",
  "refresh_token": "REFRESH_TOKEN_GOES_HERE"
}'

Show Schema

{
  "data": [
    "Successfully signed out."
  ]
}

Successfully signed out; refresh token(s) revoked