[{"label":"Latest (v1.0)","version":"latest"}]
csp

Revoke Token

Description

Only refresh tokens are supported at this time.

  1. Include the parameters using application/x-www-form-urlencoded format in the HTTP request body.
  2. Include Basic Base64_Encode(client_id:client_secret) value in the HTTP authorization header. Note: when using Public OAuth clients, Authorization is required using the format ‘Basic Base64_Encode(client_id:)’ with empty client_secret.

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Anonymous ✔️ ✔️

Request

Request

URL

URL


post
https://{api_host}/csp/gateway/am/api/auth/revoke
Copy

Header Parameters

Header Parameters

string
authorization Required

Basic auth client credentials [Basic Base64_Encode(client_id:client_secret)].
Example: authorization: Basic Y2xpZW50X2lkOmNsaWVudF9zZWNyZXQ=
Decoding this string will literally return client_id:client_secret.

Note: when using Public OAuth clients, Authorization is required using the format ‘Basic Base64_Encode(client_id:)’ with empty client_secret.

Parameter Serialization Style: simple Explode:false

Request Body

Request Body

RevokeTokenRequest of mimetype application/x-www-form-urlencoded Optional

The application/x-www-form-urlencoded form data type.

{
	"token": "string"
}
string
token Required

The token to be revoked.


string
token_type_hint Optional

Token type hint. In case not provided, refresh_token will be used.

Possible values are: refresh_token

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

200 OK

OK

Errors

Errors

404

The requested resource could not be found


409

The request could not be processed due to a conflict


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl -X POST -H "authorization: string" -H "Content-Type: application/x-www-form-urlencoded" -d '{"token":"string","token_type_hint":"refresh_token"}' https://{api_host}/csp/gateway/am/api/auth/revoke
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-required-roles: ""
x-slo-tier: TIER2


Feedback

Was this page helpful?