From 7dee4e25f5e0d4bf6300e01b8b3fe2bbee9c2895 Mon Sep 17 00:00:00 2001 From: David Patrick Date: Tue, 8 Dec 2020 09:29:24 -0800 Subject: [PATCH] Release v2.31.0 (#559) --- CHANGELOG.md | 13 + docs/RetryRestClient.js.html | 4 +- docs/auth_DatabaseAuthenticator.js.html | 4 +- docs/auth_OAUthWithIDTokenValidation.js.html | 4 +- docs/auth_OAuthAuthenticator.js.html | 12 +- docs/auth_PasswordlessAuthenticator.js.html | 54 +- docs/auth_TokensManager.js.html | 4 +- docs/auth_UsersManager.js.html | 4 +- docs/auth_idToken.js.html | 4 +- docs/auth_index.js.html | 4 +- docs/errors.js.html | 4 +- docs/external-RestClient.html | 4 +- docs/global.html | 4 +- docs/index.html | 4 +- docs/index.js.html | 4 +- ...anagement_BlacklistedTokensManager.js.html | 4 +- docs/management_BrandingManager.js.html | 4 +- docs/management_ClientGrantsManager.js.html | 4 +- docs/management_ClientsManager.js.html | 4 +- docs/management_ConnectionsManager.js.html | 4 +- docs/management_CustomDomainsManager.js.html | 4 +- ...anagement_DeviceCredentialsManager.js.html | 4 +- docs/management_EmailProviderManager.js.html | 4 +- docs/management_EmailTemplatesManager.js.html | 4 +- docs/management_GrantsManager.js.html | 4 +- docs/management_GuardianManager.js.html | 4 +- docs/management_HooksManager.js.html | 4 +- docs/management_JobsManager.js.html | 4 +- docs/management_LogStreamsManager.js.html | 4 +- docs/management_LogsManager.js.html | 4 +- ...management_ManagementTokenProvider.js.html | 4 +- docs/management_MigrationsManager.js.html | 4 +- docs/management_PromptsManager.js.html | 4 +- .../management_ResourceServersManager.js.html | 4 +- docs/management_RolesManager.js.html | 4 +- docs/management_RulesConfigsManager.js.html | 4 +- docs/management_RulesManager.js.html | 4 +- docs/management_StatsManager.js.html | 4 +- docs/management_TenantManager.js.html | 4 +- docs/management_TicketsManager.js.html | 4 +- docs/management_UserBlocksManager.js.html | 4 +- docs/management_UsersManager.js.html | 6 +- docs/management_index.js.html | 38 +- docs/module-auth.AuthenticationClient.html | 6 +- docs/module-auth.DatabaseAuthenticator.html | 4 +- ...odule-auth.OAUthWithIDTokenValidation.html | 4 +- docs/module-auth.OAuthAuthenticator.html | 18 +- ...module-auth.PasswordlessAuthenticator.html | 111 ++- docs/module-auth.TokensManager.html | 4 +- docs/module-auth.UsersManager.html | 4 +- docs/module-auth.html | 4 +- docs/module-errors.html | 4 +- ...e-management.BlacklistedTokensManager.html | 4 +- docs/module-management.BrandingManager.html | 4 +- ...module-management.ClientGrantsManager.html | 4 +- docs/module-management.ClientsManager.html | 4 +- .../module-management.ConnectionsManager.html | 4 +- ...odule-management.CustomDomainsManager.html | 4 +- ...e-management.DeviceCredentialsManager.html | 4 +- ...odule-management.EmailProviderManager.html | 4 +- ...dule-management.EmailTemplatesManager.html | 4 +- docs/module-management.GrantsManager.html | 4 +- docs/module-management.GuardianManager.html | 4 +- docs/module-management.HooksManager.html | 4 +- docs/module-management.JobsManager.html | 4 +- docs/module-management.LogStreamsManager.html | 4 +- docs/module-management.LogsManager.html | 4 +- docs/module-management.ManagementClient.html | 668 +++++++++++++++--- ...le-management.ManagementTokenProvider.html | 4 +- docs/module-management.MigrationsManager.html | 4 +- docs/module-management.PromptsManager.html | 8 +- ...ule-management.ResourceServersManager.html | 4 +- docs/module-management.RetryRestClient.html | 4 +- docs/module-management.RolesManager.html | 8 +- ...module-management.RulesConfigsManager.html | 4 +- docs/module-management.RulesManager.html | 4 +- docs/module-management.StatsManager.html | 4 +- docs/module-management.TenantManager.html | 4 +- docs/module-management.TicketsManager.html | 4 +- docs/module-management.UserBlocksManager.html | 4 +- docs/module-management.UsersManager.html | 70 +- docs/module-management.html | 4 +- docs/module-utils.html | 4 +- docs/utils.js.html | 4 +- package.json | 2 +- 85 files changed, 1007 insertions(+), 295 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index de7537d8e..aa76860ae 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,18 @@ # Change Log +## [v2.31.0](https://github.com/auth0/node-auth0/tree/v2.31.0) (2020-12-08) + +**Added** + +- Updated documentation on Link Users [\#558](https://github.com/auth0/node-auth0/pull/558) ([davidpatrick](https://github.com/davidpatrick)) +- Add support for new passwordless endpoint [\#556](https://github.com/auth0/node-auth0/pull/556) ([nbandarchi](https://github.com/nbandarchi)) + +**Fixed** + +- Adds importUsersJob to ManagementClient [\#553](https://github.com/auth0/node-auth0/pull/553) ([mikemeerschaert](https://github.com/mikemeerschaert)) + +[Full Changelog](https://github.com/auth0/node-auth0/compare/v2.30.0...v2.31.0) + ## [v2.30.0](https://github.com/auth0/node-auth0/tree/v2.30.0) (2020-10-22) **Added** diff --git a/docs/RetryRestClient.js.html b/docs/RetryRestClient.js.html index ae8feeebe..64e305b17 100644 --- a/docs/RetryRestClient.js.html +++ b/docs/RetryRestClient.js.html @@ -24,7 +24,7 @@
@@ -159,7 +159,7 @@

RetryRestClient.js


- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_DatabaseAuthenticator.js.html b/docs/auth_DatabaseAuthenticator.js.html index 84054ae50..05e6f1542 100644 --- a/docs/auth_DatabaseAuthenticator.js.html +++ b/docs/auth_DatabaseAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -348,7 +348,7 @@

auth/DatabaseAuthenticator.js


- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_OAUthWithIDTokenValidation.js.html b/docs/auth_OAUthWithIDTokenValidation.js.html index 8dd7204bd..143bc966d 100644 --- a/docs/auth_OAUthWithIDTokenValidation.js.html +++ b/docs/auth_OAUthWithIDTokenValidation.js.html @@ -24,7 +24,7 @@
@@ -175,7 +175,7 @@

auth/OAUthWithIDTokenValidation.js


- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html index b11803f8b..94ffd8689 100644 --- a/docs/auth_OAuthAuthenticator.js.html +++ b/docs/auth_OAuthAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -58,6 +58,9 @@

auth/OAuthAuthenticator.js

req.set('auth0-forwarded-for', options.forwardedFor); }; } + if (options.type) { + params.type = options.type; + } return params; } @@ -158,7 +161,10 @@

