`SessionStatus`

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

type SessionStatus =
  | 'abandoned'
  | 'active'
  | 'pending'
  | 'ended'
  | 'expired'
  | 'removed'
  | 'replaced'
  | 'revoked'

Properties

Value	Description
`abandoned`	The session was abandoned client-side.
`active`	The session is valid and all activity is allowed.
`pending`	The user has signed in but hasn't completed session tasks.
`ended`	The user signed out of the session, but the `Session` remains in the `Client` object.
`expired`	The period of allowed activity for this session has passed.
`removed`	The user signed out of the session and the `Session` was removed from the `Client` object.
`replaced`	The session has been replaced by another one, but the `Session` remains in the `Client` object.
`revoked`	The application ended the session and the `Session` was removed from the `Client` object.

Last updated on Aug 22, 2025