TenantManager

management. TenantManager

Abstracts interaction with the tenant endpoint.

Constructor

new TenantManager(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) auth0RestClient :external:RestClient

Provides an abstraction layer for consuming the Stats endpoint.

Source:
Type:

Methods

getSettings(dataopt, cbopt) → {Promise|undefined}

Get the tenant settings..

Source:
Parameters:
Name Type Attributes Description
data Object <optional>

Request parameters

cb function <optional>

Callback function.

Returns:
Type:
Promise | undefined
Example
management.tenant.getSettings({ include_fields: true, fields: 'friendly_name' }, function (err, settings) {
  if (err) {
    // Handle error.
  }

  console.log(settings);
});

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

Update the tenant settings.

Source:
Parameters:
Name Type Attributes Description
data Object

The new tenant settings.

cb function <optional>

Callback function.

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