Class RefreshTokensClient

Index

Constructors

constructor

new RefreshTokensClient(options: BaseClientOptions): RefreshTokensClient
Parameters
- options: BaseClientOptions
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: GetRefreshTokensRequestParameters
- OptionalrequestOptions: RefreshTokensClient.RequestOptions
  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
    })
```

revoke

revoke(
request?: RevokeRefreshTokensRequestContent,
requestOptions?: RefreshTokensClient.RequestOptions,
): HttpResponsePromise<void>
Revoke refresh tokens in bulk by ID list, user, user+client, or client.
Parameters
- request: RevokeRefreshTokensRequestContent = {}
- OptionalrequestOptions: RefreshTokensClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.refreshTokens.revoke()
```

get

get(
id: string,
requestOptions?: RefreshTokensClient.RequestOptions,
): HttpResponsePromise<GetRefreshTokenResponseContent>
Retrieve refresh token information.
Parameters
- id: string
  ID refresh token to retrieve
- OptionalrequestOptions: RefreshTokensClient.RequestOptions
  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")
```

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.
- OptionalrequestOptions: RefreshTokensClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.refreshTokens.delete("id")
```

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: UpdateRefreshTokenRequestContent = {}
- OptionalrequestOptions: RefreshTokensClient.RequestOptions
  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")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Class RefreshTokensClient

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns RefreshTokensClient

Methods

list

Parameters

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

Throws

Throws

Throws

Throws

Throws

Example

revoke

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetRefreshTokenResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateRefreshTokenResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

Properties

Protected Readonly_options

Settings

On This Page

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

`Protected` `Readonly`_options