• management
• SDK
• SessionsClient

Class SessionsClient

Index

Constructors

constructor

Methods

listdelete

Properties

_options

Constructors

constructor

new SessionsClient(options: BaseClientOptions): SessionsClient

Parameters

• options: BaseClientOptions

Returns SessionsClient

Methods

list

list(
user_id: string,
request?: ListUserSessionsRequestParameters,
requestOptions?: SessionsClient.RequestOptions,
): Promise<
Page<SessionResponseContent, ListUserSessionsPaginatedResponseContent>,
>

Retrieve details for a user's sessions.

Parameters

• user_id: string

ID of the user to get sessions for

• request: ListUserSessionsRequestParameters = {}
• OptionalrequestOptions: SessionsClient.RequestOptions

Request-specific configuration.

Returns Promise<Page<SessionResponseContent, ListUserSessionsPaginatedResponseContent>>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.users.sessions.list("user_id", { from: "from", take: 1 })Copy

delete

delete(
user_id: string,
requestOptions?: SessionsClient.RequestOptions,
): HttpResponsePromise<void>

Delete all sessions for a user.

Parameters

• user_id: string

ID of the user to get sessions for

• OptionalrequestOptions: SessionsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.users.sessions.delete("user_id")Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods listdelete Properties _options