Revoke OAuth2 tokens for a client

Revoke OAuth2 Token

POST/appid-{appId}/recipe/oauth/tokens/revoke

Authorization

api-keyAPI key · headerrequired

The core service API token. If you are using a self-hosted core service and you have not generated a token, you can omit the header.

Header parameters

cdi-versionstring

X.Y of the X.Y.Z CDI version.

Request body

application/json

client_idstring

Responses

200OAuth2 Token Revocation Result

One of:

object

statusstatusOK

Allowed:OK

didExistboolean

oauthError

statusstringrequired

Allowed:OAUTH_ERROR

errorstringrequired

errorDescriptionstringrequired

statusCodeintegerrequired

400error code 400

string

401error code 401

string

402error code 402

string

404error code 404

string

500error code 500

string

Try it

Server

Custom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

cdi-versionheaderX.Y of the X.Y.Z CDI version.

Bodyapplication/json

client_idstring

Request

curl -X POST "/appid-{appId}/recipe/oauth/tokens/revoke" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "client_id": "stcl_fed7cff0-cc6e-406e-b7a6-766148675a4a"
}'

const response = await fetch("/appid-{appId}/recipe/oauth/tokens/revoke", {
  method: "POST",
  headers: {
    "api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "client_id": "stcl_fed7cff0-cc6e-406e-b7a6-766148675a4a"
})
});

import requests

response = requests.post(
    "/appid-{appId}/recipe/oauth/tokens/revoke",
    headers={
        "api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
  "client_id": "stcl_fed7cff0-cc6e-406e-b7a6-766148675a4a"
},
)

Response

{
  "status": "OK",
  "didExist": true
}

"string"

"Invalid API key"

"License Error"

"Not Found"

"Internal Error"