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

Facade for the Auth0 Management API Keys endpoints.

Most applications should call Auth0.Api.Management instead of this module.

Summary

Functions

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

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

Create a Network ACL key.

Delete custom signing keys.

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

Delete a Network ACL key.

Get custom signing keys.

Retrieve details of the encryption key with the given ID.

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

Get a Network ACL Key.

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

Import wrapped key material and activate encryption key.

Get all Network ACL keys.

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

Perform rekeying operation on the key hierarchy.

Revoke the application signing key with the given ID.

Rotate the application signing key of your tenant.

Create or replace custom signing keys.

Types

@type config() :: Auth0.Config.t()
@type error() :: {:error, integer(), term()} | {:error, term()}
@type kid() :: String.t()

Functions

Link to this function

create_encryption_key(params, config)

View Source
@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

Link to this function

create_encryption_wrapping_key(kid, config)

View Source
@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

Link to this function

create_network_acl_key(params, config)

View Source
@spec create_network_acl_key(map(), config()) :: {:ok, map()} | error()

Create a Network ACL key.

Create a new key used to verify HTTP Message Signatures on Network ACL rules.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

https://auth0.com/docs/api/management/v2/keys/create-keys-network-acls

Link to this function

delete_custom_signing(config)

View Source
@spec delete_custom_signing(config()) :: {:ok, String.t()} | error()

Delete custom signing keys.

Delete entire jwks representation of custom signing keys.

see

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

Link to this function

delete_encryption_key(kid, config)

View Source
@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

Link to this function

delete_network_acl_key(id, config)

View Source
@spec delete_network_acl_key(String.t(), config()) :: {:ok, String.t()} | error()

Delete a Network ACL key.

Delete a key used to verify HTTP Message Signatures on Network ACL rules

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

https://auth0.com/docs/api/management/v2/keys/delete-keys-network-acls

Link to this function

get_custom_signing(config)

View Source
@spec get_custom_signing(config()) :: {:ok, map()} | error()

Get custom signing keys.

Get entire jwks representation of custom signing keys.

see

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

Link to this function

get_encryption_key(kid, config)

View Source
@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

Link to this function

get_encryption_keys(params, config)

View Source
@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

Link to this function

get_network_acl_key(id, config)

View Source
@spec get_network_acl_key(String.t(), config()) :: {:ok, map()} | error()

Get a Network ACL Key.

Retrieve a specific key used to verify HTTP Message Signatures on Network ACL rules.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

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

Link to this function

get_signing(kid, config)

View Source
@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

Link to this function

import_encryption_key(kid, params, config)

View Source
@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

Link to this function

list_network_acl_keys(config)

View Source
@spec list_network_acl_keys(config()) :: {:ok, map()} | error()

Get all Network ACL keys.

Retrieve all keys used to verify HTTP Message Signatures on Network ACL rules, ordered by creation time descending.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

https://auth0.com/docs/api/management/v2/keys/get-all-keys-network-acls

@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

Link to this function

rekey_encryption_key(config)

View Source
@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

Link to this function

revoke_signing(kid, config)

View Source
@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

@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

Link to this function

set_custom_signing(params, config)

View Source
@spec set_custom_signing(map(), config()) :: {:ok, map()} | error()

Create or replace custom signing keys.

Create or replace entire jwks representation of custom signing keys.

see

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