View Source Auth0.Management.Branding (Auth0Api v2.2.0)

Summary

Types

config()

error()

id()

theme_id()

Functions

configure_phone_provider(params, config)

Create an phone provider.

create_phone_template(params, config)

Create a phone notification template

create_theme(params, config)

Create branding theme.

delete_phone_provider(id, config)

Delete the configured phone provider.

delete_phone_template(id, config)

Delete a phone notification template

delete_theme(theme_id, config)

Delete branding theme.

delete_universal_login(config)

Delete template for New Universal Login Experience

get(config)

Retrieve branding settings.

get_default_theme(config)

Retrieve default branding theme.

get_phone_provider(id, config)

Retrieve phone provider details. A list of fields to include or exclude may also be specified.

get_phone_template(id, config)

Get a phone notification template

get_theme(theme_id, config)

Retrieve branding theme.

get_universal_login(config)

Get template for New Universal Login Experience

list_phone_providers(params, config)

Retrieve a list ofphone providers details set for a Tenant. A list of fields to include or exclude may also be specified.

list_phone_templates(params, config)

Get a list of phone notification templates

reset_phone_template(id, params, config)

Resets a phone notification template values

set_universal_login(params, config)

Update the Universal Login branding template.

test_phone_provider(id, params, config)

Send a test phone notification for the configured provider

test_phone_template(id, params, config)

Send a test phone notification for the configured template

update(params, config)

Update branding settings.

update_phone_provider(id, params, config)

Update an phone provider.

update_phone_template(id, params, config)

Update a phone notification template

update_theme(theme_id, params, config)

Update branding theme.

Types

config()

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

error()

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

id()

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

theme_id()

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

Functions

configure_phone_provider(params, config)

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

Create an phone provider.

see

https://auth0.com/docs/api/management/v2/branding/create-phone-provider

create_phone_template(params, config)

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

Create a phone notification template

see

https://auth0.com/docs/api/management/v2/branding/create-phone-template

create_theme(params, config)

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

Create branding theme.

see

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

delete_phone_provider(id, config)

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

Delete the configured phone provider.

see

https://auth0.com/docs/api/management/v2/branding/delete-phone-provider

delete_phone_template(id, config)

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

Delete a phone notification template

see

https://auth0.com/docs/api/management/v2/branding/delete-phone-template

delete_theme(theme_id, config)

@spec delete_theme(theme_id(), config()) :: {:ok, String.t()} | error()

Delete branding theme.

see

https://auth0.com/docs/api/management/v2/branding/delete-branding-theme

delete_universal_login(config)

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

Delete template for New Universal Login Experience

see

https://auth0.com/docs/api/management/v2/branding/delete-universal-login

get(config)

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

Retrieve branding settings.

see

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

get_default_theme(config)

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

Retrieve default branding theme.

see

https://auth0.com/docs/api/management/v2/branding/get-default-branding-theme

get_phone_provider(id, config)

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

Retrieve phone provider details. A list of fields to include or exclude may also be specified.

see

https://auth0.com/docs/api/management/v2/branding/get-phone-provider

get_phone_template(id, config)

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

Get a phone notification template

see

https://auth0.com/docs/api/management/v2/branding/get-phone-template

get_theme(theme_id, config)

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

Retrieve branding theme.

see

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

get_universal_login(config)

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

Get template for New Universal Login Experience

see

https://auth0.com/docs/api/management/v2/branding/get-universal-login

list_phone_providers(params, config)

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

Retrieve a list ofphone providers details set for a Tenant. A list of fields to include or exclude may also be specified.

see

https://auth0.com/docs/api/management/v2/branding/get-branding-phone-providers

list_phone_templates(params, config)

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

Get a list of phone notification templates

see

https://auth0.com/docs/api/management/v2/branding/get-phone-templates

reset_phone_template(id, params, config)

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

Resets a phone notification template values

see

https://auth0.com/docs/api/management/v2/branding/reset-phone-template

set_universal_login(params, config)

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

Update the Universal Login branding template.

see

https://auth0.com/docs/api/management/v2/branding/put-universal-login

test_phone_provider(id, params, config)

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

Send a test phone notification for the configured provider

see

https://auth0.com/docs/api/management/v2/branding/try-phone-provider

test_phone_template(id, params, config)

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

Send a test phone notification for the configured template

see

https://auth0.com/docs/api/management/v2/branding/try-phone-template

update(params, config)

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

Update branding settings.

see

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

update_phone_provider(id, params, config)

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

Update an phone provider.

see

https://auth0.com/docs/api/management/v2/branding/update-phone-provider

update_phone_template(id, params, config)

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

Update a phone notification template

see

https://auth0.com/docs/api/management/v2/branding/update-phone-template

update_theme(theme_id, params, config)

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

Update branding theme.

see

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