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

Documentation for Auth0 Management API of Prompts.

endpoint

/api/v2/prompts
/api/v2/prompts/{prompt}/custom-text/{language}

Link to this section Summary

Types

config()

error()

language()

prompt()

response_body()

Functions

get(config)

Get prompts settings.

get_custom_text(prompt, language, config)

Get custom text for a prompt.

set_custom_text(prompt, language, params, config)

Set custom text for a specific prompt.

update(params, config)

Update prompts settings.

Link to this section Types

config()

Specs

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

error()

Specs

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

language()

Specs

language() :: String.t()

prompt()

Specs

prompt() :: String.t()

response_body()

Specs

response_body() :: String.t()

Link to this section Functions

get(config)

Specs

get(config()) :: {:ok, Auth0.Entity.Prompt.t(), response_body()} | error()

Get prompts settings.

see

https://auth0.com/docs/api/management/v2/#!/Prompts/get_prompts

get_custom_text(prompt, language, config)

Specs

get_custom_text(prompt(), language(), config()) ::
  {:ok, Auth0.Entity.CustomText.t(), response_body()} | error()

Get custom text for a prompt.

see

https://auth0.com/docs/api/management/v2/#!/Prompts/get_custom_text_by_language

set_custom_text(prompt, language, params, config)

Specs

set_custom_text(
  prompt(),
  language(),
  Auth0.Management.Prompts.CustomText.Put.Params.t() | map(),
  config()
) :: {:ok, Auth0.Entity.CustomText.t(), response_body()} | error()

Set custom text for a specific prompt.

see

https://auth0.com/docs/api/management/v2/#!/Prompts/put_custom_text_by_language

update(params, config)

Specs

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

Update prompts settings.

see

https://auth0.com/docs/api/management/v2/#!/Prompts/patch_prompts