var retry = require('retry');
var ArgumentError = require('rest-facade').ArgumentError;
-var assign = Object.assign || require('object.assign');
-var DEFAULT_OPTIONS = { maxRetries: 10, enabled: true };
+var DEFAULT_OPTIONS = {
+ maxRetries: 3,
+ enabled: true,
+ randomize: true
+};
/**
* @class RetryRestClient
@@ -54,13 +57,14 @@ RetryRestClient.js
* @param {Object} [options] Options for the RetryRestClient.
* @param {Object} [options.enabled:true] Enabled or Disable Retry Policy functionality.
* @param {Number} [options.maxRetries=10] The maximum amount of times to retry the operation. Default is 10.
+ * @param {*} [options.*] Any options that are available in https://github.com/tim-kos/node-retry#retryoperationoptions
*/
var RetryRestClient = function(restClient, options) {
if (restClient === null || typeof restClient !== 'object') {
throw new ArgumentError('Must provide RestClient');
}
- var params = assign({}, DEFAULT_OPTIONS, options);
+ var params = Object.assign({}, DEFAULT_OPTIONS, options);
if (typeof params.enabled !== 'boolean') {
throw new ArgumentError('Must provide enabled boolean value');
@@ -71,8 +75,8 @@ RetryRestClient.js
}
this.restClient = restClient;
- this.maxRetries = params.maxRetries;
this.enabled = params.enabled;
+ this.retryOptions = Object.assign({ retries: params.maxRetries }, params);
};
RetryRestClient.prototype.getAll = function(/* [params], [callback] */) {
@@ -122,16 +126,9 @@ RetryRestClient.js
return this.restClient[method].apply(this.restClient, args);
}
- var retryOptions = {
- retries: this.maxRetries,
- factor: 1,
- minTimeout: 1, // retry immediate, use custom logic to control this.
- randomize: false
- };
-
var self = this;
- var promise = new Promise(function(resolve, reject) {
- var operation = retry.operation(retryOptions);
+ return new Promise(function(resolve, reject) {
+ var operation = retry.operation(self.retryOptions);
operation.attempt(function() {
self.restClient[method]
@@ -140,57 +137,13 @@ RetryRestClient.js
resolve(body);
})
.catch(function(err) {
- self.invokeRetry(err, operation, reject);
+ if (err && err.statusCode === 429 && operation.retry(err)) {
+ return;
+ }
+ reject(err);
});
});
});
-
- return promise;
-};
-
-RetryRestClient.prototype.invokeRetry = function(err, operation, reject) {
- var ratelimits = this.extractRatelimits(err);
- if (ratelimits) {
- var delay = ratelimits.reset * 1000 - new Date().getTime();
- if (delay > 0) {
- this.retryWithDelay(delay, operation, err, reject);
- } else {
- this.retryWithImmediate(operation, err, reject);
- }
- } else {
- reject(err);
- }
-};
-
-RetryRestClient.prototype.extractRatelimits = function(err) {
- if (err && err.statusCode === 429 && err.originalError && err.originalError.response) {
- var headers = err.originalError.response.header;
- if (headers && headers['x-ratelimit-limit']) {
- return {
- limit: headers['x-ratelimit-limit'],
- remaining: headers['x-ratelimit-remaining'],
- reset: headers['x-ratelimit-reset']
- };
- }
- }
-
- return;
-};
-
-RetryRestClient.prototype.retryWithImmediate = function(operation, err, reject) {
- if (operation.retry(err)) {
- return;
- }
- reject(err);
-};
-
-RetryRestClient.prototype.retryWithDelay = function(delay, operation, err, reject) {
- setTimeout(() => {
- if (operation.retry(err)) {
- return;
- }
- reject(err);
- }, delay);
};
module.exports = RetryRestClient;
@@ -206,7 +159,7 @@ RetryRestClient.js
diff --git a/docs/auth_DatabaseAuthenticator.js.html b/docs/auth_DatabaseAuthenticator.js.html
index 4169d79cd..84054ae50 100644
--- a/docs/auth_DatabaseAuthenticator.js.html
+++ b/docs/auth_DatabaseAuthenticator.js.html
@@ -348,7 +348,7 @@ auth/DatabaseAuthenticator.js
diff --git a/docs/auth_OAUthWithIDTokenValidation.js.html b/docs/auth_OAUthWithIDTokenValidation.js.html
index aad17517c..8dd7204bd 100644
--- a/docs/auth_OAUthWithIDTokenValidation.js.html
+++ b/docs/auth_OAUthWithIDTokenValidation.js.html
@@ -175,7 +175,7 @@ auth/OAUthWithIDTokenValidation.js
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html
index 7ff135611..b11803f8b 100644
--- a/docs/auth_OAuthAuthenticator.js.html
+++ b/docs/auth_OAuthAuthenticator.js.html
@@ -455,7 +455,7 @@ auth/OAuthAuthenticator.js
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html
index 82605d77a..fec91d017 100644
--- a/docs/auth_PasswordlessAuthenticator.js.html
+++ b/docs/auth_PasswordlessAuthenticator.js.html
@@ -290,7 +290,7 @@ auth/PasswordlessAuthenticator.js
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html
index 5f8bbb2d3..ef9d11300 100644
--- a/docs/auth_TokensManager.js.html
+++ b/docs/auth_TokensManager.js.html
@@ -226,7 +226,7 @@ auth/TokensManager.js
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html
index 0553607bf..8b0a3f85a 100644
--- a/docs/auth_UsersManager.js.html
+++ b/docs/auth_UsersManager.js.html
@@ -223,7 +223,7 @@ auth/UsersManager.js
diff --git a/docs/auth_idToken.js.html b/docs/auth_idToken.js.html
index 7678a90d8..a4d97eb9c 100644
--- a/docs/auth_idToken.js.html
+++ b/docs/auth_idToken.js.html
@@ -202,7 +202,7 @@ auth/idToken.js
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html
index 9bb4109d6..1d6bcad7c 100644
--- a/docs/auth_index.js.html
+++ b/docs/auth_index.js.html
@@ -45,7 +45,6 @@ auth/index.js
var utils = require('../utils');
var jsonToBase64 = utils.jsonToBase64;
var ArgumentError = require('rest-facade').ArgumentError;
-var assign = Object.assign || require('object.assign');
// Authenticators.
var OAuthAuthenticator = require('./OAuthAuthenticator');
@@ -105,7 +104,7 @@ auth/index.js
clientId: options.clientId,
domain: options.domain,
clientSecret: options.clientSecret,
- headers: assign(defaultHeaders, options.headers || {}),
+ headers: Object.assign(defaultHeaders, options.headers || {}),
baseUrl: util.format(BASE_URL_FORMAT, options.domain),
supportedAlgorithms: options.supportedAlgorithms,
__bypassIdTokenValidation: options.__bypassIdTokenValidation
@@ -616,7 +615,7 @@ auth/index.js
diff --git a/docs/errors.js.html b/docs/errors.js.html
index 84241046c..47cafa47d 100644
--- a/docs/errors.js.html
+++ b/docs/errors.js.html
@@ -111,7 +111,7 @@ errors.js
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html
index 9245e9cfe..89d3d4961 100644
--- a/docs/external-RestClient.html
+++ b/docs/external-RestClient.html
@@ -1639,7 +1639,7 @@
diff --git a/docs/global.html b/docs/global.html
index 760b8d6e5..238441a42 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -423,7 +423,7 @@ Returns:
diff --git a/docs/index.html b/docs/index.html
index 67b1a2e0c..4b50ba5b0 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -176,7 +176,7 @@ License
diff --git a/docs/index.js.html b/docs/index.js.html
index f3a7cabda..66aff9ef6 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -61,7 +61,7 @@ index.js
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html
index 45b17e58d..a7bdbebb5 100644
--- a/docs/management_BlacklistedTokensManager.js.html
+++ b/docs/management_BlacklistedTokensManager.js.html
@@ -153,7 +153,7 @@ management/BlacklistedTokensManager.js
diff --git a/docs/management_BrandingManager.js.html b/docs/management_BrandingManager.js.html
index a46e750d9..831cb634f 100644
--- a/docs/management_BrandingManager.js.html
+++ b/docs/management_BrandingManager.js.html
@@ -155,7 +155,7 @@ management/BrandingManager.js
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index c2935373a..f8f9fe4a3 100644
--- a/docs/management_ClientGrantsManager.js.html
+++ b/docs/management_ClientGrantsManager.js.html
@@ -216,7 +216,7 @@ management/ClientGrantsManager.js
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html
index 7ec033e57..d3ebc6af3 100644
--- a/docs/management_ClientsManager.js.html
+++ b/docs/management_ClientsManager.js.html
@@ -238,7 +238,7 @@ management/ClientsManager.js
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html
index 33c3252cc..dd27853f6 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -284,7 +284,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index 86fed6d7c..24a62dd45 100644
--- a/docs/management_CustomDomainsManager.js.html
+++ b/docs/management_CustomDomainsManager.js.html
@@ -241,7 +241,7 @@ management/CustomDomainsManager.js
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
index c90c981a9..8db772246 100644
--- a/docs/management_DeviceCredentialsManager.js.html
+++ b/docs/management_DeviceCredentialsManager.js.html
@@ -180,7 +180,7 @@ management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
index ccd0bb31d..02c10e4b7 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -198,7 +198,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index 9f2ed86de..d13675960 100644
--- a/docs/management_EmailTemplatesManager.js.html
+++ b/docs/management_EmailTemplatesManager.js.html
@@ -180,7 +180,7 @@ management/EmailTemplatesManager.js
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html
index 47043ef2e..5d29d57da 100644
--- a/docs/management_GrantsManager.js.html
+++ b/docs/management_GrantsManager.js.html
@@ -170,7 +170,7 @@ management/GrantsManager.js
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index 314147d7b..9bce8eaff 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -508,7 +508,7 @@ management/GuardianManager.js
diff --git a/docs/management_HooksManager.js.html b/docs/management_HooksManager.js.html
index a95599d37..7a1e99c99 100644
--- a/docs/management_HooksManager.js.html
+++ b/docs/management_HooksManager.js.html
@@ -419,7 +419,7 @@ management/HooksManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 0366d2afb..431f8bea0 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -165,42 +165,7 @@ management/JobsManager.js
return this.jobs.get(params);
};
-/**
- * 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
- * connection.
- * @deprecated since version 2.26. It will be deleted in version 3.0.
- *
- * @method importUsers
- * @memberOf module:management.JobsManager.prototype
- *
- * @example
- * var params = {
- * connection_id: '{CONNECTION_ID}',
- * users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}'
- * };
- *
- * management.jobs.importUsers(params, function (err) {
- * if (err) {
- * // Handle error.
- * }
- * });
- *
- * @param {Object} data Users import data.
- * @param {String} data.connection_id connection_id of the connection to which users will be imported.
- * @param {String} [data.users] Path to the users data file. Either users or users_json is mandatory.
- * @param {String} [data.users_json] JSON data for the users.
- * @param {Boolean} [data.upsert] Whether to update users if they already exist (true) or to ignore them (false).
- * @param {Boolean} [data.send_completion_email] Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
- * @param {Function} [cb] Callback function.
- *
- * @return {Promise|undefined}
- */
-JobsManager.prototype.importUsers = function(data, cb) {
- console.warn(
- '"importUsers" has been deprecated as it was inconsistent with the API. Please, use "importUsersJob" which returns the response data directly.'
- );
-
+JobsManager.prototype._importUsers = function(data, cb) {
var options = this.options;
var url = options.baseUrl + '/jobs/users-imports';
var userData = data.users_json ? Buffer.from(data.users_json) : fs.createReadStream(data.users);
@@ -244,6 +209,44 @@ management/JobsManager.js
return promise;
};
+/**
+ * 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
+ * connection.
+ * @deprecated since version 2.26. It will be deleted in version 3.0.
+ *
+ * @method importUsers
+ * @memberOf module:management.JobsManager.prototype
+ *
+ * @example
+ * var params = {
+ * connection_id: '{CONNECTION_ID}',
+ * users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}'
+ * };
+ *
+ * management.jobs.importUsers(params, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ * });
+ *
+ * @param {Object} data Users import data.
+ * @param {String} data.connection_id connection_id of the connection to which users will be imported.
+ * @param {String} [data.users] Path to the users data file. Either users or users_json is mandatory.
+ * @param {String} [data.users_json] JSON data for the users.
+ * @param {Boolean} [data.upsert] Whether to update users if they already exist (true) or to ignore them (false).
+ * @param {Boolean} [data.send_completion_email] Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+JobsManager.prototype.importUsers = function(data, cb) {
+ console.warn(
+ '"importUsers" has been deprecated as it was inconsistent with the API. Please, use "importUsersJob" which returns the response data directly.'
+ );
+ return this._importUsers(data, cb);
+};
+
/**
* 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
@@ -275,7 +278,7 @@ management/JobsManager.js
* @return {Promise|undefined}
*/
JobsManager.prototype.importUsersJob = function(data, cb) {
- var promise = this.importUsers(data).then(response => response.data);
+ var promise = this._importUsers(data).then(response => response.data);
// Don't return a promise if a callback was given.
if (cb && cb instanceof Function) {
@@ -402,6 +405,10 @@ management/JobsManager.js
*
* @param {Object} data User data object.
* @param {String} data.user_id ID of the user to be verified.
+ * @param {String} [data.client_id] client_id of the client (application). If no value provided, the global Client ID will be used.
+ * @param {Object} [data.identity] Used to verify secondary, federated, and passwordless-email identities.
+ * @param {String} data.identity.user_id user_id of the identity.
+ * @param {String} data.identity.provider provider of the identity.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
@@ -432,7 +439,7 @@ management/JobsManager.js
diff --git a/docs/management_LogStreamsManager.js.html b/docs/management_LogStreamsManager.js.html
index 227b06de3..de7347290 100644
--- a/docs/management_LogStreamsManager.js.html
+++ b/docs/management_LogStreamsManager.js.html
@@ -230,7 +230,7 @@ management/LogStreamsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 1a930eac7..626a5a812 100644
--- a/docs/management_LogsManager.js.html
+++ b/docs/management_LogsManager.js.html
@@ -165,7 +165,7 @@ management/LogsManager.js
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html
index ac4eab2b2..0232d94eb 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -40,7 +40,6 @@ management/ManagementTokenProvider.js
var ArgumentError = require('rest-facade').ArgumentError;
-var assign = Object.assign || require('object.assign');
var AuthenticationClient = require('../auth');
var memoizer = require('lru-memoizer');
var es6Promisify = require('es6-promisify');
@@ -61,13 +60,15 @@ management/ManagementTokenProvider.js
* @param {String} options.audience Audience of the Management API.
* @param {Boolean} [options.enableCache=true] Enabled or Disable Cache
* @param {Number} [options.cacheTTLInSeconds] By default the `expires_in` value will be used to determine the cached time of the token, this can be overridden.
+ * @param {Object} [options.headers] Additional headers that will be added to the outgoing requests.
+ *
*/
var ManagementTokenProvider = function(options) {
if (!options || typeof options !== 'object') {
throw new ArgumentError('Options must be an object');
}
- var params = assign({}, DEFAULT_OPTIONS, options);
+ var params = Object.assign({}, DEFAULT_OPTIONS, options);
if (!params.domain || params.domain.length === 0) {
throw new ArgumentError('Must provide a domain');
@@ -109,7 +110,8 @@ management/ManagementTokenProvider.js
clientId: this.options.clientId,
clientSecret: this.options.clientSecret,
telemetry: this.options.telemetry,
- clientInfo: this.options.clientInfo
+ clientInfo: this.options.clientInfo,
+ headers: this.options.headers
};
this.authenticationClient = new AuthenticationClient(authenticationClientOptions);
@@ -192,7 +194,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_MigrationsManager.js.html b/docs/management_MigrationsManager.js.html
index 49e7de1e7..83f7d1029 100644
--- a/docs/management_MigrationsManager.js.html
+++ b/docs/management_MigrationsManager.js.html
@@ -159,7 +159,7 @@ management/MigrationsManager.js
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html
index 3bc2b1e38..2b47677be 100644
--- a/docs/management_PromptsManager.js.html
+++ b/docs/management_PromptsManager.js.html
@@ -261,7 +261,7 @@ management/PromptsManager.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index 81b7a795e..6fa45197d 100644
--- a/docs/management_ResourceServersManager.js.html
+++ b/docs/management_ResourceServersManager.js.html
@@ -238,7 +238,7 @@ management/ResourceServersManager.js
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html
index 3bac3c50b..6ea81f448 100644
--- a/docs/management_RolesManager.js.html
+++ b/docs/management_RolesManager.js.html
@@ -460,7 +460,7 @@ management/RolesManager.js
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index e93108762..83ada3db8 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -180,7 +180,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 9189afd7b..1c67c6588 100644
--- a/docs/management_RulesManager.js.html
+++ b/docs/management_RulesManager.js.html
@@ -248,7 +248,7 @@ management/RulesManager.js
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html
index c2eab9e2f..9973a2c3d 100644
--- a/docs/management_StatsManager.js.html
+++ b/docs/management_StatsManager.js.html
@@ -174,7 +174,7 @@ management/StatsManager.js
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html
index 4906cb06f..2f309905e 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -166,7 +166,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index d4433cc16..3f5c4b379 100644
--- a/docs/management_TicketsManager.js.html
+++ b/docs/management_TicketsManager.js.html
@@ -139,6 +139,14 @@ management/TicketsManager.js
* }
* });
*
+ * @param {Object} data
+ * @param {String} [data.result_url] URL the user will be redirected to once ticket is used.
+ * @param {String} data.user_id user_id for whom the ticket should be created.
+ * @param {Integer} [data.ttl_sec] Number of seconds for which the ticket is valid before expiration.
+ * @param {Boolean} [data.includeEmailInRedirect] Whether to include the email address as part of the result_url (true), or not (false).
+ * @param {Object} [data.identity] Used to verify secondary, federated, and passwordless-email identities.
+ * @param {String} data.identity.user_id user_id of the identity.
+ * @param {String} data.identity.provider provider of the identity.
* @param {Function} [cb] Callback function.
* @return {Promise}
*/
@@ -166,7 +174,7 @@ management/TicketsManager.js
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html
index 83ebc0464..9eeab6dc4 100644
--- a/docs/management_UserBlocksManager.js.html
+++ b/docs/management_UserBlocksManager.js.html
@@ -229,7 +229,7 @@ management/UserBlocksManager.js
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html
index 84faf8eeb..c134e3184 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -975,7 +975,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index fe0d7df09..49e36799c 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -46,7 +46,6 @@ management/index.js
var jsonToBase64 = utils.jsonToBase64;
var generateClientInfo = utils.generateClientInfo;
var ArgumentError = require('rest-facade').ArgumentError;
-var assign = Object.assign || require('object.assign');
// Managers.
var ClientsManager = require('./ClientsManager');
@@ -155,12 +154,12 @@ management/index.js
};
var managerOptions = {
- headers: assign(defaultHeaders, options.headers || {}),
+ headers: Object.assign(defaultHeaders, options.headers || {}),
baseUrl: baseUrl
};
if (options.token === undefined) {
- var config = assign(
+ var config = Object.assign(
{ audience: util.format(MANAGEMENT_API_AUD_FORMAT, options.domain) },
options
);
@@ -3716,7 +3715,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 27fbffb99..9c53e80a7 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -103,7 +103,7 @@ n
Source:
databaseSource:
oauthSource:
passwordl
Source:
tokensSource:
usersSource:
changeP
Source:
Source:
get
Source:
getProfile<
Source:
password
Source:
refreshTo
Source:
Source:
reque
Source:
reque
Source:
request
Source:
verifySM
Source:
Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index 0323c027b..40ef33056 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -1765,7 +1765,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index 3e6cc617b..f785180e9 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -450,7 +450,7 @@ Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 2b8ec9516..b7dbfcb1e 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -2050,7 +2050,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 8188ddb74..2e39b07c9 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -1442,7 +1442,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index aa2a9dd5a..043c6e8e2 100644
--- a/docs/module-auth.TokensManager.html
+++ b/docs/module-auth.TokensManager.html
@@ -352,7 +352,7 @@ Parameters:
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html
index 9d052ed04..92c1014cf 100644
--- a/docs/module-auth.UsersManager.html
+++ b/docs/module-auth.UsersManager.html
@@ -1009,7 +1009,7 @@ Example
diff --git a/docs/module-auth.html b/docs/module-auth.html
index d9b6ddd08..346bec813 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -108,7 +108,7 @@ Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html
index 87c7b942e..270f48ad5 100644
--- a/docs/module-errors.html
+++ b/docs/module-errors.html
@@ -254,7 +254,7 @@ (st
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 32829ab33..2586666da 100644
--- a/docs/module-management.BlacklistedTokensManager.html
+++ b/docs/module-management.BlacklistedTokensManager.html
@@ -991,7 +991,7 @@ Example
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html
index 311700e18..d85fa4d96 100644
--- a/docs/module-management.BrandingManager.html
+++ b/docs/module-management.BrandingManager.html
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index bab6cdb62..d2bd4d7ea 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -1636,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 9a1754e3f..5cb200099 100644
--- a/docs/module-management.ClientsManager.html
+++ b/docs/module-management.ClientsManager.html
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
index 90ae2d42a..e910d7ce5 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -2269,7 +2269,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 717f43735..6d79cf133 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -1731,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index a782aade3..610f8cb50 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -1215,7 +1215,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 8c31e79a6..be1aee0ca 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -1480,7 +1480,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index fb4eb3ca6..b447bd49a 100644
--- a/docs/module-management.EmailTemplatesManager.html
+++ b/docs/module-management.EmailTemplatesManager.html
@@ -1304,7 +1304,7 @@ Example
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html
index e9e9b9705..7c2cb7236 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -842,7 +842,7 @@ deleteGran
Source:
Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index cc6f98c08..ecd70a11e 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -4415,7 +4415,7 @@ Example
diff --git a/docs/module-management.HooksManager.html b/docs/module-management.HooksManager.html
index 7efda891d..864e70a74 100644
--- a/docs/module-management.HooksManager.html
+++ b/docs/module-management.HooksManager.html
@@ -3099,7 +3099,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 92019d6f5..c91bc784c 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -616,7 +616,7 @@ errorsSource:
exportUser
Source:
importUser
Source:
importU
Source:
verifyEmai
Source:
Parameters:
Type
+ Attributes
+
@@ -2546,6 +2548,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -2556,6 +2566,155 @@ Parameters:
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ client_id of the client (application). If no value provided, the global Client ID will be used.
+
+
+
+
+
+
+
+
+ identity
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Used to verify secondary, federated, and passwordless-email identities.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ user_id of the identity.
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ provider of the identity.
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -2676,7 +2835,7 @@ Example
diff --git a/docs/module-management.LogStreamsManager.html b/docs/module-management.LogStreamsManager.html
index 9bd1fb796..97e865ebe 100644
--- a/docs/module-management.LogStreamsManager.html
+++ b/docs/module-management.LogStreamsManager.html
@@ -1763,7 +1763,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index 80aa4cf03..eb30d022d 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -1286,7 +1286,7 @@ Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index eb4b83b88..912ee10ff 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -106,7 +106,7 @@ new M
Source:
blac
Source:
brandingSource:
clientGra
Source:
clientsSource:
connection
Source:
customDo
Source:
devi
Source:
emailPro
Source:
emailTe
Source:
grantsSource:
guardianSource:
hooksSource:
jobsSource:
logsSource:
logStreams<
Source:
migrations<
Source:
promptsSource:
resour
Source:
rolesSource:
rulesSource:
rulesConf
Source:
statsSource:
tenantSource:
ticketsSource:
userBlocks<
Source:
usersSource:
addHookS
Source:
a
Source:
Source:
assi
Source:
blackli
Source:
Source:
createCli
Source:
crea
Source:
creat
Source:
cre
Source:
Source:
cr
Source:
Source:
Source:
createHook<
Source:
create
Source:
Source:
c
Source:
createRole<
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
delete
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Source:
get
Source:
Source:
Source:
Source:
ge
Source:
getHookSource:
getHooksSource:
getHook
Source:
getJobSource:
getLogSource:
getLogsSource:
getLogStr
Source:
getMigra
Source:
g
Source:
get
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRuleSource:
getRulesSource:
getRul
Source:
getT
Source:
getUserSource:
getUserB
Source:
Source:
getUserLog
Source:
get
Source:
getUserRo
Source:
getUsersSource:
getUse
Source:
getUser
Source:
importUser
Source:
Source:
linkUsersSource:
Source:
remo
Source:
Source:
Source:
re
Source:
Source:
setRule
Source:
unblockUse
Source:
unblockUse
Source:
unlinkUser
Source:
upda
Source:
Source:
updateCli
Source:
upda
Source:
updat
Source:
up
Source:
u
Source:
u
Source:
u
Source:
Source:
Source:
Source:
Source:
updateHook<
Source:
upda
Source:
update
Source:
updat
Source:
Source:
u
Source:
updateRole<
Source:
updateRule<
Source:
u
Source:
updateUser<
Source:
upd
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index c543e4b39..1ecffb14d 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -102,7 +102,7 @@ Source:
Parameters:
+
+
+
+ headers
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Additional headers that will be added to the outgoing requests.
+
+
+
+
+
@@ -556,7 +596,7 @@ getAcce
Source:
Returns:
diff --git a/docs/module-management.MigrationsManager.html b/docs/module-management.MigrationsManager.html
index 3354dd565..0b23f132f 100644
--- a/docs/module-management.MigrationsManager.html
+++ b/docs/module-management.MigrationsManager.html
@@ -885,7 +885,7 @@ Example
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index 82d7f1e73..3f138980e 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -839,7 +839,7 @@ Source:
Source:
Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index db59be4cf..95cd38f4a 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index b2f5123f7..cdce49551 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -102,7 +102,7 @@ new Re
Source:
Parameters:
+
+
+
+ *
+
+
+*
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Any options that are available in https://github.com/tim-kos/node-retry#retryoperationoptions
+
+
+
+
+
@@ -377,7 +417,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index e9c74614b..9a79e8a0c 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -4293,7 +4293,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 7b10a6545..43e19e470 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 29c6f4f7b..0ff68b398 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 600993f09..085ad162d 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index 8b40dcbeb..f13494488 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index b0ed45e73..4626a6fb3 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -609,7 +609,7 @@ Example
- verifyEmail(cbopt) → {Promise}
+ verifyEmail(data, cbopt) → {Promise}
@@ -696,6 +696,322 @@ Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ result_url
+
+
+