Class DeviceCredentials

Index

Constructors

constructor

new DeviceCredentials(_options: DeviceCredentials.Options): DeviceCredentials
Parameters
- _options: DeviceCredentials.Options
Returns DeviceCredentials

Methods

list

list(
request?: Management.ListDeviceCredentialsRequestParameters,
requestOptions?: DeviceCredentials.RequestOptions,
): Promise<Page<DeviceCredential>>
Retrieve device credential information (public_key, refresh_token, or rotating_refresh_token) associated with a specific user.
Parameters
- request: Management.ListDeviceCredentialsRequestParameters = {}
- OptionalrequestOptions: DeviceCredentials.RequestOptions
  Request-specific configuration.
Returns Promise<Page<DeviceCredential>>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.deviceCredentials.list()
```

createPublicKey

createPublicKey(
request: Management.CreatePublicKeyDeviceCredentialRequestContent,
requestOptions?: DeviceCredentials.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: Management.CreatePublicKeyDeviceCredentialRequestContent
- OptionalrequestOptions: DeviceCredentials.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",
        value: "value",
        device_id: "device_id"
    })
```

delete

delete(
id: string,
requestOptions?: DeviceCredentials.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: DeviceCredentials.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")
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: DeviceCredentials.Options

Class DeviceCredentials

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns DeviceCredentials

Methods

list

Parameters

Returns Promise<Page<DeviceCredential>>

Throws

Throws

Throws

Throws

Example

createPublicKey

Parameters

Returns HttpResponsePromise<CreatePublicKeyDeviceCredentialResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Example

Protected_getAuthorizationHeader

Returns Promise<string>

Properties

Protected Readonly_options

Settings

On This Page

`Protected`_getAuthorizationHeader

`Protected` `Readonly`_options