RetryRestClient.js
diff --git a/docs/auth_DatabaseAuthenticator.js.html b/docs/auth_DatabaseAuthenticator.js.html index 1eb4a712c..78562fd6f 100644 --- a/docs/auth_DatabaseAuthenticator.js.html +++ b/docs/auth_DatabaseAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -287,7 +287,8 @@
diff --git a/docs/auth_OAUthWithIDTokenValidation.js.html b/docs/auth_OAUthWithIDTokenValidation.js.html index 246ffd73b..e8bf02cfe 100644 --- a/docs/auth_OAUthWithIDTokenValidation.js.html +++ b/docs/auth_OAUthWithIDTokenValidation.js.html @@ -24,7 +24,7 @@
auth/DatabaseAuthenticator.js
* * var data = { * email: '{EMAIL}', - * connection: 'Username-Password-Authentication' + * connection: 'Username-Password-Authentication', + * client_id: 'OS1VzKTVjizL0VCc9Hx2ae2aTPXWy6BD' * }; * * auth0.database.requestChangePasswordEmail(data, function (err, message) { @@ -301,6 +302,7 @@auth/DatabaseAuthenticator.js
* @param {Object} data User credentials object. * @param {String} data.email User email address. * @param {String} data.connection Identity provider in use. + * @param {String} data.client_id Client ID of the Application requesting the password change, to be included in the email template. * @param {Function} [cb] Method callback. * * @return {Promise|undefined} @@ -346,7 +348,7 @@auth/DatabaseAuthenticator.js
diff --git a/docs/auth_OAUthWithIDTokenValidation.js.html b/docs/auth_OAUthWithIDTokenValidation.js.html index 246ffd73b..e8bf02cfe 100644 --- a/docs/auth_OAUthWithIDTokenValidation.js.html +++ b/docs/auth_OAUthWithIDTokenValidation.js.html @@ -24,7 +24,7 @@
@@ -176,7 +176,7 @@
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html index 0992b4e6c..43a35860d 100644 --- a/docs/auth_OAuthAuthenticator.js.html +++ b/docs/auth_OAuthAuthenticator.js.html @@ -24,7 +24,7 @@
auth/OAUthWithIDTokenValidation.js
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html index 0992b4e6c..43a35860d 100644 --- a/docs/auth_OAuthAuthenticator.js.html +++ b/docs/auth_OAuthAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -455,7 +455,7 @@
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html index 4599ae9e5..48e468483 100644 --- a/docs/auth_PasswordlessAuthenticator.js.html +++ b/docs/auth_PasswordlessAuthenticator.js.html @@ -24,7 +24,7 @@
auth/OAuthAuthenticator.js
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html index 4599ae9e5..48e468483 100644 --- a/docs/auth_PasswordlessAuthenticator.js.html +++ b/docs/auth_PasswordlessAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -290,7 +290,7 @@
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html index 67ee6414e..8ca8fa23e 100644 --- a/docs/auth_TokensManager.js.html +++ b/docs/auth_TokensManager.js.html @@ -24,7 +24,7 @@
auth/PasswordlessAuthenticator.js
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html index 67ee6414e..8ca8fa23e 100644 --- a/docs/auth_TokensManager.js.html +++ b/docs/auth_TokensManager.js.html @@ -24,7 +24,7 @@
@@ -226,7 +226,7 @@
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html index d7c425523..599c3cb7e 100644 --- a/docs/auth_UsersManager.js.html +++ b/docs/auth_UsersManager.js.html @@ -24,7 +24,7 @@
auth/TokensManager.js
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html index d7c425523..599c3cb7e 100644 --- a/docs/auth_UsersManager.js.html +++ b/docs/auth_UsersManager.js.html @@ -24,7 +24,7 @@
@@ -223,7 +223,7 @@
diff --git a/docs/auth_idToken.js.html b/docs/auth_idToken.js.html index a9d69ab24..ef2bfa39e 100644 --- a/docs/auth_idToken.js.html +++ b/docs/auth_idToken.js.html @@ -24,7 +24,7 @@
auth/UsersManager.js
diff --git a/docs/auth_idToken.js.html b/docs/auth_idToken.js.html index a9d69ab24..ef2bfa39e 100644 --- a/docs/auth_idToken.js.html +++ b/docs/auth_idToken.js.html @@ -24,7 +24,7 @@
@@ -202,7 +202,7 @@
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html index 909f2ff0e..49a38a2c6 100644 --- a/docs/auth_index.js.html +++ b/docs/auth_index.js.html @@ -24,7 +24,7 @@
auth/idToken.js
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html index 909f2ff0e..49a38a2c6 100644 --- a/docs/auth_index.js.html +++ b/docs/auth_index.js.html @@ -24,7 +24,7 @@
@@ -183,9 +183,10 @@
diff --git a/docs/errors.js.html b/docs/errors.js.html index 1157f5f68..6edf5d72f 100644 --- a/docs/errors.js.html +++ b/docs/errors.js.html @@ -24,7 +24,7 @@
auth/index.js
* } * }; * - * @param {Object} data User data object. - * @param {String} data.email User email address. - * @param {Object} [data.authParams] Authentication parameters. + * @param {Object} data User data object. + * @param {String} data.email User email address. + * @param {Object} [data.authParams] Authentication parameters. + * @param {Function} [cb] Method callback. * * @return {Promise|undefined} */ @@ -221,9 +222,10 @@auth/index.js
* } * }; * - * @param {Object} data User data object. - * @param {String} data.email User email address. - * @param {Object} [data.authParams] Authentication parameters. + * @param {Object} data User data object. + * @param {String} data.email User email address. + * @param {Object} [data.authParams] Authentication parameters. + * @param {Function} [cb] Method callback. * * @return {Promise|undefined} */ @@ -257,8 +259,9 @@auth/index.js
* * }); * - * @param {Object} data User data object. - * @param {String} data.phone_number The user phone number. + * @param {Object} data User data object. + * @param {String} data.phone_number The user phone number. + * @param {Function} [cb] Method callback. * * @return {Promise|undefined} */ @@ -303,11 +306,12 @@auth/index.js
* token_type: String * } * - * @param {Object} data Credentials object. - * @param {String} data.username Phone number. - * @param {String} data.password Verification code. - * @param {String} data.target Target client ID. - * @param {String} data.grant_type Grant type. + * @param {Object} data Credentials object. + * @param {String} data.username Phone number. + * @param {String} data.password Verification code. + * @param {String} data.target Target client ID. + * @param {String} data.grant_type Grant type. + * @param {Function} [cb] Method callback. * * @return {Promise|undefined} */ @@ -350,11 +354,12 @@auth/index.js
* console.log(token); * }); * - * @param {Object} data Token data object. - * @param {String} data.id_token The user ID token. - * @param {String} data.api_type The API type (aws, firebase, etc). - * @param {String} data.target The target client ID. - * @param {String} data.grant_type The grant type. + * @param {Object} data Token data object. + * @param {String} data.id_token The user ID token. + * @param {String} data.api_type The API type (aws, firebase, etc). + * @param {String} data.target The target client ID. + * @param {String} data.grant_type The grant type. + * @param {Function} [cb] Method callback. * * @return {Promise|undefined} */ @@ -403,6 +408,7 @@auth/index.js
* @param {String} data.email User email. * @param {String} data.password User password. * @param {String} data.connection Identity provider for the user. + * @param {Function} [cb] Method callback. * * @return {Promise|undefined} */ @@ -432,7 +438,8 @@auth/index.js
* * var data = { * email: '{EMAIL}', - * connection: 'Username-Password-Authentication' + * connection: 'Username-Password-Authentication', + * client_id: 'OS1VzKTVjizL0VCc9Hx2ae2aTPXWy6BD' * }; * * auth0.requestChangePasswordEmail(data, function (err, message) { @@ -446,6 +453,8 @@auth/index.js
* @param {Object} data User data object. * @param {String} data.email User email. * @param {String} data.connection Identity provider for the user. + * @param {String} data.client_id Client ID of the Application requesting the password change, to be included in the email template. + * @param {Function} [cb] Method callback. * * @return {Promise|undefined} */ @@ -607,7 +616,7 @@auth/index.js
diff --git a/docs/errors.js.html b/docs/errors.js.html index 1157f5f68..6edf5d72f 100644 --- a/docs/errors.js.html +++ b/docs/errors.js.html @@ -24,7 +24,7 @@
@@ -98,7 +98,7 @@
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html index dd190722d..3930cff30 100644 --- a/docs/external-RestClient.html +++ b/docs/external-RestClient.html @@ -24,7 +24,7 @@
errors.js
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html index dd190722d..3930cff30 100644 --- a/docs/external-RestClient.html +++ b/docs/external-RestClient.html @@ -24,7 +24,7 @@
@@ -1639,7 +1639,7 @@
diff --git a/docs/global.html b/docs/global.html
index e4faad115..bb94f4083 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -24,7 +24,7 @@
@@ -423,7 +423,7 @@ Returns:
diff --git a/docs/index.html b/docs/index.html
index 2c0fbab2c..768f89694 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ License
diff --git a/docs/index.js.html b/docs/index.js.html
index c726e7c30..5bb5b704e 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 3bba0c6ae..565a071bb 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_BrandingManager.js.html b/docs/management_BrandingManager.js.html
index 6ccc7f99d..f532a24db 100644
--- a/docs/management_BrandingManager.js.html
+++ b/docs/management_BrandingManager.js.html
@@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@ management/BrandingManager.js
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index 66ebcaf8d..1cea85dd3 100644
--- a/docs/management_ClientGrantsManager.js.html
+++ b/docs/management_ClientGrantsManager.js.html
@@ -24,7 +24,7 @@
@@ -216,7 +216,7 @@ management/ClientGrantsManager.js
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html
index 574b6df52..e464f8b7b 100644
--- a/docs/management_ClientsManager.js.html
+++ b/docs/management_ClientsManager.js.html
@@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@ management/ClientsManager.js
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html
index 1785ebd79..4ebb02ff7 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index 5e40816ba..4bac7dbf5 100644
--- a/docs/management_CustomDomainsManager.js.html
+++ b/docs/management_CustomDomainsManager.js.html
@@ -24,7 +24,7 @@
@@ -241,7 +241,7 @@ management/CustomDomainsManager.js
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
index 332312a75..53e57c86a 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 b6c2939f7..dc419b218 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -198,7 +198,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index 5b6d8041d..ebc3cd703 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_GrantsManager.js.html b/docs/management_GrantsManager.js.html
index 38918cae6..ce44bde42 100644
--- a/docs/management_GrantsManager.js.html
+++ b/docs/management_GrantsManager.js.html
@@ -24,7 +24,7 @@
@@ -170,7 +170,7 @@ management/GrantsManager.js
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index bada1185d..118ac3d2f 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_HooksManager.js.html b/docs/management_HooksManager.js.html
index 45ea863e6..ecdf7d6dc 100644
--- a/docs/management_HooksManager.js.html
+++ b/docs/management_HooksManager.js.html
@@ -24,7 +24,7 @@
@@ -419,7 +419,7 @@ management/HooksManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index c8bcc2891..c9177f7bc 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -170,6 +170,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
* connection.
+ * @deprecated since version 2.26. It will be deleted in version 3.0.
*
* @method importUsers
* @memberOf module:management.JobsManager.prototype
@@ -197,6 +198,10 @@ management/JobsManager.js
* @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.'
+ );
+
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);
@@ -240,6 +245,49 @@ 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.
+ *
+ * @method importUsersJob
+ * @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.importUsersJob = function(data, cb) {
+ var promise = this.importUsers(data).then(response => response.data);
+
+ // Don't return a promise if a callback was given.
+ if (cb && cb instanceof Function) {
+ promise.then(cb.bind(null, null)).catch(cb);
+
+ return;
+ }
+
+ return promise;
+};
+
/**
* Export all users to a file using a long running job.
*
@@ -385,7 +433,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 3fad92701..8a4bceca0 100644
--- a/docs/management_LogsManager.js.html
+++ b/docs/management_LogsManager.js.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ management/LogsManager.js
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html
index 17b94cf82..72b15b63e 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -192,7 +192,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html
index 86793a3c5..b18c1a38f 100644
--- a/docs/management_PromptsManager.js.html
+++ b/docs/management_PromptsManager.js.html
@@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@ management/PromptsManager.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index bc3257289..e1b3ec326 100644
--- a/docs/management_ResourceServersManager.js.html
+++ b/docs/management_ResourceServersManager.js.html
@@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@ management/ResourceServersManager.js
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html
index e085f3f6b..80cc164c7 100644
--- a/docs/management_RolesManager.js.html
+++ b/docs/management_RolesManager.js.html
@@ -24,7 +24,7 @@
@@ -460,7 +460,7 @@ management/RolesManager.js
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index 8764ef024..acb2b2484 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index e5eec72b8..de0cea670 100644
--- a/docs/management_RulesManager.js.html
+++ b/docs/management_RulesManager.js.html
@@ -24,7 +24,7 @@
@@ -248,7 +248,7 @@ management/RulesManager.js
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html
index d55989619..172d03431 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 e5b506919..27f725980 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index 9afd9efc3..56ce24fd8 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_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html
index ad79a8aa9..c08308c17 100644
--- a/docs/management_UserBlocksManager.js.html
+++ b/docs/management_UserBlocksManager.js.html
@@ -24,7 +24,7 @@
@@ -229,7 +229,7 @@ management/UserBlocksManager.js
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html
index 8d32d91c5..8841c2eec 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -927,7 +927,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index b033c41f5..7e588c5eb 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -3260,7 +3260,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 4d4095ed3..c4319b5ee 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -845,7 +845,7 @@ Methods
- changePassword(data) → {Promise|undefined}
+ changePassword(data, cbopt) → {Promise|undefined}
@@ -888,7 +888,7 @@ changeP
Source:
Parameters:
Type
+ Attributes
+
@@ -945,6 +947,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -1058,6 +1068,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -1178,7 +1224,7 @@ Source:
Example
- getDelegationToken(data) → {Promise|undefined}
+ getDelegationToken(data, cbopt) → {Promise|undefined}
@@ -1458,7 +1504,7 @@ get
Source:
Parameters:
Type
+ Attributes
+
@@ -1515,6 +1563,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -1654,6 +1710,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -1774,7 +1866,7 @@ getProfile<
Source:
password
Source:
refreshTo
Source:
Example
- requestChangePasswordEmail(data) → {Promise|undefined}
+ requestChangePasswordEmail(data, cbopt) → {Promise|undefined}
@@ -2510,7 +2602,7 @@ Source:
Parameters:
Type
+ Attributes
+
@@ -2567,6 +2661,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -2646,6 +2748,32 @@ Parameters:
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Client ID of the Application requesting the password change, to be included in the email template.
+
+
+
+
+
@@ -2654,6 +2782,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -2709,7 +2873,8 @@ Example
var data = {
email: '{EMAIL}',
- connection: 'Username-Password-Authentication'
+ connection: 'Username-Password-Authentication',
+ client_id: 'OS1VzKTVjizL0VCc9Hx2ae2aTPXWy6BD'
};
auth0.requestChangePasswordEmail(data, function (err, message) {
@@ -2729,7 +2894,7 @@ Example
- requestEmailCode(data) → {Promise|undefined}
+ requestEmailCode(data, cbopt) → {Promise|undefined}
@@ -2772,7 +2937,7 @@ reque
Source:
Parameters:
Type
+ Attributes
+
@@ -2829,6 +2996,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -2936,6 +3111,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3010,7 +3221,7 @@ Example
- requestMagicLink(data) → {Promise|undefined}
+ requestMagicLink(data, cbopt) → {Promise|undefined}
@@ -3085,6 +3296,8 @@ Parameters:
Type
+ Attributes
+
@@ -3110,6 +3323,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -3217,6 +3438,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3293,7 +3550,7 @@ Example
- requestSMSCode(data) → {Promise|undefined}
+ requestSMSCode(data, cbopt) → {Promise|undefined}
@@ -3336,7 +3593,7 @@ request
Source:
Parameters:
Type
+ Attributes
+
@@ -3393,6 +3652,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -3454,6 +3721,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3526,7 +3829,7 @@ Example
- verifySMSCode(data) → {Promise|undefined}
+ verifySMSCode(data, cbopt) → {Promise|undefined}
@@ -3569,7 +3872,7 @@ verifySM
Source:
Parameters:
Type
+ Attributes
+
@@ -3626,6 +3931,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -3765,6 +4078,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3858,7 +4207,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index f65d18760..b5f950710 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -938,6 +938,32 @@ Parameters:
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Client ID of the Application requesting the password change, to be included in the email template.
+
+
+
+
+
@@ -1037,7 +1063,8 @@ Example
var data = {
email: '{EMAIL}',
- connection: 'Username-Password-Authentication'
+ connection: 'Username-Password-Authentication',
+ client_id: 'OS1VzKTVjizL0VCc9Hx2ae2aTPXWy6BD'
};
auth0.database.requestChangePasswordEmail(data, function (err, message) {
@@ -1738,7 +1765,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index e430dfa50..7ed87cdf9 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -450,7 +450,7 @@ Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 416da9866..3b4b8ff4e 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -2050,7 +2050,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 4ca12456a..eaa3a4d56 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1442,7 +1442,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index d330a23e9..faa106317 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 590ae7363..2db164ef0 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 1bd698a3d..10c177b4b 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@ Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html
index 7a836cb91..587ea3600 100644
--- a/docs/module-errors.html
+++ b/docs/module-errors.html
@@ -24,7 +24,7 @@
@@ -254,7 +254,7 @@ (st
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 54777bf35..2135922ef 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.BrandingManager.html b/docs/module-management.BrandingManager.html
index 7a43a7f1a..87e242ebd 100644
--- a/docs/module-management.BrandingManager.html
+++ b/docs/module-management.BrandingManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index 8f313ab9d..0b34dccea 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 547f980e2..fde48120a 100644
--- a/docs/module-management.ClientsManager.html
+++ b/docs/module-management.ClientsManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
index 6f25f64f7..bc6bdcb9b 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index aa2dc4702..03ffd315c 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -1731,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index e2f659bca..ebd9db73e 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 e998086c6..41f18b371 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index 8a1b80df8..27ad509a8 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.GrantsManager.html b/docs/module-management.GrantsManager.html
index 5aca2b858..fa71e19f3 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -24,7 +24,7 @@
@@ -1515,7 +1515,7 @@ Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index ff246af61..f77df6f02 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.HooksManager.html b/docs/module-management.HooksManager.html
index 91e6bb07e..9facca9da 100644
--- a/docs/module-management.HooksManager.html
+++ b/docs/module-management.HooksManager.html
@@ -24,7 +24,7 @@
@@ -3099,7 +3099,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index f4d3b4d9d..b489005bd 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -616,7 +616,7 @@ errorsSource:
exportUser
Source:
importUser
+ Deprecated: - since version 2.26. It will be deleted in version 3.0.
Parameters:
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.
+ }
+});
+
+
+
+
+
+
+
+
+
+
+ importUsersJob(data, 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 or JSON string and associate them with the given
+connection.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Users import data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ connection_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ connection_id of the connection to which users will be imported.
+
+
+
+
+
+
+
+
+ users
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Path to the users data file. Either users or users_json is mandatory.
+
+
+
+
+
+
+
+
+ users_json
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ JSON data for the users.
+
+
+
+
+
+
+
+
+ upsert
+
+
+Boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Whether to update users if they already exist (true) or to ignore them (false).
+
+
+
+
+
+
+
+
+ send_completion_email
+
+
+Boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
@@ -2006,7 +2436,7 @@ verifyEmai
Source:
Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index f5b3b447d..ee8687280 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
@@ -1286,7 +1286,7 @@ Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index 03de93732..700e3ee3e 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -32296,7 +32296,7 @@ Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 9211270e3..76a32b605 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.PromptsManager.html b/docs/module-management.PromptsManager.html
index e556fc94b..d450ac7fd 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 40956d049..fb5b1d27f 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index f6a5571c6..961843c93 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.RolesManager.html b/docs/module-management.RolesManager.html
index d03b030be..f6980c26f 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4293,7 +4293,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 9e0103beb..838527adc 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 7707fbbec..6dbd96b97 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 1b2a3644d..3555a998f 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 48ab03555..2b6bee0fb 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 551545572..7d1f5730b 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.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index 2703b768c..8543b95d7 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index a49f7c0df..4f4e00d83 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 420fee776..fb60127dd 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 9d13d68f1..12e5b188c 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -363,7 +363,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 3d1700212..8106671bc 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -138,7 +138,7 @@ utils.js
diff --git a/package.json b/package.json
index bb2b83122..c6cecbc29 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.25.1",
+ "version": "2.26.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
Returns:
diff --git a/docs/index.html b/docs/index.html index 2c0fbab2c..768f89694 100644 --- a/docs/index.html +++ b/docs/index.html @@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@
diff --git a/docs/index.js.html b/docs/index.js.html index c726e7c30..5bb5b704e 100644 --- a/docs/index.js.html +++ b/docs/index.js.html @@ -24,7 +24,7 @@
License
diff --git a/docs/index.js.html b/docs/index.js.html index c726e7c30..5bb5b704e 100644 --- a/docs/index.js.html +++ b/docs/index.js.html @@ -24,7 +24,7 @@
@@ -61,7 +61,7 @@
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html index 3bba0c6ae..565a071bb 100644 --- a/docs/management_BlacklistedTokensManager.js.html +++ b/docs/management_BlacklistedTokensManager.js.html @@ -24,7 +24,7 @@
index.js
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html index 3bba0c6ae..565a071bb 100644 --- a/docs/management_BlacklistedTokensManager.js.html +++ b/docs/management_BlacklistedTokensManager.js.html @@ -24,7 +24,7 @@
@@ -153,7 +153,7 @@
diff --git a/docs/management_BrandingManager.js.html b/docs/management_BrandingManager.js.html index 6ccc7f99d..f532a24db 100644 --- a/docs/management_BrandingManager.js.html +++ b/docs/management_BrandingManager.js.html @@ -24,7 +24,7 @@
management/BlacklistedTokensManager.js
diff --git a/docs/management_BrandingManager.js.html b/docs/management_BrandingManager.js.html index 6ccc7f99d..f532a24db 100644 --- a/docs/management_BrandingManager.js.html +++ b/docs/management_BrandingManager.js.html @@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html index 66ebcaf8d..1cea85dd3 100644 --- a/docs/management_ClientGrantsManager.js.html +++ b/docs/management_ClientGrantsManager.js.html @@ -24,7 +24,7 @@
management/BrandingManager.js
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html index 66ebcaf8d..1cea85dd3 100644 --- a/docs/management_ClientGrantsManager.js.html +++ b/docs/management_ClientGrantsManager.js.html @@ -24,7 +24,7 @@
@@ -216,7 +216,7 @@
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html index 574b6df52..e464f8b7b 100644 --- a/docs/management_ClientsManager.js.html +++ b/docs/management_ClientsManager.js.html @@ -24,7 +24,7 @@
management/ClientGrantsManager.js
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html index 574b6df52..e464f8b7b 100644 --- a/docs/management_ClientsManager.js.html +++ b/docs/management_ClientsManager.js.html @@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html index 1785ebd79..4ebb02ff7 100644 --- a/docs/management_ConnectionsManager.js.html +++ b/docs/management_ConnectionsManager.js.html @@ -24,7 +24,7 @@
management/ClientsManager.js
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html index 1785ebd79..4ebb02ff7 100644 --- a/docs/management_ConnectionsManager.js.html +++ b/docs/management_ConnectionsManager.js.html @@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html index 5e40816ba..4bac7dbf5 100644 --- a/docs/management_CustomDomainsManager.js.html +++ b/docs/management_CustomDomainsManager.js.html @@ -24,7 +24,7 @@
management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html index 5e40816ba..4bac7dbf5 100644 --- a/docs/management_CustomDomainsManager.js.html +++ b/docs/management_CustomDomainsManager.js.html @@ -24,7 +24,7 @@
@@ -241,7 +241,7 @@
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html index 332312a75..53e57c86a 100644 --- a/docs/management_DeviceCredentialsManager.js.html +++ b/docs/management_DeviceCredentialsManager.js.html @@ -24,7 +24,7 @@
management/CustomDomainsManager.js
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html index 332312a75..53e57c86a 100644 --- a/docs/management_DeviceCredentialsManager.js.html +++ b/docs/management_DeviceCredentialsManager.js.html @@ -24,7 +24,7 @@
@@ -177,7 +177,7 @@
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html index b6c2939f7..dc419b218 100644 --- a/docs/management_EmailProviderManager.js.html +++ b/docs/management_EmailProviderManager.js.html @@ -24,7 +24,7 @@
management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html index b6c2939f7..dc419b218 100644 --- a/docs/management_EmailProviderManager.js.html +++ b/docs/management_EmailProviderManager.js.html @@ -24,7 +24,7 @@
@@ -198,7 +198,7 @@
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html index 5b6d8041d..ebc3cd703 100644 --- a/docs/management_EmailTemplatesManager.js.html +++ b/docs/management_EmailTemplatesManager.js.html @@ -24,7 +24,7 @@
management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html index 5b6d8041d..ebc3cd703 100644 --- a/docs/management_EmailTemplatesManager.js.html +++ b/docs/management_EmailTemplatesManager.js.html @@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html index 38918cae6..ce44bde42 100644 --- a/docs/management_GrantsManager.js.html +++ b/docs/management_GrantsManager.js.html @@ -24,7 +24,7 @@
management/EmailTemplatesManager.js
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html index 38918cae6..ce44bde42 100644 --- a/docs/management_GrantsManager.js.html +++ b/docs/management_GrantsManager.js.html @@ -24,7 +24,7 @@
@@ -170,7 +170,7 @@
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html index bada1185d..118ac3d2f 100644 --- a/docs/management_GuardianManager.js.html +++ b/docs/management_GuardianManager.js.html @@ -24,7 +24,7 @@
management/GrantsManager.js
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html index bada1185d..118ac3d2f 100644 --- a/docs/management_GuardianManager.js.html +++ b/docs/management_GuardianManager.js.html @@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@
diff --git a/docs/management_HooksManager.js.html b/docs/management_HooksManager.js.html index 45ea863e6..ecdf7d6dc 100644 --- a/docs/management_HooksManager.js.html +++ b/docs/management_HooksManager.js.html @@ -24,7 +24,7 @@
management/GuardianManager.js
diff --git a/docs/management_HooksManager.js.html b/docs/management_HooksManager.js.html index 45ea863e6..ecdf7d6dc 100644 --- a/docs/management_HooksManager.js.html +++ b/docs/management_HooksManager.js.html @@ -24,7 +24,7 @@
@@ -419,7 +419,7 @@
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html index c8bcc2891..c9177f7bc 100644 --- a/docs/management_JobsManager.js.html +++ b/docs/management_JobsManager.js.html @@ -24,7 +24,7 @@
management/HooksManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html index c8bcc2891..c9177f7bc 100644 --- a/docs/management_JobsManager.js.html +++ b/docs/management_JobsManager.js.html @@ -24,7 +24,7 @@
@@ -170,6 +170,7 @@
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html index 3fad92701..8a4bceca0 100644 --- a/docs/management_LogsManager.js.html +++ b/docs/management_LogsManager.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 * connection. + * @deprecated since version 2.26. It will be deleted in version 3.0. * * @method importUsers * @memberOf module:management.JobsManager.prototype @@ -197,6 +198,10 @@management/JobsManager.js
* @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.' + ); + 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); @@ -240,6 +245,49 @@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. + * + * @method importUsersJob + * @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.importUsersJob = function(data, cb) { + var promise = this.importUsers(data).then(response => response.data); + + // Don't return a promise if a callback was given. + if (cb && cb instanceof Function) { + promise.then(cb.bind(null, null)).catch(cb); + + return; + } + + return promise; +}; + /** * Export all users to a file using a long running job. * @@ -385,7 +433,7 @@management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html index 3fad92701..8a4bceca0 100644 --- a/docs/management_LogsManager.js.html +++ b/docs/management_LogsManager.js.html @@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html index 17b94cf82..72b15b63e 100644 --- a/docs/management_ManagementTokenProvider.js.html +++ b/docs/management_ManagementTokenProvider.js.html @@ -24,7 +24,7 @@
management/LogsManager.js
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html index 17b94cf82..72b15b63e 100644 --- a/docs/management_ManagementTokenProvider.js.html +++ b/docs/management_ManagementTokenProvider.js.html @@ -24,7 +24,7 @@
@@ -192,7 +192,7 @@
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html index 86793a3c5..b18c1a38f 100644 --- a/docs/management_PromptsManager.js.html +++ b/docs/management_PromptsManager.js.html @@ -24,7 +24,7 @@
management/ManagementTokenProvider.js
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html index 86793a3c5..b18c1a38f 100644 --- a/docs/management_PromptsManager.js.html +++ b/docs/management_PromptsManager.js.html @@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html index bc3257289..e1b3ec326 100644 --- a/docs/management_ResourceServersManager.js.html +++ b/docs/management_ResourceServersManager.js.html @@ -24,7 +24,7 @@
management/PromptsManager.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html index bc3257289..e1b3ec326 100644 --- a/docs/management_ResourceServersManager.js.html +++ b/docs/management_ResourceServersManager.js.html @@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html index e085f3f6b..80cc164c7 100644 --- a/docs/management_RolesManager.js.html +++ b/docs/management_RolesManager.js.html @@ -24,7 +24,7 @@
management/ResourceServersManager.js
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html index e085f3f6b..80cc164c7 100644 --- a/docs/management_RolesManager.js.html +++ b/docs/management_RolesManager.js.html @@ -24,7 +24,7 @@
@@ -460,7 +460,7 @@
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html index 8764ef024..acb2b2484 100644 --- a/docs/management_RulesConfigsManager.js.html +++ b/docs/management_RulesConfigsManager.js.html @@ -24,7 +24,7 @@
management/RolesManager.js
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html index 8764ef024..acb2b2484 100644 --- a/docs/management_RulesConfigsManager.js.html +++ b/docs/management_RulesConfigsManager.js.html @@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html index e5eec72b8..de0cea670 100644 --- a/docs/management_RulesManager.js.html +++ b/docs/management_RulesManager.js.html @@ -24,7 +24,7 @@
management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html index e5eec72b8..de0cea670 100644 --- a/docs/management_RulesManager.js.html +++ b/docs/management_RulesManager.js.html @@ -24,7 +24,7 @@
@@ -248,7 +248,7 @@
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html index d55989619..172d03431 100644 --- a/docs/management_StatsManager.js.html +++ b/docs/management_StatsManager.js.html @@ -24,7 +24,7 @@
management/RulesManager.js
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html index d55989619..172d03431 100644 --- a/docs/management_StatsManager.js.html +++ b/docs/management_StatsManager.js.html @@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html index e5b506919..27f725980 100644 --- a/docs/management_TenantManager.js.html +++ b/docs/management_TenantManager.js.html @@ -24,7 +24,7 @@
management/StatsManager.js
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html index e5b506919..27f725980 100644 --- a/docs/management_TenantManager.js.html +++ b/docs/management_TenantManager.js.html @@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html index 9afd9efc3..56ce24fd8 100644 --- a/docs/management_TicketsManager.js.html +++ b/docs/management_TicketsManager.js.html @@ -24,7 +24,7 @@
management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html index 9afd9efc3..56ce24fd8 100644 --- a/docs/management_TicketsManager.js.html +++ b/docs/management_TicketsManager.js.html @@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html index ad79a8aa9..c08308c17 100644 --- a/docs/management_UserBlocksManager.js.html +++ b/docs/management_UserBlocksManager.js.html @@ -24,7 +24,7 @@
management/TicketsManager.js
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html index ad79a8aa9..c08308c17 100644 --- a/docs/management_UserBlocksManager.js.html +++ b/docs/management_UserBlocksManager.js.html @@ -24,7 +24,7 @@
@@ -229,7 +229,7 @@
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html index 8d32d91c5..8841c2eec 100644 --- a/docs/management_UsersManager.js.html +++ b/docs/management_UsersManager.js.html @@ -24,7 +24,7 @@
management/UserBlocksManager.js
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html index 8d32d91c5..8841c2eec 100644 --- a/docs/management_UsersManager.js.html +++ b/docs/management_UsersManager.js.html @@ -24,7 +24,7 @@
@@ -927,7 +927,7 @@
diff --git a/docs/management_index.js.html b/docs/management_index.js.html index b033c41f5..7e588c5eb 100644 --- a/docs/management_index.js.html +++ b/docs/management_index.js.html @@ -24,7 +24,7 @@
management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html index b033c41f5..7e588c5eb 100644 --- a/docs/management_index.js.html +++ b/docs/management_index.js.html @@ -24,7 +24,7 @@
@@ -3260,7 +3260,7 @@
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html index 4d4095ed3..c4319b5ee 100644 --- a/docs/module-auth.AuthenticationClient.html +++ b/docs/module-auth.AuthenticationClient.html @@ -24,7 +24,7 @@
management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html index 4d4095ed3..c4319b5ee 100644 --- a/docs/module-auth.AuthenticationClient.html +++ b/docs/module-auth.AuthenticationClient.html @@ -24,7 +24,7 @@
@@ -845,7 +845,7 @@ changeP
Methods
-changePassword(data) → {Promise|undefined}
+changePassword(data, cbopt) → {Promise|undefined}
@@ -888,7 +888,7 @@changeP
Source:
Parameters:
Type
+ Attributes
+
@@ -945,6 +947,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -1058,6 +1068,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -1178,7 +1224,7 @@ Source:
Example
- getDelegationToken(data) → {Promise|undefined}
+ getDelegationToken(data, cbopt) → {Promise|undefined}
@@ -1458,7 +1504,7 @@ get
Source:
Parameters:
Type
+ Attributes
+
@@ -1515,6 +1563,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -1654,6 +1710,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -1774,7 +1866,7 @@ getProfile<
Source:
password
Source:
refreshTo
Source:
Example
- requestChangePasswordEmail(data) → {Promise|undefined}
+ requestChangePasswordEmail(data, cbopt) → {Promise|undefined}
@@ -2510,7 +2602,7 @@ Source:
Parameters:
Type
+ Attributes
+
@@ -2567,6 +2661,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -2646,6 +2748,32 @@ Parameters:
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Client ID of the Application requesting the password change, to be included in the email template.
+
+
+
+
+
@@ -2654,6 +2782,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -2709,7 +2873,8 @@ Example
var data = {
email: '{EMAIL}',
- connection: 'Username-Password-Authentication'
+ connection: 'Username-Password-Authentication',
+ client_id: 'OS1VzKTVjizL0VCc9Hx2ae2aTPXWy6BD'
};
auth0.requestChangePasswordEmail(data, function (err, message) {
@@ -2729,7 +2894,7 @@ Example
- requestEmailCode(data) → {Promise|undefined}
+ requestEmailCode(data, cbopt) → {Promise|undefined}
@@ -2772,7 +2937,7 @@ reque
Source:
Parameters:
Type
+ Attributes
+
@@ -2829,6 +2996,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -2936,6 +3111,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3010,7 +3221,7 @@ Example
- requestMagicLink(data) → {Promise|undefined}
+ requestMagicLink(data, cbopt) → {Promise|undefined}
@@ -3085,6 +3296,8 @@ Parameters:
Type
+ Attributes
+
@@ -3110,6 +3323,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -3217,6 +3438,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3293,7 +3550,7 @@ Example
- requestSMSCode(data) → {Promise|undefined}
+ requestSMSCode(data, cbopt) → {Promise|undefined}
@@ -3336,7 +3593,7 @@ request
Source:
Parameters:
Type
+ Attributes
+
@@ -3393,6 +3652,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -3454,6 +3721,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3526,7 +3829,7 @@ Example
- verifySMSCode(data) → {Promise|undefined}
+ verifySMSCode(data, cbopt) → {Promise|undefined}
@@ -3569,7 +3872,7 @@ verifySM
Source:
Parameters:
Type
+ Attributes
+
@@ -3626,6 +3931,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -3765,6 +4078,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3858,7 +4207,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index f65d18760..b5f950710 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -938,6 +938,32 @@ Parameters:
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Client ID of the Application requesting the password change, to be included in the email template.
+
+
+
+
+
@@ -1037,7 +1063,8 @@ Example
var data = {
email: '{EMAIL}',
- connection: 'Username-Password-Authentication'
+ connection: 'Username-Password-Authentication',
+ client_id: 'OS1VzKTVjizL0VCc9Hx2ae2aTPXWy6BD'
};
auth0.database.requestChangePasswordEmail(data, function (err, message) {
@@ -1738,7 +1765,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index e430dfa50..7ed87cdf9 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -450,7 +450,7 @@ Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 416da9866..3b4b8ff4e 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -2050,7 +2050,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 4ca12456a..eaa3a4d56 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1442,7 +1442,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index d330a23e9..faa106317 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 590ae7363..2db164ef0 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 1bd698a3d..10c177b4b 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@ Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html
index 7a836cb91..587ea3600 100644
--- a/docs/module-errors.html
+++ b/docs/module-errors.html
@@ -24,7 +24,7 @@
@@ -254,7 +254,7 @@ (st
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 54777bf35..2135922ef 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.BrandingManager.html b/docs/module-management.BrandingManager.html
index 7a43a7f1a..87e242ebd 100644
--- a/docs/module-management.BrandingManager.html
+++ b/docs/module-management.BrandingManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index 8f313ab9d..0b34dccea 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 547f980e2..fde48120a 100644
--- a/docs/module-management.ClientsManager.html
+++ b/docs/module-management.ClientsManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
index 6f25f64f7..bc6bdcb9b 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index aa2dc4702..03ffd315c 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -1731,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index e2f659bca..ebd9db73e 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 e998086c6..41f18b371 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index 8a1b80df8..27ad509a8 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.GrantsManager.html b/docs/module-management.GrantsManager.html
index 5aca2b858..fa71e19f3 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -24,7 +24,7 @@
@@ -1515,7 +1515,7 @@ Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index ff246af61..f77df6f02 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.HooksManager.html b/docs/module-management.HooksManager.html
index 91e6bb07e..9facca9da 100644
--- a/docs/module-management.HooksManager.html
+++ b/docs/module-management.HooksManager.html
@@ -24,7 +24,7 @@
@@ -3099,7 +3099,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index f4d3b4d9d..b489005bd 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -616,7 +616,7 @@ errorsSource:
exportUser
Source:
importUser
+ Deprecated: - since version 2.26. It will be deleted in version 3.0.
Parameters:
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.
+ }
+});
+
+
+
+
+
+
+
+
+
+
+ importUsersJob(data, 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 or JSON string and associate them with the given
+connection.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Users import data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ connection_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ connection_id of the connection to which users will be imported.
+
+
+
+
+
+
+
+
+ users
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Path to the users data file. Either users or users_json is mandatory.
+
+
+
+
+
+
+
+
+ users_json
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ JSON data for the users.
+
+
+
+
+
+
+
+
+ upsert
+
+
+Boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Whether to update users if they already exist (true) or to ignore them (false).
+
+
+
+
+
+
+
+
+ send_completion_email
+
+
+Boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
@@ -2006,7 +2436,7 @@ verifyEmai
Source:
Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index f5b3b447d..ee8687280 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
@@ -1286,7 +1286,7 @@ Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index 03de93732..700e3ee3e 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -32296,7 +32296,7 @@ Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 9211270e3..76a32b605 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.PromptsManager.html b/docs/module-management.PromptsManager.html
index e556fc94b..d450ac7fd 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 40956d049..fb5b1d27f 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index f6a5571c6..961843c93 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.RolesManager.html b/docs/module-management.RolesManager.html
index d03b030be..f6980c26f 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4293,7 +4293,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 9e0103beb..838527adc 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 7707fbbec..6dbd96b97 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 1b2a3644d..3555a998f 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 48ab03555..2b6bee0fb 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 551545572..7d1f5730b 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.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index 2703b768c..8543b95d7 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index a49f7c0df..4f4e00d83 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 420fee776..fb60127dd 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 9d13d68f1..12e5b188c 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -363,7 +363,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 3d1700212..8106671bc 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -138,7 +138,7 @@ utils.js
diff --git a/package.json b/package.json
index bb2b83122..c6cecbc29 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.25.1",
+ "version": "2.26.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
cbfunction
+
+
+
+ + + + + + +
Method callback.
+ +Example
-getDelegationToken(data) → {Promise|undefined}
+getDelegationToken(data, cbopt) → {Promise|undefined}
@@ -1458,7 +1504,7 @@get
Source:
Parameters:
Type
+ Attributes
+
@@ -1515,6 +1563,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -1654,6 +1710,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -1774,7 +1866,7 @@ getProfile<
Source:
password
Source:
refreshTo
Source:
Example
- requestChangePasswordEmail(data) → {Promise|undefined}
+ requestChangePasswordEmail(data, cbopt) → {Promise|undefined}
@@ -2510,7 +2602,7 @@ Source:
Parameters:
Type
+ Attributes
+
@@ -2567,6 +2661,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -2646,6 +2748,32 @@ Parameters:
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Client ID of the Application requesting the password change, to be included in the email template.
+
+
+
+
+
@@ -2654,6 +2782,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -2709,7 +2873,8 @@ Example
var data = {
email: '{EMAIL}',
- connection: 'Username-Password-Authentication'
+ connection: 'Username-Password-Authentication',
+ client_id: 'OS1VzKTVjizL0VCc9Hx2ae2aTPXWy6BD'
};
auth0.requestChangePasswordEmail(data, function (err, message) {
@@ -2729,7 +2894,7 @@ Example
- requestEmailCode(data) → {Promise|undefined}
+ requestEmailCode(data, cbopt) → {Promise|undefined}
@@ -2772,7 +2937,7 @@ reque
Source:
Parameters:
Type
+ Attributes
+
@@ -2829,6 +2996,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -2936,6 +3111,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3010,7 +3221,7 @@ Example
- requestMagicLink(data) → {Promise|undefined}
+ requestMagicLink(data, cbopt) → {Promise|undefined}
@@ -3085,6 +3296,8 @@ Parameters:
Type
+ Attributes
+
@@ -3110,6 +3323,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -3217,6 +3438,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3293,7 +3550,7 @@ Example
- requestSMSCode(data) → {Promise|undefined}
+ requestSMSCode(data, cbopt) → {Promise|undefined}
@@ -3336,7 +3593,7 @@ request
Source:
Parameters:
Type
+ Attributes
+
@@ -3393,6 +3652,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -3454,6 +3721,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3526,7 +3829,7 @@ Example
- verifySMSCode(data) → {Promise|undefined}
+ verifySMSCode(data, cbopt) → {Promise|undefined}
@@ -3569,7 +3872,7 @@ verifySM
Source:
Parameters:
Type
+ Attributes
+
@@ -3626,6 +3931,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -3765,6 +4078,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3858,7 +4207,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index f65d18760..b5f950710 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -938,6 +938,32 @@ Parameters:
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Client ID of the Application requesting the password change, to be included in the email template.
+
+
+
+
+
@@ -1037,7 +1063,8 @@ Example
var data = {
email: '{EMAIL}',
- connection: 'Username-Password-Authentication'
+ connection: 'Username-Password-Authentication',
+ client_id: 'OS1VzKTVjizL0VCc9Hx2ae2aTPXWy6BD'
};
auth0.database.requestChangePasswordEmail(data, function (err, message) {
@@ -1738,7 +1765,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index e430dfa50..7ed87cdf9 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -450,7 +450,7 @@ Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 416da9866..3b4b8ff4e 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -2050,7 +2050,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 4ca12456a..eaa3a4d56 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1442,7 +1442,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index d330a23e9..faa106317 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 590ae7363..2db164ef0 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 1bd698a3d..10c177b4b 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@ Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html
index 7a836cb91..587ea3600 100644
--- a/docs/module-errors.html
+++ b/docs/module-errors.html
@@ -24,7 +24,7 @@
@@ -254,7 +254,7 @@ (st
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 54777bf35..2135922ef 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.BrandingManager.html b/docs/module-management.BrandingManager.html
index 7a43a7f1a..87e242ebd 100644
--- a/docs/module-management.BrandingManager.html
+++ b/docs/module-management.BrandingManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index 8f313ab9d..0b34dccea 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 547f980e2..fde48120a 100644
--- a/docs/module-management.ClientsManager.html
+++ b/docs/module-management.ClientsManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
index 6f25f64f7..bc6bdcb9b 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index aa2dc4702..03ffd315c 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -1731,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index e2f659bca..ebd9db73e 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 e998086c6..41f18b371 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index 8a1b80df8..27ad509a8 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.GrantsManager.html b/docs/module-management.GrantsManager.html
index 5aca2b858..fa71e19f3 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -24,7 +24,7 @@
@@ -1515,7 +1515,7 @@ Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index ff246af61..f77df6f02 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.HooksManager.html b/docs/module-management.HooksManager.html
index 91e6bb07e..9facca9da 100644
--- a/docs/module-management.HooksManager.html
+++ b/docs/module-management.HooksManager.html
@@ -24,7 +24,7 @@
@@ -3099,7 +3099,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index f4d3b4d9d..b489005bd 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -616,7 +616,7 @@ errorsSource:
exportUser
Source:
importUser
+ Deprecated: - since version 2.26. It will be deleted in version 3.0.
Parameters:
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.
+ }
+});
+
+
+
+
+
+
+
+
+
+
+ importUsersJob(data, 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 or JSON string and associate them with the given
+connection.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Users import data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ connection_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ connection_id of the connection to which users will be imported.
+
+
+
+
+
+
+
+
+ users
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Path to the users data file. Either users or users_json is mandatory.
+
+
+
+
+
+
+
+
+ users_json
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ JSON data for the users.
+
+
+
+
+
+
+
+
+ upsert
+
+
+Boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Whether to update users if they already exist (true) or to ignore them (false).
+
+
+
+
+
+
+
+
+ send_completion_email
+
+
+Boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
@@ -2006,7 +2436,7 @@ verifyEmai
Source:
Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index f5b3b447d..ee8687280 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
@@ -1286,7 +1286,7 @@ Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index 03de93732..700e3ee3e 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -32296,7 +32296,7 @@ Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 9211270e3..76a32b605 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.PromptsManager.html b/docs/module-management.PromptsManager.html
index e556fc94b..d450ac7fd 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 40956d049..fb5b1d27f 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index f6a5571c6..961843c93 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.RolesManager.html b/docs/module-management.RolesManager.html
index d03b030be..f6980c26f 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4293,7 +4293,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 9e0103beb..838527adc 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 7707fbbec..6dbd96b97 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 1b2a3644d..3555a998f 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 48ab03555..2b6bee0fb 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 551545572..7d1f5730b 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.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index 2703b768c..8543b95d7 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index a49f7c0df..4f4e00d83 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 420fee776..fb60127dd 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 9d13d68f1..12e5b188c 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -363,7 +363,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 3d1700212..8106671bc 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -138,7 +138,7 @@ utils.js
diff --git a/package.json b/package.json
index bb2b83122..c6cecbc29 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.25.1",
+ "version": "2.26.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
cbfunction
+
+
+
+ + + + + + +
Method callback.
+ +password
Source:
refreshTo
Source:
Example
- requestChangePasswordEmail(data) → {Promise|undefined}
+ requestChangePasswordEmail(data, cbopt) → {Promise|undefined}
@@ -2510,7 +2602,7 @@ Source:
Parameters:
Type
+ Attributes
+
@@ -2567,6 +2661,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -2646,6 +2748,32 @@ Parameters:
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Client ID of the Application requesting the password change, to be included in the email template.
+
+
+
+
+
@@ -2654,6 +2782,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -2709,7 +2873,8 @@ Example
var data = {
email: '{EMAIL}',
- connection: 'Username-Password-Authentication'
+ connection: 'Username-Password-Authentication',
+ client_id: 'OS1VzKTVjizL0VCc9Hx2ae2aTPXWy6BD'
};
auth0.requestChangePasswordEmail(data, function (err, message) {
@@ -2729,7 +2894,7 @@ Example
- requestEmailCode(data) → {Promise|undefined}
+ requestEmailCode(data, cbopt) → {Promise|undefined}
@@ -2772,7 +2937,7 @@ reque
Source:
Parameters:
Type
+ Attributes
+
@@ -2829,6 +2996,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -2936,6 +3111,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3010,7 +3221,7 @@ Example
- requestMagicLink(data) → {Promise|undefined}
+ requestMagicLink(data, cbopt) → {Promise|undefined}
@@ -3085,6 +3296,8 @@ Parameters:
Type
+ Attributes
+
@@ -3110,6 +3323,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -3217,6 +3438,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3293,7 +3550,7 @@ Example
- requestSMSCode(data) → {Promise|undefined}
+ requestSMSCode(data, cbopt) → {Promise|undefined}
@@ -3336,7 +3593,7 @@ request
Source:
Parameters:
Type
+ Attributes
+
@@ -3393,6 +3652,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -3454,6 +3721,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3526,7 +3829,7 @@ Example
- verifySMSCode(data) → {Promise|undefined}
+ verifySMSCode(data, cbopt) → {Promise|undefined}
@@ -3569,7 +3872,7 @@ verifySM
Source:
Parameters:
Type
+ Attributes
+
@@ -3626,6 +3931,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -3765,6 +4078,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3858,7 +4207,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index f65d18760..b5f950710 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -938,6 +938,32 @@ Parameters:
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Client ID of the Application requesting the password change, to be included in the email template.
+
+
+
+
+
@@ -1037,7 +1063,8 @@ Example
var data = {
email: '{EMAIL}',
- connection: 'Username-Password-Authentication'
+ connection: 'Username-Password-Authentication',
+ client_id: 'OS1VzKTVjizL0VCc9Hx2ae2aTPXWy6BD'
};
auth0.database.requestChangePasswordEmail(data, function (err, message) {
@@ -1738,7 +1765,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index e430dfa50..7ed87cdf9 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -450,7 +450,7 @@ Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 416da9866..3b4b8ff4e 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -2050,7 +2050,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 4ca12456a..eaa3a4d56 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1442,7 +1442,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index d330a23e9..faa106317 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 590ae7363..2db164ef0 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 1bd698a3d..10c177b4b 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@ Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html
index 7a836cb91..587ea3600 100644
--- a/docs/module-errors.html
+++ b/docs/module-errors.html
@@ -24,7 +24,7 @@
@@ -254,7 +254,7 @@ (st
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 54777bf35..2135922ef 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.BrandingManager.html b/docs/module-management.BrandingManager.html
index 7a43a7f1a..87e242ebd 100644
--- a/docs/module-management.BrandingManager.html
+++ b/docs/module-management.BrandingManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index 8f313ab9d..0b34dccea 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 547f980e2..fde48120a 100644
--- a/docs/module-management.ClientsManager.html
+++ b/docs/module-management.ClientsManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
index 6f25f64f7..bc6bdcb9b 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index aa2dc4702..03ffd315c 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -1731,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index e2f659bca..ebd9db73e 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 e998086c6..41f18b371 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index 8a1b80df8..27ad509a8 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.GrantsManager.html b/docs/module-management.GrantsManager.html
index 5aca2b858..fa71e19f3 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -24,7 +24,7 @@
@@ -1515,7 +1515,7 @@ Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index ff246af61..f77df6f02 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.HooksManager.html b/docs/module-management.HooksManager.html
index 91e6bb07e..9facca9da 100644
--- a/docs/module-management.HooksManager.html
+++ b/docs/module-management.HooksManager.html
@@ -24,7 +24,7 @@
@@ -3099,7 +3099,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index f4d3b4d9d..b489005bd 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -616,7 +616,7 @@ errorsSource:
exportUser
Source:
importUser
+ Deprecated: - since version 2.26. It will be deleted in version 3.0.
Parameters:
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.
+ }
+});
+
+
+
+
+
+
+
+
+
+
+ importUsersJob(data, 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 or JSON string and associate them with the given
+connection.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Users import data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ connection_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ connection_id of the connection to which users will be imported.
+
+
+
+
+
+
+
+
+ users
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Path to the users data file. Either users or users_json is mandatory.
+
+
+
+
+
+
+
+
+ users_json
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ JSON data for the users.
+
+
+
+
+
+
+
+
+ upsert
+
+
+Boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Whether to update users if they already exist (true) or to ignore them (false).
+
+
+
+
+
+
+
+
+ send_completion_email
+
+
+Boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
@@ -2006,7 +2436,7 @@ verifyEmai
Source:
Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index f5b3b447d..ee8687280 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
@@ -1286,7 +1286,7 @@ Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index 03de93732..700e3ee3e 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -32296,7 +32296,7 @@ Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 9211270e3..76a32b605 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.PromptsManager.html b/docs/module-management.PromptsManager.html
index e556fc94b..d450ac7fd 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 40956d049..fb5b1d27f 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index f6a5571c6..961843c93 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.RolesManager.html b/docs/module-management.RolesManager.html
index d03b030be..f6980c26f 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4293,7 +4293,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 9e0103beb..838527adc 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 7707fbbec..6dbd96b97 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 1b2a3644d..3555a998f 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 48ab03555..2b6bee0fb 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 551545572..7d1f5730b 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.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index 2703b768c..8543b95d7 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index a49f7c0df..4f4e00d83 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 420fee776..fb60127dd 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 9d13d68f1..12e5b188c 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -363,7 +363,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 3d1700212..8106671bc 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -138,7 +138,7 @@ utils.js
diff --git a/package.json b/package.json
index bb2b83122..c6cecbc29 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.25.1",
+ "version": "2.26.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
Example
-requestChangePasswordEmail(data) → {Promise|undefined}
+requestChangePasswordEmail(data, cbopt) → {Promise|undefined}
@@ -2510,7 +2602,7 @@Source:
Parameters:
Type
+ Attributes
+
@@ -2567,6 +2661,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -2646,6 +2748,32 @@ Parameters:
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Client ID of the Application requesting the password change, to be included in the email template.
+
+
+
+
+
@@ -2654,6 +2782,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -2709,7 +2873,8 @@ Example
var data = {
email: '{EMAIL}',
- connection: 'Username-Password-Authentication'
+ connection: 'Username-Password-Authentication',
+ client_id: 'OS1VzKTVjizL0VCc9Hx2ae2aTPXWy6BD'
};
auth0.requestChangePasswordEmail(data, function (err, message) {
@@ -2729,7 +2894,7 @@ Example
- requestEmailCode(data) → {Promise|undefined}
+ requestEmailCode(data, cbopt) → {Promise|undefined}
@@ -2772,7 +2937,7 @@ reque
Source:
Parameters:
Type
+ Attributes
+
@@ -2829,6 +2996,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -2936,6 +3111,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3010,7 +3221,7 @@ Example
- requestMagicLink(data) → {Promise|undefined}
+ requestMagicLink(data, cbopt) → {Promise|undefined}
@@ -3085,6 +3296,8 @@ Parameters:
Type
+ Attributes
+
@@ -3110,6 +3323,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -3217,6 +3438,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3293,7 +3550,7 @@ Example
- requestSMSCode(data) → {Promise|undefined}
+ requestSMSCode(data, cbopt) → {Promise|undefined}
@@ -3336,7 +3593,7 @@ request
Source:
Parameters:
Type
+ Attributes
+
@@ -3393,6 +3652,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -3454,6 +3721,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3526,7 +3829,7 @@ Example
- verifySMSCode(data) → {Promise|undefined}
+ verifySMSCode(data, cbopt) → {Promise|undefined}
@@ -3569,7 +3872,7 @@ verifySM
Source:
Parameters:
Type
+ Attributes
+
@@ -3626,6 +3931,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -3765,6 +4078,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3858,7 +4207,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index f65d18760..b5f950710 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -938,6 +938,32 @@ Parameters:
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Client ID of the Application requesting the password change, to be included in the email template.
+
+
+
+
+
@@ -1037,7 +1063,8 @@ Example
var data = {
email: '{EMAIL}',
- connection: 'Username-Password-Authentication'
+ connection: 'Username-Password-Authentication',
+ client_id: 'OS1VzKTVjizL0VCc9Hx2ae2aTPXWy6BD'
};
auth0.database.requestChangePasswordEmail(data, function (err, message) {
@@ -1738,7 +1765,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index e430dfa50..7ed87cdf9 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -450,7 +450,7 @@ Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 416da9866..3b4b8ff4e 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -2050,7 +2050,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 4ca12456a..eaa3a4d56 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1442,7 +1442,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index d330a23e9..faa106317 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 590ae7363..2db164ef0 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 1bd698a3d..10c177b4b 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@ Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html
index 7a836cb91..587ea3600 100644
--- a/docs/module-errors.html
+++ b/docs/module-errors.html
@@ -24,7 +24,7 @@
@@ -254,7 +254,7 @@ (st
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 54777bf35..2135922ef 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.BrandingManager.html b/docs/module-management.BrandingManager.html
index 7a43a7f1a..87e242ebd 100644
--- a/docs/module-management.BrandingManager.html
+++ b/docs/module-management.BrandingManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index 8f313ab9d..0b34dccea 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 547f980e2..fde48120a 100644
--- a/docs/module-management.ClientsManager.html
+++ b/docs/module-management.ClientsManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
index 6f25f64f7..bc6bdcb9b 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index aa2dc4702..03ffd315c 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -1731,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index e2f659bca..ebd9db73e 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 e998086c6..41f18b371 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index 8a1b80df8..27ad509a8 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.GrantsManager.html b/docs/module-management.GrantsManager.html
index 5aca2b858..fa71e19f3 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -24,7 +24,7 @@
@@ -1515,7 +1515,7 @@ Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index ff246af61..f77df6f02 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.HooksManager.html b/docs/module-management.HooksManager.html
index 91e6bb07e..9facca9da 100644
--- a/docs/module-management.HooksManager.html
+++ b/docs/module-management.HooksManager.html
@@ -24,7 +24,7 @@
@@ -3099,7 +3099,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index f4d3b4d9d..b489005bd 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -616,7 +616,7 @@ errorsSource:
exportUser
Source:
importUser
+ Deprecated: - since version 2.26. It will be deleted in version 3.0.
Parameters:
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.
+ }
+});
+
+
+
+
+
+
+
+
+
+
+ importUsersJob(data, 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 or JSON string and associate them with the given
+connection.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Users import data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ connection_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ connection_id of the connection to which users will be imported.
+
+
+
+
+
+
+
+
+ users
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Path to the users data file. Either users or users_json is mandatory.
+
+
+
+
+
+
+
+
+ users_json
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ JSON data for the users.
+
+
+
+
+
+
+
+
+ upsert
+
+
+Boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Whether to update users if they already exist (true) or to ignore them (false).
+
+
+
+
+
+
+
+
+ send_completion_email
+
+
+Boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
@@ -2006,7 +2436,7 @@ verifyEmai
Source:
Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index f5b3b447d..ee8687280 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
@@ -1286,7 +1286,7 @@ Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index 03de93732..700e3ee3e 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -32296,7 +32296,7 @@ Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 9211270e3..76a32b605 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.PromptsManager.html b/docs/module-management.PromptsManager.html
index e556fc94b..d450ac7fd 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 40956d049..fb5b1d27f 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index f6a5571c6..961843c93 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.RolesManager.html b/docs/module-management.RolesManager.html
index d03b030be..f6980c26f 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4293,7 +4293,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 9e0103beb..838527adc 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 7707fbbec..6dbd96b97 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 1b2a3644d..3555a998f 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 48ab03555..2b6bee0fb 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 551545572..7d1f5730b 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.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index 2703b768c..8543b95d7 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index a49f7c0df..4f4e00d83 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 420fee776..fb60127dd 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 9d13d68f1..12e5b188c 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -363,7 +363,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 3d1700212..8106671bc 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -138,7 +138,7 @@ utils.js
diff --git a/package.json b/package.json
index bb2b83122..c6cecbc29 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.25.1",
+ "version": "2.26.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
client_idString
+
+
+
+ Client ID of the Application requesting the password change, to be included in the email template.
+ +cbfunction
+
+
+
+ + + + + + +
Method callback.
+ +var data = {
email: '{EMAIL}',
- connection: 'Username-Password-Authentication'
+ connection: 'Username-Password-Authentication',
+ client_id: 'OS1VzKTVjizL0VCc9Hx2ae2aTPXWy6BD'
};
auth0.requestChangePasswordEmail(data, function (err, message) {
@@ -2729,7 +2894,7 @@ Example
- requestEmailCode(data) → {Promise|undefined}
+ requestEmailCode(data, cbopt) → {Promise|undefined}
@@ -2772,7 +2937,7 @@ reque
Source:
Parameters:
Type
+ Attributes
+
@@ -2829,6 +2996,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -2936,6 +3111,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3010,7 +3221,7 @@ Example
- requestMagicLink(data) → {Promise|undefined}
+ requestMagicLink(data, cbopt) → {Promise|undefined}
@@ -3085,6 +3296,8 @@ Parameters:
Type
+ Attributes
+
@@ -3110,6 +3323,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -3217,6 +3438,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3293,7 +3550,7 @@ Example
- requestSMSCode(data) → {Promise|undefined}
+ requestSMSCode(data, cbopt) → {Promise|undefined}
@@ -3336,7 +3593,7 @@ request
Source:
Parameters:
Type
+ Attributes
+
@@ -3393,6 +3652,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -3454,6 +3721,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3526,7 +3829,7 @@ Example
- verifySMSCode(data) → {Promise|undefined}
+ verifySMSCode(data, cbopt) → {Promise|undefined}
@@ -3569,7 +3872,7 @@ verifySM
Source:
Parameters:
Type
+ Attributes
+
@@ -3626,6 +3931,14 @@ Parameters:
+
+
+
+
+
+
+
+
@@ -3765,6 +4078,42 @@ Parameters:
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Method callback.
+
+
+
+
+
@@ -3858,7 +4207,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index f65d18760..b5f950710 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -938,6 +938,32 @@ Parameters:
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Client ID of the Application requesting the password change, to be included in the email template.
+
+
+
+
+
@@ -1037,7 +1063,8 @@ Example
var data = {
email: '{EMAIL}',
- connection: 'Username-Password-Authentication'
+ connection: 'Username-Password-Authentication',
+ client_id: 'OS1VzKTVjizL0VCc9Hx2ae2aTPXWy6BD'
};
auth0.database.requestChangePasswordEmail(data, function (err, message) {
@@ -1738,7 +1765,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index e430dfa50..7ed87cdf9 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -450,7 +450,7 @@ Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 416da9866..3b4b8ff4e 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -2050,7 +2050,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 4ca12456a..eaa3a4d56 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1442,7 +1442,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index d330a23e9..faa106317 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 590ae7363..2db164ef0 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 1bd698a3d..10c177b4b 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@ Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html
index 7a836cb91..587ea3600 100644
--- a/docs/module-errors.html
+++ b/docs/module-errors.html
@@ -24,7 +24,7 @@
@@ -254,7 +254,7 @@ (st
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 54777bf35..2135922ef 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.BrandingManager.html b/docs/module-management.BrandingManager.html
index 7a43a7f1a..87e242ebd 100644
--- a/docs/module-management.BrandingManager.html
+++ b/docs/module-management.BrandingManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index 8f313ab9d..0b34dccea 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 547f980e2..fde48120a 100644
--- a/docs/module-management.ClientsManager.html
+++ b/docs/module-management.ClientsManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
index 6f25f64f7..bc6bdcb9b 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index aa2dc4702..03ffd315c 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -1731,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index e2f659bca..ebd9db73e 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 e998086c6..41f18b371 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index 8a1b80df8..27ad509a8 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.GrantsManager.html b/docs/module-management.GrantsManager.html
index 5aca2b858..fa71e19f3 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -24,7 +24,7 @@
@@ -1515,7 +1515,7 @@ Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index ff246af61..f77df6f02 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.HooksManager.html b/docs/module-management.HooksManager.html
index 91e6bb07e..9facca9da 100644
--- a/docs/module-management.HooksManager.html
+++ b/docs/module-management.HooksManager.html
@@ -24,7 +24,7 @@
@@ -3099,7 +3099,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index f4d3b4d9d..b489005bd 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -616,7 +616,7 @@ errorsSource:
exportUser
Source:
importUser
+ Deprecated: - since version 2.26. It will be deleted in version 3.0.
Parameters:
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.
+ }
+});
+
+
+
+
+
+
+
+
+
+
+ importUsersJob(data, 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 or JSON string and associate them with the given
+connection.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Users import data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ connection_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ connection_id of the connection to which users will be imported.
+
+
+
+
+
+
+
+
+ users
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Path to the users data file. Either users or users_json is mandatory.
+
+
+
+
+
+
+
+
+ users_json
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ JSON data for the users.
+
+
+
+
+
+
+
+
+ upsert
+
+
+Boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Whether to update users if they already exist (true) or to ignore them (false).
+
+
+
+
+
+
+
+
+ send_completion_email
+
+
+Boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
@@ -2006,7 +2436,7 @@ verifyEmai
Source:
Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index f5b3b447d..ee8687280 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
@@ -1286,7 +1286,7 @@ Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index 03de93732..700e3ee3e 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -32296,7 +32296,7 @@ Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 9211270e3..76a32b605 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.PromptsManager.html b/docs/module-management.PromptsManager.html
index e556fc94b..d450ac7fd 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 40956d049..fb5b1d27f 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index f6a5571c6..961843c93 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.RolesManager.html b/docs/module-management.RolesManager.html
index d03b030be..f6980c26f 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4293,7 +4293,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 9e0103beb..838527adc 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 7707fbbec..6dbd96b97 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 1b2a3644d..3555a998f 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 48ab03555..2b6bee0fb 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 551545572..7d1f5730b 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.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index 2703b768c..8543b95d7 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index a49f7c0df..4f4e00d83 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 420fee776..fb60127dd 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 9d13d68f1..12e5b188c 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -363,7 +363,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 3d1700212..8106671bc 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -138,7 +138,7 @@ utils.js
diff --git a/package.json b/package.json
index bb2b83122..c6cecbc29 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.25.1",
+ "version": "2.26.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [