Class KeysClient

Namespace

Auth0.ManagementApi.Clients

Assembly

Auth0.ManagementApi.dll

Contains methods to access the /keys endpoints.

public class KeysClient : BaseClient, IKeysClient

Inheritance

object

BaseClient

KeysClient

Implements

IKeysClient

Inherited Members

BaseClient.Connection

BaseClient.BaseUri

BaseClient.DefaultHeaders

BaseClient.BuildUri(string, IDictionary<string, string>)

BaseClient.EncodePath(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

KeysClient(IManagementConnection, Uri, IDictionary<string, string>)

Initializes a new instance of the KeysClient class.

public KeysClient(IManagementConnection connection, Uri baseUri, IDictionary<string, string> defaultHeaders)

Parameters

connection IManagementConnection

IManagementConnection used to make all API calls.

baseUri Uri

Uri of the endpoint to use in making API calls.

defaultHeaders IDictionary<string, string>

Dictionary containing default headers included with every request this client makes.

Methods

GetAllAsync(CancellationToken)

Get all Application Signing Keys

public Task<IList<Key>> GetAllAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<IList<Key>>

All available signing keys Key.

GetAsync(string, CancellationToken)

Get an Application Signing Key by its key ID.

public Task<Key> GetAsync(string kid, CancellationToken cancellationToken = default)

Parameters

kid string

The ID of the key to retrieve.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<Key>

The Key that was requested.

RevokeSigningKeyAsync(string, CancellationToken)

Revoke an Application Signing Key by its key ID.

public Task<RevokeSigningKeyResponse> RevokeSigningKeyAsync(string kid, CancellationToken cancellationToken = default)

Parameters

kid string

The ID of the key to revoke.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<RevokeSigningKeyResponse>

The revoked key's cert and kid.

RotateSigningKeyAsync(CancellationToken)

Rotate the Application Signing Key.

public Task<RotateSigningKeyResponse> RotateSigningKeyAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<RotateSigningKeyResponse>

The next rotated key's cert and kid.