ADadaptyvbio
tokens

Revoke the calling token and its entire lineage

Revokes the root token used to authenticate this request and all of its attenuated descendants, making the entire token family invalid for future API calls.

Idempotent: If the token family is already revoked, returns the original revocation timestamp and children_revoked: 0.

Requires token:revoke capability.

post/api/v1/tokens/revoke

Request

  • Base URL
    https://devs.adaptyvbio.com
  • URL
    https://devs.adaptyvbio.com/api/v1/tokens/revoke
  • Auth
    HTTP bearer

Response

Token family revoked successfully

children_revokedinteger required

Number of attenuated child tokens that were newly revoked in this call. Will be 0 on idempotent repeated calls (children already stamped).

revoked_atstring date-time required

Timestamp when the token was revoked (may be earlier if already revoked).

token_idstring required

The root token_id that was revoked (all descendants are also revoked).

Example response

{
  "children_revoked": 3,
  "token_id": "550e8400-e29b-41d4-a716-446655440000"
}

Changes

No recorded changes to this operation across all 1 revision of this API.