Clerk docs

Sessions

The Session object is an abstraction over an HTTP session. It models the period of information exchange between a user and the server. Sessions are created when a user successfully goes through the sign in or sign up flows.

https://clerk.com/docs/reference/clerkjs/session

List all sessions

Returns a list of all sessions. The sessions are returned sorted by creation date, with the newest sessions appearing first.

SecuritybearerAuth
Request
query Parameters
client_id
string

List sessions for the given client

user_id
string

List sessions for the given user

status
string

Filter sessions by the provided status

Enum: "abandoned" "active" "ended" "expired" "removed" "replaced" "revoked"
limit
number [ 1 .. 500 ]
Default: 10

Applies a limit to the number of results returned. Can be used for paginating the results together with offset. Must be an integer greater than zero and less than 500. By default, if not supplied, a limit of 10 is used.

offset
number >= 0
Default: 0

Skip the first offset results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with limit.

Responses
200

Success

400

Request was not successful

401

Authentication invalid

422

Invalid request parameters

get/sessions
Response samples
application/json
[
  • {
    }
]

Retrieve a session

Retrieve the details of a session

SecuritybearerAuth
Request
path Parameters
session_id
required
string

The ID of the session

Responses
200

Success

400

Request was not successful

401

Authentication invalid

404

Resource not found

get/sessions/{session_id}
Response samples
application/json
{
  • "object": "session",
  • "id": "string",
  • "user_id": "string",
  • "client_id": "string",
  • "actor": { },
  • "status": "active",
  • "last_active_organization_id": "string",
  • "last_active_at": 0,
  • "expire_at": 0,
  • "abandon_at": 0,
  • "updated_at": 0,
  • "created_at": 0
}

Revoke a session

Sets the status of a session as "revoked", which is an unauthenticated state. In multi-session mode, a revoked session will still be returned along with its client object, however the user will need to sign in again.

SecuritybearerAuth
Request
path Parameters
session_id
required
string

The ID of the session

Responses
200

Success

400

Request was not successful

401

Authentication invalid

404

Resource not found

post/sessions/{session_id}/revoke
Response samples
application/json
{
  • "object": "session",
  • "id": "string",
  • "user_id": "string",
  • "client_id": "string",
  • "actor": { },
  • "status": "active",
  • "last_active_organization_id": "string",
  • "last_active_at": 0,
  • "expire_at": 0,
  • "abandon_at": 0,
  • "updated_at": 0,
  • "created_at": 0
}

Verify a session

Returns the session if it is authenticated, otherwise returns an error.

SecuritybearerAuth
Request
path Parameters
session_id
required
string

The ID of the session

Request Body schema: application/json

Parameters.

token
string

The JWT that is sent via the __session cookie from your frontend. Note: this JWT must be associated with the supplied session ID.

Responses
200

Success

400

Request was not successful

401

Authentication invalid

404

Resource not found

post/sessions/{session_id}/verify
Request samples
application/json
{
  • "token": "string"
}
Response samples
application/json
{
  • "object": "session",
  • "id": "string",
  • "user_id": "string",
  • "client_id": "string",
  • "actor": { },
  • "status": "active",
  • "last_active_organization_id": "string",
  • "last_active_at": 0,
  • "expire_at": 0,
  • "abandon_at": 0,
  • "updated_at": 0,
  • "created_at": 0
}

Create a session token from a jwt template

Creates a JSON Web Token(JWT) based on a session and a JWT Template name defined for your instance

SecuritybearerAuth
Request
path Parameters
session_id
required
string

The ID of the session

template_name
required
string

The name of the JWT Template defined in your instance (e.g. custom_hasura).

Responses
200

OK

401

Authentication invalid

404

Resource not found

post/sessions/{session_id}/tokens/{template_name}
Response samples
application/json
{
  • "object": "token",
  • "jwt": "string"
}
➔ Next to Sign-in Tokens