Revoke a token

Overview

Revoke the access token you send with the request. Any later call with that token returns 401.

Use it when a user signs out of your app, or when a token may have been exposed.

Prerequisites

• The bearer token you want to revoke.

Base URL

Endpoint

GET /api/v1/sso/revoking-token

Authentication

Partner or Account token

• Only the token in the Authorization header is revoked. You can't revoke another token with this call.

Rate limit

This endpoint has no rate limit. Responses do not include X-RateLimit-* headers.

Request parameters

None.

Request body

None.

Request payload

None.

Response body

The payload is inside data.

Response payload

{
  "data": {
    "status": "success",
    "message": "Token revoked successfully!"
  }
}

Examples

Success payload

See Response payload.

Error payload

401 Unauthenticated

The token is missing, invalid, or already revoked.

{
  "message": "Unauthenticated."
}

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/sso/revoking-token" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'