diff --git a/CHANGELOG.md b/CHANGELOG.md index b5074f431..00a46b1ba 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # Change Log +## [v2.33.0](https://github.com/auth0/node-auth0/tree/v2.33.0) (2021-02-05) + +**Added** + +- feat: add revokeRefreshToken [\#579](https://github.com/auth0/node-auth0/pull/579) ([andreafspeziale](https://github.com/andreafspeziale)) +- ULP-2609/ULP-2914: add page templates support to /branding [\#574](https://github.com/auth0/node-auth0/pull/574) ([sebadoom](https://github.com/sebadoom)) + +[Full Changelog](https://github.com/auth0/node-auth0/compare/v2.32.0...v2.33.0) + ## [v2.32.0](https://github.com/auth0/node-auth0/tree/v2.32.0) (2021-01-21) **Added** diff --git a/docs/RetryRestClient.js.html b/docs/RetryRestClient.js.html index 1fd620300..144886bd2 100644 --- a/docs/RetryRestClient.js.html +++ b/docs/RetryRestClient.js.html @@ -24,7 +24,7 @@
@@ -159,7 +159,7 @@

RetryRestClient.js


diff --git a/docs/auth_DatabaseAuthenticator.js.html b/docs/auth_DatabaseAuthenticator.js.html index e58ed2c85..4b2289bb9 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_OAUthWithIDTokenValidation.js.html b/docs/auth_OAUthWithIDTokenValidation.js.html index 24cb84b61..16b1a7b58 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html index 6d66b459d..dce2ec4fc 100644 --- a/docs/auth_OAuthAuthenticator.js.html +++ b/docs/auth_OAuthAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -461,7 +461,7 @@

auth/OAuthAuthenticator.js


- Generated by JSDoc 3.6.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html index 8345970eb..937c62240 100644 --- a/docs/auth_PasswordlessAuthenticator.js.html +++ b/docs/auth_PasswordlessAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -344,7 +344,7 @@

auth/PasswordlessAuthenticator.js


- Generated by JSDoc 3.6.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html index 9a4020ec5..11e577a58 100644 --- a/docs/auth_TokensManager.js.html +++ b/docs/auth_TokensManager.js.html @@ -24,7 +24,7 @@
@@ -308,7 +308,7 @@

auth/TokensManager.js


- Generated by JSDoc 3.6.6 on Mon Feb 01 2021 15:09:19 GMT+0100 (Ora standard dell’Europa centrale) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html index 6abc53eac..495f8bd2c 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_idToken.js.html b/docs/auth_idToken.js.html index be7028583..eba3c7554 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html index 269ed19d9..245203740 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/errors.js.html b/docs/errors.js.html index 729840725..f8d403520 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html index c05a48ac1..94b7c6174 100644 --- a/docs/external-RestClient.html +++ b/docs/external-RestClient.html @@ -24,7 +24,7 @@
@@ -1639,7 +1639,7 @@


- Generated by JSDoc 3.6.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/global.html b/docs/global.html index c968ba37d..34c5399d7 100644 --- a/docs/global.html +++ b/docs/global.html @@ -24,7 +24,7 @@
@@ -423,7 +423,7 @@
Returns:

- Generated by JSDoc 3.6.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/index.html b/docs/index.html index 3e8a57857..b821a38a1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -24,7 +24,7 @@
@@ -176,7 +176,7 @@

License


- Generated by JSDoc 3.6.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/index.js.html b/docs/index.js.html index 847cde28e..ce3f96166 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html index 75d0ddf9a..873f9dd5d 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_BrandingManager.js.html b/docs/management_BrandingManager.js.html index 2d5af4d8c..850c67ddc 100644 --- a/docs/management_BrandingManager.js.html +++ b/docs/management_BrandingManager.js.html @@ -24,7 +24,7 @@
@@ -92,6 +92,19 @@

management/BrandingManager.js

