View Source Auth0.Management.Prompts (Auth0Api v2.3.0)

Summary

Types

config()
error()
language()
prompt()
screen()

Functions

get(config)

Retrieve details of the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features.

get_custom_text(prompt, language, config)

Retrieve custom text for a specific prompt and language.

get_partials(prompt, config)

Get template partials for a prompt

get_rendering_configuration(prompt, screen, config)

Retrieve the rendering configuration for a single screen.

set_custom_text(prompt, language, params, config)

Set custom text for a specific prompt. Existing texts will be overwritten.

set_partials(prompt, params, config)

Set template partials for a prompt

set_rendering_configuration(prompt, screen, params, config)

Configures ACUL settings on a single screen.

update(params, config)

Update the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features.

Types

Link to this type

config()

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

error()

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

language()

View Source 
@type language() :: String.t()
Link to this type

prompt()

View Source 
@type prompt() :: String.t()
Link to this type

screen()

View Source 
@type screen() :: String.t()

Functions

Link to this function

get(config)

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

Retrieve details of the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features.

see

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

Link to this function

get_custom_text(prompt, language, config)

View Source 
@spec get_custom_text(prompt(), language(), config()) :: {:ok, map()} | error()

Retrieve custom text for a specific prompt and language.

see

https://auth0.com/docs/api/management/v2/prompts/get-custom-text-by-language

Link to this function

get_partials(prompt, config)

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

Get template partials for a prompt

see

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

Link to this function

get_rendering_configuration(prompt, screen, config)

View Source 
@spec get_rendering_configuration(prompt(), screen(), config()) ::
  {:ok, map()} | error()

Retrieve the rendering configuration for a single screen.

see

https://auth0.com/docs/api/management/v2/prompts/get-rendering-configuration

Link to this function

set_custom_text(prompt, language, params, config)

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

Set custom text for a specific prompt. Existing texts will be overwritten.

see

https://auth0.com/docs/api/management/v2/prompts/put-custom-text-by-language

Link to this function

set_partials(prompt, params, config)

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

Set template partials for a prompt

see

https://auth0.com/docs/api/management/v2/prompts/put-partials

Link to this function

set_rendering_configuration(prompt, screen, params, config)

View Source 
@spec set_rendering_configuration(prompt(), screen(), map(), config()) ::
  {:ok, map()} | error()

Configures ACUL settings on a single screen.

see

https://auth0.com/docs/api/management/v2/prompts/patch-rendering-configuration

Link to this function

update(params, config)

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

Update the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features.

see

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