Clerk API (unofficial showcase)
POST/sessions/{session_id}/revoke

Revoke a session

Sets the status of a session as "revoked", which is an unauthenticated state. In multi-session mode, a revoked session will still be returned along with its client object, however the user will need to sign in again.

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

1 parameter
session_idstringrequired
The ID of the session

4 status codes
200Success
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:session
idstringrequired
user_idstringrequired
client_idstringrequired
actorobjectoptional
statusstringrequired
Allowed:activerevokedendedexpiredremovedabandonedreplacedpending
last_active_organization_idstringoptional
last_active_atintegerrequired
latest_activityobjectoptional
expire_atintegerrequired
Unix timestamp of expiration.
abandon_atintegerrequired
Unix timestamp of abandonment.
updated_atintegerrequired
Unix timestamp of last update.
created_atintegerrequired
Unix timestamp of creation.
tasksarray<object>optional
400Request was not successful
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
401Authentication invalid
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
404Resource not found
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 400 is returned: Request was not successful. A 401 is returned: Authentication invalid. A 404 is returned: Resource not found.