diff --git a/CHANGELOG.md b/CHANGELOG.md index 4b1551371..0852ec831 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,15 @@ # Change Log +## [v2.24.0](https://github.com/auth0/node-auth0/tree/v2.24.0) (2020-03-06) + +**Fixed** + +- Update and fix JSDocs related to JobsManager [\#469](https://github.com/auth0/node-auth0/pull/469) ([orangain](https://github.com/orangain)) +- Fixes test on supportedAlgorithms [\#466](https://github.com/auth0/node-auth0/pull/466) ([davidpatrick](https://github.com/davidpatrick)) +- Fixes calls on passwordless endpoints [\#465](https://github.com/auth0/node-auth0/pull/465) ([davidpatrick](https://github.com/davidpatrick)) + +[Full Changelog](https://github.com/auth0/node-auth0/compare/v2.23.0...v2.24.0) + ## [v2.23.0](https://github.com/auth0/node-auth0/tree/v2.23.0) (2020-02-21) **Added** diff --git a/docs/RetryRestClient.js.html b/docs/RetryRestClient.js.html index 827559651..3b448e80c 100644 --- a/docs/RetryRestClient.js.html +++ b/docs/RetryRestClient.js.html @@ -24,7 +24,7 @@
@@ -207,7 +207,7 @@

RetryRestClient.js


diff --git a/docs/auth_DatabaseAuthenticator.js.html b/docs/auth_DatabaseAuthenticator.js.html index 111473081..3d2003710 100644 --- a/docs/auth_DatabaseAuthenticator.js.html +++ b/docs/auth_DatabaseAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -346,7 +346,7 @@

auth/DatabaseAuthenticator.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_OAUthWithIDTokenValidation.js.html b/docs/auth_OAUthWithIDTokenValidation.js.html index 7a6a952c4..5fdc437b5 100644 --- a/docs/auth_OAUthWithIDTokenValidation.js.html +++ b/docs/auth_OAUthWithIDTokenValidation.js.html @@ -24,7 +24,7 @@
@@ -176,7 +176,7 @@

auth/OAUthWithIDTokenValidation.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html index 28be0c6d2..eeb99f114 100644 --- a/docs/auth_OAuthAuthenticator.js.html +++ b/docs/auth_OAuthAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -455,7 +455,7 @@

auth/OAuthAuthenticator.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html index 21283209d..93d415b3c 100644 --- a/docs/auth_PasswordlessAuthenticator.js.html +++ b/docs/auth_PasswordlessAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -53,6 +53,7 @@

auth/PasswordlessAuthenticator.js

