Skip to main content

Revoke a token

POST /api/tokens/:token_id/revoke revokes the identified token resource

Required scope: tokens:read:all

Path Parameters
token_id string — REQUIRED
Responses
200
Schema — OPTIONAL
data object — OPTIONAL
id string — OPTIONAL
type string — OPTIONAL
response_type string — OPTIONAL
value string — OPTIONAL
id_token string — OPTIONAL
id_token_claims object — OPTIONAL
refresh_token string — OPTIONAL
previous_code string — OPTIONAL
previous_codes object[] — OPTIONAL
previous_token string — OPTIONAL
agent_token string — OPTIONAL
scope string[] — OPTIONAL
requested_scope string[] — OPTIONAL
redirect_uri string — OPTIONAL
expires_at date-time — OPTIONAL
revoked_at date-time — OPTIONAL
refresh_token_revoked_at date-time — OPTIONAL
sub string — OPTIONAL
user object — OPTIONAL
public_client_id string — OPTIONAL
client object — OPTIONAL
inserted_at date-time — OPTIONAL
updated_at date-time — OPTIONAL
401

The client is unauthorized to access this resource.

Schema — OPTIONAL
code string
message string
403

The client is forbidden to access this resource.

Schema — OPTIONAL
code string
message string
404

The requested resource could not be found.

Schema — OPTIONAL
code string
message string
422

The request payload is invalid.

Schema — OPTIONAL
errors object — OPTIONAL