Back to Node Auth0

Interface ListDeviceCredentialsRequestParameters

docs/interfaces/management.Management.ListDeviceCredentialsRequestParameters.html

5.9.12.7 KB
Original Source

Interface ListDeviceCredentialsRequestParameters

Example

{ * 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

interface ListDeviceCredentialsRequestParameters {
page?: number | null;
per_page?: number | null;
include_totals?: boolean | null;
fields?: string | null;
include_fields?: boolean | null;
user_id?: string | null;
client_id?: string | null;
type?: Management.DeviceCredentialTypeEnum | null;
}

Index

Properties

page?per_page?include_totals?fields?include_fields?user_id?client_id?type?

Properties

Optionalpage

page?: number | null

Page index of the results to return. First page is 0.

Optionalper_page

per_page?: number | null

Number of results per page. There is a maximum of 1000 results allowed from this endpoint.

Optionalinclude_totals

include_totals?: boolean | null

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

Optionalfields

fields?: string | null

Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.

Optionalinclude_fields

include_fields?: boolean | null

Whether specified fields are to be included (true) or excluded (false).

Optionaluser_id

user_id?: string | null

user_id of the devices to retrieve.

Optionalclient_id

client_id?: string | null

client_id of the devices to retrieve.

Optionaltype

type?: Management.DeviceCredentialTypeEnum | null

Type of credentials to retrieve. Must be public_key, refresh_token or rotating_refresh_token. The property will default to refresh_token when paging is requested

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Properties pageper_pageinclude_totalsfieldsinclude_fieldsuser_idclient_idtype