Revoke OAuth token

Revokes an access/refresh token - the client id and secret can also be provided in an authorization header using the Basic scheme

POST/{apiBasePath}/oauth/revoke

Path parameters

apiBasePathstringrequired

Its value depends on the apiBasePath set by the user

Request body

application/json

tokenstringrequired

client_idstring

client_secretstring

Responses

200Revoked the access/refresh token

One of:

object

statusstatusOKrequired

Success status indicator

Allowed:OK

generalErrorResponse

statusstring

Error status code

Allowed:GENERAL_ERROR

messagestring

Error message

400OAuth2 specific error response

errorstring

The OAuth2 error code

error_descriptionstring

Human readable error description

404Resource not found error

string

500Internal server error

string

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

apiBasePathpath*Its value depends on the apiBasePath set by the user

Bodyapplication/json

tokenstring*client_idstringclient_secretstring

Request

curl -X POST "/auth/oauth/revoke" \
  -H "Content-Type: application/json" \
  -d '{
  "token": "string",
  "client_id": "st-cl-test-client",
  "client_secret": "superSecret"
}'

const response = await fetch("/auth/oauth/revoke", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "token": "string",
  "client_id": "st-cl-test-client",
  "client_secret": "superSecret"
})
});

import requests

response = requests.post(
    "/auth/oauth/revoke",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "token": "string",
  "client_id": "st-cl-test-client",
  "client_secret": "superSecret"
},
)

Response

{
  "status": "OK"
}

{
  "error": "invalid_request",
  "error_description": "Unsupported grant type: password"
}

"Not Found"

"Internal Error"