Class DeviceCredentialsClient

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

public class DeviceCredentialsClient : IDeviceCredentialsClient

Inheritance

object

DeviceCredentialsClient

Implements

IDeviceCredentialsClient

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

OptionalExtensions.AddIfNotNull<T>(T?, Dictionary<string, object?>, string)

Methods

CreatePublicKeyAsync(CreatePublicKeyDeviceCredentialRequestContent, RequestOptions?, CancellationToken)

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.

public WithRawResponseTask<CreatePublicKeyDeviceCredentialResponseContent> CreatePublicKeyAsync(CreatePublicKeyDeviceCredentialRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request CreatePublicKeyDeviceCredentialRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<CreatePublicKeyDeviceCredentialResponseContent>

Examples

await client.DeviceCredentials.CreatePublicKeyAsync(
    new CreatePublicKeyDeviceCredentialRequestContent
    {
        DeviceName = "device_name",
        Type = DeviceCredentialPublicKeyTypeEnum.PublicKey,
        Value = "value",
        DeviceId = "device_id",
    }
);

DeleteAsync(string, RequestOptions?, CancellationToken)

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

public Task DeleteAsync(string id, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.DeviceCredentials.DeleteAsync("id");

ListAsync(ListDeviceCredentialsRequestParameters, RequestOptions?, CancellationToken)

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

public Task<Pager<DeviceCredential>> ListAsync(ListDeviceCredentialsRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request ListDeviceCredentialsRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<DeviceCredential>>

Examples

await client.DeviceCredentials.ListAsync(
    new ListDeviceCredentialsRequestParameters
    {
        Page = 1,
        PerPage = 1,
        IncludeTotals = true,
        Fields = "fields",
        IncludeFields = true,
        UserId = "user_id",
        ClientId = "client_id",
        Type = DeviceCredentialTypeEnum.PublicKey,
    }
);