Auth0Api v1.4.0

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

Documentation for Auth0 Management API of Branding.

endpoint

  • /api/v2/branding
  • /api/v2/branding/templates/universal-login
  • /api/v2/branding/themes
  • /api/v2/branding/themes/default
  • /api/v2/branding/themes/{id}

Link to this section Summary

Types

config()
error()
response_body()
theme_id()

Functions

create_theme(params, config)

Create branding theme.

delete_theme(theme_id, config)

Delete branding theme.

delete_universal_login(config)

Delete template for New Universal Login Experience.

get(config)

Get branding settings.

get_default_theme(config)

Retrieve default branding theme.

get_theme(theme_id, config)

Get branding theme.

get_universal_login(config)

Get template for New Universal Login Experience.

set_universal_login(params, config)

Set template for New Universal Login Experience.

update(params, config)

Update branding settings.

update_theme(theme_id, params, config)

Update branding theme.

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

response_body()

View Source

Specs

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

theme_id()

View Source

Specs

theme_id() :: String.t()

Link to this section Functions

Link to this function

create_theme(params, config)

View Source

Specs

create_theme(
  Auth0.Management.Branding.Themes.Create.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.Theme.t(), response_body()} | error()

Create branding theme.

see

https://auth0.com/docs/api/management/v2#!/Branding/post_branding_theme

Link to this function

delete_theme(theme_id, config)

View Source

Specs

delete_theme(theme_id(), config()) ::
  {:ok, Auth0.Entity.Theme.t(), response_body()} | error()

Delete branding theme.

see

https://auth0.com/docs/api/management/v2#!/Branding/delete_branding_theme

Link to this function

delete_universal_login(config)

View Source

Specs

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

Delete template for New Universal Login Experience.

see

https://auth0.com/docs/api/management/v2/#!/Branding/delete_universal_login

Link to this function

get(config)

View Source

Specs

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

Get branding settings.

see

https://auth0.com/docs/api/management/v2/#!/Branding/get_branding

Link to this function

get_default_theme(config)

View Source

Specs

get_default_theme(config()) ::
  {:ok, Auth0.Entity.Theme.t(), response_body()} | error()

Retrieve default branding theme.

see

https://auth0.com/docs/api/management/v2#!/Branding/get_default_branding_theme

Link to this function

get_theme(theme_id, config)

View Source

Specs

get_theme(theme_id(), config()) ::
  {:ok, Auth0.Entity.Theme.t(), response_body()} | error()

Get branding theme.

see

https://auth0.com/docs/api/management/v2#!/Branding/get_branding_theme

Link to this function

get_universal_login(config)

View Source

Specs

get_universal_login(config()) ::
  {:ok, Auth0.Entity.UniversalLogin.t(), response_body()} | error()

Get template for New Universal Login Experience.

see

https://auth0.com/docs/api/management/v2/#!/Branding/get_universal_login

Link to this function

set_universal_login(params, config)

View Source

Specs

set_universal_login(
  Auth0.Management.Branding.Templates.UniversalLogin.Put.Params.t() | map(),
  config()
) :: {:ok, String.t(), response_body()} | error()

Set template for New Universal Login Experience.

see

https://auth0.com/docs/api/management/v2/#!/Branding/put_universal_login

Link to this function

update(params, config)

View Source

Specs

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

Update branding settings.

see

https://auth0.com/docs/api/management/v2/#!/Branding/patch_branding

Link to this function

update_theme(theme_id, params, config)

View Source

Specs

update_theme(
  theme_id(),
  Auth0.Management.Branding.Themes.Patch.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.Theme.t(), response_body()} | error()

Update branding theme.

see

https://auth0.com/docs/api/management/v2#!/Branding/patch_branding_theme