• management
• SDK
• DeviceCredentialsClient

Class DeviceCredentialsClient

Index

Constructors

constructor

Methods

listcreatePublicKeydelete

Properties

_options

Constructors

constructor

new DeviceCredentialsClient(options: BaseClientOptions): DeviceCredentialsClient

Parameters

• options: BaseClientOptions

Returns DeviceCredentialsClient

Methods

list

list(
request?: ListDeviceCredentialsRequestParameters,
requestOptions?: DeviceCredentialsClient.RequestOptions,
): Promise<
Page<
DeviceCredential,
ListDeviceCredentialsOffsetPaginatedResponseContent,
>,
>

Retrieve device credential information (public_key, refresh_token, or rotating_refresh_token) associated with a specific user.

Parameters

• request: ListDeviceCredentialsRequestParameters = {}
• OptionalrequestOptions: DeviceCredentialsClient.RequestOptions

Request-specific configuration.

Returns Promise< Page< DeviceCredential, ListDeviceCredentialsOffsetPaginatedResponseContent, >, >

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.deviceCredentials.list({ page: 1, per_page: 1, include_totals: true, fields: "fields", include_fields: true, user_id: "user_id", client_id: "client_id", type: "public_key" })Copy

createPublicKey

createPublicKey(
request: CreatePublicKeyDeviceCredentialRequestContent,
requestOptions?: DeviceCredentialsClient.RequestOptions,
): HttpResponsePromise<CreatePublicKeyDeviceCredentialResponseContent>

Create a device credential public key to manage refresh token rotation for a given user_id. Device Credentials APIs are designed for ad-hoc administrative use only and paging is by default enabled for GET requests.

When refresh token rotation is enabled, the endpoint becomes consistent. For more information, read Signing Keys.

Parameters

• request: CreatePublicKeyDeviceCredentialRequestContent
• OptionalrequestOptions: DeviceCredentialsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<CreatePublicKeyDeviceCredentialResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.ConflictError

Throws

Management.TooManyRequestsError

Example

await client.deviceCredentials.createPublicKey({ device_name: "device_name", type: "public_key", value: "value", device_id: "device_id" })Copy

delete

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

Permanently delete a device credential (such as a refresh token or public key) with the given ID.

Parameters

• id: string

ID of the credential to delete.

• OptionalrequestOptions: DeviceCredentialsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

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

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods listcreatePublicKeydelete Properties _options