Auth0 API

Device Credentials

device_credentials

Methods

Create A Device Public Key Credential -> { id }
post/device-credentials

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.

Delete A Device Credential ->
delete/device-credentials/{id}

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

Retrieve Device Credentials -> DeviceCredentialsPageNumberPage<{ id, client_id, device_id, 3 more... }>
get/device-credentials

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

Security

Example: Authorization: Bearer My Bearer Token

Parameters
client_id: string
Optional

client_id of the devices to retrieve.

fields: string
Optional

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.

include_fields: boolean
Optional

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

include_totals: boolean
Optional

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

page: number
Optional
(minimum: 0)

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

per_page: number
Optional
(maximum: 100, minimum: 1)

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

type:
Optional

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

"public_key"
"refresh_token"
"rotating_refresh_token"
user_id: string
Optional

user_id of the devices to retrieve.

Response fields
UnionMember0 = Array<{ id, client_id, device_id, 3 more... }>
UnionMember1 = { device_credentials, limit, start, 1 more... }
Request example
200Example