Back to Node Auth0

Class RefreshTokensClient

docs/classes/management.SDK.RefreshTokensClient.html

5.9.18.6 KB
Original Source

Class RefreshTokensClient

Index

Constructors

constructor

Methods

listrevokegetdeleteupdate

Properties

_options

Constructors

constructor

new RefreshTokensClient(options: BaseClientOptions): RefreshTokensClient

Parameters

Returns RefreshTokensClient

Methods

list

list(
request: GetRefreshTokensRequestParameters,
requestOptions?: RefreshTokensClient.RequestOptions,
): Promise<
Page<
RefreshTokenResponseContent,
GetRefreshTokensPaginatedResponseContent,
>,
>

Retrieve a paginated list of refresh tokens for a specific user, with optional filtering by client ID. Results are sorted by credential_id ascending.

Parameters

Request-specific configuration.

Returns Promise< Page< RefreshTokenResponseContent, GetRefreshTokensPaginatedResponseContent, >, >

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.refreshTokens.list({ user_id: "user_id", client_id: "client_id", from: "from", take: 1, fields: "fields", include_fields: true })Copy

revoke

revoke(
request?: RevokeRefreshTokensRequestContent,
requestOptions?: RefreshTokensClient.RequestOptions,
): HttpResponsePromise<void>

Revoke refresh tokens in bulk by ID list, user, user+client, or client.

Parameters

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.refreshTokens.revoke()Copy

get

get(
id: string,
requestOptions?: RefreshTokensClient.RequestOptions,
): HttpResponsePromise<GetRefreshTokenResponseContent>

Retrieve refresh token information.

Parameters

  • id: string

ID refresh token to retrieve

Request-specific configuration.

Returns HttpResponsePromise<GetRefreshTokenResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.refreshTokens.get("id")Copy

delete

delete(
id: string,
requestOptions?: RefreshTokensClient.RequestOptions,
): HttpResponsePromise<void>

Delete a refresh token by its ID.

Parameters

  • id: string

ID of the refresh token to delete.

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.refreshTokens.delete("id")Copy

update

update(
id: string,
request?: UpdateRefreshTokenRequestContent,
requestOptions?: RefreshTokensClient.RequestOptions,
): HttpResponsePromise<UpdateRefreshTokenResponseContent>

Update a refresh token by its ID.

Parameters

  • id: string

ID of the refresh token to update.

Request-specific configuration.

Returns HttpResponsePromise<UpdateRefreshTokenResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.refreshTokens.update("id")Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods listrevokegetdeleteupdate Properties _options