Skip to main content

revokeSession()

Revokes the given session. The user will be signed out from the client the session is associated with.

Returns the revoked Session.

function revokeSession(sessionId: string): Promise<Session>
  • Name
    sessionId
    Type
    string
    Description

    The ID of the session to revoke.

Note

Using clerkClient varies based on the SDK you're using. Refer to the overview for usage details, including guidance on how to access the userId and other properties.

const sessionId = 'sess_123'

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

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?

Last updated on