Simple facade for consuming a REST API endpoint.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -787,7 +887,7 @@
- Source:
- @@ -939,7 +1039,7 @@
- @@ -978,7 +978,7 @@
- @@ -1247,7 +1247,7 @@
- @@ -1473,7 +1473,7 @@
- @@ -1560,6 +1560,141 @@
- @@ -2186,7 +2481,7 @@
- @@ -2465,7 +2760,7 @@
- Source:
- @@ -1306,7 +1306,7 @@
- @@ -767,7 +767,7 @@
- Source:
- @@ -723,7 +723,7 @@
- Source:
- @@ -798,7 +798,7 @@
- Source:
- @@ -873,7 +873,7 @@
- @@ -948,7 +948,7 @@
- Source:
- @@ -1023,7 +1023,7 @@
- Source:
- @@ -1098,7 +1098,7 @@
- Source:
- @@ -1173,7 +1173,7 @@
- Source:
- @@ -1247,7 +1247,7 @@
- @@ -1321,7 +1321,7 @@
- @@ -1396,7 +1396,7 @@
- Source:
- @@ -1471,7 +1471,7 @@
- @@ -1498,6 +1498,80 @@
- Source: +
- + + + + + + + +
-
+
+
RulesConfigsManager+ + +
+ - @@ -1619,7 +1693,7 @@
- @@ -1693,7 +1767,7 @@
- @@ -1768,7 +1842,7 @@
- @@ -1852,7 +1926,7 @@
- Source:
- @@ -2152,7 +2226,7 @@
- @@ -2370,7 +2444,7 @@
- Source:
- @@ -2588,7 +2662,7 @@
- Source:
- @@ -2806,7 +2880,7 @@
- Source:
- @@ -3024,7 +3098,7 @@
- @@ -3208,7 +3282,7 @@
- @@ -3394,7 +3468,7 @@
- Source:
- @@ -3612,7 +3686,7 @@
- Source:
- @@ -3830,7 +3904,7 @@
- Source:
- @@ -4048,7 +4122,7 @@
- Source:
- @@ -4232,7 +4306,7 @@
- Source:
- @@ -4501,7 +4575,7 @@
- Source:
- @@ -4770,7 +4844,7 @@
- @@ -5041,7 +5115,7 @@
- Source:
- @@ -5225,7 +5299,7 @@
- Source:
- @@ -5494,7 +5568,7 @@
- Source:
- @@ -5720,14 +5794,14 @@
- Source:
- @@ -5834,7 +5908,7 @@
- Source:
- @@ -6103,7 +6177,7 @@
- Deprecated:
- The function name has a typo.
-We're shipping this so it doesn't break compatibility.
-Use
deleteUserMultifactorinstead.
-
@@ -6333,7 +6375,7 @@ - The function name has a typo.
-We're shipping this so it doesn't break compatibility.
-Use
- Source:
- @@ -6570,7 +6612,7 @@
- Deprecated:
- The function name has a typo.
+We're shipping this so it doesn't break compatibility.
+Use
deleteUserMultifactorinstead.
+
@@ -6630,7 +6676,7 @@ - The function name has a typo.
+We're shipping this so it doesn't break compatibility.
+Use
- Source:
- @@ -6674,6 +6720,117 @@
- Source: +
- + + + + + + + +
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+ - Source:
- @@ -6994,7 +7337,7 @@
- @@ -7263,7 +7606,7 @@
- Source:
- @@ -7328,7 +7671,7 @@
- Source:
- @@ -7417,13 +7760,13 @@
- - Type: - -
-
-
-
Promise-| ++ + + + +pageundefined++ + + + + +Number+ + + ++ + <optional> + + + + +
+ + + + + ++ +Page number, zero indexed.
+ + - + Type: + +
-
+
+
Promise+| + +undefined
@@ -7495,7 +7973,19 @@ - Source:
- @@ -7777,7 +8267,7 @@
- Source:
- @@ -7866,7 +8356,7 @@
- Source:
- @@ -8334,7 +8937,7 @@
- Source:
- @@ -8514,7 +9117,7 @@
- Source:
- @@ -8694,7 +9297,7 @@
- @@ -8959,7 +9562,7 @@
- @@ -9233,7 +9836,7 @@
- @@ -9459,7 +10062,7 @@
- @@ -9548,7 +10151,7 @@
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+ - Source: +
- + + + + + + + +
- Source:
- @@ -9777,6 +10942,8 @@
- Source:
- @@ -10031,7 +11254,7 @@
- @@ -10260,6 +11538,8 @@
- Source: +
- + + + + + + + +
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+ - @@ -10592,8 +12048,12 @@
- Source:
- @@ -10680,8 +12140,59 @@
- @@ -10878,7 +12419,7 @@
- Source:
- @@ -11158,6 +12809,8 @@
- @@ -11518,104 +13121,13 @@
- Source:
- @@ -11844,13 +13343,13 @@
- Source:
- @@ -12066,7 +13641,41 @@
- @@ -12364,41 +13976,7 @@
- Source:
- @@ -12697,6 +14245,91 @@
- Source:
- @@ -13247,7 +14881,7 @@
- Source:
- @@ -13556,7 +15190,7 @@
- Source:
- @@ -13862,7 +15496,7 @@
- Source:
- @@ -13933,7 +15567,7 @@
- Source:
- @@ -14421,7 +16055,7 @@
- Source:
- @@ -14727,7 +16361,7 @@
- Source:
- @@ -15032,7 +16666,7 @@
- Source:
- @@ -15248,7 +16882,7 @@
- Source:
- @@ -15554,7 +17188,7 @@
- Source:
- @@ -15832,7 +17466,7 @@
- @@ -1033,7 +1033,7 @@
- @@ -1259,7 +1259,7 @@
- @@ -1757,7 +1904,7 @@
- Source: +
- + + + + + + + +
- Source: +
- + + + + + + + +
-
+
+
external:RestClient+ + +
+ - Source: +
- + + + + + + + +
-
+
+
Object+ + +
+ - Source: +
- + + + + + + + +
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+ - Source: +
- + + + + + + + +
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+ - Source: +
- + + + + + + + +
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+ - @@ -1029,7 +1029,7 @@
- @@ -1255,7 +1255,7 @@
- @@ -1763,7 +1910,7 @@
- RetryRestClient +
- RulesConfigsManager + +
- RulesManager @@ -141,7 +144,7 @@
diff --git a/docs/index.html b/docs/index.html
index 88c45eb35..cc157863c 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -151,7 +151,7 @@ License
This project is licensed under the MIT license. See the
diff --git a/docs/index.js.html b/docs/index.js.html
index 2ac25d998..731420497 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -24,7 +24,7 @@
@@ -61,7 +61,7 @@ index.js
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html
index 570adf92e..5a90b95e8 100644
--- a/docs/management_BlacklistedTokensManager.js.html
+++ b/docs/management_BlacklistedTokensManager.js.html
@@ -24,7 +24,7 @@
@@ -153,7 +153,7 @@ management/BlacklistedTokensManager.js
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index cad917818..83db47ad5 100644
--- a/docs/management_ClientGrantsManager.js.html
+++ b/docs/management_ClientGrantsManager.js.html
@@ -24,7 +24,7 @@
@@ -123,12 +123,27 @@ management/ClientGrantsManager.js
* @method getAll
* @memberOf module:management.ClientGrantsManager.prototype
*
- * @example
- * management.clientGrants.getAll(function (err, grants) {
+ * @example <caption>
+ * 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.
+ * </caption>
+ *
+ * // Pagination settings.
+ * var params = {
+ * per_page: 10,
+ * page: 0
+ * };
+ *
+ *
+ * management.clientGrants.getAll(params, function (err, grants) {
* console.log(grants.length);
* });
*
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Client Grants parameters.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -201,7 +216,7 @@ management/ClientGrantsManager.js
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html
index 816ff5512..74727a0ca 100644
--- a/docs/management_ClientsManager.js.html
+++ b/docs/management_ClientsManager.js.html
@@ -24,7 +24,7 @@
@@ -136,16 +136,16 @@ management/ClientsManager.js
* // Pagination settings.
* var params = {
* per_page: 10,
- * page: 2
+ * page: 0
* };
*
- * management.clients.getAll(function (err, clients) {
+ * management.clients.getAll(params, function (err, clients) {
* console.log(clients.length);
* });
*
- * @param {Object} [params] Clients params.
- * @param {Number} [params.per_page] Number of clients per page.
- * @param {Number} [params.page] Page number.
+ * @param {Object} [params] Clients parameters.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
@@ -238,7 +238,7 @@ management/ClientsManager.js
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html
index 21e404918..7060b64c5 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -130,16 +130,16 @@ management/ConnectionsManager.js
* // Pagination settings.
* var params = {
* per_page: 10,
- * page: 2
+ * page: 0
* };
*
- * management.connections.getAll(function (err, connections) {
+ * management.connections.getAll(params, function (err, connections) {
* console.log(connections.length);
* });
*
* @param {Object} [params] Connections params.
- * @param {Number} [params.per_page] Number of connections per page.
- * @param {Number} [params.page] Page number.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
index bbbf31976..212f98329 100644
--- a/docs/management_DeviceCredentialsManager.js.html
+++ b/docs/management_DeviceCredentialsManager.js.html
@@ -24,7 +24,7 @@
@@ -177,7 +177,7 @@ management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
index b4f652ff7..ea866799e 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -195,7 +195,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index 4342b905f..1a5e04e97 100644
--- a/docs/management_EmailTemplatesManager.js.html
+++ b/docs/management_EmailTemplatesManager.js.html
@@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@ management/EmailTemplatesManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 5f08c8e7c..c8ff2eeb7 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -141,7 +141,7 @@ management/JobsManager.js
/**
* Given a path to a file and a connection id, create a new job that imports the
- * users contained in the file or JSON string and associate them with the given
+ * users contained in the file or JSON string and associate them with the given
* connection.
*
* @method importUsers
@@ -176,42 +176,45 @@ management/JobsManager.js
var url = options.baseUrl + '/jobs/users-imports';
var method = 'POST';
- var promise = new Promise(function(resolve, reject) {
- request(
- {
- url: url,
- method: method,
- headers: headers,
- formData: {
- users: {
- value: data.users_json ? Buffer.from(data.users_json) : fs.createReadStream(data.users),
- options: {
- filename: data.users_json ? 'users.json' : data.users,
- }
- },
- connection_id: data.connection_id
+ var promise = options.tokenProvider.getAccessToken().then(function(access_token) {
+ return new Promise(function(resolve, reject) {
+ request(
+ {
+ url: url,
+ method: method,
+ headers: extend({ Authorization: `Bearer ${access_token}` }, headers),
+ formData: {
+ users: {
+ value: data.users_json
+ ? Buffer.from(data.users_json)
+ : fs.createReadStream(data.users),
+ options: {
+ filename: data.users_json ? 'users.json' : data.users
+ }
+ },
+ connection_id: data.connection_id
+ }
+ },
+ function(err, res) {
+ if (err) {
+ reject(err);
+ return;
+ }
+ // `superagent` uses the error parameter in callback on http errors.
+ // the following code is intended to keep that behaviour (https://github.com/visionmedia/superagent/blob/master/lib/node/response.js#L170)
+ var type = (res.statusCode / 100) | 0;
+ var isErrorResponse = 4 === type || 5 === type;
+ if (isErrorResponse) {
+ var error = new Error('cannot ' + method + ' ' + url + ' (' + res.statusCode + ')');
+ error.status = res.statusCode;
+ error.method = method;
+ error.text = res.text;
+ reject(error);
+ }
+ resolve(res);
}
- },
- function(err, res) {
- // `superagent` uses the error parameter in callback on http errors.
- // the following code is intended to keep that behaviour (https://github.com/visionmedia/superagent/blob/master/lib/node/response.js#L170)
- var type = (res.statusCode / 100) | 0;
- var isErrorResponse = 4 === type || 5 === type;
- if (isErrorResponse) {
- var error = new Error('cannot ' + method + url + ' (' + res.statusCode + ')');
- error.status = res.statusCode;
- error.method = method;
- error.text = res.text;
- reject(error);
- }
-
- if (err) {
- reject(err);
- }
-
- resolve(res);
- }
- );
+ );
+ });
});
// Don't return a promise if a callback was given.
@@ -273,7 +276,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index d9283a774..8234b55fe 100644
--- a/docs/management_LogsManager.js.html
+++ b/docs/management_LogsManager.js.html
@@ -24,7 +24,7 @@
@@ -99,12 +99,31 @@ management/LogsManager.js
* @method getAll
* @memberOf module:management.LogsManager.prototype
*
- * @example
- * management.logs.getAll(function (err, logs) {
+ * @example <caption>
+ * This method takes an optional object as first argument that may be used to
+ * specify pagination settings and the search query. If pagination options are
+ * not present, the first page of a limited number of results will be returned.
+ * </caption>
+ *
+ * // Pagination settings.
+ * var params = {
+ * per_page: 10,
+ * page: 2
+ * };
+ *
+ * management.logs.getAll(params, function (err, logs) {
* console.log(logs.length);
* });
*
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Logs params.
+ * @param {String} [params.q] Search Criteria using Query String Syntax
+ * @param {Number} [params.page] Page number. Zero based
+ * @param {Number} [params.per_page] The amount of entries per page
+ * @param {String} [params.sort] The field to use for sorting.
+ * @param {String} [params.fields] A comma separated list of fields to include or exclude
+ * @param {Boolean} [params.include_fields] true if the fields specified are to be included in the result, false otherwise.
+ * @param {Boolean} [params.include_totals] true if a query summary must be included in the result, false otherwise. Default false
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -146,7 +165,7 @@ management/LogsManager.js
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html
index eeee64cd5..3f4b6b57b 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -189,7 +189,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index f9307a8e8..a87f20eb8 100644
--- a/docs/management_ResourceServersManager.js.html
+++ b/docs/management_ResourceServersManager.js.html
@@ -24,7 +24,7 @@
@@ -127,12 +127,26 @@ management/ResourceServersManager.js
* @method getAll
* @memberOf module:management.ResourceServersManager.prototype
*
- * @example
- * management.resourceServers.getAll(function (err, resourceServers) {
+ * @example <caption>
+ * 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.
+ * </caption>
+ *
+ * // Pagination settings.
+ * var params = {
+ * per_page: 10,
+ * page: 0
+ * };
+ *
+ * management.resourceServers.getAll(params, function (err, resourceServers) {
* console.log(resourceServers.length);
* });
*
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Resource Servers parameters.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -224,7 +238,7 @@ management/ResourceServersManager.js
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
new file mode 100644
index 000000000..e92906ae3
--- /dev/null
+++ b/docs/management_RulesConfigsManager.js.html
@@ -0,0 +1,188 @@
+
+
+
+
+
+ management/RulesConfigsManager.js - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ management/RulesConfigsManager.js
+
+
+
+
+
+
+
+
+
+ var ArgumentError = require('rest-facade').ArgumentError;
+var utils = require('../utils');
+var Auth0RestClient = require('../Auth0RestClient');
+var RetryRestClient = require('../RetryRestClient');
+
+/**
+ * Simple facade for consuming a REST API endpoint.
+ * @external RestClient
+ * @see https://github.com/ngonzalvez/rest-facade
+ */
+
+
+/**
+ * @class RulesConfigsManager
+ * The rules configs manager class provides a simple abstraction for performing CRUD operations
+ * on Auth0 RulesConfigsManager.
+ * @constructor
+ * @memberOf module:management
+ *
+ * @param {Object} options The client options.
+ * @param {String} options.baseUrl The URL of the API.
+ * @param {Object} [options.headers] Headers to be included in all requests.
+ * @param {Object} [options.retry] Retry Policy Config
+ */
+var RulesConfigsManager = function (options) {
+ if (options === null || typeof options !== 'object') {
+ throw new ArgumentError('Must provide manager options');
+ }
+
+ if (options.baseUrl === null || options.baseUrl === undefined) {
+ throw new ArgumentError('Must provide a base URL for the API');
+ }
+
+ if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
+ throw new ArgumentError('The provided base URL is invalid');
+ }
+
+ /**
+ * Options object for the Rest Client instance.
+ *
+ * @type {Object}
+ */
+ var clientOptions = {
+ headers: options.headers,
+ query: { repeatParams: false }
+ };
+
+ /**
+ * Provides an abstraction layer for performing CRUD operations on
+ * {@link https://auth0.com/docs/api/v2#!/RulesConfigsManager Auth0 RulesConfigsManager}.
+ *
+ * @type {external:RestClient}
+ */
+ var auth0RestClient = new Auth0RestClient(options.baseUrl + '/rules-configs/:key', clientOptions, options.tokenProvider);
+ this.resource = new RetryRestClient(auth0RestClient, options.retry);
+};
+
+
+/**
+ * Set a new rules config.
+ *
+ * @method set
+ * @memberOf module:management.RulesConfigsManager.prototype
+ *
+ * @example
+ * var params = { key: RULE_CONFIG_KEY };
+ * var data = { value: RULES_CONFIG_VALUE };
+ *
+ * management.rulesConfigs.set(params, data, function (err, rulesConfig) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Rules Config set.
+ * });
+ *
+ * @param {Object} params Rule Config parameters.
+ * @param {String} params.key Rule Config key.
+ * @param {Object} data Rule Config Data parameters.
+ * @param {String} data.value Rule Config Data value.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(RulesConfigsManager, 'set', 'resource.update');
+
+
+/**
+ * Get all rules configs.
+ *
+ * @method getAll
+ * @memberOf module:management.RulesConfigsManager.prototype
+ *
+ * @example
+ * management.rulesConfigs.getAll(function (err, rulesConfig) {
+ * console.log(rulesConfig.length);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(RulesConfigsManager, 'getAll', 'resource.getAll');
+
+
+/**
+ * Delete an existing rules config.
+ *
+ * @method delete
+ * @memberOf module:management.RulesConfigsManager.prototype
+ *
+ * @example
+ * management.rulesConfigs.delete({ key: RULE_CONFIG_KEY }, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Rules Config deleted.
+ * });
+ *
+ * @param {Object} params Rule Configs parameters.
+ * @param {String} params.key Rule Configs key.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(RulesConfigsManager, 'delete', 'resource.delete');
+
+module.exports = RulesConfigsManager;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 660dc2cb8..4609238a5 100644
--- a/docs/management_RulesManager.js.html
+++ b/docs/management_RulesManager.js.html
@@ -24,7 +24,7 @@
@@ -127,12 +127,26 @@ management/RulesManager.js
* @method getAll
* @memberOf module:management.RulesManager.prototype
*
- * @example
- * management.rules.getAll(function (err, rules) {
+ * @example <caption>
+ * 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.
+ * </caption>
+ *
+ * // Pagination settings.
+ * var params = {
+ * per_page: 10,
+ * page: 0
+ * };
+ *
+ * management.rules.getAll(params, function (err, rules) {
* console.log(rules.length);
* });
*
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Rules parameters.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -234,7 +248,7 @@ management/RulesManager.js
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html
index f9e9f55d2..ae40ac457 100644
--- a/docs/management_StatsManager.js.html
+++ b/docs/management_StatsManager.js.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ management/StatsManager.js
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html
index 654809e72..a04bc4efe 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -161,7 +161,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index aa6977e20..08b49f382 100644
--- a/docs/management_TicketsManager.js.html
+++ b/docs/management_TicketsManager.js.html
@@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@ management/TicketsManager.js
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html
index 10dfd95bb..055304cbf 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -192,16 +192,16 @@ management/UsersManager.js
* // Pagination settings.
* var params = {
* per_page: 10,
- * page: 2
+ * page: 0
* };
*
- * management.users.getAll(function (err, users) {
+ * management.users.getAll(params, function (err, users) {
* console.log(users.length);
* });
*
* @param {Object} [params] Users params.
- * @param {Number} [params.per_page] Number of users per page.
- * @param {Number} [params.page] Page number.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
@@ -579,8 +579,8 @@ management/UsersManager.js
*
* @param {Object} params Get logs data.
* @param {String} params.id User id.
- * @param {Number} params.per_page Number of logs per page.
- * @param {Number} params.page Page number.
+ * @param {Number} params.per_page Number of results per page.
+ * @param {Number} params.page Page number, zero indexed.
* @param {String} params.sort The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
* @param {Boolean} params.include_totals true if a query summary must be included in the result, false otherwise. Default false;
* @param {Function} [cb] Callback function.
@@ -631,7 +631,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index a798d2a61..95a6cc229 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -65,6 +65,7 @@ management/index.js
var LogsManager = require('./LogsManager');
var ResourceServersManager = require('./ResourceServersManager');
var ManagementTokenProvider = require('./ManagementTokenProvider');
+var RulesConfigsManager = require('./RulesConfigsManager');
var EmailTemplatesManager = require('./EmailTemplatesManager');
var BASE_URL_FORMAT = 'https://%s/api/v2';
@@ -285,6 +286,13 @@ management/index.js
* @type {EmailTemplatesManager}
*/
this.emailTemplates = new EmailTemplatesManager(managerOptions);
+
+ /**
+ * RulesConfigs manager.
+ *
+ * @type {RulesConfigsManager}
+ */
+ this.rulesConfigs = new RulesConfigsManager(managerOptions);
};
/**
@@ -324,13 +332,26 @@ management/index.js
* @method getConnections
* @memberOf module:management.ManagementClient.prototype
*
- * @example
- * management.getConnections(function (err, connections) {
+ * @example <caption>
+ * 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.
+ * </caption>
+ *
+ * // Pagination settings.
+ * var params = {
+ * per_page: 10,
+ * page: 0
+ * };
+ *
+ * management.getConnections(params, function (err, connections) {
* console.log(connections.length);
* });
*
- * @param {Object} data Connection data object.
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Connections params.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -422,7 +443,7 @@ management/index.js
* console.log(connection.name); // 'newConnectionName'
* });
*
- * @param {Object} params Conneciton parameters.
+ * @param {Object} params Connection parameters.
* @param {String} params.id Connection ID.
* @param {Object} data Updated connection data.
* @param {Function} [cb] Callback function.
@@ -437,12 +458,26 @@ management/index.js
* @method getClients
* @memberOf module:management.ManagementClient.prototype
*
- * @example
- * management.getClients(function (err, clients) {
+ * @example <caption>
+ * 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.
+ * </caption>
+ *
+ * // Pagination settings.
+ * var params = {
+ * per_page: 10,
+ * page: 0
+ * };
+ *
+ * management.getClients(params, function (err, clients) {
* console.log(clients.length);
* });
*
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Clients parameters.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -549,12 +584,26 @@ management/index.js
* @method getAll
* @memberOf module:management.ClientGrantsManager.prototype
*
- * @example
- * management.clientGrants.getAll(function (err, grants) {
+ * @example <caption>
+ * 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.
+ * </caption>
+ *
+ * // Pagination settings.
+ * var params = {
+ * per_page: 10,
+ * page: 0
+ * };
+ *
+ * management.getClientGrants(params, function (err, grants) {
* console.log(grants.length);
* });
*
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Client Grants parameters.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -710,12 +759,26 @@ management/index.js
* @method getRules
* @memberOf module:management.ManagementClient.prototype
*
- * @example
- * management.getRules(function (err, rules) {
+ * @example <caption>
+ * 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.
+ * </caption>
+ *
+ * // Pagination settings.
+ * var params = {
+ * per_page: 10,
+ * page: 0
+ * };
+ *
+ * management.getRules(params, function (err, rules) {
* console.log(rules.length);
* });
*
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Rules parameters.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -823,13 +886,14 @@ management/index.js
*
* @example <caption>
* This method takes an optional object as first argument that may be used to
- * specify pagination settings and the search query.
+ * specify pagination settings. If pagination options are not present,
+ * the first page of a limited number of results will be returned.
* </caption>
*
* // Pagination settings.
* var params = {
* per_page: 10,
- * page: 2
+ * page: 0
* };
*
* auth0.getUsers(params, function (err, users) {
@@ -837,8 +901,8 @@ management/index.js
* });
*
* @param {Object} [params] Users params.
- * @param {Number} [params.per_page] Number of users per page.
- * @param {Number} [params.page] Page number.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
@@ -1180,8 +1244,8 @@ management/index.js
*
* @param {Object} params Get logs data.
* @param {String} params.id User id.
- * @param {Number} params.per_page Number of logs per page.
- * @param {Number} params.page Page number.
+ * @param {Number} params.per_page Number of results per page.
+ * @param {Number} params.page Page number, zero indexed.
* @param {String} params.sort The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
* @param {Boolean} params.include_totals true if a query summary must be included in the result, false otherwise. Default false;
* @param {Function} [cb] Callback function.
@@ -1592,13 +1656,31 @@ management/index.js
* @method getLogs
* @memberOf module:management.ManagementClient.prototype
*
- * @example
- * management.getLogs(function (err, logs) {
+ * @example <caption>
+ * This method takes an optional object as first argument that may be used to
+ * specify pagination settings and the search query. If pagination options are
+ * not present, the first page of a limited number of results will be returned.
+ * </caption>
+ *
+ * // Pagination settings.
+ * var params = {
+ * per_page: 10,
+ * page: 2
+ * };
+ *
+ * management.getLogs(params, function (err, logs) {
* console.log(logs.length);
* });
*
- * @param {Object} data Log data object.
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Logs params.
+ * @param {String} [params.q] Search Criteria using Query String Syntax
+ * @param {Number} [params.page] Page number. Zero based
+ * @param {Number} [params.per_page] The amount of entries per page
+ * @param {String} [params.sort] The field to use for sorting.
+ * @param {String} [params.fields] A comma separated list of fields to include or exclude
+ * @param {Boolean} [params.include_fields] true if the fields specified are to be included in the result, false otherwise.
+ * @param {Boolean} [params.include_totals] true if a query summary must be included in the result, false otherwise. Default false
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -1632,13 +1714,26 @@ management/index.js
* @method getResourceServers
* @memberOf module:management.ManagementClient.prototype
*
- * @example
- * management.getResourceServers(function (err, resourceServers) {
+ * @example <caption>
+ * 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.
+ * </caption>
+ *
+ * // Pagination settings.
+ * var params = {
+ * per_page: 10,
+ * page: 0
+ * };
+ *
+ * management.getResourceServers(params, function (err, resourceServers) {
* console.log(resourceServers.length);
* });
*
- * @param {Object} data Connection data object.
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Resource Servers parameters.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -1716,6 +1811,80 @@ management/index.js
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(ManagementClient, 'updateResourceServer', 'resourceServers.update');
+
+/**
+ * Set a new rules config.
+ *
+ * @method setRulesConfig
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var params = { key: RULE_CONFIG_KEY };
+ * var data = { value: RULES_CONFIG_VALUE };
+ *
+ * management.setRulesConfig(params, data, function (err, rulesConfig) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Rules Config set.
+ * });
+ *
+ * @param {Object} params Rule Config parameters.
+ * @param {String} params.key Rule Config key.
+ * @param {Object} data Rule Config Data parameters.
+ * @param {String} data.value Rule Config Data value.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'setRulesConfig', 'rulesConfigs.set');
+
+/**
+ * Get rules config.
+ *
+ * @method getRulesConfigs
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ *
+ * management.getRulesConfigs(function (err, rulesConfigs) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Get Rules Configs.
+ * });
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getRulesConfigs', 'rulesConfigs.getAll');
+
+/**
+ * Delete rules config.
+ *
+ * @method deleteRulesConfig
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ *
+ * management.deleteRulesConfig({ key: RULE_CONFIG_KEY }, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Rules Config deleted.
+ * });
+ *
+ * @param {Object} params Rule Configs parameters.
+ * @param {String} params.key Rule Configs key.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'deleteRulesConfig', 'rulesConfigs.delete');
+
+
module.exports = ManagementClient;
@@ -1729,7 +1898,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 78bf69bda..767a42097 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -3622,7 +3622,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index 15dc60c43..f73820dca 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 31dbb16ab..e0e65f98b 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1284,7 +1284,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index e1cd7e45b..a21bd9114 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index 96a999e72..8befa00d1 100644
--- a/docs/module-auth.TokensManager.html
+++ b/docs/module-auth.TokensManager.html
@@ -24,7 +24,7 @@
@@ -352,7 +352,7 @@ Parameters:
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html
index e320fc68e..263aa0379 100644
--- a/docs/module-auth.UsersManager.html
+++ b/docs/module-auth.UsersManager.html
@@ -24,7 +24,7 @@
@@ -1009,7 +1009,7 @@ Example
diff --git a/docs/module-auth.html b/docs/module-auth.html
index 1885e3cba..5c148a786 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -105,7 +105,7 @@ Classes
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 5b67cdd19..b8eadce77 100644
--- a/docs/module-management.BlacklistedTokensManager.html
+++ b/docs/module-management.BlacklistedTokensManager.html
@@ -24,7 +24,7 @@
@@ -991,7 +991,7 @@ Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index fb05d1429..2c1b70877 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -542,7 +542,7 @@ createSource:
deleteSource:
deleteSource:
Example
- getAll(cbopt) → {Promise|undefined}
+ getAll(paramsopt, cbopt) → {Promise|undefined}
@@ -1516,7 +1516,7 @@ getAllSource:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Client Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.clientGrants.getAll(function (err, grants) {
+
+ 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.getClientGrants(params, function (err, grants) {
console.log(grants.length);
});
@@ -1653,7 +1800,7 @@ Example
- getAll(cbopt) → {Promise|undefined}
+ getAll(paramsopt, cbopt) → {Promise|undefined}
@@ -1740,6 +1887,141 @@ Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Client Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.clientGrants.getAll(function (err, grants) {
+
+ 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.clientGrants.getAll(params, function (err, grants) {
console.log(grants.length);
});
@@ -1876,7 +2171,7 @@ updateSource:
updateSource:
Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 2aeb4314c..6660e333f 100644
--- a/docs/module-management.ClientsManager.html
+++ b/docs/module-management.ClientsManager.html
@@ -24,7 +24,7 @@
@@ -1375,7 +1375,7 @@ Parameters:
- Clients params.
+ Clients parameters.
@@ -1430,7 +1430,7 @@ Parameters:
- Number of clients per page.
+ Number of results per page.
@@ -1466,7 +1466,7 @@ Parameters:
- Page number.
+ Page number, zero indexed.
@@ -1570,10 +1570,10 @@ Example
// Pagination settings.
var params = {
per_page: 10,
- page: 2
+ page: 0
};
-management.clients.getAll(function (err, clients) {
+management.clients.getAll(params, function (err, clients) {
console.log(clients.length);
});
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
index 64fba72b9..ba59d39d8 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1425,7 +1425,7 @@ Parameters:
- Number of connections per page.
+ Number of results per page.
@@ -1461,7 +1461,7 @@ Parameters:
- Page number.
+ Page number, zero indexed.
@@ -1565,10 +1565,10 @@ Example
// Pagination settings.
var params = {
per_page: 10,
- page: 2
+ page: 0
};
-management.connections.getAll(function (err, connections) {
+management.connections.getAll(params, function (err, connections) {
console.log(connections.length);
});
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index e1cbd7842..694636a5e 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index c9a00106a..ef80c4764 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1345,7 +1345,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index 39ee99e0a..b9d4bb269 100644
--- a/docs/module-management.EmailTemplatesManager.html
+++ b/docs/module-management.EmailTemplatesManager.html
@@ -24,7 +24,7 @@
@@ -1304,7 +1304,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 81278da5c..86062089a 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -705,7 +705,7 @@ importUser
Given a path to a file and a connection id, create a new job that imports the
-users contained in the file or JSON string and associate them with the given
+users contained in the file or JSON string and associate them with the given
connection.
@@ -1066,7 +1066,7 @@ verifyEmai
Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index 91506e36c..90bb3156b 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
@@ -541,7 +541,7 @@ getSource:
Example
- getAll(cbopt) → {Promise|undefined}
+ getAll(paramsopt, cbopt) → {Promise|undefined}
@@ -854,6 +854,321 @@ Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Logs params.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ q
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Search Criteria using Query String Syntax
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number. Zero based
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The amount of entries per page
+
+
+
+
+
+
+
+
+ sort
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The field to use for sorting.
+
+
+
+
+
+
+
+
+ fields
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ A comma separated list of fields to include or exclude
+
+
+
+
+
+
+
+
+ include_fields
+
+
+Boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ true if the fields specified are to be included in the result, false otherwise.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.logs.getAll(function (err, logs) {
+
+ This method takes an optional object as first argument that may be used to
+ specify pagination settings and the search query. 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: 2
+};
+
+management.logs.getAll(params, function (err, logs) {
console.log(logs.length);
});
@@ -959,7 +1286,7 @@ Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index 13d55fffb..9092609a0 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -106,7 +106,7 @@ new M
blac
clientGra
clientsSource:
connection
devi
emailPro
emailTe
jobsSource:
logsSource:
resour
rulesSource:
Type:
+
+
+
+
+
+rulesConfigs :RulesConfigsManager
+
+
+
+
+
+ RulesConfigs manager.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type:
+
+
+
+
+
+
+
@@ -1545,7 +1619,7 @@ statsSource:
tenantSource:
ticketsSource:
usersSource:
blackli
Source:
createCli
creat
Source:
Source:
c
createRule<
createUser<
deleteA
deleteCli
delet
Source:
de
d
deleteRule<
Example
- deleteUser(params, cbopt) → {Promise|undefined}
+ deleteRulesConfig(params, cbopt) → {Promise|undefined}
- Delete a user by its id.
+ Delete rules config.
@@ -5763,7 +5837,7 @@ deleteUser<
Parameters:
- The user data object..
+ Rule Configs parameters.
@@ -5860,7 +5934,7 @@ Parameters:
- idkey
@@ -5877,7 +5951,7 @@ Parameters:
- The user id.
+ Rule Configs key.
@@ -5921,7 +5995,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -5972,12 +6046,12 @@ Returns:
Example
- management.deleteUser({ id: USER_ID }, function (err) {
+ management.deleteRulesConfig({ key: RULE_CONFIG_KEY }, function (err) {
if (err) {
// Handle error.
}
- // User deleted.
+ // Rules Config deleted.
});
@@ -5989,14 +6063,14 @@ Example
- deleteUserMultifactor(params, cbopt) → {Promise|undefined}
+ deleteUser(params, cbopt) → {Promise|undefined}
- Delete a multifactor provider for a user.
+ Delete a user by its id.
@@ -6032,7 +6106,7 @@
Parameters:
- Data object.
+ The user data object..
@@ -6152,32 +6226,6 @@ Parameters:
-
-
-
- provider
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Multifactor provider.
-
-
-
-
-
@@ -6267,14 +6315,12 @@ Returns:
Example
- var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-
-management.deleteUserMultifactor(params, function (err, user) {
+ management.deleteUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // User deleted.
});
@@ -6286,7 +6332,7 @@ Example
- deleteUserMultifcator(params, cbopt) → {Promise|undefined}
+ deleteUserMultifactor(params, cbopt) → {Promise|undefined}
@@ -6317,10 +6363,6 @@
-
Example
var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-management.deleteUserMultifcator(params, function (err, user) {
+management.deleteUserMultifactor(params, function (err, user) {
if (err) {
// Handle error.
}
@@ -6587,14 +6629,14 @@ Example
- getActiveUsersCount(cbopt) → {Promise|undefined}
+ deleteUserMultifcator(params, cbopt) → {Promise|undefined}
- Get a the active users count.
+ Delete a multifactor provider for a user.
@@ -6618,6 +6660,10 @@ ge
+ ge
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data object.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Multifactor provider.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbParameters:
- Callback function.
+ Callback function
@@ -6754,12 +6911,14 @@ Returns:
Example
- management.getActiveUsersCount(function (err, usersCount) {
+ var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
+
+management.deleteUserMultifcator(params, function (err, user) {
if (err) {
// Handle error.
}
- console.log(usersCount);
+ // Users accounts unlinked.
});
@@ -6771,7 +6930,191 @@ Example
- getBlacklistedTokens(cbopt) → {Promise|undefined}
+ getActiveUsersCount(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a the active users count.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getActiveUsersCount(function (err, usersCount) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(usersCount);
+});
+
+
+
+
+
+
+
+
+
+
+ getBlacklistedTokens(cbopt) → {Promise|undefined}
@@ -6814,7 +7157,7 @@ g
getClientSource:
getClien
Returns:
- getClients(cbopt) → {Promise|undefined}
+ getClients(paramsopt, cbopt) → {Promise|undefined}
@@ -7371,7 +7714,7 @@ getClients<
Parameters:
- cbparams
-function
+Object
@@ -7444,43 +7787,178 @@ Parameters:
- Callback function.
+ Clients parameters.
-
-
+
-
-
-
+
+
+
+
+ Name
+
+ Type
+
+ Attributes
+
+
+ Description
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
-
-Returns:
+
+ Number of results per page.
+
+
+
-
+
-
-
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ Returns:
Example
- management.getClients(function (err, clients) {
+
+ 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.getClients(params, function (err, clients) {
console.log(clients.length);
});
@@ -7551,7 +8041,7 @@ getConne
Example
- getConnections(data, cbopt) → {Promise|undefined}
+ getConnections(paramsopt, cbopt) → {Promise|undefined}
@@ -7820,7 +8310,7 @@ getConn
Parameters:
- dataparams
@@ -7881,6 +8371,8 @@ Parameters:
+ <optional>
+
@@ -7891,7 +8383,106 @@ Parameters:
- Connection data object.
+ Connections params.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
@@ -7978,7 +8569,19 @@ Returns:
Example
- management.getConnections(function (err, connections) {
+
+ 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.getConnections(params, function (err, connections) {
console.log(connections.length);
});
@@ -8034,7 +8637,7 @@ getDaily
g
getEm
Source:
getJobSource:
getLogSource:
Example
- getLogs(data, cbopt) → {Promise|undefined}
+ getLogs(paramsopt, cbopt) → {Promise|undefined}
@@ -9502,7 +10105,7 @@ getLogsSource:
Parameters:
- dataparams
@@ -9563,6 +10166,8 @@ Parameters:
+ <optional>
+
@@ -9573,22 +10178,41 @@ Parameters:
- Log data object.
+ Logs params.
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Description
+
+
+
+
- cbq
-function
+String
@@ -9609,17 +10233,554 @@ Parameters:
- Callback function.
+ Search Criteria using Query String Syntax
-
-
-
-
-
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number. Zero based
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The amount of entries per page
+
+
+
+
+
+
+
+
+ sort
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The field to use for sorting.
+
+
+
+
+
+
+
+
+ fields
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ A comma separated list of fields to include or exclude
+
+
+
+
+
+
+
+
+ include_fields
+
+
+Boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ true if the fields specified are to be included in the result, false otherwise.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+
+ This method takes an optional object as first argument that may be used to
+ specify pagination settings and the search query. 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: 2
+};
+
+management.getLogs(params, function (err, logs) {
+ console.log(logs.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getResourceServer(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a Resource Server.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Resource Server parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Resource Server ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
@@ -9660,8 +10821,12 @@ Returns:
Example
- management.getLogs(function (err, logs) {
- console.log(logs.length);
+ management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(resourceServer);
});
@@ -9673,14 +10838,14 @@ Example
- getResourceServer(params, cbopt) → {Promise|undefined}
+ getResourceServers(paramsopt, cbopt) → {Promise|undefined}
- Get a Resource Server.
+ Get all resource servers.
@@ -9716,7 +10881,7 @@ getR
Parameters:
+ <optional>
+
@@ -9787,7 +10954,7 @@ Parameters:
- Resource Server parameters.
+ Resource Servers parameters.
@@ -9801,6 +10968,8 @@ Parameters:
Type
+ Attributes
+
@@ -9813,24 +10982,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- Resource Server ID.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -9925,12 +11140,20 @@ Returns:
Example
- management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
- if (err) {
- // Handle error.
- }
+
+ 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
+};
- console.log(resourceServer);
+management.getResourceServers(params, function (err, resourceServers) {
+ console.log(resourceServers.length);
});
@@ -9942,14 +11165,14 @@ Example
- getResourceServers(data, cbopt) → {Promise|undefined}
+ getRule(params, cbopt) → {Promise|undefined}
- Get all resource servers.
+ Get an Auth0 rule.
@@ -9985,7 +11208,7 @@ get
Parameters:
- dataparams
@@ -10055,8 +11278,59 @@ Parameters:
-
- Connection data object.
+
+ Rule parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule ID.
+
+
+
+
+
+
+
+
@@ -10143,8 +11417,12 @@ Returns:
Example
- management.getResourceServers(function (err, resourceServers) {
- console.log(resourceServers.length);
+ management.getRule({ id: RULE_ID }, function (err, rule) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(rule);
});
@@ -10156,14 +11434,14 @@ Example
- getRule(params, cbopt) → {Promise|undefined}
+ getRules(paramsopt, cbopt) → {Promise|undefined}
- Get an Auth0 rule.
+ Get all rules.
@@ -10199,7 +11477,7 @@ getRuleSource:
Parameters:
+ <optional>
+
@@ -10270,7 +11550,7 @@ Parameters:
- Rule parameters.
+ Rules parameters.
@@ -10284,6 +11564,8 @@ Parameters:
Type
+ Attributes
+
@@ -10296,24 +11578,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- Rule ID.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -10408,12 +11736,140 @@ Returns:
Example
- management.getRule({ id: RULE_ID }, function (err, rule) {
+
+ 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.getRules(params, function (err, rules) {
+ console.log(rules.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getRulesConfigs() → {Promise|undefined}
+
+
+
+
+
+
+ Get rules config.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getRulesConfigs(function (err, rulesConfigs) {
if (err) {
// Handle error.
}
- console.log(rule);
+ // Get Rules Configs.
});
@@ -10425,14 +11881,14 @@ Example
- getRules(cbopt) → {Promise|undefined}
+ getTenantSettings(cbopt) → {Promise|undefined}
- Get all rules.
+ Get the tenant settings..
@@ -10468,7 +11924,7 @@ getRulesSource:
Returns:
Example
- management.getRules(function (err, rules) {
- console.log(rules.length);
+ management.getSettings(function (err, settings) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(settings);
});
@@ -10605,14 +12065,14 @@ Example
- getTenantSettings(cbopt) → {Promise|undefined}
+ getUser(data, cbopt) → {Promise|undefined}
- Get the tenant settings..
+ Get a user by its id.
@@ -10648,7 +12108,7 @@ getT
Parameters:
Type
- Attributes
-
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The user data object.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
@@ -10692,6 +12203,40 @@ Parameters:
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.getSettings(function (err, settings) {
- if (err) {
- // Handle error.
- }
-
- console.log(settings);
+ management.getUser({ id: USER_ID }, function (err, user) {
+ console.log(user);
});
@@ -10789,14 +12330,14 @@ Example
- getUser(data, cbopt) → {Promise|undefined}
+ getUserLogs(params, cbopt) → {Promise|undefined}
- Get a user by its id.
+ Get user's log events.
@@ -10832,7 +12373,7 @@ getUserSource:
Parameters:
- dataparams
@@ -10903,7 +12444,7 @@ Parameters:
- The user data object.
+ Get logs data.
@@ -10946,7 +12487,111 @@ Parameters:
- The user id.
+ User id.
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ sort
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false;
@@ -11041,8 +12686,14 @@ Returns:
Example
- management.getUser({ id: USER_ID }, function (err, user) {
- console.log(user);
+ var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+
+management.getUserLogs(params, function (err, logs) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logs);
});
@@ -11054,14 +12705,14 @@ Example
- getUserLogs(params, cbopt) → {Promise|undefined}
+ getUsers(paramsopt, cbopt) → {Promise|undefined}
- Get user's log events.
+ Get all users.
@@ -11097,7 +12748,7 @@ getUserLog
Parameters:
+ <optional>
+
@@ -11168,7 +12821,7 @@ Parameters:
- Get logs data.
+ Users params.
@@ -11182,6 +12835,8 @@ Parameters:
Type
+ Attributes
+
@@ -11189,107 +12844,39 @@ Parameters:
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- User id.
-
-
-
-
-
-
-
-
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
-
-
- Number of logs per page.
-
-
-
-
-
-
-
-
- page
-
-
-Number
-
-
-
-
-
-
-
-
-
-
- Page number.
-
-
-
-
+
- sortper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+ Number of results per page.
@@ -11298,24 +12885,34 @@ Parameters:
- include_totalspage
-Boolean
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- true if a query summary must be included in the result, false otherwise. Default false;
+ Page number, zero indexed.
@@ -11410,14 +13007,20 @@ Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-
-management.getUserLogs(params, function (err, logs) {
- if (err) {
- // Handle error.
- }
+
+ 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
+};
- console.log(logs);
+auth0.getUsers(params, function (err, users) {
+ console.log(users.length);
});
@@ -11429,14 +13032,14 @@ Example
- getUsers(paramsopt, cbopt) → {Promise|undefined}
+ getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
- Get all users.
+ Get users for a given email address
@@ -11472,7 +13075,7 @@ getUsersSource:
Parameters:
- params
-
-
-Object
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Users params.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of users per page.
-
-
-
-
-
-
-
-
- pageemail
-Number
+String
@@ -11636,15 +13148,7 @@ Parameters:
- Page number.
-
-
-
-
-
-
-
-
+ Email Address of users to locate
@@ -11732,18 +13236,12 @@ Returns:
Example
- This method takes an optional object as first argument that may be used to
- specify pagination settings and the search query.
+ This method takes an email address as the first argument,
+ and returns all users with that email address
- // Pagination settings.
-var params = {
- per_page: 10,
- page: 2
-};
-
-auth0.getUsers(params, function (err, users) {
- console.log(users.length);
+ auth0.getUsersByEmail(email, function (err, users) {
+ console.log(users);
});
@@ -11755,14 +13253,15 @@ Example
- getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+ importUsers(data, cbopt) → {Promise|undefined}
- Get users for a given email address
+ Given a path to a file and a connection id, create a new job that imports the
+users contained in the file and associate them with the given connection.
@@ -11798,7 +13297,7 @@ getUse
Parameters:
- emaildata
-String
+Object
@@ -11859,8 +13358,6 @@ Parameters:
- <optional>
-
@@ -11870,8 +13367,85 @@ Parameters:
-
- Email Address of users to locate
+
+ Users import data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ connectionId
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Connection for the users insertion.
+
+
+
+
+
+
+
+
+ users
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Path to the users data file.
+
+
+
+
+
+
+
+
@@ -11958,13 +13532,15 @@ Returns:
Example
-
- This method takes an email address as the first argument,
- and returns all users with that email address
-
-
- auth0.getUsersByEmail(email, function (err, users) {
- console.log(users);
+ var params = {
+ connection_id: '{CONNECTION_ID}',
+ users: '{PATH_TO_USERS_FILE}'
+};
+
+management.get(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
});
@@ -11976,15 +13552,14 @@ Example
- importUsers(data, cbopt) → {Promise|undefined}
+ linkUsers(userId, params, cbopt) → {Promise|undefined}
- Given a path to a file and a connection id, create a new job that imports the
-users contained in the file and associate them with the given connection.
+ Link the user with another account.
@@ -12020,7 +13595,7 @@ importUser
Parameters:
- datauserId
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ID of the primary user.
+
+
+
+
+
+
+
+
+ params
@@ -12091,7 +13700,7 @@ Parameters:
- Users import data.
+ Secondary user data.
@@ -12117,7 +13726,7 @@ Parameters:
- connectionIduser_id
@@ -12134,7 +13743,7 @@ Parameters:
- Connection for the users insertion.
+ ID of the user to be linked.
@@ -12143,7 +13752,7 @@ Parameters:
- usersconnection_id
@@ -12160,7 +13769,7 @@ Parameters:
- Path to the users data file.
+ ID of the connection to be used.
@@ -12255,15 +13864,18 @@ Returns:
Example
- var params = {
- connection_id: '{CONNECTION_ID}',
- users: '{PATH_TO_USERS_FILE}'
+ var userId = 'USER_ID';
+var params = {
+ user_id: 'OTHER_USER_ID',
+ connection_id: 'CONNECTION_ID'
};
-management.get(params, function (err) {
+management.linkUsers(userId, params, function (err, user) {
if (err) {
// Handle error.
}
+
+ // Users linked.
});
@@ -12275,14 +13887,14 @@ Example
- linkUsers(userId, params, cbopt) → {Promise|undefined}
+ sendEmailVerification(data, cbopt) → {Promise|undefined}
- Link the user with another account.
+ Send a verification email to a user.
@@ -12318,7 +13930,7 @@ linkUsersSource:
Parameters:
- userId
-
-
-String
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ID of the primary user.
-
-
-
-
-
-
-
-
- paramsdata
@@ -12423,7 +14001,7 @@ Parameters:
- Secondary user data.
+ User data object.
@@ -12466,33 +14044,7 @@ Parameters:
- ID of the user to be linked.
-
-
-
-
-
-
-
-
- connection_id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- ID of the connection to be used.
+ ID of the user to be verified.
@@ -12587,18 +14139,14 @@ Returns:
Example
- var userId = 'USER_ID';
-var params = {
- user_id: 'OTHER_USER_ID',
- connection_id: 'CONNECTION_ID'
+ var params = {
+ user_id: '{USER_ID}'
};
-management.linkUsers(userId, params, function (err, user) {
+management.sendEmailVerification(function (err) {
if (err) {
// Handle error.
}
-
- // Users linked.
});
@@ -12610,14 +14158,14 @@ Example
- sendEmailVerification(data, cbopt) → {Promise|undefined}
+ setRulesConfig(params, data, cbopt) → {Promise|undefined}
- Send a verification email to a user.
+ Set a new rules config.
@@ -12653,7 +14201,7 @@
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rule Config parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule Config key.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
dataParameters:
- User data object.
+ Rule Config Data parameters.
@@ -12750,7 +14383,7 @@ Parameters:
- user_idvalue
@@ -12767,7 +14400,7 @@ Parameters:
- ID of the user to be verified.
+ Rule Config Data value.
@@ -12862,14 +14495,15 @@ Returns:
Example
- var params = {
- user_id: '{USER_ID}'
-};
+ var params = { key: RULE_CONFIG_KEY };
+var data = { value: RULES_CONFIG_VALUE };
-management.sendEmailVerification(function (err) {
+management.setRulesConfig(params, data, function (err, rulesConfig) {
if (err) {
// Handle error.
}
+
+ // Rules Config set.
});
@@ -12924,7 +14558,7 @@ unlinkUser
upda
updateCli
updat
Parameters:
- Conneciton parameters.
+ Connection parameters.
@@ -14168,7 +15802,7 @@ up
u
updateRule<
u
updateUser<
upd
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index e7a7a25ec..550fb0649 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 2aa84c486..7c507c01e 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -764,7 +764,7 @@ deleteSource:
getSource:
Example
- getAll(cbopt) → {Promise|undefined}
+ getAll(paramsopt, cbopt) → {Promise|undefined}
@@ -1346,6 +1346,141 @@ Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Resource Servers parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.resourceServers.getAll(function (err, resourceServers) {
+
+ 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.resourceServers.getAll(params, function (err, resourceServers) {
console.log(resourceServers.length);
});
@@ -1482,7 +1629,7 @@ updateSource:
Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index 7104caf06..3eec1b0be 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
new file mode 100644
index 000000000..befe42be7
--- /dev/null
+++ b/docs/module-management.RulesConfigsManager.html
@@ -0,0 +1,1326 @@
+
+
+
+
+
+ RulesConfigsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RulesConfigsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ RulesConfigsManager
+
+
+ RulesConfigsManager
+The rules configs manager class provides a simple abstraction for performing CRUD operations
+on Auth0 RulesConfigsManager.
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new RulesConfigsManager(options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 RulesConfigsManager.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type:
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) clientOptions :Object
+
+
+
+
+
+ Options object for the Rest Client instance.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type:
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete an existing rules config.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rule Configs parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule Configs key.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.rulesConfigs.delete({ key: RULE_CONFIG_KEY }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Rules Config deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ getAll(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all rules configs.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.rulesConfigs.getAll(function (err, rulesConfig) {
+ console.log(rulesConfig.length);
+});
+
+
+
+
+
+
+
+
+
+
+ set(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Set a new rules config.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rule Config parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule Config key.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rule Config Data parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ value
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule Config Data value.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = { key: RULE_CONFIG_KEY };
+var data = { value: RULES_CONFIG_VALUE };
+
+management.rulesConfigs.set(params, data, function (err, rulesConfig) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Rules Config set.
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 7b05c7f88..ec01820be 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -760,7 +760,7 @@ deleteSource:
getSource:
Example
- getAll(cbopt) → {Promise|undefined}
+ getAll(paramsopt, cbopt) → {Promise|undefined}
@@ -1342,6 +1342,141 @@ Parameters:
+
+
+ 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.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.rules.getAll(function (err, rules) {
+
+ 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);
});
@@ -1478,7 +1625,7 @@ updateSource:
Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index e0d697018..3352f9484 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index ba6aad4e3..366cdfc78 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -835,7 +835,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 02480d991..9a8dbf3df 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index e8dbd1de6..8b54ed544 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -2123,7 +2123,7 @@ Parameters:
- Number of users per page.
+ Number of results per page.
@@ -2159,7 +2159,7 @@ Parameters:
- Page number.
+ Page number, zero indexed.
@@ -2263,10 +2263,10 @@ Example
// Pagination settings.
var params = {
per_page: 10,
- page: 2
+ page: 0
};
-management.users.getAll(function (err, users) {
+management.users.getAll(params, function (err, users) {
console.log(users.length);
});
@@ -3283,7 +3283,7 @@ Parameters:
- Number of logs per page.
+ Number of results per page.
@@ -3309,7 +3309,7 @@ Parameters:
- Page number.
+ Page number, zero indexed.
@@ -4734,7 +4734,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 54dcb6bfe..f2f6fa3dc 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -101,6 +101,9 @@ Classes
Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index a3ea1a0cb..cce277c28 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -339,7 +339,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index dccdc7239..bc514ecf9 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -124,7 +124,7 @@ utils.js
diff --git a/package.json b/package.json
index b0e7daf86..62f678001 100644
--- a/package.json
+++ b/package.json
@@ -1,11 +1,9 @@
{
"name": "auth0",
- "version": "2.10.0",
+ "version": "2.11.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
- "files": [
- "src"
- ],
+ "files": ["src"],
"scripts": {
"test": "mocha -R spec $(find ./test -name *.tests.js)",
"test:ci":
@@ -43,7 +41,7 @@
"codecov": "^2.2.0",
"husky": "^0.14.3",
"istanbul": "^0.4.0",
- "jsdoc": "^3.4.0",
+ "jsdoc": "^3.5.5",
"json-loader": "^0.5.4",
"minami": "^1.2.3",
"mocha": "^2.2.4",
diff --git a/yarn.lock b/yarn.lock
index 4877e816c..638ad7960 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -6,13 +6,7 @@ abbrev@1, abbrev@1.0.x:
version "1.0.9"
resolved "https://registry.yarnpkg.com/abbrev/-/abbrev-1.0.9.tgz#91b4792588a7738c25f35dd6f63752a2f8776135"
-acorn-jsx@^3.0.0:
- version "3.0.1"
- resolved "https://registry.yarnpkg.com/acorn-jsx/-/acorn-jsx-3.0.1.tgz#afdf9488fb1ecefc8348f6fb22f464e32a58b36b"
- dependencies:
- acorn "^3.0.4"
-
-acorn@^3.0.0, acorn@^3.0.4, acorn@^3.3.0:
+acorn@^3.0.0:
version "3.3.0"
resolved "https://registry.yarnpkg.com/acorn/-/acorn-3.3.0.tgz#45e37fb39e8da3f25baee3ff5369e2bb5f22017a"
@@ -175,6 +169,10 @@ aws4@^1.2.1, aws4@^1.6.0:
version "1.6.0"
resolved "https://registry.yarnpkg.com/aws4/-/aws4-1.6.0.tgz#83ef5ca860b2b32e4a0deedee8c771b9db57471e"
+babylon@7.0.0-beta.19:
+ version "7.0.0-beta.19"
+ resolved "https://registry.yarnpkg.com/babylon/-/babylon-7.0.0-beta.19.tgz#e928c7e807e970e0536b078ab3e0c48f9e052503"
+
balanced-match@^1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.0.tgz#89b4d199ab2bee49de164ea02b89ce462d71b767"
@@ -207,9 +205,9 @@ bluebird@^2.10.2:
version "2.11.0"
resolved "https://registry.yarnpkg.com/bluebird/-/bluebird-2.11.0.tgz#534b9033c022c9579c56ba3b3e5a5caafbb650e1"
-bluebird@~3.4.6:
- version "3.4.7"
- resolved "https://registry.yarnpkg.com/bluebird/-/bluebird-3.4.7.tgz#f72d760be09b7f76d08ed8fae98b289a8d05fab3"
+bluebird@~3.5.0:
+ version "3.5.1"
+ resolved "https://registry.yarnpkg.com/bluebird/-/bluebird-3.5.1.tgz#d9551f9de98f1fcda1e683d17ee91a0602ee2eb9"
boom@2.x.x:
version "2.10.1"
@@ -291,9 +289,9 @@ caseless@~0.12.0:
version "0.12.0"
resolved "https://registry.yarnpkg.com/caseless/-/caseless-0.12.0.tgz#1b681c21ff84033c826543090689420d187151dc"
-catharsis@~0.8.8:
- version "0.8.8"
- resolved "https://registry.yarnpkg.com/catharsis/-/catharsis-0.8.8.tgz#693479f43aac549d806bd73e924cd0d944951a06"
+catharsis@~0.8.9:
+ version "0.8.9"
+ resolved "https://registry.yarnpkg.com/catharsis/-/catharsis-0.8.9.tgz#98cc890ca652dd2ef0e70b37925310ff9e90fc8b"
dependencies:
underscore-contrib "~0.3.0"
@@ -680,13 +678,6 @@ escodegen@1.x.x:
optionalDependencies:
source-map "~0.5.6"
-espree@~3.1.7:
- version "3.1.7"
- resolved "https://registry.yarnpkg.com/espree/-/espree-3.1.7.tgz#fd5deec76a97a5120a9cd3a7cb1177a0923b11d2"
- dependencies:
- acorn "^3.3.0"
- acorn-jsx "^3.0.0"
-
esprima@2.7.x, esprima@^2.6.0, esprima@^2.7.1:
version "2.7.3"
resolved "https://registry.yarnpkg.com/esprima/-/esprima-2.7.3.tgz#96e3b70d5779f6ad49cd032673d1c312767ba581"
@@ -1306,24 +1297,26 @@ js-yaml@3.x:
argparse "^1.0.7"
esprima "^2.6.0"
-js2xmlparser@~1.0.0:
- version "1.0.0"
- resolved "https://registry.yarnpkg.com/js2xmlparser/-/js2xmlparser-1.0.0.tgz#5a170f2e8d6476ce45405e04823242513782fe30"
+js2xmlparser@~3.0.0:
+ version "3.0.0"
+ resolved "https://registry.yarnpkg.com/js2xmlparser/-/js2xmlparser-3.0.0.tgz#3fb60eaa089c5440f9319f51760ccd07e2499733"
+ dependencies:
+ xmlcreate "^1.0.1"
jsbn@~0.1.0:
version "0.1.1"
resolved "https://registry.yarnpkg.com/jsbn/-/jsbn-0.1.1.tgz#a5e654c2e5a2deb5f201d96cefbca80c0ef2f513"
-jsdoc@^3.4.0:
- version "3.4.3"
- resolved "https://registry.yarnpkg.com/jsdoc/-/jsdoc-3.4.3.tgz#e5740d6145c681f6679e6c17783a88dbdd97ccd3"
+jsdoc@^3.5.5:
+ version "3.5.5"
+ resolved "https://registry.yarnpkg.com/jsdoc/-/jsdoc-3.5.5.tgz#484521b126e81904d632ff83ec9aaa096708fa4d"
dependencies:
- bluebird "~3.4.6"
- catharsis "~0.8.8"
+ babylon "7.0.0-beta.19"
+ bluebird "~3.5.0"
+ catharsis "~0.8.9"
escape-string-regexp "~1.0.5"
- espree "~3.1.7"
- js2xmlparser "~1.0.0"
- klaw "~1.3.0"
+ js2xmlparser "~3.0.0"
+ klaw "~2.0.0"
marked "~0.3.6"
mkdirp "~0.5.1"
requizzle "~0.2.1"
@@ -1386,10 +1379,10 @@ kind-of@^4.0.0:
dependencies:
is-buffer "^1.1.5"
-klaw@~1.3.0:
- version "1.3.1"
- resolved "https://registry.yarnpkg.com/klaw/-/klaw-1.3.1.tgz#4088433b46b3b1ba259d78785d8e96f73ba02439"
- optionalDependencies:
+klaw@~2.0.0:
+ version "2.0.0"
+ resolved "https://registry.yarnpkg.com/klaw/-/klaw-2.0.0.tgz#59c128e0dc5ce410201151194eeb9cbf858650f6"
+ dependencies:
graceful-fs "^4.1.9"
lazy-cache@^1.0.3:
@@ -2766,6 +2759,10 @@ xml@^1.0.0:
version "1.0.1"
resolved "https://registry.yarnpkg.com/xml/-/xml-1.0.1.tgz#78ba72020029c5bc87b8a81a3cfcd74b4a2fc1e5"
+xmlcreate@^1.0.1:
+ version "1.0.2"
+ resolved "https://registry.yarnpkg.com/xmlcreate/-/xmlcreate-1.0.2.tgz#fa6bf762a60a413fb3dd8f4b03c5b269238d308f"
+
xregexp@2.0.0:
version "2.0.0"
resolved "https://registry.yarnpkg.com/xregexp/-/xregexp-2.0.0.tgz#52a63e56ca0b84a7f3a5f3d61872f126ad7a5943"
diff --git a/docs/index.html b/docs/index.html index 88c45eb35..cc157863c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -24,7 +24,7 @@
License
This project is licensed under the MIT license. See the
diff --git a/docs/index.js.html b/docs/index.js.html
index 2ac25d998..731420497 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -24,7 +24,7 @@
Client Grants parameters. Number of results per page. Page number, zero indexed.
+ 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.
+ Client Grants parameters. Number of results per page. Page number, zero indexed.
+ 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.
+ Clients params. Clients parameters. Number of clients per page. Number of results per page. Page number. Page number, zero indexed. Number of connections per page. Number of results per page. Page number. Page number, zero indexed. Given a path to a file and a connection id, create a new job that imports the
-users contained in the file or JSON string and associate them with the given
+users contained in the file or JSON string and associate them with the given
connection. Logs params. Search Criteria using Query String Syntax Page number. Zero based The amount of entries per page The field to use for sorting. A comma separated list of fields to include or exclude true if the fields specified are to be included in the result, false otherwise. true if a query summary must be included in the result, false otherwise. Default false
+ This method takes an optional object as first argument that may be used to
+ specify pagination settings and the search query. If pagination options are
+ not present, the first page of a limited number of results will be returned.
+ RulesConfigs manager. Delete a user by its id. Delete rules config. The user data object.. Rule Configs parameters. The user id. Rule Configs key. Callback function Callback function. Delete a multifactor provider for a user. Delete a user by its id. Data object. The user data object.. Multifactor provider. Get a the active users count. Delete a multifactor provider for a user. Data object. The user id. Multifactor provider. Callback function. Callback function Get a the active users count. Callback function. Callback function. Clients parameters. Number of results per page. Callback function.
+ 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.
+ Connection data object. Connections params. Number of results per page. Page number, zero indexed.
+ 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.
+ Log data object. Logs params. Callback function. Search Criteria using Query String Syntax Page number. Zero based The amount of entries per page The field to use for sorting. A comma separated list of fields to include or exclude true if the fields specified are to be included in the result, false otherwise. true if a query summary must be included in the result, false otherwise. Default false Callback function.
+ This method takes an optional object as first argument that may be used to
+ specify pagination settings and the search query. If pagination options are
+ not present, the first page of a limited number of results will be returned.
+ Get a Resource Server. Resource Server parameters. Resource Server ID. Callback function. Get a Resource Server. Get all resource servers. Resource Server parameters. Resource Servers parameters. Resource Server ID. Number of results per page. Page number, zero indexed.
+ 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.
+ Get all resource servers. Get an Auth0 rule. Connection data object. Rule parameters. Rule ID. Get an Auth0 rule. Get all rules. Rule parameters. Rules parameters. Rule ID. Number of results per page. Page number, zero indexed.
+ 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.
+ Get rules config. Get all rules. Get the tenant settings.. Get the tenant settings.. Get a user by its id. The user data object. The user id. Get a user by its id. Get user's log events. The user data object. Get logs data. The user id. User id. Number of results per page. Page number, zero indexed. The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1. true if a query summary must be included in the result, false otherwise. Default false; Get user's log events. Get all users. Get logs data. Users params. User id. Number of logs per page. Page number. The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1. Number of results per page. true if a query summary must be included in the result, false otherwise. Default false; Page number, zero indexed.
+ 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.
+ Get all users. Get users for a given email address Users params. Number of users per page. Page number. Email Address of users to locate
- This method takes an optional object as first argument that may be used to
- specify pagination settings and the search query.
+ This method takes an email address as the first argument,
+ and returns all users with that email address
Get users for a given email address Given a path to a file and a connection id, create a new job that imports the
+users contained in the file and associate them with the given connection. Email Address of users to locate Users import data. Connection for the users insertion. Path to the users data file.
- This method takes an email address as the first argument,
- and returns all users with that email address
- Given a path to a file and a connection id, create a new job that imports the
-users contained in the file and associate them with the given connection. Link the user with another account. ID of the primary user. Users import data. Secondary user data. Connection for the users insertion. ID of the user to be linked. Path to the users data file. ID of the connection to be used. Link the user with another account. Send a verification email to a user. ID of the primary user. Secondary user data. User data object. ID of the user to be linked. ID of the connection to be used. ID of the user to be verified. Send a verification email to a user. Set a new rules config. Rule Config parameters. Rule Config key. User data object. Rule Config Data parameters. ID of the user to be verified. Rule Config Data value. Conneciton parameters. Connection parameters. Resource Servers parameters. Number of results per page. Page number, zero indexed.
+ 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.
+ RulesConfigsManager
+The rules configs manager class provides a simple abstraction for performing CRUD operations
+on Auth0 RulesConfigsManager. The client options. The URL of the API. Headers to be included in all requests. Retry Policy Config Provides an abstraction layer for performing CRUD operations on
+Auth0 RulesConfigsManager. Options object for the Rest Client instance. Delete an existing rules config. Rule Configs parameters. Rule Configs key. Callback function. Get all rules configs. Callback function. Set a new rules config. Rule Config parameters. Rule Config key. Rule Config Data parameters. Rule Config Data value. Callback function. Rules parameters. Number of results per page. Page number, zero indexed.
+ 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.
+ Number of users per page. Number of results per page. Page number. Page number, zero indexed. Number of logs per page. Number of results per page. Page number. Page number, zero indexed.index.js
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html
index 570adf92e..5a90b95e8 100644
--- a/docs/management_BlacklistedTokensManager.js.html
+++ b/docs/management_BlacklistedTokensManager.js.html
@@ -24,7 +24,7 @@
management/BlacklistedTokensManager.js
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index cad917818..83db47ad5 100644
--- a/docs/management_ClientGrantsManager.js.html
+++ b/docs/management_ClientGrantsManager.js.html
@@ -24,7 +24,7 @@
management/ClientGrantsManager.js
* @method getAll
* @memberOf module:management.ClientGrantsManager.prototype
*
- * @example
- * management.clientGrants.getAll(function (err, grants) {
+ * @example <caption>
+ * 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.
+ * </caption>
+ *
+ * // Pagination settings.
+ * var params = {
+ * per_page: 10,
+ * page: 0
+ * };
+ *
+ *
+ * management.clientGrants.getAll(params, function (err, grants) {
* console.log(grants.length);
* });
*
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Client Grants parameters.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -201,7 +216,7 @@ management/ClientGrantsManager.js
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html
index 816ff5512..74727a0ca 100644
--- a/docs/management_ClientsManager.js.html
+++ b/docs/management_ClientsManager.js.html
@@ -24,7 +24,7 @@
management/ClientsManager.js
* // Pagination settings.
* var params = {
* per_page: 10,
- * page: 2
+ * page: 0
* };
*
- * management.clients.getAll(function (err, clients) {
+ * management.clients.getAll(params, function (err, clients) {
* console.log(clients.length);
* });
*
- * @param {Object} [params] Clients params.
- * @param {Number} [params.per_page] Number of clients per page.
- * @param {Number} [params.page] Page number.
+ * @param {Object} [params] Clients parameters.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
@@ -238,7 +238,7 @@ management/ClientsManager.js
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html
index 21e404918..7060b64c5 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
management/ConnectionsManager.js
* // Pagination settings.
* var params = {
* per_page: 10,
- * page: 2
+ * page: 0
* };
*
- * management.connections.getAll(function (err, connections) {
+ * management.connections.getAll(params, function (err, connections) {
* console.log(connections.length);
* });
*
* @param {Object} [params] Connections params.
- * @param {Number} [params.per_page] Number of connections per page.
- * @param {Number} [params.page] Page number.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
index bbbf31976..212f98329 100644
--- a/docs/management_DeviceCredentialsManager.js.html
+++ b/docs/management_DeviceCredentialsManager.js.html
@@ -24,7 +24,7 @@
management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
index b4f652ff7..ea866799e 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index 4342b905f..1a5e04e97 100644
--- a/docs/management_EmailTemplatesManager.js.html
+++ b/docs/management_EmailTemplatesManager.js.html
@@ -24,7 +24,7 @@
management/EmailTemplatesManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 5f08c8e7c..c8ff2eeb7 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
management/JobsManager.js
/**
* Given a path to a file and a connection id, create a new job that imports the
- * users contained in the file or JSON string and associate them with the given
+ * users contained in the file or JSON string and associate them with the given
* connection.
*
* @method importUsers
@@ -176,42 +176,45 @@ management/JobsManager.js
var url = options.baseUrl + '/jobs/users-imports';
var method = 'POST';
- var promise = new Promise(function(resolve, reject) {
- request(
- {
- url: url,
- method: method,
- headers: headers,
- formData: {
- users: {
- value: data.users_json ? Buffer.from(data.users_json) : fs.createReadStream(data.users),
- options: {
- filename: data.users_json ? 'users.json' : data.users,
- }
- },
- connection_id: data.connection_id
+ var promise = options.tokenProvider.getAccessToken().then(function(access_token) {
+ return new Promise(function(resolve, reject) {
+ request(
+ {
+ url: url,
+ method: method,
+ headers: extend({ Authorization: `Bearer ${access_token}` }, headers),
+ formData: {
+ users: {
+ value: data.users_json
+ ? Buffer.from(data.users_json)
+ : fs.createReadStream(data.users),
+ options: {
+ filename: data.users_json ? 'users.json' : data.users
+ }
+ },
+ connection_id: data.connection_id
+ }
+ },
+ function(err, res) {
+ if (err) {
+ reject(err);
+ return;
+ }
+ // `superagent` uses the error parameter in callback on http errors.
+ // the following code is intended to keep that behaviour (https://github.com/visionmedia/superagent/blob/master/lib/node/response.js#L170)
+ var type = (res.statusCode / 100) | 0;
+ var isErrorResponse = 4 === type || 5 === type;
+ if (isErrorResponse) {
+ var error = new Error('cannot ' + method + ' ' + url + ' (' + res.statusCode + ')');
+ error.status = res.statusCode;
+ error.method = method;
+ error.text = res.text;
+ reject(error);
+ }
+ resolve(res);
}
- },
- function(err, res) {
- // `superagent` uses the error parameter in callback on http errors.
- // the following code is intended to keep that behaviour (https://github.com/visionmedia/superagent/blob/master/lib/node/response.js#L170)
- var type = (res.statusCode / 100) | 0;
- var isErrorResponse = 4 === type || 5 === type;
- if (isErrorResponse) {
- var error = new Error('cannot ' + method + url + ' (' + res.statusCode + ')');
- error.status = res.statusCode;
- error.method = method;
- error.text = res.text;
- reject(error);
- }
-
- if (err) {
- reject(err);
- }
-
- resolve(res);
- }
- );
+ );
+ });
});
// Don't return a promise if a callback was given.
@@ -273,7 +276,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index d9283a774..8234b55fe 100644
--- a/docs/management_LogsManager.js.html
+++ b/docs/management_LogsManager.js.html
@@ -24,7 +24,7 @@
management/LogsManager.js
* @method getAll
* @memberOf module:management.LogsManager.prototype
*
- * @example
- * management.logs.getAll(function (err, logs) {
+ * @example <caption>
+ * This method takes an optional object as first argument that may be used to
+ * specify pagination settings and the search query. If pagination options are
+ * not present, the first page of a limited number of results will be returned.
+ * </caption>
+ *
+ * // Pagination settings.
+ * var params = {
+ * per_page: 10,
+ * page: 2
+ * };
+ *
+ * management.logs.getAll(params, function (err, logs) {
* console.log(logs.length);
* });
*
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Logs params.
+ * @param {String} [params.q] Search Criteria using Query String Syntax
+ * @param {Number} [params.page] Page number. Zero based
+ * @param {Number} [params.per_page] The amount of entries per page
+ * @param {String} [params.sort] The field to use for sorting.
+ * @param {String} [params.fields] A comma separated list of fields to include or exclude
+ * @param {Boolean} [params.include_fields] true if the fields specified are to be included in the result, false otherwise.
+ * @param {Boolean} [params.include_totals] true if a query summary must be included in the result, false otherwise. Default false
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -146,7 +165,7 @@ management/LogsManager.js
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html
index eeee64cd5..3f4b6b57b 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
management/ManagementTokenProvider.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index f9307a8e8..a87f20eb8 100644
--- a/docs/management_ResourceServersManager.js.html
+++ b/docs/management_ResourceServersManager.js.html
@@ -24,7 +24,7 @@
management/ResourceServersManager.js
* @method getAll
* @memberOf module:management.ResourceServersManager.prototype
*
- * @example
- * management.resourceServers.getAll(function (err, resourceServers) {
+ * @example <caption>
+ * 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.
+ * </caption>
+ *
+ * // Pagination settings.
+ * var params = {
+ * per_page: 10,
+ * page: 0
+ * };
+ *
+ * management.resourceServers.getAll(params, function (err, resourceServers) {
* console.log(resourceServers.length);
* });
*
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Resource Servers parameters.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -224,7 +238,7 @@ management/ResourceServersManager.js
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
new file mode 100644
index 000000000..e92906ae3
--- /dev/null
+++ b/docs/management_RulesConfigsManager.js.html
@@ -0,0 +1,188 @@
+
+
+
+
+
+ management/RulesConfigsManager.js
+
+
+
+
+
+
+
+
+ var ArgumentError = require('rest-facade').ArgumentError;
+var utils = require('../utils');
+var Auth0RestClient = require('../Auth0RestClient');
+var RetryRestClient = require('../RetryRestClient');
+
+/**
+ * Simple facade for consuming a REST API endpoint.
+ * @external RestClient
+ * @see https://github.com/ngonzalvez/rest-facade
+ */
+
+
+/**
+ * @class RulesConfigsManager
+ * The rules configs manager class provides a simple abstraction for performing CRUD operations
+ * on Auth0 RulesConfigsManager.
+ * @constructor
+ * @memberOf module:management
+ *
+ * @param {Object} options The client options.
+ * @param {String} options.baseUrl The URL of the API.
+ * @param {Object} [options.headers] Headers to be included in all requests.
+ * @param {Object} [options.retry] Retry Policy Config
+ */
+var RulesConfigsManager = function (options) {
+ if (options === null || typeof options !== 'object') {
+ throw new ArgumentError('Must provide manager options');
+ }
+
+ if (options.baseUrl === null || options.baseUrl === undefined) {
+ throw new ArgumentError('Must provide a base URL for the API');
+ }
+
+ if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
+ throw new ArgumentError('The provided base URL is invalid');
+ }
+
+ /**
+ * Options object for the Rest Client instance.
+ *
+ * @type {Object}
+ */
+ var clientOptions = {
+ headers: options.headers,
+ query: { repeatParams: false }
+ };
+
+ /**
+ * Provides an abstraction layer for performing CRUD operations on
+ * {@link https://auth0.com/docs/api/v2#!/RulesConfigsManager Auth0 RulesConfigsManager}.
+ *
+ * @type {external:RestClient}
+ */
+ var auth0RestClient = new Auth0RestClient(options.baseUrl + '/rules-configs/:key', clientOptions, options.tokenProvider);
+ this.resource = new RetryRestClient(auth0RestClient, options.retry);
+};
+
+
+/**
+ * Set a new rules config.
+ *
+ * @method set
+ * @memberOf module:management.RulesConfigsManager.prototype
+ *
+ * @example
+ * var params = { key: RULE_CONFIG_KEY };
+ * var data = { value: RULES_CONFIG_VALUE };
+ *
+ * management.rulesConfigs.set(params, data, function (err, rulesConfig) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Rules Config set.
+ * });
+ *
+ * @param {Object} params Rule Config parameters.
+ * @param {String} params.key Rule Config key.
+ * @param {Object} data Rule Config Data parameters.
+ * @param {String} data.value Rule Config Data value.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(RulesConfigsManager, 'set', 'resource.update');
+
+
+/**
+ * Get all rules configs.
+ *
+ * @method getAll
+ * @memberOf module:management.RulesConfigsManager.prototype
+ *
+ * @example
+ * management.rulesConfigs.getAll(function (err, rulesConfig) {
+ * console.log(rulesConfig.length);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(RulesConfigsManager, 'getAll', 'resource.getAll');
+
+
+/**
+ * Delete an existing rules config.
+ *
+ * @method delete
+ * @memberOf module:management.RulesConfigsManager.prototype
+ *
+ * @example
+ * management.rulesConfigs.delete({ key: RULE_CONFIG_KEY }, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Rules Config deleted.
+ * });
+ *
+ * @param {Object} params Rule Configs parameters.
+ * @param {String} params.key Rule Configs key.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(RulesConfigsManager, 'delete', 'resource.delete');
+
+module.exports = RulesConfigsManager;
+
+
+
+
+
+
+
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 660dc2cb8..4609238a5 100644
--- a/docs/management_RulesManager.js.html
+++ b/docs/management_RulesManager.js.html
@@ -24,7 +24,7 @@
management/RulesManager.js
* @method getAll
* @memberOf module:management.RulesManager.prototype
*
- * @example
- * management.rules.getAll(function (err, rules) {
+ * @example <caption>
+ * 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.
+ * </caption>
+ *
+ * // Pagination settings.
+ * var params = {
+ * per_page: 10,
+ * page: 0
+ * };
+ *
+ * management.rules.getAll(params, function (err, rules) {
* console.log(rules.length);
* });
*
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Rules parameters.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -234,7 +248,7 @@ management/RulesManager.js
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html
index f9e9f55d2..ae40ac457 100644
--- a/docs/management_StatsManager.js.html
+++ b/docs/management_StatsManager.js.html
@@ -24,7 +24,7 @@
management/StatsManager.js
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html
index 654809e72..a04bc4efe 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index aa6977e20..08b49f382 100644
--- a/docs/management_TicketsManager.js.html
+++ b/docs/management_TicketsManager.js.html
@@ -24,7 +24,7 @@
management/TicketsManager.js
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html
index 10dfd95bb..055304cbf 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
management/UsersManager.js
* // Pagination settings.
* var params = {
* per_page: 10,
- * page: 2
+ * page: 0
* };
*
- * management.users.getAll(function (err, users) {
+ * management.users.getAll(params, function (err, users) {
* console.log(users.length);
* });
*
* @param {Object} [params] Users params.
- * @param {Number} [params.per_page] Number of users per page.
- * @param {Number} [params.page] Page number.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
@@ -579,8 +579,8 @@ management/UsersManager.js
*
* @param {Object} params Get logs data.
* @param {String} params.id User id.
- * @param {Number} params.per_page Number of logs per page.
- * @param {Number} params.page Page number.
+ * @param {Number} params.per_page Number of results per page.
+ * @param {Number} params.page Page number, zero indexed.
* @param {String} params.sort The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
* @param {Boolean} params.include_totals true if a query summary must be included in the result, false otherwise. Default false;
* @param {Function} [cb] Callback function.
@@ -631,7 +631,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index a798d2a61..95a6cc229 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
management/index.js
var LogsManager = require('./LogsManager');
var ResourceServersManager = require('./ResourceServersManager');
var ManagementTokenProvider = require('./ManagementTokenProvider');
+var RulesConfigsManager = require('./RulesConfigsManager');
var EmailTemplatesManager = require('./EmailTemplatesManager');
var BASE_URL_FORMAT = 'https://%s/api/v2';
@@ -285,6 +286,13 @@ management/index.js
* @type {EmailTemplatesManager}
*/
this.emailTemplates = new EmailTemplatesManager(managerOptions);
+
+ /**
+ * RulesConfigs manager.
+ *
+ * @type {RulesConfigsManager}
+ */
+ this.rulesConfigs = new RulesConfigsManager(managerOptions);
};
/**
@@ -324,13 +332,26 @@ management/index.js
* @method getConnections
* @memberOf module:management.ManagementClient.prototype
*
- * @example
- * management.getConnections(function (err, connections) {
+ * @example <caption>
+ * 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.
+ * </caption>
+ *
+ * // Pagination settings.
+ * var params = {
+ * per_page: 10,
+ * page: 0
+ * };
+ *
+ * management.getConnections(params, function (err, connections) {
* console.log(connections.length);
* });
*
- * @param {Object} data Connection data object.
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Connections params.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -422,7 +443,7 @@ management/index.js
* console.log(connection.name); // 'newConnectionName'
* });
*
- * @param {Object} params Conneciton parameters.
+ * @param {Object} params Connection parameters.
* @param {String} params.id Connection ID.
* @param {Object} data Updated connection data.
* @param {Function} [cb] Callback function.
@@ -437,12 +458,26 @@ management/index.js
* @method getClients
* @memberOf module:management.ManagementClient.prototype
*
- * @example
- * management.getClients(function (err, clients) {
+ * @example <caption>
+ * 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.
+ * </caption>
+ *
+ * // Pagination settings.
+ * var params = {
+ * per_page: 10,
+ * page: 0
+ * };
+ *
+ * management.getClients(params, function (err, clients) {
* console.log(clients.length);
* });
*
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Clients parameters.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -549,12 +584,26 @@ management/index.js
* @method getAll
* @memberOf module:management.ClientGrantsManager.prototype
*
- * @example
- * management.clientGrants.getAll(function (err, grants) {
+ * @example <caption>
+ * 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.
+ * </caption>
+ *
+ * // Pagination settings.
+ * var params = {
+ * per_page: 10,
+ * page: 0
+ * };
+ *
+ * management.getClientGrants(params, function (err, grants) {
* console.log(grants.length);
* });
*
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Client Grants parameters.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -710,12 +759,26 @@ management/index.js
* @method getRules
* @memberOf module:management.ManagementClient.prototype
*
- * @example
- * management.getRules(function (err, rules) {
+ * @example <caption>
+ * 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.
+ * </caption>
+ *
+ * // Pagination settings.
+ * var params = {
+ * per_page: 10,
+ * page: 0
+ * };
+ *
+ * management.getRules(params, function (err, rules) {
* console.log(rules.length);
* });
*
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Rules parameters.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -823,13 +886,14 @@ management/index.js
*
* @example <caption>
* This method takes an optional object as first argument that may be used to
- * specify pagination settings and the search query.
+ * specify pagination settings. If pagination options are not present,
+ * the first page of a limited number of results will be returned.
* </caption>
*
* // Pagination settings.
* var params = {
* per_page: 10,
- * page: 2
+ * page: 0
* };
*
* auth0.getUsers(params, function (err, users) {
@@ -837,8 +901,8 @@ management/index.js
* });
*
* @param {Object} [params] Users params.
- * @param {Number} [params.per_page] Number of users per page.
- * @param {Number} [params.page] Page number.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
@@ -1180,8 +1244,8 @@ management/index.js
*
* @param {Object} params Get logs data.
* @param {String} params.id User id.
- * @param {Number} params.per_page Number of logs per page.
- * @param {Number} params.page Page number.
+ * @param {Number} params.per_page Number of results per page.
+ * @param {Number} params.page Page number, zero indexed.
* @param {String} params.sort The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
* @param {Boolean} params.include_totals true if a query summary must be included in the result, false otherwise. Default false;
* @param {Function} [cb] Callback function.
@@ -1592,13 +1656,31 @@ management/index.js
* @method getLogs
* @memberOf module:management.ManagementClient.prototype
*
- * @example
- * management.getLogs(function (err, logs) {
+ * @example <caption>
+ * This method takes an optional object as first argument that may be used to
+ * specify pagination settings and the search query. If pagination options are
+ * not present, the first page of a limited number of results will be returned.
+ * </caption>
+ *
+ * // Pagination settings.
+ * var params = {
+ * per_page: 10,
+ * page: 2
+ * };
+ *
+ * management.getLogs(params, function (err, logs) {
* console.log(logs.length);
* });
*
- * @param {Object} data Log data object.
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Logs params.
+ * @param {String} [params.q] Search Criteria using Query String Syntax
+ * @param {Number} [params.page] Page number. Zero based
+ * @param {Number} [params.per_page] The amount of entries per page
+ * @param {String} [params.sort] The field to use for sorting.
+ * @param {String} [params.fields] A comma separated list of fields to include or exclude
+ * @param {Boolean} [params.include_fields] true if the fields specified are to be included in the result, false otherwise.
+ * @param {Boolean} [params.include_totals] true if a query summary must be included in the result, false otherwise. Default false
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -1632,13 +1714,26 @@ management/index.js
* @method getResourceServers
* @memberOf module:management.ManagementClient.prototype
*
- * @example
- * management.getResourceServers(function (err, resourceServers) {
+ * @example <caption>
+ * 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.
+ * </caption>
+ *
+ * // Pagination settings.
+ * var params = {
+ * per_page: 10,
+ * page: 0
+ * };
+ *
+ * management.getResourceServers(params, function (err, resourceServers) {
* console.log(resourceServers.length);
* });
*
- * @param {Object} data Connection data object.
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Resource Servers parameters.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -1716,6 +1811,80 @@ management/index.js
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(ManagementClient, 'updateResourceServer', 'resourceServers.update');
+
+/**
+ * Set a new rules config.
+ *
+ * @method setRulesConfig
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var params = { key: RULE_CONFIG_KEY };
+ * var data = { value: RULES_CONFIG_VALUE };
+ *
+ * management.setRulesConfig(params, data, function (err, rulesConfig) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Rules Config set.
+ * });
+ *
+ * @param {Object} params Rule Config parameters.
+ * @param {String} params.key Rule Config key.
+ * @param {Object} data Rule Config Data parameters.
+ * @param {String} data.value Rule Config Data value.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'setRulesConfig', 'rulesConfigs.set');
+
+/**
+ * Get rules config.
+ *
+ * @method getRulesConfigs
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ *
+ * management.getRulesConfigs(function (err, rulesConfigs) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Get Rules Configs.
+ * });
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getRulesConfigs', 'rulesConfigs.getAll');
+
+/**
+ * Delete rules config.
+ *
+ * @method deleteRulesConfig
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ *
+ * management.deleteRulesConfig({ key: RULE_CONFIG_KEY }, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Rules Config deleted.
+ * });
+ *
+ * @param {Object} params Rule Configs parameters.
+ * @param {String} params.key Rule Configs key.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'deleteRulesConfig', 'rulesConfigs.delete');
+
+
module.exports = ManagementClient;
@@ -1729,7 +1898,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 78bf69bda..767a42097 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index 15dc60c43..f73820dca 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
Example
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 31dbb16ab..e0e65f98b 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index e1cd7e45b..a21bd9114 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index 96a999e72..8befa00d1 100644
--- a/docs/module-auth.TokensManager.html
+++ b/docs/module-auth.TokensManager.html
@@ -24,7 +24,7 @@
Parameters:
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html
index e320fc68e..263aa0379 100644
--- a/docs/module-auth.UsersManager.html
+++ b/docs/module-auth.UsersManager.html
@@ -24,7 +24,7 @@
Example
diff --git a/docs/module-auth.html b/docs/module-auth.html
index 1885e3cba..5c148a786 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
Classes
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 5b67cdd19..b8eadce77 100644
--- a/docs/module-management.BlacklistedTokensManager.html
+++ b/docs/module-management.BlacklistedTokensManager.html
@@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index fb05d1429..2c1b70877 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
createSource:
deleteSource:
deleteSource:
Example
- getAll(cbopt) → {Promise|undefined}
+ getAll(paramsopt, cbopt) → {Promise|undefined}
@@ -1516,7 +1516,7 @@ getAllSource:
Parameters:
+
+
+
+
+
+
params
+
+
+
+
+
+ Object
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ per_page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cbReturns:
Example
- management.clientGrants.getAll(function (err, grants) {
+
@@ -1653,7 +1800,7 @@ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
+};
+
+management.getClientGrants(params, function (err, grants) {
console.log(grants.length);
});Example
- getAll(cbopt) → {Promise|undefined}
+ getAll(paramsopt, cbopt) → {Promise|undefined}
@@ -1740,6 +1887,141 @@ Parameters:
+
+
+
+
+
+
params
+
+
+
+
+
+ Object
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ per_page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1466,7 +1466,7 @@ cbReturns:
Example
- management.clientGrants.getAll(function (err, grants) {
+
@@ -1876,7 +2171,7 @@ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
+};
+
+
+management.clientGrants.getAll(params, function (err, grants) {
console.log(grants.length);
});updateSource:
updateSource:
Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 2aeb4314c..6660e333f 100644
--- a/docs/module-management.ClientsManager.html
+++ b/docs/module-management.ClientsManager.html
@@ -24,7 +24,7 @@
Parameters:
- Parameters:
-
Parameters:
-
@@ -1570,10 +1570,10 @@ Example
@@ -1904,7 +1904,7 @@ // Pagination settings.
var params = {
per_page: 10,
- page: 2
+ page: 0
};
-management.clients.getAll(function (err, clients) {
+management.clients.getAll(params, function (err, clients) {
console.log(clients.length);
});Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
index 64fba72b9..ba59d39d8 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
Parameters:
-
@@ -1461,7 +1461,7 @@ Parameters:
-
@@ -1565,10 +1565,10 @@ Example
@@ -1899,7 +1899,7 @@ // Pagination settings.
var params = {
per_page: 10,
- page: 2
+ page: 0
};
-management.connections.getAll(function (err, connections) {
+management.connections.getAll(params, function (err, connections) {
console.log(connections.length);
});Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index e1cbd7842..694636a5e 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index c9a00106a..ef80c4764 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index 39ee99e0a..b9d4bb269 100644
--- a/docs/module-management.EmailTemplatesManager.html
+++ b/docs/module-management.EmailTemplatesManager.html
@@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 81278da5c..86062089a 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
importUser
verifyEmai
Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index 91506e36c..90bb3156b 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
getSource:
Example
- getAll(cbopt) → {Promise|undefined}
+ getAll(paramsopt, cbopt) → {Promise|undefined}
@@ -854,6 +854,321 @@ Parameters:
+
+
+
+
+
+
params
+
+
+
+
+
+ Object
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ q
+
+
+
+
+
+ String
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ per_page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ sort
+
+
+
+
+
+ String
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ fields
+
+
+
+
+
+ String
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ include_fields
+
+
+
+
+
+ Boolean
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+include_totals
+
+
+
+
+
+ Boolean
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -5972,12 +6046,12 @@ cbReturns:
Example
- management.logs.getAll(function (err, logs) {
+
@@ -959,7 +1286,7 @@ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 2
+};
+
+management.logs.getAll(params, function (err, logs) {
console.log(logs.length);
});Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index 13d55fffb..9092609a0 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
new M
blac
clientGra
clientsSource:
connection
devi
emailPro
emailTe
jobsSource:
logsSource:
resour
rulesSource:
Type:
+rulesConfigs :RulesConfigsManager
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type:
+
+
+
+
+
+
+
statsSource:
tenantSource:
ticketsSource:
usersSource:
blackli
Source:
createCli
creat
Source:
Source:
c
createRule<
createUser<
deleteA
deleteCli
delet
Source:
de
d
deleteRule<
Example
- deleteUser(params, cbopt) → {Promise|undefined}
+ deleteRulesConfig(params, cbopt) → {Promise|undefined}
deleteUser<
Parameters:
- Parameters:
-
@@ -5921,7 +5995,7 @@ idkey
@@ -5877,7 +5951,7 @@ Parameters:
-
Parameters:
-
Returns:
Example
- management.deleteUser({ id: USER_ID }, function (err) {
+ management.deleteRulesConfig({ key: RULE_CONFIG_KEY }, function (err) {
if (err) {
// Handle error.
}
- // User deleted.
+ // Rules Config deleted.
});Example
- deleteUserMultifactor(params, cbopt) → {Promise|undefined}
+ deleteUser(params, cbopt) → {Promise|undefined}
@@ -6267,14 +6315,12 @@ Parameters:
- Parameters:
-
-
-
-
-
-
provider
-
-
-
-
-
-
-
-
- String
-
-
-
-
-
- Returns:
Example
- var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-
-management.deleteUserMultifactor(params, function (err, user) {
+ management.deleteUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // User deleted.
});Example
- deleteUserMultifcator(params, cbopt) → {Promise|undefined}
+ deleteUserMultifactor(params, cbopt) → {Promise|undefined}
@@ -6317,10 +6363,6 @@
-
Example
var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-management.deleteUserMultifcator(params, function (err, user) {
+management.deleteUserMultifactor(params, function (err, user) {
if (err) {
// Handle error.
}
@@ -6587,14 +6629,14 @@ Example
- getActiveUsersCount(cbopt) → {Promise|undefined}
+ deleteUserMultifcator(params, cbopt) → {Promise|undefined}
ge
+
ge
Parameters:
+
+
+
+
+
+
params
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+ id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+provider
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
@@ -6754,12 +6911,14 @@ cbParameters:
-
Returns:
Example
- management.getActiveUsersCount(function (err, usersCount) {
+ var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
+
+management.deleteUserMultifcator(params, function (err, user) {
if (err) {
// Handle error.
}
- console.log(usersCount);
+ // Users accounts unlinked.
});Example
- getBlacklistedTokens(cbopt) → {Promise|undefined}
+ getActiveUsersCount(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+
+
+
+
+
+
+
+
+Example
+
+
+
+management.getActiveUsersCount(function (err, usersCount) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(usersCount);
+});getBlacklistedTokens(cbopt) → {Promise|undefined}
@@ -6814,7 +7157,7 @@ g
getClient
getClien
Returns:
- getClients(cbopt) → {Promise|undefined}
+ getClients(paramsopt, cbopt) → {Promise|undefined}
@@ -7371,7 +7714,7 @@ getClients<
Parameters:
-
+
-
- cbparams
- function
+Object
@@ -7444,43 +7787,178 @@ Parameters:
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+ Type
+
+ Attributes
+
+
+ Description
+
+
+
-
+
-per_page
+
+
+
+
+ Number
+
+
+
+ <optional>
+
+
-
+
+
+
+ Returns:
+
+
+
-
+
+
+
+
+
+ cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+
+
+
+
+
Returns:
Example
- management.getClients(function (err, clients) {
+
@@ -7551,7 +8041,7 @@ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
+};
+
+management.getClients(params, function (err, clients) {
console.log(clients.length);
});getConne
Example
- getConnections(data, cbopt) → {Promise|undefined}
+ getConnections(paramsopt, cbopt) → {Promise|undefined}
@@ -7820,7 +8310,7 @@ getConn
Parameters:
-
@@ -7978,7 +8569,19 @@ dataparams
@@ -7881,6 +8371,8 @@ Parameters:
+ <optional>
+
@@ -7891,7 +8383,106 @@ Parameters:
-
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ per_page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
Example
- management.getConnections(function (err, connections) {
+
@@ -8034,7 +8637,7 @@ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
+};
+
+management.getConnections(params, function (err, connections) {
console.log(connections.length);
});getDaily
g
getEm
Source:
getJobSource:
getLogSource:
Example
- getLogs(data, cbopt) → {Promise|undefined}
+ getLogs(paramsopt, cbopt) → {Promise|undefined}
@@ -9502,7 +10105,7 @@ getLogsSource:
Parameters:
-
+
+
+dataparams
@@ -9563,6 +10166,8 @@ Parameters:
+ <optional>
+
@@ -9573,22 +10178,41 @@ Parameters:
-
-
+
+
-
-
-
+
+
+
+
+
+
+
Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Description
+
-
-
-cbq
- function
+String
@@ -9609,17 +10233,554 @@ Parameters:
-
+
+
+
+
+
+ page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ per_page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ sort
+
+
+
+
+
+ String
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ fields
+
+
+
+
+
+ String
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ include_fields
+
+
+
+
+
+ Boolean
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ include_totals
+
+
+
+
+
+ Boolean
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+
+
+
+
+
+
+
+
+Example
+
+
+
+// Pagination settings.
+var params = {
+ per_page: 10,
+ page: 2
+};
+
+management.getLogs(params, function (err, logs) {
+ console.log(logs.length);
+});getResourceServer(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
@@ -9660,8 +10821,12 @@
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ params
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
Example
- management.getLogs(function (err, logs) {
- console.log(logs.length);
+ management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(resourceServer);
});Example
- getResourceServer(params, cbopt) → {Promise|undefined}
+ getResourceServers(paramsopt, cbopt) → {Promise|undefined}
getR
Parameters:
+ <optional>
+
@@ -9787,7 +10954,7 @@ Parameters:
- Parameters:
Type
+ Attributes
+
@@ -9813,24 +10982,70 @@ Parameters:
-
+
+
+
+ idper_page
-
+ String
+Number
+
+ <optional>
+
+
+
+
+
+
+
-
+
+
+
@@ -9925,12 +11140,20 @@ page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
Example
- management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
- if (err) {
- // Handle error.
- }
+ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
+};
- console.log(resourceServer);
+management.getResourceServers(params, function (err, resourceServers) {
+ console.log(resourceServers.length);
});Example
- getResourceServers(data, cbopt) → {Promise|undefined}
+ getRule(params, cbopt) → {Promise|undefined}
get
Parameters:
-
@@ -10143,8 +11417,12 @@ dataparams
@@ -10055,8 +11278,59 @@ Parameters:
-
-
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+ Returns:
Example
- management.getResourceServers(function (err, resourceServers) {
- console.log(resourceServers.length);
+ management.getRule({ id: RULE_ID }, function (err, rule) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(rule);
});Example
- getRule(params, cbopt) → {Promise|undefined}
+ getRules(paramsopt, cbopt) → {Promise|undefined}
getRuleSource:
Parameters:
+ <optional>
+
@@ -10270,7 +11550,7 @@ Parameters:
- Parameters:
Type
+ Attributes
+
@@ -10296,24 +11578,70 @@ Parameters:
-
+
+
+
+ idper_page
-
+ String
+Number
+
+ <optional>
+
+
+
+
+
+
+
-
+
+
+
@@ -10408,12 +11736,140 @@ page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
Example
- management.getRule({ id: RULE_ID }, function (err, rule) {
+
+
+// Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
+};
+
+management.getRules(params, function (err, rules) {
+ console.log(rules.length);
+});getRulesConfigs() → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+Example
+
+ management.getRulesConfigs(function (err, rulesConfigs) {
if (err) {
// Handle error.
}
- console.log(rule);
+ // Get Rules Configs.
});Example
- getRules(cbopt) → {Promise|undefined}
+ getTenantSettings(cbopt) → {Promise|undefined}
getRulesSource:
Returns:
Example
- management.getRules(function (err, rules) {
- console.log(rules.length);
+ management.getSettings(function (err, settings) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(settings);
});Example
- getTenantSettings(cbopt) → {Promise|undefined}
+ getUser(data, cbopt) → {Promise|undefined}
getT
Parameters:
Type
- Attributes
-
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+
+
+
+
data
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
@@ -10692,6 +12203,40 @@ Parameters:
+
+
+
+
+
+id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
-
-
-
- cbReturns:
Example
- management.getSettings(function (err, settings) {
- if (err) {
- // Handle error.
- }
-
- console.log(settings);
+ management.getUser({ id: USER_ID }, function (err, user) {
+ console.log(user);
});Example
- getUser(data, cbopt) → {Promise|undefined}
+ getUserLogs(params, cbopt) → {Promise|undefined}
getUserSource:
Parameters:
-
+
+
+
+ dataparams
@@ -10903,7 +12444,7 @@ Parameters:
- Parameters:
-
+
+
+
+
+
+
+ per_page
+
+
+
+
+
+
+
+
+ Number
+
+
+
+
+
+
+
+
+
+
+
+ page
+
+
+
+
+
+
+
+
+ Number
+
+
+
+
+
+
+
+
+
+
+
+ sort
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
@@ -11041,8 +12686,14 @@ include_totals
+
+
+
+
+
+
+
+
+ Boolean
+
+
+
+
+
Returns:
Example
- management.getUser({ id: USER_ID }, function (err, user) {
- console.log(user);
+ var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+
+management.getUserLogs(params, function (err, logs) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logs);
});Example
- getUserLogs(params, cbopt) → {Promise|undefined}
+ getUsers(paramsopt, cbopt) → {Promise|undefined}
getUserLog
Parameters:
+ <optional>
+
@@ -11168,7 +12821,7 @@ Parameters:
- Parameters:
Type
+ Attributes
+
@@ -11189,107 +12844,39 @@ Parameters:
-
-
-
-
-
- id
-
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
-
-
- per_page
-
-
-
-
-
-
-
-
- Number
-
-
-
-
-
-
-
-
-
+
page
-
-
-
-
-
-
-
-
- Number
-
-
-
-
-
-
-
@@ -11298,24 +12885,34 @@ sortper_page
-
+ String
+Number
+
+ <optional>
+
+
+
+
+
+
+
-
Parameters:
-
@@ -11410,14 +13007,20 @@ include_totalspage
-
+ Boolean
+Number
+
+ <optional>
+
+
+
+
+
+
+
-
Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-
-management.getUserLogs(params, function (err, logs) {
- if (err) {
- // Handle error.
- }
+ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
+};
- console.log(logs);
+auth0.getUsers(params, function (err, users) {
+ console.log(users.length);
});Example
- getUsers(paramsopt, cbopt) → {Promise|undefined}
+ getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
getUsersSource:
Parameters:
-
@@ -11732,18 +13236,12 @@ params
-
-
-
-
-
- Object
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
- per_page
-
-
-
-
-
- Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-pageemail
- Number
+String
@@ -11636,15 +13148,7 @@ Parameters:
-
- Returns:
Example
// Pagination settings.
-var params = {
- per_page: 10,
- page: 2
-};
-
-auth0.getUsers(params, function (err, users) {
- console.log(users.length);
+
@@ -11755,14 +13253,15 @@ auth0.getUsersByEmail(email, function (err, users) {
+ console.log(users);
});Example
- getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+ importUsers(data, cbopt) → {Promise|undefined}
getUse
Parameters:
-
@@ -11958,13 +13532,15 @@ emaildata
- String
+Object
@@ -11859,8 +13358,6 @@ Parameters:
- <optional>
-
@@ -11870,8 +13367,85 @@ Parameters:
-
-
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+ connectionId
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+users
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+ Returns:
Example
- auth0.getUsersByEmail(email, function (err, users) {
- console.log(users);
+ var params = {
+ connection_id: '{CONNECTION_ID}',
+ users: '{PATH_TO_USERS_FILE}'
+};
+
+management.get(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
});Example
- importUsers(data, cbopt) → {Promise|undefined}
+ linkUsers(userId, params, cbopt) → {Promise|undefined}
importUser
Parameters:
-
+
+
+
+ datauserId
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ params
@@ -12091,7 +13700,7 @@ Parameters:
- Parameters:
-
@@ -12143,7 +13752,7 @@ connectionIduser_id
@@ -12134,7 +13743,7 @@ Parameters:
-
Parameters:
-
@@ -12255,15 +13864,18 @@ usersconnection_id
@@ -12160,7 +13769,7 @@ Parameters:
-
Returns:
Example
- var params = {
- connection_id: '{CONNECTION_ID}',
- users: '{PATH_TO_USERS_FILE}'
+ var userId = 'USER_ID';
+var params = {
+ user_id: 'OTHER_USER_ID',
+ connection_id: 'CONNECTION_ID'
};
-management.get(params, function (err) {
+management.linkUsers(userId, params, function (err, user) {
if (err) {
// Handle error.
}
+
+ // Users linked.
});Example
- linkUsers(userId, params, cbopt) → {Promise|undefined}
+ sendEmailVerification(data, cbopt) → {Promise|undefined}
linkUsers
Parameters:
-
-
-
-
- userId
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- paramsdata
@@ -12423,7 +14001,7 @@ Parameters:
- Parameters:
-
-
-
-
@@ -12587,18 +14139,14 @@ connection_id
-
-
-
-
-
-
-
-
- String
-
-
-
-
-
Returns:
Example
- var userId = 'USER_ID';
-var params = {
- user_id: 'OTHER_USER_ID',
- connection_id: 'CONNECTION_ID'
+ var params = {
+ user_id: '{USER_ID}'
};
-management.linkUsers(userId, params, function (err, user) {
+management.sendEmailVerification(function (err) {
if (err) {
// Handle error.
}
-
- // Users linked.
});Example
- sendEmailVerification(data, cbopt) → {Promise|undefined}
+ setRulesConfig(params, data, cbopt) → {Promise|undefined}
Parameters:
+
+
+
+
+
+
params
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+key
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
dataParameters:
- Parameters:
-
@@ -12862,14 +14495,15 @@ user_idvalue
@@ -12767,7 +14400,7 @@ Parameters:
-
Returns:
Example
- var params = {
- user_id: '{USER_ID}'
-};
+ var params = { key: RULE_CONFIG_KEY };
+var data = { value: RULES_CONFIG_VALUE };
-management.sendEmailVerification(function (err) {
+management.setRulesConfig(params, data, function (err, rulesConfig) {
if (err) {
// Handle error.
}
+
+ // Rules Config set.
});unlinkUser
upda
updateCli
updat
Parameters:
- up
u
updateRule<
u
updateUser<
upd
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index e7a7a25ec..550fb0649 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
Returns:
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 2aa84c486..7c507c01e 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
deleteSource:
getSource:
Example
- getAll(cbopt) → {Promise|undefined}
+ getAll(paramsopt, cbopt) → {Promise|undefined}
@@ -1346,6 +1346,141 @@ Parameters:
+
+
+
+
+
+
params
+
+
+
+
+
+ Object
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ per_page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.resourceServers.getAll(function (err, resourceServers) {
+
@@ -1482,7 +1629,7 @@ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
+};
+
+management.resourceServers.getAll(params, function (err, resourceServers) {
console.log(resourceServers.length);
});updateSource:
Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index 7104caf06..3eec1b0be 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
Parameters:
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
new file mode 100644
index 000000000..befe42be7
--- /dev/null
+++ b/docs/module-management.RulesConfigsManager.html
@@ -0,0 +1,1326 @@
+
+
+
+
+
+ RulesConfigsManager
+
+
+
+
+
+
+
+
+ management.
+
+ RulesConfigsManager
+
+
+ Constructor
+
+
+ new RulesConfigsManager(options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+options
+
+
+
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ baseUrl
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ headers
+
+
+
+
+
+ Object
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+retry
+
+
+
+
+
+ Object
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+(inner) auth0RestClient :external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type:
+
+
+
+
+
+
+
+(inner) clientOptions :Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type:
+
+
+
+
+
+
+
+Methods
+
+
+
+delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ params
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+key
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+
+
+
+
+
+
+
+
+Example
+
+
+
+management.rulesConfigs.delete({ key: RULE_CONFIG_KEY }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Rules Config deleted.
+});getAll(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+
+
+
+
+
+
+
+
+Example
+
+
+
+management.rulesConfigs.getAll(function (err, rulesConfig) {
+ console.log(rulesConfig.length);
+});set(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ params
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+key
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+value
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+
+
+
+
+
+
+
+
+Example
+
+
+
+var params = { key: RULE_CONFIG_KEY };
+var data = { value: RULES_CONFIG_VALUE };
+
+management.rulesConfigs.set(params, data, function (err, rulesConfig) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Rules Config set.
+});
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 7b05c7f88..ec01820be 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
deleteSource:
getSource:
Example
- getAll(cbopt) → {Promise|undefined}
+ getAll(paramsopt, cbopt) → {Promise|undefined}
@@ -1342,6 +1342,141 @@ Parameters:
+
+
+
+
+
+
params
+
+
+
+
+
+ Object
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ per_page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -2159,7 +2159,7 @@ cbReturns:
Example
- management.rules.getAll(function (err, rules) {
+
@@ -1478,7 +1625,7 @@ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
+};
+
+management.rules.getAll(params, function (err, rules) {
console.log(rules.length);
});updateSource:
Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index e0d697018..3352f9484 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index ba6aad4e3..366cdfc78 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 02480d991..9a8dbf3df 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index e8dbd1de6..8b54ed544 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
Parameters:
-
Parameters:
-
@@ -2263,10 +2263,10 @@ Example
@@ -3283,7 +3283,7 @@ // Pagination settings.
var params = {
per_page: 10,
- page: 2
+ page: 0
};
-management.users.getAll(function (err, users) {
+management.users.getAll(params, function (err, users) {
console.log(users.length);
});Parameters:
-
@@ -3309,7 +3309,7 @@ Parameters:
-
@@ -4734,7 +4734,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 54dcb6bfe..f2f6fa3dc 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
Classes
Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index a3ea1a0cb..cce277c28 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
(static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index dccdc7239..bc514ecf9 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
utils.js
diff --git a/package.json b/package.json
index b0e7daf86..62f678001 100644
--- a/package.json
+++ b/package.json
@@ -1,11 +1,9 @@
{
"name": "auth0",
- "version": "2.10.0",
+ "version": "2.11.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
- "files": [
- "src"
- ],
+ "files": ["src"],
"scripts": {
"test": "mocha -R spec $(find ./test -name *.tests.js)",
"test:ci":
@@ -43,7 +41,7 @@
"codecov": "^2.2.0",
"husky": "^0.14.3",
"istanbul": "^0.4.0",
- "jsdoc": "^3.4.0",
+ "jsdoc": "^3.5.5",
"json-loader": "^0.5.4",
"minami": "^1.2.3",
"mocha": "^2.2.4",
diff --git a/yarn.lock b/yarn.lock
index 4877e816c..638ad7960 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -6,13 +6,7 @@ abbrev@1, abbrev@1.0.x:
version "1.0.9"
resolved "https://registry.yarnpkg.com/abbrev/-/abbrev-1.0.9.tgz#91b4792588a7738c25f35dd6f63752a2f8776135"
-acorn-jsx@^3.0.0:
- version "3.0.1"
- resolved "https://registry.yarnpkg.com/acorn-jsx/-/acorn-jsx-3.0.1.tgz#afdf9488fb1ecefc8348f6fb22f464e32a58b36b"
- dependencies:
- acorn "^3.0.4"
-
-acorn@^3.0.0, acorn@^3.0.4, acorn@^3.3.0:
+acorn@^3.0.0:
version "3.3.0"
resolved "https://registry.yarnpkg.com/acorn/-/acorn-3.3.0.tgz#45e37fb39e8da3f25baee3ff5369e2bb5f22017a"
@@ -175,6 +169,10 @@ aws4@^1.2.1, aws4@^1.6.0:
version "1.6.0"
resolved "https://registry.yarnpkg.com/aws4/-/aws4-1.6.0.tgz#83ef5ca860b2b32e4a0deedee8c771b9db57471e"
+babylon@7.0.0-beta.19:
+ version "7.0.0-beta.19"
+ resolved "https://registry.yarnpkg.com/babylon/-/babylon-7.0.0-beta.19.tgz#e928c7e807e970e0536b078ab3e0c48f9e052503"
+
balanced-match@^1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.0.tgz#89b4d199ab2bee49de164ea02b89ce462d71b767"
@@ -207,9 +205,9 @@ bluebird@^2.10.2:
version "2.11.0"
resolved "https://registry.yarnpkg.com/bluebird/-/bluebird-2.11.0.tgz#534b9033c022c9579c56ba3b3e5a5caafbb650e1"
-bluebird@~3.4.6:
- version "3.4.7"
- resolved "https://registry.yarnpkg.com/bluebird/-/bluebird-3.4.7.tgz#f72d760be09b7f76d08ed8fae98b289a8d05fab3"
+bluebird@~3.5.0:
+ version "3.5.1"
+ resolved "https://registry.yarnpkg.com/bluebird/-/bluebird-3.5.1.tgz#d9551f9de98f1fcda1e683d17ee91a0602ee2eb9"
boom@2.x.x:
version "2.10.1"
@@ -291,9 +289,9 @@ caseless@~0.12.0:
version "0.12.0"
resolved "https://registry.yarnpkg.com/caseless/-/caseless-0.12.0.tgz#1b681c21ff84033c826543090689420d187151dc"
-catharsis@~0.8.8:
- version "0.8.8"
- resolved "https://registry.yarnpkg.com/catharsis/-/catharsis-0.8.8.tgz#693479f43aac549d806bd73e924cd0d944951a06"
+catharsis@~0.8.9:
+ version "0.8.9"
+ resolved "https://registry.yarnpkg.com/catharsis/-/catharsis-0.8.9.tgz#98cc890ca652dd2ef0e70b37925310ff9e90fc8b"
dependencies:
underscore-contrib "~0.3.0"
@@ -680,13 +678,6 @@ escodegen@1.x.x:
optionalDependencies:
source-map "~0.5.6"
-espree@~3.1.7:
- version "3.1.7"
- resolved "https://registry.yarnpkg.com/espree/-/espree-3.1.7.tgz#fd5deec76a97a5120a9cd3a7cb1177a0923b11d2"
- dependencies:
- acorn "^3.3.0"
- acorn-jsx "^3.0.0"
-
esprima@2.7.x, esprima@^2.6.0, esprima@^2.7.1:
version "2.7.3"
resolved "https://registry.yarnpkg.com/esprima/-/esprima-2.7.3.tgz#96e3b70d5779f6ad49cd032673d1c312767ba581"
@@ -1306,24 +1297,26 @@ js-yaml@3.x:
argparse "^1.0.7"
esprima "^2.6.0"
-js2xmlparser@~1.0.0:
- version "1.0.0"
- resolved "https://registry.yarnpkg.com/js2xmlparser/-/js2xmlparser-1.0.0.tgz#5a170f2e8d6476ce45405e04823242513782fe30"
+js2xmlparser@~3.0.0:
+ version "3.0.0"
+ resolved "https://registry.yarnpkg.com/js2xmlparser/-/js2xmlparser-3.0.0.tgz#3fb60eaa089c5440f9319f51760ccd07e2499733"
+ dependencies:
+ xmlcreate "^1.0.1"
jsbn@~0.1.0:
version "0.1.1"
resolved "https://registry.yarnpkg.com/jsbn/-/jsbn-0.1.1.tgz#a5e654c2e5a2deb5f201d96cefbca80c0ef2f513"
-jsdoc@^3.4.0:
- version "3.4.3"
- resolved "https://registry.yarnpkg.com/jsdoc/-/jsdoc-3.4.3.tgz#e5740d6145c681f6679e6c17783a88dbdd97ccd3"
+jsdoc@^3.5.5:
+ version "3.5.5"
+ resolved "https://registry.yarnpkg.com/jsdoc/-/jsdoc-3.5.5.tgz#484521b126e81904d632ff83ec9aaa096708fa4d"
dependencies:
- bluebird "~3.4.6"
- catharsis "~0.8.8"
+ babylon "7.0.0-beta.19"
+ bluebird "~3.5.0"
+ catharsis "~0.8.9"
escape-string-regexp "~1.0.5"
- espree "~3.1.7"
- js2xmlparser "~1.0.0"
- klaw "~1.3.0"
+ js2xmlparser "~3.0.0"
+ klaw "~2.0.0"
marked "~0.3.6"
mkdirp "~0.5.1"
requizzle "~0.2.1"
@@ -1386,10 +1379,10 @@ kind-of@^4.0.0:
dependencies:
is-buffer "^1.1.5"
-klaw@~1.3.0:
- version "1.3.1"
- resolved "https://registry.yarnpkg.com/klaw/-/klaw-1.3.1.tgz#4088433b46b3b1ba259d78785d8e96f73ba02439"
- optionalDependencies:
+klaw@~2.0.0:
+ version "2.0.0"
+ resolved "https://registry.yarnpkg.com/klaw/-/klaw-2.0.0.tgz#59c128e0dc5ce410201151194eeb9cbf858650f6"
+ dependencies:
graceful-fs "^4.1.9"
lazy-cache@^1.0.3:
@@ -2766,6 +2759,10 @@ xml@^1.0.0:
version "1.0.1"
resolved "https://registry.yarnpkg.com/xml/-/xml-1.0.1.tgz#78ba72020029c5bc87b8a81a3cfcd74b4a2fc1e5"
+xmlcreate@^1.0.1:
+ version "1.0.2"
+ resolved "https://registry.yarnpkg.com/xmlcreate/-/xmlcreate-1.0.2.tgz#fa6bf762a60a413fb3dd8f4b03c5b269238d308f"
+
xregexp@2.0.0:
version "2.0.0"
resolved "https://registry.yarnpkg.com/xregexp/-/xregexp-2.0.0.tgz#52a63e56ca0b84a7f3a5f3d61872f126ad7a5943"