* @param {Object} options Authenticator options. * @param {String} options.baseUrl The auth0 account URL. * @param {String} [options.clientId] Default client ID. + * @param {String} [options.clientSecret] Default client secret. * @param {OAuthAuthenticator} oauth OAuthAuthenticator instance. */ var PasswordlessAuthenticator = function(options, oauth) { @@ -77,6 +78,7 @@

auth/PasswordlessAuthenticator.js

this.oauth = oauth; this.passwordless = new RestClient(options.baseUrl + '/passwordless/start', clientOptions); this.clientId = options.clientId; + this.clientSecret = options.clientSecret; }; /** @@ -115,14 +117,14 @@

auth/PasswordlessAuthenticator.js

* @param {String} userData.username Username. * @param {String} userData.password Password. * @param {String} [userData.connection=sms] Connection string: "sms" or "email". - * @param {String} [userData.client_id] Client ID. * @param {Function} [cb] Method callback. * * @return {Promise|undefined} */ PasswordlessAuthenticator.prototype.signIn = function(userData, cb) { var defaultFields = { - client_id: this.clientId + client_id: this.clientId, + client_secret: this.clientSecret }; var data = extend(defaultFields, userData); @@ -194,7 +196,8 @@

auth/PasswordlessAuthenticator.js

*/ PasswordlessAuthenticator.prototype.sendEmail = function(userData, cb) { var defaultFields = { - client_id: this.clientId + client_id: this.clientId, + client_secret: this.clientSecret }; var data = extend(defaultFields, userData); @@ -245,14 +248,14 @@

auth/PasswordlessAuthenticator.js

* * @param {Object} userData User account data. * @param {String} userData.phone_number User phone number. - * @param {String} [userData.client_id] Client ID. * @param {Function} [cb] Method callback. * * @return {Promise|undefined} */ PasswordlessAuthenticator.prototype.sendSMS = function(userData, cb) { var defaultFields = { - client_id: this.clientId + client_id: this.clientId, + client_secret: this.clientSecret }; var data = extend(defaultFields, userData); @@ -287,7 +290,7 @@

auth/PasswordlessAuthenticator.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html index 4a26f20fb..62f15ecfa 100644 --- a/docs/auth_TokensManager.js.html +++ b/docs/auth_TokensManager.js.html @@ -24,7 +24,7 @@
@@ -226,7 +226,7 @@

auth/TokensManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html index 11b4dc7ef..e8bc86d3a 100644 --- a/docs/auth_UsersManager.js.html +++ b/docs/auth_UsersManager.js.html @@ -24,7 +24,7 @@
@@ -224,7 +224,7 @@

auth/UsersManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_idToken.js.html b/docs/auth_idToken.js.html index 3a5c7f345..ed2196519 100644 --- a/docs/auth_idToken.js.html +++ b/docs/auth_idToken.js.html @@ -24,7 +24,7 @@
@@ -202,7 +202,7 @@

auth/idToken.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html index 4e891958c..43ef35423 100644 --- a/docs/auth_index.js.html +++ b/docs/auth_index.js.html @@ -24,7 +24,7 @@
@@ -607,7 +607,7 @@

auth/index.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/errors.js.html b/docs/errors.js.html index ee8bcd1f0..55f9e004d 100644 --- a/docs/errors.js.html +++ b/docs/errors.js.html @@ -24,7 +24,7 @@
@@ -98,7 +98,7 @@

errors.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html index 24f35312c..70ca4d5f9 100644 --- a/docs/external-RestClient.html +++ b/docs/external-RestClient.html @@ -24,7 +24,7 @@
@@ -1639,7 +1639,7 @@


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/global.html b/docs/global.html index 3237012ad..e57b6457d 100644 --- a/docs/global.html +++ b/docs/global.html @@ -24,7 +24,7 @@
@@ -423,7 +423,7 @@
Returns:

- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/index.html b/docs/index.html index 27373ba00..fb84ab6e2 100644 --- a/docs/index.html +++ b/docs/index.html @@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@

License


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/index.js.html b/docs/index.js.html index 227d299ed..5ace7a90c 100644 --- a/docs/index.js.html +++ b/docs/index.js.html @@ -24,7 +24,7 @@
@@ -61,7 +61,7 @@

index.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html index 8dea1c859..6fe317353 100644 --- a/docs/management_BlacklistedTokensManager.js.html +++ b/docs/management_BlacklistedTokensManager.js.html @@ -24,7 +24,7 @@
@@ -153,7 +153,7 @@

management/BlacklistedTokensManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_BrandingManager.js.html b/docs/management_BrandingManager.js.html index aa7f6cdbb..5e27d9119 100644 --- a/docs/management_BrandingManager.js.html +++ b/docs/management_BrandingManager.js.html @@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@

management/BrandingManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html index 66972579c..ed997ff26 100644 --- a/docs/management_ClientGrantsManager.js.html +++ b/docs/management_ClientGrantsManager.js.html @@ -24,7 +24,7 @@
@@ -216,7 +216,7 @@

management/ClientGrantsManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html index 83dff6425..9a0698f0a 100644 --- a/docs/management_ClientsManager.js.html +++ b/docs/management_ClientsManager.js.html @@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@

management/ClientsManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html index 1bbed4270..65e3d7608 100644 --- a/docs/management_ConnectionsManager.js.html +++ b/docs/management_ConnectionsManager.js.html @@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@

management/ConnectionsManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html index a0f690e6e..719740a88 100644 --- a/docs/management_CustomDomainsManager.js.html +++ b/docs/management_CustomDomainsManager.js.html @@ -24,7 +24,7 @@
@@ -241,7 +241,7 @@

management/CustomDomainsManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html index da46a9b79..de34c2ff5 100644 --- a/docs/management_DeviceCredentialsManager.js.html +++ b/docs/management_DeviceCredentialsManager.js.html @@ -24,7 +24,7 @@
@@ -177,7 +177,7 @@

management/DeviceCredentialsManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html index 60879bb61..29727fd79 100644 --- a/docs/management_EmailProviderManager.js.html +++ b/docs/management_EmailProviderManager.js.html @@ -24,7 +24,7 @@
@@ -198,7 +198,7 @@

management/EmailProviderManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html index f7d2844e5..ed0a8578b 100644 --- a/docs/management_EmailTemplatesManager.js.html +++ b/docs/management_EmailTemplatesManager.js.html @@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@

management/EmailTemplatesManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html index 98eb4c31e..d2e7d8861 100644 --- a/docs/management_GrantsManager.js.html +++ b/docs/management_GrantsManager.js.html @@ -24,7 +24,7 @@
@@ -170,7 +170,7 @@

management/GrantsManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html index 5c28db391..c53c6195d 100644 --- a/docs/management_GuardianManager.js.html +++ b/docs/management_GuardianManager.js.html @@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@

management/GuardianManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_HooksManager.js.html b/docs/management_HooksManager.js.html index 7e6239bf4..036b22182 100644 --- a/docs/management_HooksManager.js.html +++ b/docs/management_HooksManager.js.html @@ -24,7 +24,7 @@
@@ -419,7 +419,7 @@

management/HooksManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html index 7dd3eca9a..4322f287a 100644 --- a/docs/management_JobsManager.js.html +++ b/docs/management_JobsManager.js.html @@ -24,7 +24,7 @@
@@ -176,9 +176,7 @@

management/JobsManager.js

* @example * var params = { * connection_id: '{CONNECTION_ID}', - * users: '{PATH_TO_USERS_FILE}', - * upsert: true, //optional - * send_completion_email: false //optional + * users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}' * }; * * management.jobs.importUsers(params, function (err) { @@ -187,13 +185,13 @@

management/JobsManager.js

* } * }); * - * @param {Object} data Users import data. - * @param {String} data.connectionId Connection for the users insertion. - * @param {String} data.users Path to the users data file. - * @param {String} data.users_json JSON data for the users. - * @param {String} data.upsert OPTIONAL: set to true to upsert users, defaults to false - * @param {String} data.send_completion_email OPTIONAL: defaults to true - * @param {Function} [cb] Callback function. + * @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} */ @@ -328,7 +326,7 @@

