Interface IEncryptionClient

Namespace

Auth0.ManagementApi.Keys

Assembly

Auth0.ManagementApi.dll

public interface IEncryptionClient

Extension Methods

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

Methods

CreateAsync(CreateEncryptionKeyRequestContent, RequestOptions?, CancellationToken)

Create the new, pre-activated encryption key, without the key material.

WithRawResponseTask<CreateEncryptionKeyResponseContent> CreateAsync(CreateEncryptionKeyRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request CreateEncryptionKeyRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateEncryptionKeyResponseContent>

CreatePublicWrappingKeyAsync(string, RequestOptions?, CancellationToken)

Create the public wrapping key to wrap your own encryption key material.

WithRawResponseTask<CreateEncryptionKeyPublicWrappingResponseContent> CreatePublicWrappingKeyAsync(string kid, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

kid string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateEncryptionKeyPublicWrappingResponseContent>

DeleteAsync(string, RequestOptions?, CancellationToken)

Delete the custom provided encryption key with the given ID and move back to using native encryption key.

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

Parameters

kid string

options RequestOptions

cancellationToken CancellationToken

Returns

Task

GetAsync(string, RequestOptions?, CancellationToken)

Retrieve details of the encryption key with the given ID.

WithRawResponseTask<GetEncryptionKeyResponseContent> GetAsync(string kid, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

kid string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetEncryptionKeyResponseContent>

ImportAsync(string, ImportEncryptionKeyRequestContent, RequestOptions?, CancellationToken)

Import wrapped key material and activate encryption key.

WithRawResponseTask<ImportEncryptionKeyResponseContent> ImportAsync(string kid, ImportEncryptionKeyRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

kid string

request ImportEncryptionKeyRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<ImportEncryptionKeyResponseContent>

ListAsync(ListEncryptionKeysRequestParameters, RequestOptions?, CancellationToken)

Retrieve details of all the encryption keys associated with your tenant.

Task<Pager<EncryptionKey>> ListAsync(ListEncryptionKeysRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request ListEncryptionKeysRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<EncryptionKey>>

RekeyAsync(RequestOptions?, CancellationToken)

Perform rekeying operation on the key hierarchy.

Task RekeyAsync(RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task