Docs

revokeSession()

Revokes a Session.

User will be signed out from the particular client the referred to.

function revokeSession(sessionId: string): Promise<Session>

Parameters

  • Name
    sessionId
    Type
    string
    Description

    The ID of the session to revoke.

Example

Note

Learn how to get the sessionId and other properties.

const sessionId = 'sess_123'

const response = await clerkClient.sessions.revokeSession(sessionId)

console.log(response)
/*
_Session {
  id: 'sess_123',
  clientId: 'client_123',
  userId: 'user_123',
  status: 'revoked',
  lastActiveAt: 1705601584837,
  expireAt: 1706135713248,
  abandonAt: 1708122913248,
  createdAt: 1705530913248,
  updatedAt: 1705601602540
}
*/

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint POST/sessions/{session_id}/revoke. See the BAPI reference for more information.

Feedback

What did you think of this content?
Edit this page on GitHub

Last updated on