`Session`

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, Clerk creates 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.

Properties

Name	Type	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`	`SessionStatus`	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.
`createdAt`	`Date`	The time the session was created.
`lastActiveToken`	`TokenResource \| null`	The last active token for the session
`lastActiveOrganizationId`	`string \| null`	The last active organization identifier
`actor`	`ActJWTClaim \| null`	The JWT actor for the session

Methods

`end()`


function end(): Promise<Session>;

Marks the session as ended. The session will no longer be active for this Client and its status will become ended.

Returns

Type	Description
`Promise<Session>`	The session that was just ended.

`remove()`


function remove(): Promise<Session>;

Marks the session as removed. The session will no longer be active for this Client and its status will become removed.

Returns

Type	Description
`Promise<Session>`	The session that was just removed.

`touch()`


function touch(): Promise<Session>;

Touches the session, signifying some kind of user activity. Use this method to record any updates to user activity.

Returns

Type	Description
`Promise<Session>`	The session that was just touched.

`getToken()`


function getToken(options?: GetTokenOptions): Promise<string | null>;

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.

`GetTokenOptions`

Name	Type	Description
`leewayInSeconds`	`number`	The number of seconds to allow the token to be cached for.
`template?`	`string`	The name of the JWT template from the Clerk Dashboard to generate a new token from. E.g. 'firebase', 'grafbase', or your custom template's name.
`throwOnError?`	`boolean`	Whether to throw an error or return an empty string, if an error occurs.
`skipCache?`	`boolean`	Whether to skip the cache lookup and force a call to the server instead, even within the TTL. Useful if the token claims are time-sensitive or depend on data that can be updated (e.g. user fields). Defaults to `false`.

Returns

Type	Description
`Promise<string \| null>`	The requested token.

Types

`PublicUserData`

Name	Type	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.
`imageUrl`	`string`	A getter boolean to check if the user has uploaded an image or one was copied from OAuth. Returns `false` if Clerk is displaying an avatar for the user.
`hasImage`	`boolean`	Whether the user has a profile image.
`identifier`	`string`	The user's identifier (email address, phone number, username, etc) that was used for authentication when this session was created.

`SessionStatus`


type 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 updated on October 24, 2023