OAuth API

Revoke tokens

Revoke an access token or refresh token. Once revoked, the token can no longer be used.

Revoking a refresh token revokes all access tokens that were created using the same authorization.

This endpoint can only be accessed using OAuth client credentials.

delete/oauth2/tokens

Headers

Authorizationstring required

The OAuth client ID and client secret as basic access credentials.

Pseudo code: "Basic " + toBase64(client_id + ":" + client_secret)

For example: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Content-Typestring

This header value must match the type of the request body you send, if there is a request body. For example, if you send the request body as JSON, this header must be set to application/json, and if you send it as form encoded you must set this header to application/x-www-form-urlencoded.

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Request body

token_type_hint'access_token' | 'refresh_token' required
tokenstring required

The token you want to revoke.

Example request

{
  "token_type_hint": "access_token",
  "token": "access_..."
}

Response

An empty response.

Changes

Changed in 3 of the 79 revisions of this API.15

    • added the non-success response with the status

      response-non-success-status-added

    • the endpoint scheme security basicAuth was added to the API

      api-security-added

    • the endpoint scheme security oAuth was removed from the API

      api-security-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a5774ab4d46512See the full diff
    • request property was restricted to a list of enum values

      request-property-became-enum

    • added the new access_token enum value to the request property

      request-property-enum-value-added

    • added the new refresh_token enum value to the request property

      request-property-enum-value-added

Of the 79 revisions, 9 have no diff computed.