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

Facade for the Auth0 Management API Prompts endpoints.

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

Summary

Types

config()

error()

language()

prompt()

screen()

value_params()

Functions

bulk_update_renderings(params, config)

Update render settings for multiple screens.

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.

list_renderings(params, config)

Get render setting configurations for all screens.

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

config()

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

error()

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

language()

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

prompt()

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

screen()

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

value_params()

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

Functions

bulk_update_renderings(params, config)

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

Update render settings for multiple screens.

Learn more about configuring render settings for advanced customization.

see

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

get(config)

@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

get_custom_text(prompt, language, config)

@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

get_partials(prompt, config)

@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

get_rendering_configuration(prompt, screen, config)

@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

list_renderings(params, config)

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

Get render setting configurations for all screens.

see

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

set_custom_text(prompt, language, params, config)

@spec set_custom_text(prompt(), language(), value_params(), 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

set_partials(prompt, params, config)

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

Set template partials for a prompt

see

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

set_rendering_configuration(prompt, screen, params, config)

@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

update(params, config)

@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