Skip to main content

Function: listUserSessions()

listUserSessions(client, props): Promise<{ rows: object[]; rowCount: number; }>

Lists active user sessions for a user with pagination and sorting. SECURITY: Does NOT return userSessionToken - only public session data.

Parameters​

client​

ApiClient

The API client instance

props​

The request properties

params​

{ userName: string; } = listUserSessionsParamsSchema

Path parameters (userName)

params.userName​

string = userNameSchema

query​

{ pageOffset?: number; pageSize?: number; sortBy?: "createdAt" | "lastUsedAt" | "ipAddress" | "expiresAt"; sortDir?: "asc" | "desc"; } = listUserSessionsQuerySchema

Query parameters for pagination and sorting

query.pageOffset?​

number = ...

query.pageSize?​

number = ...

query.sortBy?​

"createdAt" | "lastUsedAt" | "ipAddress" | "expiresAt" = ...

query.sortDir?​

"asc" | "desc" = ...

Returns​

Promise<{ rows: object[]; rowCount: number; }>

Promise resolving to a paginated list of user sessions

Operation Id​

list-user-sessions

Example​

const sessions = await listUserSessions(client, {
  params: { userName: 'john-doe' },
  query: { pageOffset: 0, pageSize: 20 }
});