Revoke Token

POST

/api/canvas/{deal_id}/token/revoke

curl --request POST \
  --url https://example.com/api/canvas/example/token/revoke \
  --header 'Authorization: Bearer <token>'

Revoke the current access token.

Adds the token’s JTI to the Redis revocation blocklist so it is rejected on subsequent requests even before its natural expiry.

Args: deal_id: Deal ID scope (must match the token’s deal_id).

Returns: {“revoked”: true}

Authorizations

• HTTPBearer

Parameters

Path Parameters

deal_id

required

Deal Id

string

Responses

200

Successful Response

Media type application/json

RevokeTokenResponse

Response from POST /canvas/{deal_id}/token/revoke.

object

revoked

required

Revoked

boolean

Example ^generated

{
  "revoked": true
}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}