RulesManager

management. RulesManager

RulesManager The rule class provides a simple abstraction for performing CRUD operations on Auth0 RulesManagers.

Constructor

new RulesManager(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 performing CRUD operations on Auth0 RulesManagers.

Source:
Type:

(inner) clientOptions :Object

Options object for the Rest Client instance.

Source:
Type:
  • Object

Methods

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

Create a new rule.

Source:
Parameters:
Name Type Attributes Description
data Object

Rule data object.

cb function <optional>

Callback function.

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

  // Rule created.
});

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

Delete an existing rule.

Source:
Parameters:
Name Type Attributes Description
params Object

Rule parameters.

Name Type Description
id String

Rule ID.

cb function <optional>

Callback function.

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

  // Rule deleted.
});

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

Get an Auth0 rule.

Source:
Parameters:
Name Type Attributes Description
params Object

Rule parameters.

Name Type Description
id String

Rule ID.

cb function <optional>

Callback function.

Returns:
Type:
Promise | undefined
Example
management.rules.get({ id: RULE_ID }, function (err, rule) {
  if (err) {
    // Handle error.
  }

  console.log(rule);
});

getAll(paramsopt, cbopt) → {Promise|undefined}

Get all rules.

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

Rules parameters.

Name Type Attributes Description
per_page Number <optional>

Number of results per page.

page Number <optional>

Page number, zero indexed.

cb function <optional>

Callback function.

Returns:
Type:
Promise | undefined
Example

This method takes an optional object as first argument that may be used to specify pagination settings. If pagination options are not present, the first page of a limited number of results will be returned.

// Pagination settings.
var params = {
  per_page: 10,
  page: 0
};

management.rules.getAll(params, function (err, rules) {
  console.log(rules.length);
});

update(params, data, cbopt) → {Promise|undefined}

Update an existing rule.

Source:
Parameters:
Name Type Attributes Description
params Object

Rule parameters.

Name Type Description
id String

Rule ID.

data Object

Updated rule data.

cb function <optional>

Callback function.

Returns:
Type:
Promise | undefined
Example
var data = { name: 'New name' };
var params = { id: RULE_ID };

// Using auth0 instance.
management.updateRule(params, data, function (err, rule) {
  if (err) {
    // Handle error.
  }

  console.log(rule.name);  // 'New name'
});

// Using the rules manager directly.
management.rules.update(params, data, function (err, rule) {
  if (err) {
    // Handle error.
  }

  console.log(rule.name);  // 'New name'
});