Auth0Api v1.4.0

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

Documentation for Auth0 Management API of Hooks.

endpoint

  • /api/v2/hooks
  • /api/v2/hooks/{id}
  • /api/v2/hooks/{id}/secrets

Link to this section Summary

Types

config()
error()
id()
response_body()

Functions

add_secrets(id, params, config)

Add hook secrets.

create(params, config)

Create a hook.

delete(id, config)

Delete a hook.

delete_secrets(id, params, config)

Delete hook secrets.

get(id, params, config)

Get a hook.

get_secrets(id, config)

Get hook secrets.

list(params, config)

Get hooks.

update(id, params, config)

Update a hook.

update_secrets(id, params, config)

Update hook secrets.

Link to this section Types

Link to this type

config()

View Source

Specs

config() :: Auth0.Config.t()
Link to this type

error()

View Source

Specs

error() :: {:error, integer(), term()} | {:error, term()}
Link to this type

id()

View Source

Specs

id() :: String.t()
Link to this type

response_body()

View Source

Specs

response_body() :: String.t()

Link to this section Functions

Link to this function

add_secrets(id, params, config)

View Source

Specs

add_secrets(
  id(),
  Auth0.Management.Hooks.Secrets.Add.Params.t() | map(),
  config()
) ::
  {:ok, map(), response_body()} | error()

Add hook secrets.

see

https://auth0.com/docs/api/management/v2/#!/Hooks/post_secrets

Link to this function

create(params, config)

View Source

Specs

create(Auth0.Management.Hooks.Create.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.Hook.t(), response_body()} | error()

Create a hook.

see

https://auth0.com/docs/api/management/v2/#!/Hooks/post_hooks

Link to this function

delete(id, config)

View Source

Specs

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

Delete a hook.

see

https://auth0.com/docs/api/management/v2/#!/Hooks/delete_hooks_by_id

Link to this function

delete_secrets(id, params, config)

View Source

Specs

delete_secrets(
  id(),
  Auth0.Management.Hooks.Secrets.Delete.Params.t() | map(),
  config()
) ::
  {:ok, String.t(), response_body()} | error()

Delete hook secrets.

see

https://auth0.com/docs/api/management/v2/#!/Hooks/delete_secrets

Link to this function

get(id, params, config)

View Source

Specs

get(id(), Auth0.Management.Hooks.Get.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.Hook.t(), response_body()} | error()

Get a hook.

see

https://auth0.com/docs/api/management/v2/#!/Hooks/get_hooks_by_id

Link to this function

get_secrets(id, config)

View Source

Specs

get_secrets(id(), config()) ::
  {:ok, Auth0.Entity.HookSecret.t(), response_body()} | error()

Get hook secrets.

see

https://auth0.com/docs/api/management/v2/#!/Hooks/get_secrets

Link to this function

list(params, config)

View Source

Specs

list(Auth0.Management.Hooks.List.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.Hooks.t(), response_body()} | error()

Get hooks.

see

https://auth0.com/docs/api/management/v2/#!/Hooks/get_hooks

Link to this function

update(id, params, config)

View Source

Specs

update(id(), Auth0.Management.Hooks.Patch.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.Hook.t(), response_body()} | error()

Update a hook.

see

https://auth0.com/docs/api/management/v2/#!/Hooks/patch_hooks_by_id

Link to this function

update_secrets(id, params, config)

View Source

Specs

update_secrets(
  id(),
  Auth0.Management.Hooks.Secrets.Patch.Params.t() | map(),
  config()
) ::
  {:ok, map(), response_body()} | error()

Update hook secrets.

see

https://auth0.com/docs/api/management/v2/#!/Hooks/patch_hooks_by_id