revokeSession()
Revokes a Session
given its ID, if the ID is valid.
User will be signed out from the particular client the referred to.
function revokeSession: (sessionId: string) => Promise<Session>;
revokeSession()
parameters
Name | Type | Description |
---|---|---|
sessionId | string | The ID of the session to revoke. |
revokeSession()
example
const sessionId = 'sess_2b6M8I4VZ1wMtgXGQeDe3SJD3cG'; const response = await clerkClient.sessions.revokeSession(sessionId); console.log(response); /* _Session { id: 'sess_2b6M8I4VZ1wMtgXGQeDe3SJD3cG', clientId: 'client_2b6J9fCrQt0KRCCtFu7WCIQvSfd', userId: 'user_2V7JJKmoA9HqzHhfMqK5cpgLl56', 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(opens in a new tab) for more details.
Last updated on August 16, 2023