options.tokenProvider ); this.resource = new RetryRestClient(auth0RestClient, options.retry); + + /** + * Provides an abstraction layer for consuming the + * {@link https://auth0.com/docs/api/management/v2#!/Branding/get_universal_login Branding new universal login template endpoint}. + * + * @type {external:RestClient} + */ + var brandingTemplateAuth0RestClient = new Auth0RestClient( + options.baseUrl + '/branding/templates/universal-login', + clientOptions, + options.tokenProvider + ); + this.brandingTemplates = new RetryRestClient(brandingTemplateAuth0RestClient, options.retry); }; /** @@ -142,6 +155,72 @@

management/BrandingManager.js

*/ utils.wrapPropertyMethod(BrandingManager, 'getSettings', 'resource.get'); +/** + * Get the new universal login template. + * + * @method getUniversalLoginTemplate + * @memberOf module:management.BrandingManager.prototype + * + * @example + * management.branding.getUniversalLoginTemplate(data, function (err, template) { + * if (err) { + * // Handle error. + * } + * + * // Branding + * console.log(template); + * }); + * + * @param {Object} params Branding parameters (leave empty). + * @param {Object} data Branding data (leave empty). + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod(BrandingManager, 'getUniversalLoginTemplate', 'brandingTemplates.get'); + +/** + * Set the new universal login template. + * + * @method setUniversalLoginTemplate + * @memberOf module:management.BrandingManager.prototype + * + * @example + * management.branding.setUniversalLoginTemplate({ template: "a template" }, function (err) { + * if (err) { + * // Handle error. + * } + * }); + * + * @param {Object} params Branding parameters (leavy empty). + * @param {Object} data Branding data (object with template field). + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod(BrandingManager, 'setUniversalLoginTemplate', 'brandingTemplates.update'); + +/** + * Delete the new universal login template (revert to default). + * + * @method deleteUniversalLoginTemplate + * @memberOf module:management.BrandingManager.prototype + * + * @example + * management.branding.deleteUniversalLoginTemplate(data, function (err) { + * if (err) { + * // Handle error. + * } + * }); + * + * @param {Object} params Branding parameters (leavy empty). + * @param {Object} data Branding data (leave empty). + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod(BrandingManager, 'deleteUniversalLoginTemplate', 'brandingTemplates.delete'); + module.exports = BrandingManager; @@ -155,7 +234,7 @@

management/BrandingManager.js


- Generated by JSDoc 3.6.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html index 5164a0f47..756dfb9d1 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html index 937827f39..8bd51efde 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html index 0e0775215..f2fd1142f 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html index ebe0700d3..cd2419bd0 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html index 0c87d4c1a..f2c945b4f 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html index 61fc666f7..c1f4410ed 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html index 82ad1b6bc..7e4ccd4bd 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html index 468d4eebc..bf324f0d6 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html index d23eeb8ae..cded592d5 100644 --- a/docs/management_GuardianManager.js.html +++ b/docs/management_GuardianManager.js.html @@ -24,7 +24,7 @@
@@ -559,7 +559,7 @@

management/GuardianManager.js


- Generated by JSDoc 3.6.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_HooksManager.js.html b/docs/management_HooksManager.js.html index 33b9a8a63..1e154c771 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html index 3909c2f90..8ec7899d1 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_LogStreamsManager.js.html b/docs/management_LogStreamsManager.js.html index 5d6889ca5..e521dd0cd 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html index 047297000..8114f63a8 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html index 76493f948..9a11c9277 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_MigrationsManager.js.html b/docs/management_MigrationsManager.js.html index f54356b8e..6df0de382 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html index 9b7c12a3e..522676d07 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html index 24c182400..621fef7d2 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html index 93997d82f..20c9d9853 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html index 83dad4887..79ff24aac 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html index 633925ceb..cdb150601 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html index 0d1649234..1461ba143 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html index 25f38364d..05b601aa2 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html index aab52fba0..0de81d33b 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html index 64ef3b4ba..3e3c00bb8 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html index f6d5ad7a7..e9bfbc14c 100644 --- a/docs/management_UsersManager.js.html +++ b/docs/management_UsersManager.js.html @@ -24,7 +24,7 @@
@@ -983,7 +983,7 @@

management/UsersManager.js


- Generated by JSDoc 3.6.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_index.js.html b/docs/management_index.js.html index f2e393233..7d0a1b91f 100644 --- a/docs/management_index.js.html +++ b/docs/management_index.js.html @@ -24,7 +24,7 @@
@@ -3692,6 +3692,72 @@

management/index.js

*/ utils.wrapPropertyMethod(ManagementClient, 'getBrandingSettings', 'branding.getSettings'); +/** + * Get the new universal login template. + * + * @method getBrandingUniversalLoginTemplate + * @memberOf module:management.ManagementClient.prototype + * + * @example + * management.getBrandingUniversalLoginTemplate(data, function (err, template) { + * if (err) { + * // Handle error. + * } + * + * // Branding + * console.log(template); + * }); + * + * @param {Object} params Branding parameters (leave empty). + * @param {Object} data Branding data (leave empty). + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod(ManagementClient, 'getBrandingUniversalLoginTemplate', 'branding.getUniversalLoginTemplate'); + +/** + * Get the new universal login template. + * + * @method setBrandingUniversalLoginTemplate + * @memberOf module:management.ManagementClient.prototype + * + * @example + * management.setBrandingUniversalLoginTemplate({ template: "a template" }, function (err, template) { + * if (err) { + * // Handle error. + * } + * }); + * + * @param {Object} params Branding parameters (leave empty). + * @param {Object} template Branding data (object with template field). + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod(ManagementClient, 'setBrandingUniversalLoginTemplate', 'branding.setUniversalLoginTemplate'); + +/** + * Delete the new universal login template. + * + * @method deleteBrandingUniversalLoginTemplate + * @memberOf module:management.ManagementClient.prototype + * + * @example + * management.deleteBrandingUniversalLoginTemplate(template, function (err) { + * if (err) { + * // Handle error. + * } + * }); + * + * @param {Object} params Branding parameters (leave empty). + * @param {Object} data Branding data (leave empty). + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod(ManagementClient, 'deleteBrandingUniversalLoginTemplate', 'branding.deleteUniversalLoginTemplate'); + /** * Update the tenant migrations. * @@ -3857,7 +3923,7 @@

management/index.js


- Generated by JSDoc 3.6.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html index 03fa83391..b8240cb74 100644 --- a/docs/module-auth.AuthenticationClient.html +++ b/docs/module-auth.AuthenticationClient.html @@ -24,7 +24,7 @@
@@ -4207,7 +4207,7 @@
Examples

- Generated by JSDoc 3.6.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html index af91ea7a2..75a7148fa 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html index ac77381b5..1f84d9e13 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html index 843904425..7667e9be9 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html index 475d29bdb..af41ab7e6 100644 --- a/docs/module-auth.PasswordlessAuthenticator.html +++ b/docs/module-auth.PasswordlessAuthenticator.html @@ -24,7 +24,7 @@
@@ -1834,7 +1834,7 @@
Examples

- Generated by JSDoc 3.6.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html index 41fb67c4f..4fac89847 100644 --- a/docs/module-auth.TokensManager.html +++ b/docs/module-auth.TokensManager.html @@ -24,7 +24,7 @@
@@ -101,7 +101,7 @@

new Toke
Source:
@@ -293,6 +293,42 @@

Parameters:
+ + + + clientSecret + + + + + +String + + + + + + + + + <optional>
+ + + + + + + + + + + +

Default client Secret.

+ + + + + @@ -352,7 +388,7 @@
Parameters:

- Generated by JSDoc 3.6.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html index 388e4f3af..e2b175178 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.html b/docs/module-auth.html index d956457b4..80b90e83f 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-errors.html b/docs/module-errors.html index 727f1203c..60ed46bf7 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html index 68361d7a8..b82c48fad 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html index 0c111be04..a63d23cf0 100644 --- a/docs/module-management.BrandingManager.html +++ b/docs/module-management.BrandingManager.html @@ -24,7 +24,7 @@
@@ -392,6 +392,81 @@

(inner) + + + +
Type:
+ + + + + + +

+ + + +
+

(inner) brandingTemplateAuth0RestClient :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the +Branding new universal login template endpoint.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + +
@@ -424,14 +499,14 @@

Methods

-

getSettings(params, data, cbopt) → {Promise|undefined}

+

deleteUniversalLoginTemplate(params, data, cbopt) → {Promise|undefined}

-

Get the branding settings..

+

Delete the new universal login template (revert to default).

@@ -467,7 +542,7 @@

getSetting
Source:
@@ -538,7 +613,7 @@

Parameters:
-

Branding parameters.

+

Branding parameters (leavy empty).

@@ -572,7 +647,7 @@
Parameters:
-

Branding data.

+

Branding data (leave empty).

@@ -659,13 +734,766 @@
Returns:
Example
- 
management.branding.getSettings(data, function (err, branding) {
+    
management.branding.deleteUniversalLoginTemplate(data, function (err) {
   if (err) {
     // Handle error.
   }
+});

 
-// Branding
-   console.log(branding);
+
+ +
+ + +
+ + + +

getSettings(params, data, cbopt) → {Promise|undefined}

+ + + + + +
+

Get the branding settings..

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
params + + +Object + + + + + + + + + + +

Branding parameters.

+ +
data + + +Object + + + + + + + + + + +

Branding data.

+ +
cb + + +function + + + + + + <optional>
+ + + + + + 		+

Callback function.

+ +
+ + + + + + + + + + + + + + +
+
Returns:
+ + + +
+
+ Type: +
+
+ +Promise +| + +undefined + + +
+
+ + + +
+ + + +
+
Example
+ + 
management.branding.getSettings(data, function (err, branding) {
+  if (err) {
+    // Handle error.
+  }
+
+// Branding
+   console.log(branding);
+});
+ +
+ +
+ + +
+ + + +

getUniversalLoginTemplate(params, data, cbopt) → {Promise|undefined}

+ + + + + +
+

Get the new universal login template.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
params + + +Object + + + + + + + + + + +

Branding parameters (leave empty).

+ +
data + + +Object + + + + + + + + + + +

Branding data (leave empty).

+ +
cb + + +function + + + + + + <optional>
+ + + + + + 		+

Callback function.

+ +
+ + + + + + + + + + + + + + +
+
Returns:
+ + + +
+
+ Type: +
+
+ +Promise +| + +undefined + + +
+
+ + + +
+ + + +
+
Example
+ + 
management.branding.getUniversalLoginTemplate(data, function (err, template) {
+  if (err) {
+    // Handle error.
+  }
+
+// Branding
+   console.log(template);
+});
+ +
+ +
+ + +
+ + + +

setUniversalLoginTemplate(params, data, cbopt) → {Promise|undefined}

+ + + + + +
+

Set the new universal login template.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
params + + +Object + + + + + + + + + + +

Branding parameters (leavy empty).

+ +
data + + +Object + + + + + + + + + + +

Branding data (object with template field).

+ +
cb + + +function + + + + + + <optional>
+ + + + + + 		+

Callback function.

+ +
+ + + + + + + + + + + + + + +
+
Returns:
+ + + +
+
+ Type: +
+
+ +Promise +| + +undefined + + +
+
+ + + +
+ + + +
+
Example
+ + 
management.branding.setUniversalLoginTemplate({ template: "a template" }, function (err) {
+  if (err) {
+    // Handle error.
+  }
 });
@@ -720,7 +1548,7 @@

updateS
Source:
@@ -942,7 +1770,7 @@

Example

- Generated by JSDoc 3.6.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html index 43b6235a6..f7671a159 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html index 53004a8a2..7fee17ad6 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html index e86bf8710..90126eaf0 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html index 7e2713c00..cffe008c4 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html index 56b5fcbae..a9fa3e060 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html index efbd2c9c9..4f7af385e 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html index 71b3cc382..4e8b17ab0 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html index 11018a156..603acc8db 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html index 40074a738..6f3b2af40 100644 --- a/docs/module-management.GuardianManager.html +++ b/docs/module-management.GuardianManager.html @@ -24,7 +24,7 @@
@@ -4920,7 +4920,7 @@
Example

- Generated by JSDoc 3.6.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.HooksManager.html b/docs/module-management.HooksManager.html index bad90e732..c856e6fff 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html index 100dc7816..518826921 100644 --- a/docs/module-management.JobsManager.html +++ b/docs/module-management.JobsManager.html @@ -24,7 +24,7 @@
@@ -3109,7 +3109,7 @@
Example

- Generated by JSDoc 3.6.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.LogStreamsManager.html b/docs/module-management.LogStreamsManager.html index d07a6fefa..228787292 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html index d59f3ef23..f7a3452c2 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html index 35b1f52cd..0d6dd77c3 100644 --- a/docs/module-management.ManagementClient.html +++ b/docs/module-management.ManagementClient.html @@ -24,7 +24,7 @@
@@ -8326,14 +8326,14 @@
Example
-

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

+

deleteBrandingUniversalLoginTemplate(params, data, cbopt) → {Promise|undefined}

-

Delete an Auth0 client.

+

Delete the new universal login template.

@@ -8369,7 +8369,7 @@

deleteCli
Source:
@@ -8440,58 +8440,41 @@

Parameters:
-

Client parameters.

+

Branding parameters (leave empty).

- - - - - - - - - - - - - - - - - - + + - - + + - + + - - -
NameTypeDescription
client_iddata -String +Object + - + - -

Application client ID.

-
+ + +

Branding data (leave empty).

@@ -8578,12 +8561,10 @@
Returns:
Example
- 
management.deleteClient({ client_id: CLIENT_ID }, function (err) {
+    
management.deleteBrandingUniversalLoginTemplate(template, function (err) {
   if (err) {
     // Handle error.
   }
-
-  // Client deleted.
 });
@@ -8595,14 +8576,14 @@
Example
-

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

+

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

-

Delete an Auth0 client grant.

+

Delete an Auth0 client.

@@ -8638,7 +8619,7 @@

dele
Source:
@@ -8735,7 +8716,7 @@

Parameters:
- id + client_id @@ -8752,7 +8733,7 @@
Parameters:
-

Client grant ID.

+

Application client ID.

@@ -8847,12 +8828,12 @@
Returns:
Example
- 
management.clientGrants.delete({ id: GRANT_ID }, function (err) {
+    
management.deleteClient({ client_id: CLIENT_ID }, function (err) {
   if (err) {
     // Handle error.
   }
 
-  // Grant deleted.
+  // Client deleted.
 });
@@ -8864,14 +8845,14 @@
Example
-

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

+

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

-

Delete an existing connection.

+

Delete an Auth0 client grant.

@@ -8907,7 +8888,7 @@

delet
Source:
@@ -8978,7 +8959,7 @@

Parameters:
-

Connection parameters.

+

Client parameters.

@@ -9021,7 +9002,7 @@
Parameters:
-

Connection ID.

+

Client grant ID.

@@ -9116,12 +9097,12 @@
Returns:
Example
- 
management.deleteConnection({ id: CONNECTION_ID }, function (err) {
+    
management.clientGrants.delete({ id: GRANT_ID }, function (err) {
   if (err) {
     // Handle error.
   }
 
-  // Connection deleted.
+  // Grant deleted.
 });
@@ -9133,14 +9114,14 @@
Example
-

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

+

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

-

Delete a Custom Domain.

+

Delete an existing connection.

@@ -9176,7 +9157,7 @@

del
Source:
@@ -9247,7 +9228,7 @@

Parameters:
-

Custom Domain parameters.

+

Connection parameters.

@@ -9290,7 +9271,7 @@
Parameters:
-

Custom Domain ID.

+

Connection ID.

@@ -9385,12 +9366,12 @@
Returns:
Example
- 
management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
+    
management.deleteConnection({ id: CONNECTION_ID }, function (err) {
   if (err) {
     // Handle error.
   }
 
-  // CustomDomain deleted.
+  // Connection deleted.
 });
@@ -9402,14 +9383,14 @@
Example
-

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

+

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

-

Delete an Auth0 device credential.

+

Delete a Custom Domain.

@@ -9445,7 +9426,7 @@

Source:
@@ -9516,7 +9497,7 @@

Parameters:
-

Credential parameters.

+

Custom Domain parameters.

@@ -9559,7 +9540,7 @@
Parameters:
-

Device credential ID.

+

Custom Domain ID.

@@ -9654,14 +9635,12 @@
Returns:
Example
- 
var params = { id: CREDENTIAL_ID };
-
-management.deleteDeviceCredential(params, function (err) {
+    
management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
   if (err) {
     // Handle error.
   }
 
-  // Credential deleted.
+  // CustomDomain deleted.
 });
@@ -9673,14 +9652,14 @@
Example
-

deleteEmailProvider(cbopt) → {Promise|undefined}

+

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

-

Delete email provider.

+

Delete an Auth0 device credential.

@@ -9716,7 +9695,7 @@

de
Source:
@@ -9760,6 +9739,91 @@

Parameters:
+ + + params + + + + + +Object + + + + + + + + + + + + + + + + + + +

Credential parameters.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
id + + +String + + + + +

Device credential ID.

+ +
+ + + + + + + cb @@ -9840,12 +9904,14 @@
Returns:
Example
- 
management.deleteEmailProvider(function (err) {
+    
var params = { id: CREDENTIAL_ID };
+
+management.deleteDeviceCredential(params, function (err) {
   if (err) {
     // Handle error.
   }
 
-  // Email provider deleted.
+  // Credential deleted.
 });
@@ -9857,14 +9923,14 @@
Example
-

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

+

deleteEmailProvider(cbopt) → {Promise|undefined}

-

Delete a user's Guardian enrollment.

+

Delete email provider.

@@ -9900,7 +9966,7 @@

Source:
@@ -9944,91 +10010,6 @@
Parameters:
- - - data - - - - - -Object - - - - - - - - - - - - - - - - - - -

The Guardian enrollment data object.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
id - - -String - - - - -

The Guardian enrollment id.

- -
- - - - - - - cb @@ -10109,7 +10090,7 @@
Returns:
Example
- 
management.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err) {
+    
management.deleteEmailProvider(function (err) {
   if (err) {
     // Handle error.
   }
@@ -10126,14 +10107,14 @@ 
Example

 
     
 
-    
deleteHook(params, cbopt) → {Promise|undefined}

+    
deleteGuardianEnrollment(data, cbopt) → {Promise|undefined}

 
     
 
 
 
 

-    
Delete an existing hook.

+    
Delete a user's Guardian enrollment.

 

 
 
@@ -10169,7 +10150,7 @@ 
deleteHook<
     
     
Source:

     

     
 
@@ -10215,7 +10196,7 @@ 
Parameters:

 
         
             
-                params
+                data
             
 
             
@@ -10240,7 +10221,7 @@ 
Parameters:

             
 
             
-                
Hook parameters.

+                
The Guardian enrollment data object.

                 
                     
 
@@ -10283,7 +10264,7 @@ 
Parameters:

             
 
             
-                
Hook ID.

+                
The Guardian enrollment id.

                 
             
         
@@ -10378,12 +10359,12 @@ 
Returns:

 

 
Example

 
-    
auth0.deleteHook({ id: HOOK_ID }, function (err) {
+    
management.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err) {
   if (err) {
     // Handle error.
   }
 
-  // Hook deleted.
+  // Email provider deleted.
 });

 
 

@@ -10395,14 +10376,14 @@ 
Example

 
     
 
-    
deleteLogStream(params, cbopt) → {Promise|undefined}

+    
deleteHook(params, cbopt) → {Promise|undefined}

 
     
 
 
 
 

-    
Delete an existing Log Stream.

+    
Delete an existing hook.

 

 
 
@@ -10438,7 +10419,7 @@ 
delete
     
     
Source:

     

     
 
@@ -10509,7 +10490,7 @@ 
Parameters:

             
 
             
-                
Log Stream parameters.

+                
Hook parameters.

                 
                     
 
@@ -10552,7 +10533,7 @@ 
Parameters:

             
 
             
-                
Log Stream ID.

+                
Hook ID.

                 
             
         
@@ -10647,12 +10628,12 @@ 
Returns:

 

 
Example

 
-    
management.deleteLogStream({ id: LOG_STREAM_ID }, function (err) {
+    
auth0.deleteHook({ id: HOOK_ID }, function (err) {
   if (err) {
     // Handle error.
   }
 
-  // Log Stream deleted.
+  // Hook deleted.
 });

 
 

@@ -10664,14 +10645,14 @@ 
Example

 
     
 
-    
deleteResourceServer(params, cbopt) → {Promise|undefined}

+    
deleteLogStream(params, cbopt) → {Promise|undefined}

 
     
 
 
 
 

-    
Delete an existing resource server.

+    
Delete an existing Log Stream.

 

 
 
@@ -10707,7 +10688,7 @@ 
d
     
     
Source:

     

     
 
@@ -10778,7 +10759,7 @@ 
Parameters:

             
 
             
-                
Resource Server parameters.

+                
Log Stream parameters.

                 
                     
 
@@ -10821,7 +10802,7 @@ 
Parameters:

             
 
             
-                
Resource Server ID.

+                
Log Stream ID.

                 
             
         
@@ -10916,12 +10897,12 @@ 
Returns:

 

 
Example

 
-    
management.deleteResourceServer({ id: RESOURCE_SERVER_ID }, function (err) {
+    
management.deleteLogStream({ id: LOG_STREAM_ID }, function (err) {
   if (err) {
     // Handle error.
   }
 
-  // Resource Server deleted.
+  // Log Stream deleted.
 });

 
 

@@ -10933,14 +10914,14 @@ 
Example

 
     
 
-    
deleteRole(params, cbopt) → {Promise|undefined}

+    
deleteResourceServer(params, cbopt) → {Promise|undefined}

 
     
 
 
 
 

-    
Delete an existing role.

+    
Delete an existing resource server.

 

 
 
@@ -10976,7 +10957,7 @@ 
deleteRole<
     
     
Source:

     

     
 
@@ -11047,7 +11028,7 @@ 
Parameters:

             
 
             
-                
Role parameters.

+                
Resource Server parameters.

                 
                     
 
@@ -11090,7 +11071,7 @@ 
Parameters:

             
 
             
-                
Role ID.

+                
Resource Server ID.

                 
             
         
@@ -11185,12 +11166,12 @@ 
Returns:

 

 
Example

 
-    
management.deleteRole({ id: ROLE_ID }, function (err) {
+    
management.deleteResourceServer({ id: RESOURCE_SERVER_ID }, function (err) {
   if (err) {
     // Handle error.
   }
 
-  // Role deleted.
+  // Resource Server deleted.
 });

 
 

@@ -11202,14 +11183,14 @@ 
Example

 
     
 
-    
deleteRule(params, cbopt) → {Promise|undefined}

+    
deleteRole(params, cbopt) → {Promise|undefined}

 
     
 
 
 
 

-    
Delete an existing rule.

+    
Delete an existing role.

 

 
 
@@ -11245,7 +11226,7 @@ 
deleteRule<
     
     
Source:

     

     
 
@@ -11316,7 +11297,7 @@ 
Parameters:

             
 
             
-                
Rule parameters.

+                
Role parameters.

                 
                     
 
@@ -11359,7 +11340,7 @@ 
Parameters:

             
 
             
-                
Rule ID.

+                
Role ID.

                 
             
         
@@ -11454,12 +11435,12 @@ 
Returns:

 

 
Example

 
-    
auth0.deleteRule({ id: RULE_ID }, function (err) {
+    
management.deleteRole({ id: ROLE_ID }, function (err) {
   if (err) {
     // Handle error.
   }
 
-  // Rule deleted.
+  // Role deleted.
 });

 
 

@@ -11471,14 +11452,14 @@ 
Example

 
     
 
-    
deleteRulesConfig(params, cbopt) → {Promise|undefined}

+    
deleteRule(params, cbopt) → {Promise|undefined}

 
     
 
 
 
 

-    
Delete rules config.

+    
Delete an existing rule.

 

 
 
@@ -11514,7 +11495,7 @@ 
dele
     
     
Source:

     

     
 
@@ -11585,7 +11566,7 @@ 
Parameters:

             
 
             
-                
Rule Configs parameters.

+                
Rule parameters.

                 
                     
 
@@ -11611,7 +11592,7 @@ 
Parameters:

 
         
             
-                key
+                id
             
 
             
@@ -11628,7 +11609,7 @@ 
Parameters:

             
 
             
-                
Rule Configs key.

+                
Rule ID.

                 
             
         
@@ -11723,12 +11704,12 @@ 
Returns:

 

 
Example

 
-    
management.deleteRulesConfig({ key: RULE_CONFIG_KEY }, function (err) {
+    
auth0.deleteRule({ id: RULE_ID }, function (err) {
   if (err) {
     // Handle error.
   }
 
-  // Rules Config deleted.
+  // Rule deleted.
 });

 
 

@@ -11740,14 +11721,14 @@ 
Example

 
     
 
-    
deleteUser(params, cbopt) → {Promise|undefined}

+    
deleteRulesConfig(params, cbopt) → {Promise|undefined}

 
     
 
 
 
 

-    
Delete a user by its id.

+    
Delete rules config.

 

 
 
@@ -11783,7 +11764,7 @@ 
deleteUser<
     
     
Source:

     

     
 
@@ -11854,7 +11835,7 @@ 
Parameters:

             
 
             
-                
The user data object..

+                
Rule Configs parameters.

                 
                     
 
@@ -11880,7 +11861,7 @@ 
Parameters:

 
         
             
-                id
+                key
             
 
             
@@ -11897,7 +11878,7 @@ 
Parameters:

             
 
             
-                
The user id.

+                
Rule Configs key.

                 
             
         
@@ -11941,7 +11922,7 @@ 
Parameters:

             
 
             
-                
Callback function

+                
Callback function.

                 
             
         
@@ -11992,12 +11973,12 @@ 
Returns:

 

 
Example

 
-    
management.deleteUser({ id: USER_ID }, function (err) {
+    
management.deleteRulesConfig({ key: RULE_CONFIG_KEY }, function (err) {
   if (err) {
     // Handle error.
   }
 
-  // User deleted.
+  // Rules Config deleted.
 });

 
 

@@ -12009,14 +11990,14 @@ 
Example

 
     
 
-    
deleteUserMultifactor(params, cbopt) → {Promise|undefined}

+    
deleteUser(params, cbopt) → {Promise|undefined}

 
     
 
 
 
 

-    
Delete a multifactor provider for a user.

+    
Delete a user by its id.

 

 
 
@@ -12052,7 +12033,7 @@ 

     
     
Source:

     

     
 
@@ -12123,7 +12104,7 @@ 
Parameters:

             
 
             
-                
Data object.

+                
The user data object..

                 
                     
 
@@ -12172,32 +12153,6 @@ 
Parameters:

         
 
     
-
-        
-            
-                provider
-            
-
-            
-            
-                
-String
-
-
-            
-            
-
-            
-
-            
-
-            
-                
Multifactor provider.

-                
-            
-        
-
-    
     
 
 
@@ -12287,14 +12242,12 @@ 
Returns:

 

 
Example

 
-    
var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-
-management.deleteUserMultifactor(params, function (err, user) {
+    
management.deleteUser({ id: USER_ID }, function (err) {
   if (err) {
     // Handle error.
   }
 
-  // Users accounts unlinked.
+  // User deleted.
 });

 
 

@@ -12306,7 +12259,7 @@ 
Example

 
     
 
-    
deleteUserMultifcator(params, cbopt) → {Promise|undefined}

+    
deleteUserMultifactor(params, cbopt) → {Promise|undefined}

 
     
 
@@ -12337,10 +12290,6 @@ 

     
 
     
-        
Deprecated:
  • The function name has a typo.
-We're shipping this so it doesn't break compatibility.
-Use deleteUserMultifactor instead.

-    
 
     
 
@@ -12353,7 +12302,7 @@ 

     
     
Source:

     

     
 
@@ -12590,7 +12539,7 @@ 
Example

 
     
var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
 
-management.deleteUserMultifcator(params, function (err, user) {
+management.deleteUserMultifactor(params, function (err, user) {
   if (err) {
     // Handle error.
   }
@@ -12607,14 +12556,14 @@ 
Example

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

+    
deleteUserMultifcator(params, cbopt) → {Promise|undefined}

 
     
 
 
 
 

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

+    
Delete a multifactor provider for a user.

 

 
 
@@ -12638,6 +12587,10 @@ 
exportUser
     
 
     
+        
Deprecated:
  • The function name has a typo.
+We're shipping this so it doesn't break compatibility.
+Use deleteUserMultifactor instead.

+    
 
     
 
@@ -12650,7 +12603,7 @@ 
exportUser
     
     
Source:

     

     
 
@@ -12696,7 +12649,7 @@ 
Parameters:

 
         
             
-                data
+                params
             
 
             
@@ -12721,7 +12674,7 @@ 
Parameters:

             
 
             
-                
Users export data.

+                
Data object.

                 
                     
 
@@ -12735,8 +12688,6 @@ 
Parameters:

         Type
 
         
-        Attributes
-        
 
         
 
@@ -12749,7 +12700,7 @@ 
Parameters:

 
         
             
-                connection_id
+                id
             
 
             
@@ -12762,21 +12713,11 @@ 
Parameters:

             
 
             
-                
-                
-                    <optional>

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

+                
The user id.

                 
             
         
@@ -12785,7 +12726,7 @@ 
Parameters:

 
         
             
-                format
+                provider
             
 
             
@@ -12798,93 +12739,402 @@ 
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.

+                
Multifactor provider.

+                
+            
+        
+
+    
+    
+
+
+                
+            
+        
+
+    
+
+        
+            
+                cb
+            
+
+            
+            
+                
+function
+
+
+            
+            
+
+            
+                
+                
+                    <optional>

+                
+
+                
+
+                
+                
+            
+
+            
+
+            
+                
Callback function

+                
+            
+        
+
+    
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+
Returns:

+
+        
+
+

+    

+        Type:
+    

+    

+        
+Promise
+|
+
+undefined
+
+
+    

+

+
+
+    
+

+
+
+
+

+
Example

+
+    
var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
+
+management.deleteUserMultifcator(params, function (err, user) {
+  if (err) {
+    // Handle error.
+  }
+
+  // Users accounts unlinked.
+});

+
+

+
+
+ + +
+ + + +

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

+ + + + + +
+

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

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -
- - - -

getBlacklistedTokens(cbopt) → {Promise|undefined}

- - - - - -
-

Get all blacklisted tokens.

-
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - +
-
NameTypeAttributesDescription
data + + +Object + + + + + + + + + + +

Users export data.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -13218,13 +13468,377 @@
Parameters:
- + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
connection_id + + +String + + + + + + <optional>
+ + + + + + 		+

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.
cbcb + + +function + + + + + + <optional>
+ + + + + + 		+

Callback function.

+ +
+ + + + + + + + + + + + + + +
+
Returns:
+ + + +
+
+ Type: +
+
+ +Promise +| + +undefined + + +
+
+ + + +
+ + + +
+
Example
+ + 
management.getActiveUsersCount(function (err, usersCount) {
+  if (err) {
+    // Handle error.
+  }
+
+  console.log(usersCount);
+});
+ +
+ + + + +
+ + + +

getBlacklistedTokens(cbopt) → {Promise|undefined}

+ + + + + +
+

Get all blacklisted tokens.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
cb + + +function + + + + + + <optional>
+ + + + + + 		+

Callback function.

+ +
+ + + + + + + + + + + + + + +
+
Returns:
+ + + +
+
+ Type: +
+
+ +Promise +| + +undefined + + +
+
+ + + +
+ + + +
+
Example
+ + 
management.getBlacklistedTokens(function (err, tokens) {
+  console.log(tokens.length);
+});
+ +
+ +
+ + +
+ + + +

getBrandingSettings(params, data, cbopt) → {Promise|undefined}

+ + + + + +
+

Get the branding settings..

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + - -
NameTypeAttributesDescription
params -function +Object @@ -13233,8 +13847,6 @@
Parameters:
 - <optional>
- @@ -13245,159 +13857,45 @@
Parameters:
 -

Callback function.

+

Branding parameters.
- - - - - - - - - - - - - - -
-
Returns:
- - - -
-
- Type: -
-
- -Promise -| - -undefined - - -
-
- - - -
- - - -
-
Example
- - 
management.getActiveUsersCount(function (err, usersCount) {
-  if (err) {
-    // Handle error.
-  }
-
-  console.log(usersCount);
-});
-
- -
- +
data + + +Object -
Parameters:
- + +
- - - - - + + + - - - + + + - + - - - + + - @@ -13480,8 +13978,13 @@
Returns:
Example
- 
management.getBlacklistedTokens(function (err, tokens) {
-  console.log(tokens.length);
+    
management.getBrandingSettings(data, function (err, branding) {
+  if (err) {
+    // Handle error.
+  }
+
+// Branding
+   console.log(branding);
 });
@@ -13493,14 +13996,14 @@
Example
-

getBrandingSettings(params, data, cbopt) → {Promise|undefined}

+

getBrandingUniversalLoginTemplate(params, data, cbopt) → {Promise|undefined}

-

Get the branding settings..

+

Get the new universal login template.

@@ -13536,7 +14039,7 @@

ge
Source:
@@ -13607,7 +14110,7 @@

Parameters:
 @@ -13641,7 +14144,7 @@
Parameters:
 @@ -13728,13 +14231,13 @@
Returns:
Example
- 
management.getBrandingSettings(data, function (err, branding) {
+    
management.getBrandingUniversalLoginTemplate(data, function (err, template) {
   if (err) {
     // Handle error.
   }
 
 // Branding
-   console.log(branding);
+   console.log(template);
 });
@@ -21274,7 +21777,7 @@

getMigra
Source:
@@ -21683,7 +22186,7 @@

get
Source:
@@ -29921,7 +30424,92 @@

Parameters:
 - + + + + + + + + + + + + + + +
Name + - TypeAttributesDescription
+

Branding data.

+ +
-

Branding parameters.

+

Branding parameters (leave empty).
-

Branding data.

+

Branding data (leave empty).
idid + + +String + + + + +

user_id

+ +
+ + + + + + + + + + data + + + + + +String + + + + + + + + + + + + + + + + + + +

data object containing list of role IDs

+ + + + + + + + + + + + + + + + + + + + + + + + + + @@ -29953,6 +30541,193 @@
Parameters:
+ + + + + + + + + + + + + + + + + + +
NameTypeDescription
roles @@ -29938,7 +30526,7 @@
Parameters:
 -

user_id

+

Array of role IDs
cb + + +function + + + + + + <optional>
+ + + + + + 		+

Callback function.

+ +
+ + + + + + + + + + + + + + +
+
Returns:
+ + + +
+
+ Type: +
+
+ +Promise +| + +undefined + + +
+
+ + + +
+ + + +
+
Example
+ + 
var parms =  { id : 'USER_ID'};
+var data = { "roles" :["role1"]};
+
+management.removeRolesFromUser(params, data, function (err) {
+  if (err) {
+    // Handle error.
+  }
+
+  // User assigned roles.
+});
+ +
+ +
+ + +
+ + + +

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

+ + + + + +
+

Send a verification email to a user.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + @@ -29961,7 +30736,7 @@
Parameters:
- + @@ -30118,15 +30893,14 @@
Returns:
Example
- 
var parms =  { id : 'USER_ID'};
-var data = { "roles" :["role1"]};
+    
var params = {
+	user_id: '{USER_ID}'
+};
 
-management.removeRolesFromUser(params, data, function (err) {
+management.sendEmailVerification(params, function (err) {
   if (err) {
     // Handle error.
   }
-
-  // User assigned roles.
 });
@@ -30138,14 +30912,14 @@
Example
-

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

+

setBrandingUniversalLoginTemplate(params, template, cbopt) → {Promise|undefined}

-

Send a verification email to a user.

+

Get the new universal login template.

@@ -30181,7 +30955,7 @@

Source:
@@ -30227,7 +31001,7 @@

Parameters:
 - + @@ -30390,11 +31147,7 @@
Returns:
Example
- 
var params = {
-	user_id: '{USER_ID}'
-};
-
-management.sendEmailVerification(params, function (err) {
+    
management.setBrandingUniversalLoginTemplate({ template: "a template" }, function (err, template) {
   if (err) {
     // Handle error.
   }
@@ -36484,7 +37237,7 @@ 
updat
     
     
Source:

     

     
 
@@ -36704,7 +37457,7 @@ 

     
     
Source:

     

     
 
@@ -38905,7 +39658,7 @@ 
Example

 

 
 

-    Generated by JSDoc 3.6.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 4919f9306..e0d63a373 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.MigrationsManager.html b/docs/module-management.MigrationsManager.html
index 900408b09..165961592 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index ab697a17e..0e8b9429a 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 4ad894547..fde62c6a4 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index aea29a357..198d27719 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 3f16d41df..eb4979601 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 18a1e2279..e10323da1 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 2cecbae76..f02cdbf92 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 3c0ff047c..e0656b2f3 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index 605faa889..4e96d27fa 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 4c5ef7eec..711fcbe5c 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index 1fa15aa21..4264e49f3 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.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 3de798f41..1c942f68a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
 
 
 
 
 

@@ -6283,7 +6283,7 @@ 
Example

 

 
 

-    Generated by JSDoc 3.6.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.html b/docs/module-management.html
index aebe1ff30..94dbe4a0e 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
 
 
 
 
 

@@ -174,7 +174,7 @@ 
Classes

 

 
 

-    Generated by JSDoc 3.6.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-utils.html b/docs/module-utils.html
index ada534b97..6ed611866 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
 
 
 
 
 

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

 
 

-    Generated by JSDoc 3.6.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:06 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 6fce3ff1d..0f8a4d928 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
 
 
 
 
 

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

 

 
 

-    Generated by JSDoc 3.6.6 on Thu Jan 21 2021 12:34:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.6 on Fri Feb 05 2021 10:43:05 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/package.json b/package.json
index 3b5bac15a..f3dc3b090 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "auth0",
-  "version": "2.32.0",
+  "version": "2.33.0",
   "description": "SDK for Auth0 API v2",
   "main": "src/index.js",
   "files": [
NameTypeAttributesDescription
data -String +Object @@ -29980,7 +30755,7 @@
Parameters:
 -

data object containing list of role IDs

+

User data object.

@@ -30006,7 +30781,7 @@
Parameters:
rolesuser_id @@ -30023,7 +30798,7 @@
Parameters:
 -

Array of role IDs

+

ID of the user to be verified.
dataparams @@ -30252,58 +31026,41 @@
Parameters:
 -

User data object.

+

Branding parameters (leave empty).

- - - - - - - - - - - - - - - - - - + + - - + + - + + - - -
NameTypeDescription
user_idtemplate -String +Object + - + - -

ID of the user to be verified.

-
+ + 		+

Branding data (object with template field).