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

Revoke the calling token and its entire lineage

cURL

curl --request POST \
  --url https://foundry-api-public.adaptyvbio.com/api/v1/tokens/revoke \
  --header 'Authorization: Bearer <token>'

200

{
  "children_revoked": 3,
  "revoked_at": "2023-11-07T05:31:56Z",
  "token_id": "550e8400-e29b-41d4-a716-446655440000"
}

Authorizations

Authorization · string · header · required

Biscuit-based bearer token. Obtain tokens from the Adaptyv Portal or via the /tokens endpoint. Tokens encode organization membership and role-based capabilities; the API verifies the token's cryptographic signature and authorization claims before processing requests. Use /tokens/attenuate to create restricted tokens for delegation.

Response

200

application/json

Token family revoked successfully

Response returned when a token family is revoked.

children_revoked · integer<int64> · required

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

Example:

3

revoked_at · string<date-time> · required

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

token_id · string · required

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

Example:

"550e8400-e29b-41d4-a716-446655440000"