Interface GetDeviceCredentialsRequest

Hierarchy

  • GetDeviceCredentialsRequest

Properties

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

Properties

Optional client_id

client_id?: string

client_id of the devices to retrieve.

Optional fields

fields?: string

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.

Optional include_fields

include_fields?: boolean

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

Optional include_totals

include_totals?: boolean

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

Optional page

page?: number

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

Optional per_page

per_page?: number

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

Optional type

type?: GetDeviceCredentialsTypeEnum

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

Optional user_id

user_id?: string

user_id of the devices to retrieve.

Settings

Member Visibility

Theme

On This Page