management/JobsManager.js

/** * Given a job ID, retrieve the failed/errored items * - * @method get + * @method errors * @memberOf module:management.JobsManager.prototype * * @example @@ -413,7 +411,7 @@

management/JobsManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html index c41174636..0571b2ab5 100644 --- a/docs/management_LogsManager.js.html +++ b/docs/management_LogsManager.js.html @@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@

management/LogsManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html index 99bec8cb2..9c9ec4ca2 100644 --- a/docs/management_ManagementTokenProvider.js.html +++ b/docs/management_ManagementTokenProvider.js.html @@ -24,7 +24,7 @@
@@ -192,7 +192,7 @@

management/ManagementTokenProvider.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html index 8a8573820..09d130536 100644 --- a/docs/management_PromptsManager.js.html +++ b/docs/management_PromptsManager.js.html @@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@

management/PromptsManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html index 82255a129..85cb3b408 100644 --- a/docs/management_ResourceServersManager.js.html +++ b/docs/management_ResourceServersManager.js.html @@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@

management/ResourceServersManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html index b7b81d63c..db16e1374 100644 --- a/docs/management_RolesManager.js.html +++ b/docs/management_RolesManager.js.html @@ -24,7 +24,7 @@
@@ -460,7 +460,7 @@

management/RolesManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html index a40e3bdec..dc126ac83 100644 --- a/docs/management_RulesConfigsManager.js.html +++ b/docs/management_RulesConfigsManager.js.html @@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@

management/RulesConfigsManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html index f9d7ac9dd..34bb6a0c6 100644 --- a/docs/management_RulesManager.js.html +++ b/docs/management_RulesManager.js.html @@ -24,7 +24,7 @@
@@ -248,7 +248,7 @@

management/RulesManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html index bbb23f9af..d946a3e6e 100644 --- a/docs/management_StatsManager.js.html +++ b/docs/management_StatsManager.js.html @@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@

management/StatsManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html index 7ae0b9e16..b16dab789 100644 --- a/docs/management_TenantManager.js.html +++ b/docs/management_TenantManager.js.html @@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@

management/TenantManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html index 59f0536de..7372e6799 100644 --- a/docs/management_TicketsManager.js.html +++ b/docs/management_TicketsManager.js.html @@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@

management/TicketsManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html index 04c4e7d8f..b1f7e4dca 100644 --- a/docs/management_UserBlocksManager.js.html +++ b/docs/management_UserBlocksManager.js.html @@ -24,7 +24,7 @@
@@ -229,7 +229,7 @@

management/UserBlocksManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html index 86914e017..c55cc4311 100644 --- a/docs/management_UsersManager.js.html +++ b/docs/management_UsersManager.js.html @@ -24,7 +24,7 @@
@@ -927,7 +927,7 @@

management/UsersManager.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_index.js.html b/docs/management_index.js.html index 7890e4c02..4c413fcdd 100644 --- a/docs/management_index.js.html +++ b/docs/management_index.js.html @@ -24,7 +24,7 @@
@@ -2056,7 +2056,8 @@

management/index.js

/** * Given a path to a file and a connection id, create a new job that imports the - * users contained in the file and associate them with the given connection. + * users contained in the file or JSON string and associate them with the given + * connection. * * @method importUsers * @memberOf module:management.ManagementClient.prototype @@ -2064,19 +2065,22 @@

management/index.js

* @example * var params = { * connection_id: '{CONNECTION_ID}', - * users: '{PATH_TO_USERS_FILE}' + * users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}' * }; * - * management.get(params, function (err) { + * management.importUsers(params, function (err) { * if (err) { * // Handle error. * } * }); * - * @param {Object} data Users import data. - * @param {String} data.connectionId Connection for the users insertion. - * @param {String} data.users Path to the users data file. - * @param {Function} [cb] Callback function. + * @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} */ @@ -3255,7 +3259,7 @@

