View Source Auth0.Management.Keys (Auth0Api v2.2.0)

Summary

Types

config()

error()

kid()

Functions

create_encryption_key(params, config)

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

create_encryption_wrapping_key(kid, config)

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

delete_encryption_key(kid, config)

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

get_encryption_key(kid, config)

Retrieve details of the encryption key with the given ID.

get_encryption_keys(params, config)

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

get_signing(kid, config)

Retrieve details of the application signing key with the given ID.

import_encryption_key(kid, params, config)

Import wrapped key material and activate encryption key.

list_signing(config)

Retrieve details of all the application signing keys associated with your tenant.

rekey_encryption_key(config)

Perform rekeying operation on the key hierarchy.

revoke_signing(kid, config)

Revoke the application signing key with the given ID.

rotate_signing(config)

Rotate the application signing key of your tenant.

Types

config()

@type config() :: Auth0.Config.t()

error()

@type error() :: {:error, integer(), term()} | {:error, term()}

kid()

@type kid() :: String.t()

Functions

create_encryption_key(params, config)

@spec create_encryption_key(map(), config()) :: {:ok, map()} | error()

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

see

https://auth0.com/docs/api/management/v2/keys/post-encryption

create_encryption_wrapping_key(kid, config)

@spec create_encryption_wrapping_key(kid(), config()) :: {:ok, map()} | error()

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

see

https://auth0.com/docs/api/management/v2/keys/post-encryption-wrapping-key

delete_encryption_key(kid, config)

@spec delete_encryption_key(kid(), config()) :: {:ok, String.t()} | error()

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

see

https://auth0.com/docs/api/management/v2/keys/delete-encryption-key

get_encryption_key(kid, config)

@spec get_encryption_key(kid(), config()) :: {:ok, map()} | error()

Retrieve details of the encryption key with the given ID.

see

https://auth0.com/docs/api/management/v2/keys/get-encryption-key

get_encryption_keys(params, config)

@spec get_encryption_keys(map(), config()) :: {:ok, [map()] | map()} | error()

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

see

https://auth0.com/docs/api/management/v2/keys/get-encryption-keys

get_signing(kid, config)

@spec get_signing(kid(), config()) :: {:ok, map()} | error()

Retrieve details of the application signing key with the given ID.

see

https://auth0.com/docs/api/management/v2/keys/get-signing-key

import_encryption_key(kid, params, config)

@spec import_encryption_key(kid(), map(), config()) :: {:ok, map()} | error()

Import wrapped key material and activate encryption key.

see

https://auth0.com/docs/api/management/v2/keys/post-encryption-key

list_signing(config)

@spec list_signing(config()) :: {:ok, [map()]} | error()

Retrieve details of all the application signing keys associated with your tenant.

see

https://auth0.com/docs/api/management/v2/keys/get-signing-keys

rekey_encryption_key(config)

@spec rekey_encryption_key(config()) :: {:ok, String.t()} | error()

Perform rekeying operation on the key hierarchy.

see

https://auth0.com/docs/api/management/v2/keys/post-encryption-rekey

revoke_signing(kid, config)

@spec revoke_signing(kid(), config()) :: {:ok, map()} | error()

Revoke the application signing key with the given ID.

see

https://auth0.com/docs/api/management/v2/keys/put-signing-keys

rotate_signing(config)

@spec rotate_signing(config()) :: {:ok, map()} | error()

Rotate the application signing key of your tenant.

see

https://auth0.com/docs/api/management/v2/keys/post-signing-keys