• management
• SDK
• RefreshTokenClient

Class RefreshTokenClient

Index

Constructors

constructor

Methods

listdelete

Properties

_options

Constructors

constructor

new RefreshTokenClient(options: BaseClientOptions): RefreshTokenClient

Parameters

• options: BaseClientOptions

Returns RefreshTokenClient

Methods

list

list(
user_id: string,
request?: ListRefreshTokensRequestParameters,
requestOptions?: RefreshTokenClient.RequestOptions,
): Promise<
Page<
RefreshTokenResponseContent,
ListRefreshTokensPaginatedResponseContent,
>,
>

Retrieve details for a user's refresh tokens.

Parameters

• user_id: string

ID of the user to get refresh tokens for

• request: ListRefreshTokensRequestParameters = {}
• OptionalrequestOptions: RefreshTokenClient.RequestOptions

Request-specific configuration.

Returns Promise< Page< RefreshTokenResponseContent, ListRefreshTokensPaginatedResponseContent, >, >

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

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

delete

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

Delete all refresh tokens for a user.

Parameters

• user_id: string

ID of the user to get remove refresh tokens for

• OptionalrequestOptions: RefreshTokenClient.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.refreshToken.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