Clerk API (unofficial showcase)
POST/admin_portal_link_tokens/{adminPortalLinkTokenID}/revoke

Revoke an admin portal link token

Revokes an admin portal link token identified by its token ID. You can include revocation_reason to record why the token was revoked. The response contains the token's updated revocation state.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
adminPortalLinkTokenIDstringrequired
The token identifier, formatted as `aplt_` followed by 32 hexadecimal characters.

Optional revocation details. No body fields are marked as required.

revocation_reasonstringoptional
A reason to record for revoking the token.

5 status codes
200Returns the updated admin portal link token object, including its revocation state and any revocation reason.
objectstringrequired
Allowed:admin_portal_link_token
idstringrequired
admin_portal_link_idstringrequired
The origin-level admin_portal_link this token was issued for.
instance_idstringrequired
organization_idstringrequired
Optional. Present only when the link is scoped to an existing org.
it_contact_idstringrequired
Optional opaque reference to the IT contact associated with this link.
scopesarray<string>required
Caller-provided scopes for this token.
revokedbooleanrequired
revocation_reasonstringrequired
expiredbooleanrequired
expirationnumberrequired
The timestamp for when the token will expire, in milliseconds.
created_atnumberrequired
The timestamp for when the token was created, in milliseconds.
updated_atnumberrequired
The timestamp for when the token was last updated, in milliseconds.
400Returned when the request is invalid.
errorsarray<object>required
401Returned when the request is unauthorized.
errorsarray<object>required
403Returned when the request is forbidden.
errorsarray<object>required
404Returned when the admin portal link token is not found.
errorsarray<object>required

Error handling

A 400 indicates invalid request data; a 401 indicates unauthorized access; a 403 indicates forbidden access; a 404 indicates the token was not found. The adminPortalLinkTokenID path parameter must match the aplt_ identifier format followed by 32 hexadecimal characters.