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

Documentation for Auth0 Management API of CustomDomains.

endpoint

/api/v2/custom-domains
/api/v2/custom-domains/{id}
/api/v2/custom-domains/{id}/verify

Link to this section Summary

Types

config()

error()

id()

response_body()

Functions

configure(params, config)

Configure a new custom domain.

delete(id, config)

Delete custom domain configuration.

get(id, config)

Get custom domain configuration.

list(config)

Get custom domains configurations.

update(id, params, config)

Update custom domain configuration.

verify(id, config)

Verify a custom domain.

Link to this section Types

config()

Specs

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

error()

Specs

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

id()

Specs

id() :: String.t()

response_body()

Specs

response_body() :: String.t()

Link to this section Functions

configure(params, config)

Specs

configure(Auth0.Management.CustomDomains.Configure.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.CustomDomain.t(), response_body()} | error()

Configure a new custom domain.

see

https://auth0.com/docs/api/management/v2/#!/Custom_Domains/post_custom_domains

delete(id, config)

Specs

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

Delete custom domain configuration.

see

https://auth0.com/docs/api/management/v2/#!/Custom_Domains/delete_custom_domains_by_id

get(id, config)

Specs

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

Get custom domain configuration.

see

https://auth0.com/docs/api/management/v2/#!/Custom_Domains/get_custom_domains_by_id

list(config)

Specs

list(config()) ::
  {:ok, Auth0.Entity.CustomDomains.t(), response_body()} | error()

Get custom domains configurations.

see

https://auth0.com/docs/api/management/v2/#!/Custom_Domains/get_custom_domains

update(id, params, config)

Specs

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

Update custom domain configuration.

see

https://auth0.com/docs/api/management/v2/#!/Custom_Domains/patch_custom_domains_by_id

verify(id, config)

Specs

verify(id(), config()) ::
  {:ok, Auth0.Entity.CustomDomain.t(), response_body()} | error()

Verify a custom domain.

see

https://auth0.com/docs/api/management/v2/#!/Custom_Domains/post_verify