Auth0.Management.Keys (Auth0Api v1.4.0) View Source

Documentation for Auth0 Management API of Keys.

endpoint

  • /api/v2/keys/signing
  • /api/v2/keys/signing/{kid}
  • /api/v2/keys/signing/rotate
  • /api/v2/keys/signing/{kid}/revoke

Link to this section Summary

Functions

Get an Application Signing Key by its key id.

Get all Application Signing Keys.

Revoke an Application Signing Key by its key id.

Rotate the Application Signing Key.

Link to this section Types

Specs

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

Specs

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

Specs

kid() :: String.t()

Specs

response_body() :: String.t()

Link to this section Functions

Link to this function

get_signing(kid, config)

View Source

Specs

get_signing(kid(), config()) ::
  {:ok, Auth0.Entity.SigningKey.t(), response_body()} | error()

Get an Application Signing Key by its key id.

see

https://auth0.com/docs/api/management/v2/#!/Keys/get_signing_key

Specs

list_signing(config()) ::
  {:ok, Auth0.Entity.SigningKeys.t(), response_body()} | error()

Get all Application Signing Keys.

see

https://auth0.com/docs/api/management/v2/#!/Keys/get_signing_keys

Link to this function

revoke_signing(kid, config)

View Source

Specs

revoke_signing(kid(), config()) ::
  {:ok, Auth0.Entity.SigningKey.t(), response_body()} | error()

Revoke an Application Signing Key by its key id.

see

https://auth0.com/docs/api/management/v2/#!/Keys/put_signing_keys

Specs

rotate_signing(config()) ::
  {:ok, Auth0.Entity.SigningKey.t(), response_body()} | error()

Rotate the Application Signing Key.

see

https://auth0.com/docs/api/management/v2/#!/Keys/post_signing_keys