auth/OAuthAuthenticator.js

throw new ArgumentError('Missing user data object'); } - if (typeof data.connection !== 'string' || data.connection.split().length === 0) { + if ( + params.type === 'ro' && + (typeof data.connection !== 'string' || data.connection.split().length === 0) + ) { throw new ArgumentError('connection field is required'); } @@ -455,7 +461,7 @@

auth/OAuthAuthenticator.js


- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html index fec91d017..8835fb28d 100644 --- a/docs/auth_PasswordlessAuthenticator.js.html +++ b/docs/auth_PasswordlessAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -89,7 +89,7 @@

auth/PasswordlessAuthenticator.js

* @example <caption> * Given the user credentials (`phone_number` and `code`), it will do the * authentication on the provider and return a JSON with the `access_token` - * and `id_token`. + * and `id_token` using `/oauth/ro` endpoint. * </caption> * * var data = { @@ -104,6 +104,21 @@

auth/PasswordlessAuthenticator.js

* }); * * @example <caption> + * To use `/oauth/token` endpoint, use `otp` and `realm` instead + * </caption> + * + * var data = { + * username: '{PHONE_NUMBER}', + * otp: '{VERIFICATION_CODE}' + * }; + * + * auth0.passwordless.signIn(data, function (err) { + * if (err) { + * // Handle error. + * } + * }); + * + * @example <caption> * The user data object has the following structure. * </caption> * @@ -114,9 +129,11 @@

auth/PasswordlessAuthenticator.js

* } * * @param {Object} userData User credentials object. - * @param {String} userData.username Username. - * @param {String} userData.password Password. - * @param {String} [userData.connection=sms] Connection string: "sms" or "email". + * @param {String} userData.otp The user's verification code. + * @param {String} [userData.realm=sms] Realm string: "sms" or "email". + * @param {String} userData.username The user's phone number if realm=sms, or the user's email if realm=email + * @param {String} userData.password [DEPRECATED] Password. + * @param {String} [userData.connection=sms] [DEPRECATED] Connection string: "sms" or "email". * @param {Function} [cb] Method callback. * * @return {Promise|undefined} @@ -128,12 +145,6 @@

auth/PasswordlessAuthenticator.js

}; var data = extend(defaultFields, userData); - // Don't let the user override the connection nor the grant type. - if (!data.connection || (data.connection !== 'email' && data.connection !== 'sms')) { - data.connection = 'sms'; - } - data.grant_type = 'password'; - if (!userData || typeof userData !== 'object') { throw new ArgumentError('Missing user data object'); } @@ -142,10 +153,29 @@

auth/PasswordlessAuthenticator.js

throw new ArgumentError('username field (phone number) is required'); } + // If otp is provided, attempt to sign in using otp grant + if (typeof data.otp === 'string' && data.otp.trim().length > 0) { + if (!data.realm || (data.realm !== 'email' && data.realm !== 'sms')) { + data.realm = 'sms'; + } + data.grant_type = 'http://auth0.com/oauth/grant-type/passwordless/otp'; + return this.oauth.signIn(data, { type: 'token' }, cb); + } + + // Don't let the user override the connection nor the grant type. + if (!data.connection || (data.connection !== 'email' && data.connection !== 'sms')) { + data.connection = 'sms'; + } + data.grant_type = 'password'; + if (typeof data.password !== 'string' || data.password.trim().length === 0) { throw new ArgumentError('password field (verification code) is required'); } + console.warn( + 'The oauth/ro endpoint has been deprecated. Please use the realm and otp parameters in this function.' + ); + return this.oauth.signIn(data, cb); }; @@ -290,7 +320,7 @@