management/index.js


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html index 1a249b9b8..16eaa6449 100644 --- a/docs/module-auth.AuthenticationClient.html +++ b/docs/module-auth.AuthenticationClient.html @@ -24,7 +24,7 @@
@@ -3858,7 +3858,7 @@
Examples

- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html index 03f1b827a..b960b813d 100644 --- a/docs/module-auth.DatabaseAuthenticator.html +++ b/docs/module-auth.DatabaseAuthenticator.html @@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@
Example

- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html index b13a7ff10..e90a737ee 100644 --- a/docs/module-auth.OAUthWithIDTokenValidation.html +++ b/docs/module-auth.OAUthWithIDTokenValidation.html @@ -24,7 +24,7 @@
@@ -450,7 +450,7 @@
Parameters:

- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html index 137ac0644..1731176e6 100644 --- a/docs/module-auth.OAuthAuthenticator.html +++ b/docs/module-auth.OAuthAuthenticator.html @@ -24,7 +24,7 @@
@@ -2050,7 +2050,7 @@
Returns:

- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html index d9d7a0caa..dd1a3ff7e 100644 --- a/docs/module-auth.PasswordlessAuthenticator.html +++ b/docs/module-auth.PasswordlessAuthenticator.html @@ -24,7 +24,7 @@
@@ -101,7 +101,7 @@

Source:
@@ -257,6 +257,42 @@
Parameters:
+ + + + clientSecret + + + + + +String + + + + + + + + + <optional>
+ + + + + + + + + + + +

Default client secret.

+ + + + + @@ -371,7 +407,7 @@

(inner) Source:
@@ -455,7 +491,7 @@

sendEmailSource:
@@ -775,7 +811,7 @@

sendSMSSource:
@@ -860,8 +896,6 @@
Parameters:
Type - Attributes - @@ -887,14 +921,6 @@
Parameters:
- - - - - - - - @@ -905,42 +931,6 @@
Parameters:
- - - - client_id - - - - - -String - - - - - - - - - <optional>
- - - - - - - - - - - -

Client ID.

- - - - - @@ -1099,7 +1089,7 @@

signInSource:
@@ -1315,46 +1305,6 @@
Parameters:
- - - - client_id - - - - - -String - - - - - - - - - <optional>
- - - - - - - - - - - - - - - -

Client ID.

- - - - - @@ -1492,7 +1442,7 @@
Examples

- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html index ab644ea01..5aa1a3629 100644 --- a/docs/module-auth.TokensManager.html +++ b/docs/module-auth.TokensManager.html @@ -24,7 +24,7 @@
@@ -352,7 +352,7 @@
Parameters:

- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html index 6a45cef6e..6d9cb03f6 100644 --- a/docs/module-auth.UsersManager.html +++ b/docs/module-auth.UsersManager.html @@ -24,7 +24,7 @@
@@ -1009,7 +1009,7 @@
Example

- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.html b/docs/module-auth.html index 9f85f6066..911862694 100644 --- a/docs/module-auth.html +++ b/docs/module-auth.html @@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@

Classes


- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-errors.html b/docs/module-errors.html index 839a6ffa1..38ddbd019 100644 --- a/docs/module-errors.html +++ b/docs/module-errors.html @@ -24,7 +24,7 @@
@@ -254,7 +254,7 @@

(st
- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html index f712ad34f..96cce7a29 100644 --- a/docs/module-management.BlacklistedTokensManager.html +++ b/docs/module-management.BlacklistedTokensManager.html @@ -24,7 +24,7 @@
@@ -991,7 +991,7 @@
Example

- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html index 7749a28e2..e4c91e283 100644 --- a/docs/module-management.BrandingManager.html +++ b/docs/module-management.BrandingManager.html @@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@
Example

- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html index ab7c65b3c..0fd08a77e 100644 --- a/docs/module-management.ClientGrantsManager.html +++ b/docs/module-management.ClientGrantsManager.html @@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@
Example

- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html index 17b79b863..fdc30808a 100644 --- a/docs/module-management.ClientsManager.html +++ b/docs/module-management.ClientsManager.html @@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@
Example

- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html index 8bc8c9788..4064ac446 100644 --- a/docs/module-management.ConnectionsManager.html +++ b/docs/module-management.ConnectionsManager.html @@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@
Example

- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html index f706a54c9..406399ea6 100644 --- a/docs/module-management.CustomDomainsManager.html +++ b/docs/module-management.CustomDomainsManager.html @@ -24,7 +24,7 @@
@@ -1731,7 +1731,7 @@
Example

- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html index 055d68d56..2bac7c7ed 100644 --- a/docs/module-management.DeviceCredentialsManager.html +++ b/docs/module-management.DeviceCredentialsManager.html @@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@
Example

- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html index 57f0b20bf..fa0966df0 100644 --- a/docs/module-management.EmailProviderManager.html +++ b/docs/module-management.EmailProviderManager.html @@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@
Example

- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html index 6b8792497..8661130a4 100644 --- a/docs/module-management.EmailTemplatesManager.html +++ b/docs/module-management.EmailTemplatesManager.html @@ -24,7 +24,7 @@
@@ -1304,7 +1304,7 @@
Example

- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html index 4e2d3c000..0a3d9e857 100644 --- a/docs/module-management.GrantsManager.html +++ b/docs/module-management.GrantsManager.html @@ -24,7 +24,7 @@
@@ -1515,7 +1515,7 @@
Example

- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html index d16aad48a..079feeb35 100644 --- a/docs/module-management.GuardianManager.html +++ b/docs/module-management.GuardianManager.html @@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@
Example

- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.HooksManager.html b/docs/module-management.HooksManager.html index feabe7dc3..5596fa9c6 100644 --- a/docs/module-management.HooksManager.html +++ b/docs/module-management.HooksManager.html @@ -24,7 +24,7 @@
@@ -3099,7 +3099,7 @@
Example

- Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html index 40e262d57..b57b0981b 100644 --- a/docs/module-management.JobsManager.html +++ b/docs/module-management.JobsManager.html @@ -24,7 +24,7 @@
@@ -573,14 +573,14 @@

Methods

-

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

+

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

-

Export all users to a file using a long running job.

+

Given a job ID, retrieve the failed/errored items

@@ -616,7 +616,7 @@

exportUser
Source:
@@ -662,7 +662,7 @@

Parameters:
- data + params @@ -687,7 +687,7 @@
Parameters:
-

Users export data.

+

Job parameters.

@@ -701,8 +701,6 @@
Parameters:
Type - Attributes - @@ -715,43 +713,7 @@
Parameters:
- connection_id - - - - - -String - - - - - - - - - <optional>
- - - - - - - - - - - -

The connection id of the connection from which users will be exported

- - - - - - - - - format + id @@ -764,93 +726,11 @@
Parameters:
- - - <optional>
- - - - - - - - - - - -

The format of the file. Valid values are: "json" and "csv".

- - - - - - - - - limit - - - - - -Number - - - - - - - - - <optional>
- - - - - - - -

Limit the number of records.

- - - - - - - - - fields - - - - - -Array.<Object> - - - - - - - - - <optional>
- - - - - - - - - - - -

A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.

+

Job ID.

@@ -945,37 +825,17 @@
Returns:
Example
- 
var data = {
-  connection_id: 'con_0000000000000001',
-  format: 'csv',
-  limit: 5,
-  fields: [
-    {
-      "name": "user_id"
-    },
-    {
-      "name": "name"
-    },
-    {
-      "name": "email"
-    },
-    {
-      "name": "identities[0].connection",
-      "export_as": "provider"
-    },
-    {
-      "name": "user_metadata.some_field"
-    }
-  ]
-}
+    
var params = {
+  id: '{JOB_ID}'
+};
 
-management.jobs.exportUsers(data, function (err, results) {
+management.jobs.errors(params, function (err, job) {
   if (err) {
     // Handle error.
   }
 
   // Retrieved job.
-  console.log(results);
+  console.log(job);
 });
@@ -987,14 +847,14 @@
Example
-

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

+

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

-

Get a job by its ID.

+

Export all users to a file using a long running job.

@@ -1030,7 +890,7 @@

getSource:
@@ -1076,7 +936,7 @@
Parameters:
- params + data @@ -1101,7 +961,7 @@
Parameters:
-

Job parameters.

+

Users export data.

@@ -1115,6 +975,8 @@
Parameters:
Type + Attributes + @@ -1127,7 +989,7 @@
Parameters:
- id + connection_id @@ -1140,11 +1002,129 @@
Parameters:
+ + + <optional>
+ + + + + + + -

Job ID.

+

The connection id of the connection from which users will be exported

+ + + + + + + + + format + + + + + +String + + + + + + + + + <optional>
+ + + + + + + + + + + +

The format of the file. Valid values are: "json" and "csv".

+ + + + + + + + + limit + + + + + +Number + + + + + + + + + <optional>
+ + + + + + + + + + + +

Limit the number of records.

+ + + + + + + + + fields + + + + + +Array.<Object> + + + + + + + + + <optional>
+ + + + + + + + + + + +

A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.

@@ -1239,17 +1219,37 @@
Returns:
Example
- 
var params = {
-  id: '{JOB_ID}'
-};
+    
var data = {
+  connection_id: 'con_0000000000000001',
+  format: 'csv',
+  limit: 5,
+  fields: [
+    {
+      "name": "user_id"
+    },
+    {
+      "name": "name"
+    },
+    {
+      "name": "email"
+    },
+    {
+      "name": "identities[0].connection",
+      "export_as": "provider"
+    },
+    {
+      "name": "user_metadata.some_field"
+    }
+  ]
+}
 
-management.jobs.get(params, function (err, job) {
+management.jobs.exportUsers(data, function (err, results) {
   if (err) {
     // Handle error.
   }
 
   // Retrieved job.
-  console.log(job);
+  console.log(results);
 });
@@ -1268,7 +1268,7 @@

get -

Given a job ID, retrieve the failed/errored items

+

Get a job by its ID.

@@ -1304,7 +1304,7 @@

getSource:
@@ -1517,7 +1517,7 @@
Example
id: '{JOB_ID}' }; -management.jobs.errors(params, function (err, job) { +management.jobs.get(params, function (err, job) { if (err) { // Handle error. } @@ -1665,6 +1665,8 @@
Parameters:
Type + Attributes + @@ -1677,7 +1679,7 @@
Parameters:
- connectionId + connection_id @@ -1690,11 +1692,19 @@
Parameters:
+ + + + + + + + -

Connection for the users insertion.

+

connection_id of the connection to which users will be imported.

@@ -1716,11 +1726,21 @@
Parameters:
+ + + <optional>
+ + + + + + + -

Path to the users data file.

+

Path to the users data file. Either users or users_json is mandatory.

@@ -1742,6 +1762,16 @@
Parameters:
+ + + <optional>
+ + + + + + + @@ -1761,18 +1791,28 @@
Parameters:
-String +Boolean + + + <optional>
+ + + + + + + -

OPTIONAL: set to true to upsert users, defaults to false

+

Whether to update users if they already exist (true) or to ignore them (false).

@@ -1787,18 +1827,28 @@
Parameters:
-String +Boolean + + + <optional>
+ + + + + + + -

OPTIONAL: defaults to true

+

Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).

@@ -1895,9 +1945,7 @@
Example
var params = {
   connection_id: '{CONNECTION_ID}',
-  users: '{PATH_TO_USERS_FILE}',
-  upsert: true, //optional
-  send_completion_email: false //optional
+  users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}'
 };
 
 management.jobs.importUsers(params, function (err) {
@@ -1958,7 +2006,7 @@ 
verifyEmai
     
     
Source:

     

     
 
@@ -2198,7 +2246,7 @@ 
Example

 

 
 

-    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index b63b5f5ad..8658c926c 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
 
 
 
 
 

@@ -1286,7 +1286,7 @@ 
Example

 

 
 

-    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index 4c4449758..c4d9c8d9e 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
 
 
 
 
 

@@ -2491,7 +2491,7 @@ 
addHookS
     
     
Source:

     

     
 
@@ -2796,7 +2796,7 @@ 
a
     
     
Source:

     

     
 
@@ -5061,7 +5061,7 @@ 
cre
     
     
Source:

     

     
 
@@ -5713,7 +5713,7 @@ 
Source:
     

     
 
@@ -5897,7 +5897,7 @@ 
Source:
     

     
 
@@ -6077,7 +6077,7 @@ 
createHook<
     
     
Source:

     

     
 
@@ -6295,7 +6295,7 @@ 
Source:
     

     
 
@@ -6487,7 +6487,7 @@ 
c
     
     
Source:

     

     
 
@@ -6705,7 +6705,7 @@ 
createRole<
     
     
Source:

     

     
 
@@ -8353,7 +8353,7 @@ 
del
     
     
Source:

     

     
 
@@ -9346,7 +9346,7 @@ 
deleteHook<
     
     
Source:

     

     
 
@@ -9615,7 +9615,7 @@ 
d
     
     
Source:

     

     
 
@@ -9884,7 +9884,7 @@ 
deleteRole<
     
     
Source:

     

     
 
@@ -10422,7 +10422,7 @@ 
dele
     
     
Source:

     

     
 
@@ -11558,7 +11558,7 @@ 
exportUser
     
     
Source:

     

     
 
@@ -11972,7 +11972,7 @@ 
getAcce
     
     
Source:

     

     
 
@@ -12444,7 +12444,7 @@ 
ge
     
     
Source:

     

     
 
@@ -14216,7 +14216,7 @@ 
getCus
     
     
Source:

     

     
 
@@ -14485,7 +14485,7 @@ 
getCu
     
     
Source:

     

     
 
@@ -16599,7 +16599,7 @@ 
getHookSource:
     

     
 
@@ -16868,7 +16868,7 @@ 
getHooksSource:
     

     
 
@@ -17195,7 +17195,7 @@ 
getHook
     
     
Source:

     

     
 
@@ -17739,7 +17739,7 @@ 
getLogSource:
     

     
 
@@ -18008,7 +18008,7 @@ 
getLogsSource:
     

     
 
@@ -18515,7 +18515,7 @@ 
g
     
     
Source:

     

     
 
@@ -18739,7 +18739,7 @@ 
getR
     
     
Source:

     

     
 
@@ -19008,7 +19008,7 @@ 
get
     
     
Source:

     

     
 
@@ -19335,7 +19335,7 @@ 
getRoleSource:
     

     
 
@@ -19604,7 +19604,7 @@ 
getRolesSource:
     

     
 
@@ -20527,7 +20527,7 @@ 
getRul
     
     
Source:

     

     
 
@@ -23381,7 +23381,7 @@ 
getUser
     
     
Source:

     

     
 
@@ -23644,7 +23644,8 @@ 
importUser
 
 

     
Given a path to a file and a connection id, create a new job that imports the
-users contained in the file and associate them with the given connection.

+users contained in the file or JSON string and associate them with the given
+connection.

 

 
 
@@ -23765,6 +23766,8 @@ 
Parameters:

         Type
 
         
+        Attributes
+        
 
         
 
@@ -23777,7 +23780,7 @@ 
Parameters:

 
         
             
-                connectionId
+                connection_id
             
 
             
@@ -23790,11 +23793,19 @@ 
Parameters:

             
 
             
+                
+                
+
+                
+
+                
+                
+            
 
             
 
             
-                
Connection for the users insertion.

+                
connection_id of the connection to which users will be imported.

                 
             
         
@@ -23816,11 +23827,129 @@ 
Parameters:

             
 
             
+                
+                
+                    <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>

+                
+
+                
+
+                
+                
+            
 
             
 
             
-                
Path to the users data file.

+                
Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).

                 
             
         
@@ -23917,10 +24046,10 @@ 
Example

 
     
var params = {
   connection_id: '{CONNECTION_ID}',
-  users: '{PATH_TO_USERS_FILE}'
+  users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}'
 };
 
-management.get(params, function (err) {
+management.importUsers(params, function (err) {
   if (err) {
     // Handle error.
   }
@@ -24578,7 +24707,7 @@ 
remo
     
     
Source:

     

     
 
@@ -24883,7 +25012,7 @@ 
Source:
     

     
 
@@ -25976,7 +26105,7 @@ 

     
     
Source:

     

     
 
@@ -26247,7 +26376,7 @@ 
setRule
     
     
Source:

     

     
 
@@ -27774,7 +27903,7 @@ 
Source:
     

     
 
@@ -29508,7 +29637,7 @@ 
updateHook<
     
     
Source:

     

     
 
@@ -29813,7 +29942,7 @@ 
upda
     
     
Source:

     

     
 
@@ -30118,7 +30247,7 @@ 
u
     
     
Source:

     

     
 
@@ -30424,7 +30553,7 @@ 
updateRole<
     
     
Source:

     

     
 
@@ -31865,7 +31994,7 @@ 
ver
     
     
Source:

     

     
 
@@ -32103,7 +32232,7 @@ 
Example

 

 
 

-    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index cfb0e4aed..094b6367a 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
 
 
 
 
 

@@ -633,7 +633,7 @@ 
Returns:

 

 
 

-    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index d3b0a7a49..85722ebb3 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
 
 
 
 
 

@@ -942,7 +942,7 @@ 
Example

 

 
 

-    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 0df0be4a8..f61722c40 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
 
 
 
 
 

@@ -1904,7 +1904,7 @@ 
Example

 

 
 

-    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index 84acdc373..51bd719e3 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
 
 
 
 
 

@@ -377,7 +377,7 @@ 
Parameters:

 

 
 

-    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index b4e0d9add..e4a81c5df 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
 
 
 
 
 

@@ -4293,7 +4293,7 @@ 
Example

 

 
 

-    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b976ae251..c14ae7b68 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
 
 
 
 
 

@@ -1317,7 +1317,7 @@ 
Example

 

 
 

-    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index df521ae84..7790c07ef 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
 
 
 
 
 

@@ -1910,7 +1910,7 @@ 
Example

 

 
 

-    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index fad5d77dd..2494655df 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
 
 
 
 
 

@@ -919,7 +919,7 @@ 
Example

 

 
 

-    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index 07a8228a0..688b10dee 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
 
 
 
 
 

@@ -871,7 +871,7 @@ 
Example

 

 
 

-    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index c127cb06c..a35339679 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
 
 
 
 
 

@@ -805,7 +805,7 @@ 
Example

 

 
 

-    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index 721dd8d41..b4a13effe 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
 
 
 
 
 

@@ -1432,7 +1432,7 @@ 
Example

 

 
 

-    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 1190c6617..1bb1b0360 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
 
 
 
 
 

@@ -5753,7 +5753,7 @@ 
Example

 

 
 

-    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.html b/docs/module-management.html
index 3a337ac36..ce1529c57 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
 
 
 
 
 

@@ -168,7 +168,7 @@ 
Classes

 

 
 

-    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 5aef78c60..b93a24031 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
 
 
 
 
 

@@ -447,7 +447,7 @@ 
(static)
 

 
 

-    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/utils.js.html b/docs/utils.js.html
index c67354430..9566bed48 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
 
 
 
 
 

@@ -168,7 +168,7 @@ 
utils.js

 

 
 

-    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Mar 06 2020 12:40:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/package.json b/package.json
index 70498370b..c796677ca 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "auth0",
-  "version": "2.23.0",
+  "version": "2.24.0",
   "description": "SDK for Auth0 API v2",
   "main": "src/index.js",
   "files": [