View Source Auth0.Management.Hooks (Auth0Api v2.5.1)

Facade for the Auth0 Management API Hooks endpoints.

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

Deprecated: Auth0 Hooks are deprecated (end of life announced by Auth0). Migrate to Actions (Auth0.Management.Actions). The corresponding Auth0.Api.Management functions are marked with @deprecated.

Summary

Types

config()

error()

id()

value_params()

Functions

add_secrets(id, params, config)

Add one or more secrets to an existing hook. Accepts an object of key-value pairs, where the key is the name of the secret. A hook can have a maximum of 20 secrets.

create(params, config)

Create a new hook.

delete(id, config)

Delete a hook.

delete_secrets(id, params, config)

Delete one or more existing secrets for a given hook. Accepts an array of secret names to delete.

get(id, params, config)

Retrieve a hook by its ID. Accepts a list of fields to include in the result.

get_secrets(id, config)

Retrieve a hook's secrets by the ID of the hook.

list(params, config)

Retrieve all hooks. Accepts a list of fields to include or exclude in the result.

update(id, params, config)

Update an existing hook.

update_secrets(id, params, config)

Update one or more existing secrets for an existing hook. Accepts an object of key-value pairs, where the key is the name of the existing secret.

Types

config()

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

error()

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

id()

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

value_params()

@type value_params() :: %{:value => list() | map(), optional(any()) => any()}

Functions

add_secrets(id, params, config)

@spec add_secrets(id(), value_params(), config()) ::
  {:ok, map() | String.t()} | error()

Add one or more secrets to an existing hook. Accepts an object of key-value pairs, where the key is the name of the secret. A hook can have a maximum of 20 secrets.

see

https://auth0.com/docs/api/management/v2/hooks/post-secrets

create(params, config)

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

Create a new hook.

see

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

delete(id, config)

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

Delete a hook.

see

https://auth0.com/docs/api/management/v2/hooks/delete-hooks-by-id

delete_secrets(id, params, config)

@spec delete_secrets(id(), value_params(), config()) :: {:ok, String.t()} | error()

Delete one or more existing secrets for a given hook. Accepts an array of secret names to delete.

see

https://auth0.com/docs/api/management/v2/hooks/delete-secrets

get(id, params, config)

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

Retrieve a hook by its ID. Accepts a list of fields to include in the result.

see

https://auth0.com/docs/api/management/v2/hooks/get-hooks-by-id

get_secrets(id, config)

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

Retrieve a hook's secrets by the ID of the hook.

see

https://auth0.com/docs/api/management/v2/hooks/get-secrets

list(params, config)

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

Retrieve all hooks. Accepts a list of fields to include or exclude in the result.

see

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

update(id, params, config)

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

Update an existing hook.

see

https://auth0.com/docs/api/management/v2/hooks/patch-hooks-by-id

update_secrets(id, params, config)

@spec update_secrets(id(), value_params(), config()) ::
  {:ok, map() | String.t()} | error()

Update one or more existing secrets for an existing hook. Accepts an object of key-value pairs, where the key is the name of the existing secret.

see

https://auth0.com/docs/api/management/v2/hooks/patch-secrets