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

Summary

Types

config()

error()

id()

Functions

configure(params, config)

Create a new custom domain.

delete(id, config)

Delete a custom domain and stop serving requests for it.

get(id, config)

Get custom domain configuration.

list(config)

Retrieve details on custom domains.

update(id, params, config)

Update a custom domain.

verify(id, config)

Run the verification process on a custom domain.

Types

config()

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

error()

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

id()

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

Functions

configure(params, config)

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

Create a new custom domain.

see

https://auth0.com/docs/api/management/v2/custom-domains/post-custom-domains

delete(id, config)

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

Delete a custom domain and stop serving requests for it.

see

https://auth0.com/docs/api/management/v2/custom-domains/delete-custom-domains-by-id

get(id, config)

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

Get custom domain configuration.

see

https://auth0.com/docs/api/management/v2/custom-domains/get-custom-domains-by-id

list(config)

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

Retrieve details on custom domains.

see

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

update(id, params, config)

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

Update a custom domain.

see

https://auth0.com/docs/api/management/v2/custom-domains/patch-custom-domains-by-id

verify(id, config)

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

Run the verification process on a custom domain.

see

https://auth0.com/docs/api/management/v2/custom-domains/post-verify