CustomDomainsManager

management. CustomDomainsManager

CustomDomainsManager Auth0 Custom Domains Manager.

CustomDomains represent custom domain names. You can learn more about this in the CustomDomains section of the documentation.

Constructor

new CustomDomainsManager(options)

Source:
Parameters:
Name Type Description
options Object

The client options.

Name Type Attributes Description
baseUrl String

The URL of the API.

headers Object <optional>

Headers to be included in all requests.

retry Object <optional>

Retry Policy Config

Members

(inner) auth0CustomDomainsRestClient :external:RestClient

Provides an abstraction layer for consuming the Auth0 Custom Domains endpoint.

Source:
Type:

(inner) auth0VerifyRestClient :external:RestClient

Provides an abstraction layer for consuming the Auth0 Custom Domains Verify endpoint.

Source:
Type:

(inner) clientOptions :Object

Options object for the Rest Client instance.

Source:
Type:
  • Object

Methods

create(data, cbopt) → {Promise|undefined}

Create an Auth0 Custom Domain.

Source:
Parameters:
Name Type Attributes Description
data Object

The custom domain data object.

cb function <optional>

Callback function.

Returns:
Type:
Promise | undefined
Example
management.customDomains.create(data, function (err) {
  if (err) {
    // Handle error.
  }

  // CustomDomain created.
});

delete(params, cbopt) → {Promise|undefined}

Delete a Custom Domain.

Source:
Parameters:
Name Type Attributes Description
params Object

Custom Domain parameters.

Name Type Description
id String

Custom Domain ID.

cb function <optional>

Callback function.

Returns:
Type:
Promise | undefined
Example
management.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
  if (err) {
    // Handle error.
  }

  // CustomDomain deleted.
});

get(params, cbopt) → {Promise|undefined}

Get a Custom Domain.

Source:
Parameters:
Name Type Attributes Description
params Object

Custom Domain parameters.

Name Type Description
id String

Custom Domain ID.

cb function <optional>

Callback function.

Returns:
Type:
Promise | undefined
Example
management.customDomains.get({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
  if (err) {
    // Handle error.
  }

  console.log(customDomain);
});

getAll() → {Promise|undefined}

Get all Auth0 CustomDomains.

Source:
Returns:
Type:
Promise | undefined
Example
management.customDomains.getAll(function (err, customDomains) {
  console.log(customDomains.length);
});

verify(params, cbopt) → {Promise|undefined}

Verify a Custom Domain.

Source:
Parameters:
Name Type Attributes Description
params Object

Custom Domain parameters.

Name Type Description
id String

Custom Domain ID.

cb function <optional>

Callback function.

Returns:
Type:
Promise | undefined
Example
management.customDomains.verify({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
  if (err) {
    // Handle error.
  }

  console.log(customDomain);
});