Sessions

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.

post/sessions/{session_id}/revoke

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/sessions/{session_id}/revoke
  • Auth: HTTP bearer

Path parameters

session_idstring required

The ID of the session

Response

Success

object'session' required

String representing the object's type. Objects of the same type share the same value.

idstring required
user_idstring required
client_idstring required
actorobject nullable
status'active' | 'revoked' | 'ended' | 'expired' | 'removed' | 'abandoned' | 'replaced' | 'pending' required
last_active_organization_idstring nullable
last_active_atinteger required
expire_atinteger required

Unix timestamp in milliseconds of expiration. Zero means no maximum lifetime.

abandon_atinteger required

Unix timestamp in milliseconds of abandonment. Zero means no abandonment deadline.

updated_atinteger required

Unix timestamp of last update.

created_atinteger required

Unix timestamp of creation.

Changes

No recorded changes to this operation across all 49 revisions of this API.