Skip to Content
Clerk logo

Clerk Docs

Ctrl + K
Go to clerk.com

SessionStatus

The SessionStatus enum is used to indicate the status of a session.

type SessionStatus = "abandoned" | "active" | "ended" | "expired" | "removed" | "replaced" | "revoked";

Properties

ValueDescription
abandonedThe session was abandoned client-side.
activeThe session is valid and all activity is allowed.
endedThe user signed out of the session, but the Session remains in the Client object.
expiredThe period of allowed activity for this session has passed.
removedThe user signed out of the session and the Session was removed from the Client object.
replacedThe session has been replaced by another one, but the Session remains in the Client object.
revokedThe application ended the session and the Session was removed from the Client object.

Last updated on February 21, 2024

What did you think of this content?

Clerk © 2024