Session object is an abstraction over an HTTP session. It models the period of information exchange between a user and the server.
Session object includes methods for recording session activity and ending the session client-side. For security reasons, sessions can also expire server-side.
In certain scenarios, a session might be replaced by another one. This is often the case with mutli-session applications.
All sessions that are expired, removed, replaced, ended or abandoned are not considered valid.
A unique identifier for the session.
The user associated with the session.
Public information about the user that this session belongs to.
The current state of the session.
The time the session was last active on the Client.
The time when the session was abandoned by the user.
The time the session expires and will seize to be active.
The last time the session recorded activity of any kind.
end() => Promise<SessionResource>
Marks the session as ended. The session will no longer be active for this Client and its status will become ended.
remove() => Promise<SessionResource>
Marks the session as removed. The session will no longer be active for this Client and its status will become removed.
touch() => Promise<SessionResource>
Touches the session, signifying some kind of user activity. Use this method to record any updates to user activity.
string | null
The user's first name. This attribute will only be populated if name is enabled in instance settings.
string | null
The user's last name. This attribute will only be populated if name is enabled in instance settings.
The URL of the user's profile image.
The user's identifier (email address, phone number, username, etc) that was used for authentication when this session was created.
abandoned | active | ended | expired | removed | replaced | revoked
The session was abandoned client-side.
The session is valid and all activity is allowed.
The user signed out of the session, but the
The period of allowed activity for this session has passed.
The user signed out of the session and the
The session has been replaced by another one, but the
The application ended the session and the