Search…
Session
The client-side user session.

Overview

The Session object is an abstraction over an HTTP session. It models the period of information exchange between a user and the server.
The Session object includes methods for recording session activity and ending the session client-side. For security reasons, sessions can also expire server-side.
As soon as a User signs in, we create a Session for the current Client. Clients can have more than one sessions at any point in time, but only one of those sessions will be active.
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.
For more details regarding the different session states, see our documentation on Session management.

Attributes

Property
Description
id
string
A unique identifier for the session.
user
User
The user associated with the session.
publicUserData
PublicUserData
Public information about the user that this session belongs to.
status
The current state of the session.
lastActiveAt
Date
The time the session was last active on the Client.
abandonAt
Date
The time when the session was abandoned by the user.
expireAt
Date
The time the session expires and will seize to be active.
updatedAt
Date
The last time the session recorded activity of any kind.

Methods

end()

end() => Promise<SessionResource>
Marks the session as ended. The session will no longer be active for this Client and its status will become ended.
Parameters
Returns
This method accepts no parameters.
This method returns a Promise which resolves with a Session object.

remove()

remove() => Promise<SessionResource>
Marks the session as removed. The session will no longer be active for this Client and its status will become removed.
Parameters
Returns
This method accepts no parameters.
This method returns a Promise which resolves with a Session object.

touch()

touch() => Promise<SessionResource>
Touches the session, signifying some kind of user activity. Use this method to record any updates to user activity.
Parameters
Returns
This method accepts no parameters.
This method returns a Promise which resolves with a Session object.

getToken(options?)

getToken(options?: GetSessionTokenOptions) => Promise<string>
Retrieves the user's session token for the given template or the default clerk token. This method uses a cache so a network request will only be made if the token in memory has expired. The TTL for clerk token is one minute.
Parameters
Returns
options?
GetSessionTokenOptions Optionally pass the JWT template name and the leeway for expiring the cache. Default leeway is 10 seconds
Promise<string> Returns a Promise that resolves to a string. The string is the user's session token.

Interfaces

PublicUserData

Property
Description
firstName
string | null
The user's first name. This attribute will only be populated if name is enabled in instance settings.
lastName
string | null
The user's last name. This attribute will only be populated if name is enabled in instance settings.
profileImageUrl
string
The URL of the user's profile image.
identifier
string
The user's identifier (email address, phone number, username, etc) that was used for authentication when this session was created.

GetSessionTokenOptions

Property
Description
leewayInSeconds?
number
The number of seconds that we allow the token to be cached.
template?
string
The name of the JWT template to generate a new token from.
throwOnError?
boolean
Whether to throw an error or return an empty string, if an error occur.

Types

SessionStatus

abandoned | active | ended | expired | removed | replaced | revoked
Value
Description
abandoned
The session was abandoned client-side.
active
The session is valid and all activity is allowed.
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 modified 1mo ago