auth/PasswordlessAuthenticator.js


- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html index ef9d11300..92235c039 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html index 8b0a3f85a..ef1a2cdc6 100644 --- a/docs/auth_UsersManager.js.html +++ b/docs/auth_UsersManager.js.html @@ -24,7 +24,7 @@
@@ -223,7 +223,7 @@

auth/UsersManager.js


- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_idToken.js.html b/docs/auth_idToken.js.html index a4d97eb9c..ad1d8c66c 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html index 0faa982b9..bcb0c9adf 100644 --- a/docs/auth_index.js.html +++ b/docs/auth_index.js.html @@ -24,7 +24,7 @@
@@ -615,7 +615,7 @@

auth/index.js


- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/errors.js.html b/docs/errors.js.html index 47cafa47d..abdcc6a6a 100644 --- a/docs/errors.js.html +++ b/docs/errors.js.html @@ -24,7 +24,7 @@
@@ -111,7 +111,7 @@

errors.js


- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html index 89d3d4961..d34e362fb 100644 --- a/docs/external-RestClient.html +++ b/docs/external-RestClient.html @@ -24,7 +24,7 @@
@@ -1639,7 +1639,7 @@


- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/global.html b/docs/global.html index 238441a42..345c8793c 100644 --- a/docs/global.html +++ b/docs/global.html @@ -24,7 +24,7 @@
@@ -423,7 +423,7 @@
Returns:

- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/index.html b/docs/index.html index 4b50ba5b0..336b7d8f9 100644 --- a/docs/index.html +++ b/docs/index.html @@ -24,7 +24,7 @@
@@ -176,7 +176,7 @@

License


- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/index.js.html b/docs/index.js.html index 66aff9ef6..e8190fcf7 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html index a7bdbebb5..c8aae6f5b 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_BrandingManager.js.html b/docs/management_BrandingManager.js.html index 831cb634f..ae7c0fb3f 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html index f8f9fe4a3..7c062b5de 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html index d3ebc6af3..f731f1d2e 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html index dd27853f6..e03a84b26 100644 --- a/docs/management_ConnectionsManager.js.html +++ b/docs/management_ConnectionsManager.js.html @@ -24,7 +24,7 @@
@@ -284,7 +284,7 @@

management/ConnectionsManager.js


- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html index 24a62dd45..2d083bec4 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html index 8db772246..90d8c7bda 100644 --- a/docs/management_DeviceCredentialsManager.js.html +++ b/docs/management_DeviceCredentialsManager.js.html @@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@

management/DeviceCredentialsManager.js


- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html index 02c10e4b7..d320b6555 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html index d13675960..380c0dde4 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html index 5d29d57da..edf3ad769 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html index 9bce8eaff..e2a0efba2 100644 --- a/docs/management_GuardianManager.js.html +++ b/docs/management_GuardianManager.js.html @@ -24,7 +24,7 @@
@@ -508,7 +508,7 @@

management/GuardianManager.js


- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_HooksManager.js.html b/docs/management_HooksManager.js.html index 7a1e99c99..68e0ac269 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html index 431f8bea0..e893a7411 100644 --- a/docs/management_JobsManager.js.html +++ b/docs/management_JobsManager.js.html @@ -24,7 +24,7 @@
@@ -439,7 +439,7 @@

management/JobsManager.js


- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_LogStreamsManager.js.html b/docs/management_LogStreamsManager.js.html index de7347290..50df79e57 100644 --- a/docs/management_LogStreamsManager.js.html +++ b/docs/management_LogStreamsManager.js.html @@ -24,7 +24,7 @@
@@ -230,7 +230,7 @@

management/LogStreamsManager.js


- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html index 626a5a812..63579190e 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html index 0232d94eb..3eb5b1e8b 100644 --- a/docs/management_ManagementTokenProvider.js.html +++ b/docs/management_ManagementTokenProvider.js.html @@ -24,7 +24,7 @@
@@ -194,7 +194,7 @@

management/ManagementTokenProvider.js


- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_MigrationsManager.js.html b/docs/management_MigrationsManager.js.html index 83f7d1029..78a082c55 100644 --- a/docs/management_MigrationsManager.js.html +++ b/docs/management_MigrationsManager.js.html @@ -24,7 +24,7 @@
@@ -159,7 +159,7 @@

management/MigrationsManager.js


- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html index 2b47677be..52e507112 100644 --- a/docs/management_PromptsManager.js.html +++ b/docs/management_PromptsManager.js.html @@ -24,7 +24,7 @@
@@ -261,7 +261,7 @@

management/PromptsManager.js


- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html index 6fa45197d..58bbcbc67 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html index 6ea81f448..b604eb0b5 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html index 83ada3db8..d38ab43b1 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html index 1c67c6588..a76c48add 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html index 9973a2c3d..aa2075a8b 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html index 2f309905e..c934e47d9 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html index 3f5c4b379..4c8144ef0 100644 --- a/docs/management_TicketsManager.js.html +++ b/docs/management_TicketsManager.js.html @@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@

