Clerk API (unofficial showcase)
POST/sign_in_tokens/{sign_in_token_id}/revoke

Revoke a sign-in token

Revokes a pending sign-in token. Use the sign_in_token_id path parameter to identify the token; a successful response returns the token with its updated status.

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

1 parameter
sign_in_token_idstringrequired
The ID of the sign-in token to revoke.

3 status codes
200Returns the sign-in token object with its status and token details.
objectstringrequired
Allowed:sign_in_token
idstringrequired
statusstringrequired
Allowed:pendingacceptedrevoked
user_idstringrequired
tokenstringoptional
urlstringoptional
created_atintegerrequired
Unix timestamp of creation.
updated_atintegerrequired
Unix timestamp of last update.
400Returned when the revocation request is not successful.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
404Returned when the sign-in token cannot be found.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 400 indicates that the revocation request was not successful. A 404 is returned when the sign-in token cannot be found; the sign_in_token_id path parameter must identify the token to revoke.