Ask Moov Beta
Generative AI is experimental and can make mistakes.
Guides Dashboard Use cases API Changelog
  1. API reference
  2. Authentication
  3. Access tokens

Revoke an access token

Revoke an auth token.

Allows clients to notify the authorization server that a previously obtained refresh or access token is no longer needed.

POST
/oauth2/revoke
cURL cURL 
curl --request POST \
  --url https://api.moov.io/oauth2/revoke \
  --header 'Authorization: Basic REPLACE_BASIC_AUTH' \
  --header 'content-type: application/json' \
  --header 'x-moov-version: SOME_STRING_VALUE' \
  --data '{"token":"string","token_type_hint":"access_token","client_id":"5clTR_MdVrrkgxw2","client_secret":"dNC-hg7sVm22jc3g_Eogtyu0_1Mqh_4-"}'
curl --request POST \
  --url https://api.moov.io/oauth2/revoke \
  --header 'Authorization: Basic REPLACE_BASIC_AUTH' \
  --header 'content-type: application/x-www-form-urlencoded' \
  --header 'x-moov-version: SOME_STRING_VALUE' \
  --data token=string \
  --data token_type_hint=access_token \
  --data client_id=5clTR_MdVrrkgxw2 \
  --data client_secret=dNC-hg7sVm22jc3g_Eogtyu0_1Mqh_4-
204 400 422 429 500 504
The request completed successfully, but there is no content to return.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The server could not understand the request due to invalid syntax.
{
  "error": "string"
}

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request was well-formed, but the contents failed validation. Check the request for missing or invalid fields.
{
  "token": "string",
  "token_type_hint": "string"
}

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
Request was refused due to rate limiting.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed due to an unexpected error.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.

Headers

x-moov-version

string
API version

Specify an API version.

API versioning follows the format vYYYY.QQ.BB, where

  • YYYY is the year
  • QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
  • BB is the build number, starting at .01, for subsequent builds in the same quarter.
    • For example, v2024.01.00 is the initial release of the first quarter of 2024.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Default: v2024.01.00

Body

application/json

token

string required
The access or refresh token to revoke.

client_id

string
Client ID can be provided here in the body, or as the Username in HTTP Basic Auth.

client_secret

string
Client secret can be provided here in the body, or as the Password in HTTP Basic Auth.

token_type_hint

string<enum>
The type of token being revoked.
Possible values: access_token, refresh_token