management/TicketsManager.js


- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html index 9eeab6dc4..d208fe567 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html index c134e3184..48326f1b9 100644 --- a/docs/management_UsersManager.js.html +++ b/docs/management_UsersManager.js.html @@ -24,7 +24,7 @@
@@ -546,6 +546,8 @@

management/UsersManager.js

* @param {Object} params Secondary user data. * @param {String} params.user_id ID of the user to be linked. * @param {String} params.connection_id ID of the connection to be used. + * @param {String} params.provider Identity provider of the secondary user account being linked. + * @param {String} params.link_with JWT for the secondary account being linked. If sending this parameter, provider, user_id, and connection_id must not be sent. * @param {Function} [cb] Callback function. * * @return {Promise|undefined} @@ -975,7 +977,7 @@

management/UsersManager.js


- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_index.js.html b/docs/management_index.js.html index 49e36799c..f601d93c0 100644 --- a/docs/management_index.js.html +++ b/docs/management_index.js.html @@ -24,7 +24,7 @@
@@ -1357,6 +1357,8 @@

management/index.js

* @param {Object} params Secondary user data. * @param {String} params.user_id ID of the user to be linked. * @param {String} params.connection_id ID of the connection to be used. + * @param {String} params.provider Identity provider of the secondary user account being linked. + * @param {String} params.link_with JWT for the secondary account being linked. If sending this parameter, provider, user_id, and connection_id must not be sent. * @param {Function} [cb] Callback function. * * @return {Promise|undefined} @@ -2139,6 +2141,38 @@

management/index.js

*/ utils.wrapPropertyMethod(ManagementClient, 'importUsers', 'jobs.importUsers'); +/** + * 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.ManagementClient.prototype + * + * @example + * var params = { + * connection_id: '{CONNECTION_ID}', + * users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}' + * }; + * + * management.importUsersJob(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} + */ +utils.wrapPropertyMethod(ManagementClient, 'importUsersJob', 'jobs.importUsersJob'); + /** * Export all users to a file using a long running job. * @@ -3715,7 +3749,7 @@

management/index.js


- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html index a2d48af91..29c10d273 100644 --- a/docs/module-auth.AuthenticationClient.html +++ b/docs/module-auth.AuthenticationClient.html @@ -24,7 +24,7 @@
@@ -4207,10 +4207,10 @@
Examples

- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
- + \ No newline at end of file diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html index 40ef33056..f12b64aee 100644 --- a/docs/module-auth.DatabaseAuthenticator.html +++ b/docs/module-auth.DatabaseAuthenticator.html @@ -24,7 +24,7 @@
@@ -1765,7 +1765,7 @@
Example

- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html index f785180e9..467f8b70e 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html index b7dbfcb1e..c47defe12 100644 --- a/docs/module-auth.OAuthAuthenticator.html +++ b/docs/module-auth.OAuthAuthenticator.html @@ -24,7 +24,7 @@
@@ -102,7 +102,7 @@

new
Source:
@@ -452,7 +452,7 @@

(inner) Source:
@@ -536,7 +536,7 @@

Source:
@@ -777,7 +777,7 @@

password
Source:
@@ -1207,7 +1207,7 @@

refreshTo
Source:
@@ -1444,7 +1444,7 @@

signInSource:
@@ -1845,7 +1845,7 @@

socialSig
Source:
@@ -2050,7 +2050,7 @@

Returns:

- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html index 2e39b07c9..b684b13a1 100644 --- a/docs/module-auth.PasswordlessAuthenticator.html +++ b/docs/module-auth.PasswordlessAuthenticator.html @@ -24,7 +24,7 @@
@@ -491,7 +491,7 @@

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

sendSMSSource:
@@ -1188,6 +1188,86 @@
Parameters:
+ + + otp + + + + + +String + + + + + + + + + + + + + + + + + + + + + + +

The user's verification code.

+ + + + + + + + + realm + + + + + +String + + + + + + + + + <optional>
+ + + + + + + + + + + + sms + + + + + +

Realm string: "sms" or "email".

+ + + + + + username @@ -1219,7 +1299,7 @@
Parameters:
-

Username.

+

The user's phone number if realm=sms, or the user's email if realm=email

@@ -1257,7 +1337,7 @@
Parameters:
-

Password.

+

[DEPRECATED] Password.

@@ -1299,7 +1379,7 @@
Parameters:
-

Connection string: "sms" or "email".

+

[DEPRECATED] Connection string: "sms" or "email".

@@ -1397,7 +1477,7 @@
Examples

Given the user credentials (`phone_number` and `code`), it will do the authentication on the provider and return a JSON with the `access_token` - and `id_token`. + and `id_token` using `/oauth/ro` endpoint.

var data = {
@@ -1405,6 +1485,21 @@ 
Examples
password: '{VERIFICATION_CODE}' }; +auth0.passwordless.signIn(data, function (err) { + if (err) { + // Handle error. + } +});
+ +

+To use `/oauth/token` endpoint, use `otp` and `realm` instead +

+ +
var data = {
+  username: '{PHONE_NUMBER}',
+  otp: '{VERIFICATION_CODE}'
+};
+
 auth0.passwordless.signIn(data, function (err) {
   if (err) {
     // Handle error.
@@ -1442,7 +1537,7 @@ 
Examples

- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html index 043c6e8e2..0d091baa4 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html index 92c1014cf..e241a4c45 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.html b/docs/module-auth.html index 346bec813..f762aabe6 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-errors.html b/docs/module-errors.html index 270f48ad5..f1847d707 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html index 2586666da..cca7a3c1f 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html index d85fa4d96..3bc95e61e 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html index d2bd4d7ea..cd7d683b1 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html index 5cb200099..e8a13271b 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html index e910d7ce5..65318555f 100644 --- a/docs/module-management.ConnectionsManager.html +++ b/docs/module-management.ConnectionsManager.html @@ -24,7 +24,7 @@
@@ -2269,7 +2269,7 @@
Example

- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html index 6d79cf133..21dd9f6b6 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html index 610f8cb50..1e180020c 100644 --- a/docs/module-management.DeviceCredentialsManager.html +++ b/docs/module-management.DeviceCredentialsManager.html @@ -24,7 +24,7 @@
@@ -1215,7 +1215,7 @@
Example

- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html index be1aee0ca..f7aa94edb 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html index b447bd49a..ec2187953 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html index 7c2cb7236..2804cfda0 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html index ecd70a11e..7b2993036 100644 --- a/docs/module-management.GuardianManager.html +++ b/docs/module-management.GuardianManager.html @@ -24,7 +24,7 @@
@@ -4415,7 +4415,7 @@
Example

- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.HooksManager.html b/docs/module-management.HooksManager.html index 864e70a74..53adb8f4d 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html index c91bc784c..3860cfcae 100644 --- a/docs/module-management.JobsManager.html +++ b/docs/module-management.JobsManager.html @@ -24,7 +24,7 @@
@@ -2835,7 +2835,7 @@
Example

- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.LogStreamsManager.html b/docs/module-management.LogStreamsManager.html index 97e865ebe..96a740e21 100644 --- a/docs/module-management.LogStreamsManager.html +++ b/docs/module-management.LogStreamsManager.html @@ -24,7 +24,7 @@
@@ -1763,7 +1763,7 @@
Example

- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html index eb30d022d..bf9f3ed17 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html index 912ee10ff..59a552d06 100644 --- a/docs/module-management.ManagementClient.html +++ b/docs/module-management.ManagementClient.html @@ -24,7 +24,7 @@
@@ -2713,7 +2713,7 @@

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

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

Source:
@@ -3754,7 +3754,7 @@

assi
Source:
@@ -4111,7 +4111,7 @@

blackli
Source:
@@ -4411,7 +4411,7 @@

Source:
@@ -5283,7 +5283,7 @@

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

cr
Source:
@@ -5935,7 +5935,7 @@

Source:
@@ -6119,7 +6119,7 @@

Source:
@@ -6299,7 +6299,7 @@

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

create
Source:
@@ -6735,7 +6735,7 @@

Source:
@@ -6927,7 +6927,7 @@

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

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

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

de
Source:
@@ -9517,7 +9517,7 @@

Source:
@@ -9786,7 +9786,7 @@

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

delete
Source:
@@ -10324,7 +10324,7 @@

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

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

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

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

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

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

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

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

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

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

getDaily
Source:
@@ -15826,7 +15826,7 @@

getEm
Source:
@@ -16141,7 +16141,7 @@

getEm
Source:
@@ -16814,7 +16814,7 @@

Source:
@@ -17079,7 +17079,7 @@

Source:
@@ -17344,7 +17344,7 @@

Source:
@@ -17558,7 +17558,7 @@

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

Source:
@@ -17952,7 +17952,7 @@

Source:
@@ -18132,7 +18132,7 @@

Source:
@@ -18312,7 +18312,7 @@

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

getHookSource:
@@ -18761,7 +18761,7 @@

getHooksSource:
@@ -19088,7 +19088,7 @@

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

getJobSource:
@@ -19632,7 +19632,7 @@

getLogSource:
@@ -19901,7 +19901,7 @@

getLogsSource:
@@ -20408,7 +20408,7 @@

getLogStr
Source:
@@ -20677,7 +20677,7 @@

getMigra
Source:
@@ -20862,7 +20862,7 @@

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

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

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

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

getRoleSource:
@@ -22135,7 +22135,7 @@

getRolesSource:
@@ -23058,7 +23058,7 @@

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

getT
Source:
@@ -23691,7 +23691,7 @@

getUserB
Source:
@@ -23960,7 +23960,7 @@

Source:
@@ -24229,7 +24229,7 @@

getUserLog
Source:
@@ -24604,7 +24604,7 @@

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

getUserRo
Source:
@@ -25976,7 +25976,7 @@

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

importUser
Source:
@@ -26655,6 +26655,434 @@

Example

+
+ + + +

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:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
data + + +Object + + + + + + + + + + +

Users import data.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
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:
+ + + +
+
+ Type: +
+
+ +Promise +| + +undefined + + +
+
+ + + +
+ + + +
+
Example
+ +
var params = {
+  connection_id: '{CONNECTION_ID}',
+  users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}'
+};
+
+management.importUsersJob(params, function (err) {
+  if (err) {
+    // Handle error.
+  }
+});
+ +
+ +
+ +
@@ -26702,7 +27130,7 @@

Source:
@@ -27151,6 +27579,58 @@
Parameters:
+ + + + provider + + + + + +String + + + + + + + + + + +

Identity provider of the secondary user account being linked.

+ + + + + + + + + link_with + + + + + +String + + + + + + + + + + +

JWT for the secondary account being linked. If sending this parameter, provider, user_id, and connection_id must not be sent.

+ + + + + @@ -27306,7 +27786,7 @@

Source:
@@ -27571,7 +28051,7 @@

remo
Source:
@@ -27876,7 +28356,7 @@

Source:
@@ -28255,7 +28735,7 @@

Source:
@@ -28612,7 +29092,7 @@

re
Source:
@@ -28969,7 +29449,7 @@

Source:
@@ -29240,7 +29720,7 @@

setRule
Source:
@@ -29597,7 +30077,7 @@

unblockUse
Source:
@@ -29866,7 +30346,7 @@

unblockUse
Source:
@@ -30767,7 +31247,7 @@

Source:
@@ -31942,7 +32422,7 @@

up
Source:
@@ -32195,7 +32675,7 @@

u
Source:
@@ -32501,7 +32981,7 @@

u
Source:
@@ -32753,7 +33233,7 @@

u
Source:
@@ -33003,7 +33483,7 @@

Source:
@@ -33254,7 +33734,7 @@

Source:
@@ -33555,7 +34035,7 @@

Source:
@@ -33856,7 +34336,7 @@

Source:
@@ -34106,7 +34586,7 @@

updateHook<
Source:
@@ -34411,7 +34891,7 @@

upda
Source:
@@ -34716,7 +35196,7 @@

update
Source:
@@ -35021,7 +35501,7 @@

updat
Source:
@@ -35241,7 +35721,7 @@

Source:
@@ -35457,7 +35937,7 @@

u
Source:
@@ -35763,7 +36243,7 @@

updateRole<
Source:
@@ -36373,7 +36853,7 @@

u
Source:
@@ -37204,7 +37684,7 @@

ver
Source:
@@ -37442,7 +37922,7 @@

Example

- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html index 1ecffb14d..24b9401dd 100644 --- a/docs/module-management.ManagementTokenProvider.html +++ b/docs/module-management.ManagementTokenProvider.html @@ -24,7 +24,7 @@
@@ -673,7 +673,7 @@
Returns:

- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.MigrationsManager.html b/docs/module-management.MigrationsManager.html index 0b23f132f..be6f6c9a1 100644 --- a/docs/module-management.MigrationsManager.html +++ b/docs/module-management.MigrationsManager.html @@ -24,7 +24,7 @@
@@ -885,7 +885,7 @@
Example

- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html index 3f138980e..312ec5991 100644 --- a/docs/module-management.PromptsManager.html +++ b/docs/module-management.PromptsManager.html @@ -24,7 +24,7 @@
@@ -839,7 +839,7 @@

Source:
@@ -1712,7 +1712,7 @@

Source:
@@ -2257,7 +2257,7 @@
Example

- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html index 95cd38f4a..656055922 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html index cdce49551..048cc3972 100644 --- a/docs/module-management.RetryRestClient.html +++ b/docs/module-management.RetryRestClient.html @@ -24,7 +24,7 @@
@@ -417,7 +417,7 @@
Parameters:

- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html index 9a79e8a0c..d198b8e1b 100644 --- a/docs/module-management.RolesManager.html +++ b/docs/module-management.RolesManager.html @@ -24,7 +24,7 @@
@@ -925,7 +925,7 @@

assignRole
Source:
@@ -3651,7 +3651,7 @@

removeRole
Source:
@@ -4293,7 +4293,7 @@

Example

- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html index 43e19e470..466a78d0a 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html index 0ff68b398..6b48c71b3 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html index 085ad162d..9689ce00e 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html index f13494488..d4121219e 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html index 4626a6fb3..09217a724 100644 --- a/docs/module-management.TicketsManager.html +++ b/docs/module-management.TicketsManager.html @@ -24,7 +24,7 @@
@@ -1121,7 +1121,7 @@
Example

- Generated by JSDoc 3.6.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html index f8f436791..4414ea348 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.4 on Thu Oct 22 2020 14:44:11 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html index 78f0ae3ca..0b9107617 100644 --- a/docs/module-management.UsersManager.html +++ b/docs/module-management.UsersManager.html @@ -24,7 +24,7 @@
@@ -2841,7 +2841,7 @@

Source:
@@ -3106,7 +3106,7 @@

getPerm
Source:
@@ -3371,7 +3371,7 @@

getUserRo
Source:
@@ -3636,7 +3636,7 @@

Source:
@@ -4085,6 +4085,58 @@
Parameters:
+ + + + provider + + + + + +String + + + + + + + + + + +

Identity provider of the secondary user account being linked.

+ + + + + + + + + link_with + + + + + +String + + + + + + + + + + +

JWT for the secondary account being linked. If sending this parameter, provider, user_id, and connection_id must not be sent.

+ + + + + @@ -4240,7 +4292,7 @@

logsSource:
@@ -4615,7 +4667,7 @@

Source:
@@ -4880,7 +4932,7 @@