var util = require('util');
+
+/**
+ * @module errors
+ */
+var errors = (module.exports = {});
+
+/**
+ * Given a response request error, sanitize sensitive data.
+ *
+ * @method sanitizeErrorRequestData
+ * @memberOf module:errors
+ */
+errors.sanitizeErrorRequestData = function(error) {
+ if (!error.response || !error.response.request || !error.response.request._data) {
+ return error;
+ }
+
+ Object.keys(error.response.request._data).forEach(function(key) {
+ if (key.toLowerCase().match('password|secret')) {
+ error.response.request._data[key] = '[SANITIZED]';
+ }
+ });
+
+ return error;
+};
+
+/**
+ * Given an Api Error, modify the original error and sanitize
+ * sensitive information using sanitizeErrorRequestData
+ *
+ * @method SanitizedError
+ * @memberOf module:errors
+ */
+var SanitizedError = function(name, message, status, requestInfo, originalError) {
+ this.name = name || this.constructor.name || this.constructor.prototype.name || '';
+ this.message = message || '';
+ this.statusCode = status || (originalError && originalError.code);
+ this.requestInfo = Object.assign({}, requestInfo);
+ this.originalError = errors.sanitizeErrorRequestData(originalError);
+
+ Error.captureStackTrace(this, this.constructor);
+};
+
+util.inherits(SanitizedError, Error);
+
+errors.SanitizedError = SanitizedError;
+RetryRestClient.js
diff --git a/docs/auth_DatabaseAuthenticator.js.html b/docs/auth_DatabaseAuthenticator.js.html index e3410b04d..5a832b92b 100644 --- a/docs/auth_DatabaseAuthenticator.js.html +++ b/docs/auth_DatabaseAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -346,7 +346,7 @@
diff --git a/docs/auth_OAUthWithIDTokenValidation.js.html b/docs/auth_OAUthWithIDTokenValidation.js.html index c92039e9b..e853cea9d 100644 --- a/docs/auth_OAUthWithIDTokenValidation.js.html +++ b/docs/auth_OAUthWithIDTokenValidation.js.html @@ -24,7 +24,7 @@
auth/DatabaseAuthenticator.js
diff --git a/docs/auth_OAUthWithIDTokenValidation.js.html b/docs/auth_OAUthWithIDTokenValidation.js.html index c92039e9b..e853cea9d 100644 --- a/docs/auth_OAUthWithIDTokenValidation.js.html +++ b/docs/auth_OAUthWithIDTokenValidation.js.html @@ -24,7 +24,7 @@
@@ -163,7 +163,7 @@
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html index 5b01cef58..f138f6f15 100644 --- a/docs/auth_OAuthAuthenticator.js.html +++ b/docs/auth_OAuthAuthenticator.js.html @@ -24,7 +24,7 @@
auth/OAUthWithIDTokenValidation.js
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html index 5b01cef58..f138f6f15 100644 --- a/docs/auth_OAuthAuthenticator.js.html +++ b/docs/auth_OAuthAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -45,6 +45,7 @@
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html index d21344a5c..1ba23d1ed 100644 --- a/docs/auth_PasswordlessAuthenticator.js.html +++ b/docs/auth_PasswordlessAuthenticator.js.html @@ -24,7 +24,7 @@
auth/OAuthAuthenticator.js
var ArgumentError = require('rest-facade').ArgumentError; var RestClient = require('rest-facade').Client; +var SanitizedError = require('../errors').SanitizedError; var OAUthWithIDTokenValidation = require('./OAUthWithIDTokenValidation'); function getParamsFromOptions(options) { @@ -89,6 +90,7 @@auth/OAuthAuthenticator.js
* @type {Object} */ var clientOptions = { + errorCustomizer: SanitizedError, errorFormatter: { message: 'message', name: 'error' }, headers: options.headers }; @@ -448,7 +450,7 @@auth/OAuthAuthenticator.js
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html index d21344a5c..1ba23d1ed 100644 --- a/docs/auth_PasswordlessAuthenticator.js.html +++ b/docs/auth_PasswordlessAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -287,7 +287,7 @@
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html index d9089b55d..b59104adc 100644 --- a/docs/auth_TokensManager.js.html +++ b/docs/auth_TokensManager.js.html @@ -24,7 +24,7 @@
auth/PasswordlessAuthenticator.js
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html index d9089b55d..b59104adc 100644 --- a/docs/auth_TokensManager.js.html +++ b/docs/auth_TokensManager.js.html @@ -24,7 +24,7 @@
@@ -226,7 +226,7 @@
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html index 82993210e..ce9171abb 100644 --- a/docs/auth_UsersManager.js.html +++ b/docs/auth_UsersManager.js.html @@ -24,7 +24,7 @@
auth/TokensManager.js
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html index 82993210e..ce9171abb 100644 --- a/docs/auth_UsersManager.js.html +++ b/docs/auth_UsersManager.js.html @@ -24,7 +24,7 @@
@@ -224,7 +224,7 @@
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html index 4d34b8428..8ca635db6 100644 --- a/docs/auth_index.js.html +++ b/docs/auth_index.js.html @@ -24,7 +24,7 @@
auth/UsersManager.js
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html index 4d34b8428..8ca635db6 100644 --- a/docs/auth_index.js.html +++ b/docs/auth_index.js.html @@ -24,7 +24,7 @@
@@ -603,7 +603,7 @@
diff --git a/docs/errors.js.html b/docs/errors.js.html new file mode 100644 index 000000000..a5a20120d --- /dev/null +++ b/docs/errors.js.html @@ -0,0 +1,107 @@ + + + + + +errors.js - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + + + + + + diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html index b1402b8ee..be3536675 100644 --- a/docs/external-RestClient.html +++ b/docs/external-RestClient.html @@ -24,7 +24,7 @@
auth/index.js
diff --git a/docs/errors.js.html b/docs/errors.js.html new file mode 100644 index 000000000..a5a20120d --- /dev/null +++ b/docs/errors.js.html @@ -0,0 +1,107 @@ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+errors.js
+ + + + + + + ++ + + + + + + diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html index b1402b8ee..be3536675 100644 --- a/docs/external-RestClient.html +++ b/docs/external-RestClient.html @@ -24,7 +24,7 @@
@@ -87,7 +87,7 @@
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
diff --git a/docs/index.html b/docs/index.html
index 69267ff9f..3a4f8c030 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ License
diff --git a/docs/index.js.html b/docs/index.js.html
index a5c695cb3..b985f7bb8 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -24,7 +24,7 @@
@@ -61,7 +61,7 @@ index.js
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html
index 18c8b12d3..e7bc25fea 100644
--- a/docs/management_BlacklistedTokensManager.js.html
+++ b/docs/management_BlacklistedTokensManager.js.html
@@ -24,7 +24,7 @@
@@ -153,7 +153,7 @@ management/BlacklistedTokensManager.js
diff --git a/docs/management_BrandingManager.js.html b/docs/management_BrandingManager.js.html
index cf394d1b3..bf1dc88a4 100644
--- a/docs/management_BrandingManager.js.html
+++ b/docs/management_BrandingManager.js.html
@@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@ management/BrandingManager.js
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index e6dcde384..f930bb76d 100644
--- a/docs/management_ClientGrantsManager.js.html
+++ b/docs/management_ClientGrantsManager.js.html
@@ -24,7 +24,7 @@
@@ -216,7 +216,7 @@ management/ClientGrantsManager.js
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html
index 718043c3c..8d95cb7b6 100644
--- a/docs/management_ClientsManager.js.html
+++ b/docs/management_ClientsManager.js.html
@@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@ management/ClientsManager.js
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html
index 712848434..765102488 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index a382f144f..09c194bff 100644
--- a/docs/management_CustomDomainsManager.js.html
+++ b/docs/management_CustomDomainsManager.js.html
@@ -24,7 +24,7 @@
@@ -241,7 +241,7 @@ management/CustomDomainsManager.js
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
index 05ed896b3..1744f73d1 100644
--- a/docs/management_DeviceCredentialsManager.js.html
+++ b/docs/management_DeviceCredentialsManager.js.html
@@ -24,7 +24,7 @@
@@ -177,7 +177,7 @@ management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
index 687dbd736..6c0901e8f 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -198,7 +198,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index 95521b87a..48202748c 100644
--- a/docs/management_EmailTemplatesManager.js.html
+++ b/docs/management_EmailTemplatesManager.js.html
@@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@ management/EmailTemplatesManager.js
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html
index e1e0bb1ae..c01d116bc 100644
--- a/docs/management_GrantsManager.js.html
+++ b/docs/management_GrantsManager.js.html
@@ -24,7 +24,7 @@
@@ -170,7 +170,7 @@ management/GrantsManager.js
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index 59c9be7d3..96b17ee17 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index b7c0c404f..71ce6691b 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -413,7 +413,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 7b8b23d14..a32ec12bc 100644
--- a/docs/management_LogsManager.js.html
+++ b/docs/management_LogsManager.js.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ management/LogsManager.js
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html
index d2327a315..4bb10dba6 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -192,7 +192,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html
index 116f67b2f..cc059ef03 100644
--- a/docs/management_PromptsManager.js.html
+++ b/docs/management_PromptsManager.js.html
@@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@ management/PromptsManager.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index c4e8e3327..f69d6d479 100644
--- a/docs/management_ResourceServersManager.js.html
+++ b/docs/management_ResourceServersManager.js.html
@@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@ management/ResourceServersManager.js
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html
index 84e58474a..ab80951eb 100644
--- a/docs/management_RolesManager.js.html
+++ b/docs/management_RolesManager.js.html
@@ -24,7 +24,7 @@
@@ -453,7 +453,7 @@ management/RolesManager.js
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index 02eebf01f..f813f6be4 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 303791a96..65bb8954f 100644
--- a/docs/management_RulesManager.js.html
+++ b/docs/management_RulesManager.js.html
@@ -24,7 +24,7 @@
@@ -248,7 +248,7 @@ management/RulesManager.js
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html
index d6e64c8e3..b1a4f039f 100644
--- a/docs/management_StatsManager.js.html
+++ b/docs/management_StatsManager.js.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ management/StatsManager.js
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html
index 72dd36d02..34e16bd5f 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index e47b880bf..113d1bf3c 100644
--- a/docs/management_TicketsManager.js.html
+++ b/docs/management_TicketsManager.js.html
@@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@ management/TicketsManager.js
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html
index a6554e34b..95fcfd3d0 100644
--- a/docs/management_UserBlocksManager.js.html
+++ b/docs/management_UserBlocksManager.js.html
@@ -24,7 +24,7 @@
@@ -229,7 +229,7 @@ management/UserBlocksManager.js
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html
index 3cb6d7bde..832a49996 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -927,7 +927,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index abac30797..bd6156704 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -1753,6 +1753,76 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'blacklistToken', 'blacklistedTokens.add');
+/**
+ * Create a new Email Template.
+ *
+ * @method createEmailTemplate
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.createEmailTemplate(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * // Email Template created.
+ * });
+ *
+ * @param {Object} data Email Template data object.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'createEmailTemplate', 'emailTemplates.create');
+
+/**
+ * Get an Auth0 Email Template.
+ *
+ * @method getEmailTemplate
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(emailTemplate);
+ * });
+ *
+ * @param {Object} params Email Template parameters.
+ * @param {String} params.name Template Name
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getEmailTemplate', 'emailTemplates.get');
+
+/**
+ * Update an existing Email Template.
+ *
+ * @method updateEmailTemplates
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var data = { from: 'new@email.com' };
+ * var params = { name: EMAIL_TEMPLATE_NAME };
+ *
+ * management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(emailTemplate.from); // 'new@email.com'
+ * });
+ *
+ * @param {Object} params Email Template parameters.
+ * @param {String} params.name Template Name
+ * @param {Object} data Updated Email Template data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'updateEmailTemplate', 'emailTemplates.update');
+
/**
* Get the email provider.
*
@@ -2880,7 +2950,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 2318969f0..beaf697ed 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -3822,7 +3822,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index c958b6a9f..5cca41240 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index f4ca2c526..b8f357216 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -450,7 +450,7 @@ Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index b1081b4ec..fe6720748 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -102,7 +102,7 @@ new
Source:
(inner) Source:
Source:
password
Source:
refreshTo
Source:
signInSource:
socialSig
Source:
Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 2c7338b26..6b4dd491a 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index b90115d33..ecf882540 100644
--- a/docs/module-auth.TokensManager.html
+++ b/docs/module-auth.TokensManager.html
@@ -24,7 +24,7 @@
@@ -352,7 +352,7 @@ Parameters:
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html
index 1fb994b71..c6664357a 100644
--- a/docs/module-auth.UsersManager.html
+++ b/docs/module-auth.UsersManager.html
@@ -24,7 +24,7 @@
@@ -1009,7 +1009,7 @@ Example
diff --git a/docs/module-auth.html b/docs/module-auth.html
index 67edc6ef6..5f31661c2 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@ Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html
new file mode 100644
index 000000000..ba83f853f
--- /dev/null
+++ b/docs/module-errors.html
@@ -0,0 +1,263 @@
+
+
+
+
+
+ errors - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ errors
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ (static) SanitizedError()
+
+
+
+
+
+
+ Given an Api Error, modify the original error and sanitize
+sensitive information using sanitizeErrorRequestData
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 122846930..f69d82d5e 100644
--- a/docs/module-management.BlacklistedTokensManager.html
+++ b/docs/module-management.BlacklistedTokensManager.html
@@ -24,7 +24,7 @@
@@ -991,7 +991,7 @@ Example
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html
index b604f8895..401bda83e 100644
--- a/docs/module-management.BrandingManager.html
+++ b/docs/module-management.BrandingManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index de293e317..74e4efc91 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 81c75d824..a5d4b0146 100644
--- a/docs/module-management.ClientsManager.html
+++ b/docs/module-management.ClientsManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
index d246d9852..09313b8ba 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 33024c066..a2f58e6bf 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -1731,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index c50d0230e..8d5658130 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 85b48818c..98b68990c 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index aa2d4f718..cfe8647da 100644
--- a/docs/module-management.EmailTemplatesManager.html
+++ b/docs/module-management.EmailTemplatesManager.html
@@ -24,7 +24,7 @@
@@ -1304,7 +1304,7 @@ Example
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html
index 4e2f67aee..dfdbc7616 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -24,7 +24,7 @@
@@ -1515,7 +1515,7 @@ Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index fbb741e09..865df2f99 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 43f1c0d5d..cb838e052 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -994,7 +994,7 @@ get
- Given a job ID, retrieve the failed/errored items
+ Get a job by its ID.
@@ -1030,7 +1030,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.errors(params, function (err, job) {
+management.jobs.get(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -1268,7 +1268,7 @@ get
- Get a job by its ID.
+ Given a job ID, retrieve the failed/errored items
@@ -1304,7 +1304,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.get(params, function (err, job) {
+management.jobs.errors(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -2198,7 +2198,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index be6183bb5..b5307d3f3 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
@@ -1286,7 +1286,7 @@ Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index 112165b2c..7fd390a6e 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -2301,7 +2301,7 @@ a
Source:
Source:
cre
Source:
Example
+
+
+
+
+ createEmailTemplate(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Create a new Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template data object.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.createEmailTemplate(data, function (err) {
+ if (err) {
+ // Handle error.
+ // Email Template created.
+});
+
+
+
+
+
+
@@ -5002,7 +5218,7 @@ Source:
Source:
Source:
c
Source:
createRole<
Source:
del
Source:
de
Source:
d
Source:
deleteRole<
Source:
dele
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
getEm
Source:
Example
- getGrants(params, cbopt) → {Promise|undefined}
+ getEmailTemplate(params, cbopt) → {Promise|undefined}
- Get all Auth0 Grants.
+ Get an Auth0 Email Template.
@@ -13945,7 +14161,7 @@ getGrantsSource:
Parameters:
- Grants parameters.
+ Email Template parameters.
@@ -14042,13 +14258,13 @@ Parameters:
- per_pagename
-Number
+String
@@ -14059,7 +14275,15 @@ Parameters:
- Number of results per page.
+ Template Name
+
+
+
+
+
+
+
+
@@ -14068,38 +14292,299 @@ Parameters:
- pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ Callback function.
+
+
-
-
- include_totals
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate);
+});
+
+
+
+
+
+
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
Boolean
@@ -14879,7 +15364,7 @@ getJobSource:
getLogSource:
getLogsSource:
g
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRul
Source:
getT
Source:
getUser
Source:
importUser
Source:
Source:
Source:
setRule
Source:
unblockUse
Source:
Parameters:
- identifierid
@@ -23716,7 +24201,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ The user id.
@@ -23811,7 +24296,7 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
diff --git a/docs/index.html b/docs/index.html
index 69267ff9f..3a4f8c030 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ License
diff --git a/docs/index.js.html b/docs/index.js.html
index a5c695cb3..b985f7bb8 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -24,7 +24,7 @@
@@ -61,7 +61,7 @@ index.js
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html
index 18c8b12d3..e7bc25fea 100644
--- a/docs/management_BlacklistedTokensManager.js.html
+++ b/docs/management_BlacklistedTokensManager.js.html
@@ -24,7 +24,7 @@
@@ -153,7 +153,7 @@ management/BlacklistedTokensManager.js
diff --git a/docs/management_BrandingManager.js.html b/docs/management_BrandingManager.js.html
index cf394d1b3..bf1dc88a4 100644
--- a/docs/management_BrandingManager.js.html
+++ b/docs/management_BrandingManager.js.html
@@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@ management/BrandingManager.js
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index e6dcde384..f930bb76d 100644
--- a/docs/management_ClientGrantsManager.js.html
+++ b/docs/management_ClientGrantsManager.js.html
@@ -24,7 +24,7 @@
@@ -216,7 +216,7 @@ management/ClientGrantsManager.js
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html
index 718043c3c..8d95cb7b6 100644
--- a/docs/management_ClientsManager.js.html
+++ b/docs/management_ClientsManager.js.html
@@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@ management/ClientsManager.js
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html
index 712848434..765102488 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index a382f144f..09c194bff 100644
--- a/docs/management_CustomDomainsManager.js.html
+++ b/docs/management_CustomDomainsManager.js.html
@@ -24,7 +24,7 @@
@@ -241,7 +241,7 @@ management/CustomDomainsManager.js
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
index 05ed896b3..1744f73d1 100644
--- a/docs/management_DeviceCredentialsManager.js.html
+++ b/docs/management_DeviceCredentialsManager.js.html
@@ -24,7 +24,7 @@
@@ -177,7 +177,7 @@ management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
index 687dbd736..6c0901e8f 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -198,7 +198,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index 95521b87a..48202748c 100644
--- a/docs/management_EmailTemplatesManager.js.html
+++ b/docs/management_EmailTemplatesManager.js.html
@@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@ management/EmailTemplatesManager.js
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html
index e1e0bb1ae..c01d116bc 100644
--- a/docs/management_GrantsManager.js.html
+++ b/docs/management_GrantsManager.js.html
@@ -24,7 +24,7 @@
@@ -170,7 +170,7 @@ management/GrantsManager.js
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index 59c9be7d3..96b17ee17 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index b7c0c404f..71ce6691b 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -413,7 +413,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 7b8b23d14..a32ec12bc 100644
--- a/docs/management_LogsManager.js.html
+++ b/docs/management_LogsManager.js.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ management/LogsManager.js
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html
index d2327a315..4bb10dba6 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -192,7 +192,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html
index 116f67b2f..cc059ef03 100644
--- a/docs/management_PromptsManager.js.html
+++ b/docs/management_PromptsManager.js.html
@@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@ management/PromptsManager.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index c4e8e3327..f69d6d479 100644
--- a/docs/management_ResourceServersManager.js.html
+++ b/docs/management_ResourceServersManager.js.html
@@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@ management/ResourceServersManager.js
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html
index 84e58474a..ab80951eb 100644
--- a/docs/management_RolesManager.js.html
+++ b/docs/management_RolesManager.js.html
@@ -24,7 +24,7 @@
@@ -453,7 +453,7 @@ management/RolesManager.js
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index 02eebf01f..f813f6be4 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 303791a96..65bb8954f 100644
--- a/docs/management_RulesManager.js.html
+++ b/docs/management_RulesManager.js.html
@@ -24,7 +24,7 @@
@@ -248,7 +248,7 @@ management/RulesManager.js
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html
index d6e64c8e3..b1a4f039f 100644
--- a/docs/management_StatsManager.js.html
+++ b/docs/management_StatsManager.js.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ management/StatsManager.js
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html
index 72dd36d02..34e16bd5f 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index e47b880bf..113d1bf3c 100644
--- a/docs/management_TicketsManager.js.html
+++ b/docs/management_TicketsManager.js.html
@@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@ management/TicketsManager.js
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html
index a6554e34b..95fcfd3d0 100644
--- a/docs/management_UserBlocksManager.js.html
+++ b/docs/management_UserBlocksManager.js.html
@@ -24,7 +24,7 @@
@@ -229,7 +229,7 @@ management/UserBlocksManager.js
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html
index 3cb6d7bde..832a49996 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -927,7 +927,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index abac30797..bd6156704 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -1753,6 +1753,76 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'blacklistToken', 'blacklistedTokens.add');
+/**
+ * Create a new Email Template.
+ *
+ * @method createEmailTemplate
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.createEmailTemplate(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * // Email Template created.
+ * });
+ *
+ * @param {Object} data Email Template data object.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'createEmailTemplate', 'emailTemplates.create');
+
+/**
+ * Get an Auth0 Email Template.
+ *
+ * @method getEmailTemplate
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(emailTemplate);
+ * });
+ *
+ * @param {Object} params Email Template parameters.
+ * @param {String} params.name Template Name
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getEmailTemplate', 'emailTemplates.get');
+
+/**
+ * Update an existing Email Template.
+ *
+ * @method updateEmailTemplates
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var data = { from: 'new@email.com' };
+ * var params = { name: EMAIL_TEMPLATE_NAME };
+ *
+ * management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(emailTemplate.from); // 'new@email.com'
+ * });
+ *
+ * @param {Object} params Email Template parameters.
+ * @param {String} params.name Template Name
+ * @param {Object} data Updated Email Template data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'updateEmailTemplate', 'emailTemplates.update');
+
/**
* Get the email provider.
*
@@ -2880,7 +2950,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 2318969f0..beaf697ed 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -3822,7 +3822,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index c958b6a9f..5cca41240 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index f4ca2c526..b8f357216 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -450,7 +450,7 @@ Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index b1081b4ec..fe6720748 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -102,7 +102,7 @@ new
Source:
(inner) Source:
Source:
password
Source:
refreshTo
Source:
signInSource:
socialSig
Source:
Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 2c7338b26..6b4dd491a 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index b90115d33..ecf882540 100644
--- a/docs/module-auth.TokensManager.html
+++ b/docs/module-auth.TokensManager.html
@@ -24,7 +24,7 @@
@@ -352,7 +352,7 @@ Parameters:
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html
index 1fb994b71..c6664357a 100644
--- a/docs/module-auth.UsersManager.html
+++ b/docs/module-auth.UsersManager.html
@@ -24,7 +24,7 @@
@@ -1009,7 +1009,7 @@ Example
diff --git a/docs/module-auth.html b/docs/module-auth.html
index 67edc6ef6..5f31661c2 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@ Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html
new file mode 100644
index 000000000..ba83f853f
--- /dev/null
+++ b/docs/module-errors.html
@@ -0,0 +1,263 @@
+
+
+
+
+
+ errors - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ errors
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ (static) SanitizedError()
+
+
+
+
+
+
+ Given an Api Error, modify the original error and sanitize
+sensitive information using sanitizeErrorRequestData
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 122846930..f69d82d5e 100644
--- a/docs/module-management.BlacklistedTokensManager.html
+++ b/docs/module-management.BlacklistedTokensManager.html
@@ -24,7 +24,7 @@
@@ -991,7 +991,7 @@ Example
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html
index b604f8895..401bda83e 100644
--- a/docs/module-management.BrandingManager.html
+++ b/docs/module-management.BrandingManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index de293e317..74e4efc91 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 81c75d824..a5d4b0146 100644
--- a/docs/module-management.ClientsManager.html
+++ b/docs/module-management.ClientsManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
index d246d9852..09313b8ba 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 33024c066..a2f58e6bf 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -1731,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index c50d0230e..8d5658130 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 85b48818c..98b68990c 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index aa2d4f718..cfe8647da 100644
--- a/docs/module-management.EmailTemplatesManager.html
+++ b/docs/module-management.EmailTemplatesManager.html
@@ -24,7 +24,7 @@
@@ -1304,7 +1304,7 @@ Example
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html
index 4e2f67aee..dfdbc7616 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -24,7 +24,7 @@
@@ -1515,7 +1515,7 @@ Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index fbb741e09..865df2f99 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 43f1c0d5d..cb838e052 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -994,7 +994,7 @@ get
- Given a job ID, retrieve the failed/errored items
+ Get a job by its ID.
@@ -1030,7 +1030,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.errors(params, function (err, job) {
+management.jobs.get(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -1268,7 +1268,7 @@ get
- Get a job by its ID.
+ Given a job ID, retrieve the failed/errored items
@@ -1304,7 +1304,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.get(params, function (err, job) {
+management.jobs.errors(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -2198,7 +2198,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index be6183bb5..b5307d3f3 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
@@ -1286,7 +1286,7 @@ Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index 112165b2c..7fd390a6e 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -2301,7 +2301,7 @@ a
Source:
Source:
cre
Source:
Example
+
+
+
+
+ createEmailTemplate(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Create a new Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template data object.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.createEmailTemplate(data, function (err) {
+ if (err) {
+ // Handle error.
+ // Email Template created.
+});
+
+
+
+
+
+
@@ -5002,7 +5218,7 @@ Source:
Source:
Source:
c
Source:
createRole<
Source:
del
Source:
de
Source:
d
Source:
deleteRole<
Source:
dele
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
getEm
Source:
Example
- getGrants(params, cbopt) → {Promise|undefined}
+ getEmailTemplate(params, cbopt) → {Promise|undefined}
- Get all Auth0 Grants.
+ Get an Auth0 Email Template.
@@ -13945,7 +14161,7 @@ getGrantsSource:
Parameters:
- Grants parameters.
+ Email Template parameters.
@@ -14042,13 +14258,13 @@ Parameters:
- per_pagename
-Number
+String
@@ -14059,7 +14275,15 @@ Parameters:
- Number of results per page.
+ Template Name
+
+
+
+
+
+
+
+
@@ -14068,38 +14292,299 @@ Parameters:
- pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ Callback function.
+
+
-
-
- include_totals
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate);
+});
+
+
+
+
+
+
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
Boolean
@@ -14879,7 +15364,7 @@ getJobSource:
getLogSource:
getLogsSource:
g
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRul
Source:
getT
Source:
getUser
Source:
importUser
Source:
Source:
Source:
setRule
Source:
unblockUse
Source:
Parameters:
- identifierid
@@ -23716,7 +24201,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ The user id.
@@ -23811,7 +24296,7 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
diff --git a/docs/index.html b/docs/index.html
index 69267ff9f..3a4f8c030 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ License
diff --git a/docs/index.js.html b/docs/index.js.html
index a5c695cb3..b985f7bb8 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -24,7 +24,7 @@
@@ -61,7 +61,7 @@ index.js
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html
index 18c8b12d3..e7bc25fea 100644
--- a/docs/management_BlacklistedTokensManager.js.html
+++ b/docs/management_BlacklistedTokensManager.js.html
@@ -24,7 +24,7 @@
@@ -153,7 +153,7 @@ management/BlacklistedTokensManager.js
diff --git a/docs/management_BrandingManager.js.html b/docs/management_BrandingManager.js.html
index cf394d1b3..bf1dc88a4 100644
--- a/docs/management_BrandingManager.js.html
+++ b/docs/management_BrandingManager.js.html
@@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@ management/BrandingManager.js
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index e6dcde384..f930bb76d 100644
--- a/docs/management_ClientGrantsManager.js.html
+++ b/docs/management_ClientGrantsManager.js.html
@@ -24,7 +24,7 @@
@@ -216,7 +216,7 @@ management/ClientGrantsManager.js
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html
index 718043c3c..8d95cb7b6 100644
--- a/docs/management_ClientsManager.js.html
+++ b/docs/management_ClientsManager.js.html
@@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@ management/ClientsManager.js
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html
index 712848434..765102488 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index a382f144f..09c194bff 100644
--- a/docs/management_CustomDomainsManager.js.html
+++ b/docs/management_CustomDomainsManager.js.html
@@ -24,7 +24,7 @@
@@ -241,7 +241,7 @@ management/CustomDomainsManager.js
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
index 05ed896b3..1744f73d1 100644
--- a/docs/management_DeviceCredentialsManager.js.html
+++ b/docs/management_DeviceCredentialsManager.js.html
@@ -24,7 +24,7 @@
@@ -177,7 +177,7 @@ management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
index 687dbd736..6c0901e8f 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -198,7 +198,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index 95521b87a..48202748c 100644
--- a/docs/management_EmailTemplatesManager.js.html
+++ b/docs/management_EmailTemplatesManager.js.html
@@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@ management/EmailTemplatesManager.js
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html
index e1e0bb1ae..c01d116bc 100644
--- a/docs/management_GrantsManager.js.html
+++ b/docs/management_GrantsManager.js.html
@@ -24,7 +24,7 @@
@@ -170,7 +170,7 @@ management/GrantsManager.js
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index 59c9be7d3..96b17ee17 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index b7c0c404f..71ce6691b 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -413,7 +413,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 7b8b23d14..a32ec12bc 100644
--- a/docs/management_LogsManager.js.html
+++ b/docs/management_LogsManager.js.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ management/LogsManager.js
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html
index d2327a315..4bb10dba6 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -192,7 +192,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html
index 116f67b2f..cc059ef03 100644
--- a/docs/management_PromptsManager.js.html
+++ b/docs/management_PromptsManager.js.html
@@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@ management/PromptsManager.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index c4e8e3327..f69d6d479 100644
--- a/docs/management_ResourceServersManager.js.html
+++ b/docs/management_ResourceServersManager.js.html
@@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@ management/ResourceServersManager.js
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html
index 84e58474a..ab80951eb 100644
--- a/docs/management_RolesManager.js.html
+++ b/docs/management_RolesManager.js.html
@@ -24,7 +24,7 @@
@@ -453,7 +453,7 @@ management/RolesManager.js
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index 02eebf01f..f813f6be4 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 303791a96..65bb8954f 100644
--- a/docs/management_RulesManager.js.html
+++ b/docs/management_RulesManager.js.html
@@ -24,7 +24,7 @@
@@ -248,7 +248,7 @@ management/RulesManager.js
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html
index d6e64c8e3..b1a4f039f 100644
--- a/docs/management_StatsManager.js.html
+++ b/docs/management_StatsManager.js.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ management/StatsManager.js
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html
index 72dd36d02..34e16bd5f 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index e47b880bf..113d1bf3c 100644
--- a/docs/management_TicketsManager.js.html
+++ b/docs/management_TicketsManager.js.html
@@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@ management/TicketsManager.js
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html
index a6554e34b..95fcfd3d0 100644
--- a/docs/management_UserBlocksManager.js.html
+++ b/docs/management_UserBlocksManager.js.html
@@ -24,7 +24,7 @@
@@ -229,7 +229,7 @@ management/UserBlocksManager.js
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html
index 3cb6d7bde..832a49996 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -927,7 +927,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index abac30797..bd6156704 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -1753,6 +1753,76 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'blacklistToken', 'blacklistedTokens.add');
+/**
+ * Create a new Email Template.
+ *
+ * @method createEmailTemplate
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.createEmailTemplate(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * // Email Template created.
+ * });
+ *
+ * @param {Object} data Email Template data object.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'createEmailTemplate', 'emailTemplates.create');
+
+/**
+ * Get an Auth0 Email Template.
+ *
+ * @method getEmailTemplate
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(emailTemplate);
+ * });
+ *
+ * @param {Object} params Email Template parameters.
+ * @param {String} params.name Template Name
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getEmailTemplate', 'emailTemplates.get');
+
+/**
+ * Update an existing Email Template.
+ *
+ * @method updateEmailTemplates
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var data = { from: 'new@email.com' };
+ * var params = { name: EMAIL_TEMPLATE_NAME };
+ *
+ * management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(emailTemplate.from); // 'new@email.com'
+ * });
+ *
+ * @param {Object} params Email Template parameters.
+ * @param {String} params.name Template Name
+ * @param {Object} data Updated Email Template data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'updateEmailTemplate', 'emailTemplates.update');
+
/**
* Get the email provider.
*
@@ -2880,7 +2950,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 2318969f0..beaf697ed 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -3822,7 +3822,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index c958b6a9f..5cca41240 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index f4ca2c526..b8f357216 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -450,7 +450,7 @@ Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index b1081b4ec..fe6720748 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -102,7 +102,7 @@ new
Source:
(inner) Source:
Source:
password
Source:
refreshTo
Source:
signInSource:
socialSig
Source:
Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 2c7338b26..6b4dd491a 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index b90115d33..ecf882540 100644
--- a/docs/module-auth.TokensManager.html
+++ b/docs/module-auth.TokensManager.html
@@ -24,7 +24,7 @@
@@ -352,7 +352,7 @@ Parameters:
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html
index 1fb994b71..c6664357a 100644
--- a/docs/module-auth.UsersManager.html
+++ b/docs/module-auth.UsersManager.html
@@ -24,7 +24,7 @@
@@ -1009,7 +1009,7 @@ Example
diff --git a/docs/module-auth.html b/docs/module-auth.html
index 67edc6ef6..5f31661c2 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@ Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html
new file mode 100644
index 000000000..ba83f853f
--- /dev/null
+++ b/docs/module-errors.html
@@ -0,0 +1,263 @@
+
+
+
+
+
+ errors - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ errors
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ (static) SanitizedError()
+
+
+
+
+
+
+ Given an Api Error, modify the original error and sanitize
+sensitive information using sanitizeErrorRequestData
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 122846930..f69d82d5e 100644
--- a/docs/module-management.BlacklistedTokensManager.html
+++ b/docs/module-management.BlacklistedTokensManager.html
@@ -24,7 +24,7 @@
@@ -991,7 +991,7 @@ Example
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html
index b604f8895..401bda83e 100644
--- a/docs/module-management.BrandingManager.html
+++ b/docs/module-management.BrandingManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index de293e317..74e4efc91 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 81c75d824..a5d4b0146 100644
--- a/docs/module-management.ClientsManager.html
+++ b/docs/module-management.ClientsManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
index d246d9852..09313b8ba 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 33024c066..a2f58e6bf 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -1731,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index c50d0230e..8d5658130 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 85b48818c..98b68990c 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index aa2d4f718..cfe8647da 100644
--- a/docs/module-management.EmailTemplatesManager.html
+++ b/docs/module-management.EmailTemplatesManager.html
@@ -24,7 +24,7 @@
@@ -1304,7 +1304,7 @@ Example
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html
index 4e2f67aee..dfdbc7616 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -24,7 +24,7 @@
@@ -1515,7 +1515,7 @@ Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index fbb741e09..865df2f99 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 43f1c0d5d..cb838e052 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -994,7 +994,7 @@ get
- Given a job ID, retrieve the failed/errored items
+ Get a job by its ID.
@@ -1030,7 +1030,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.errors(params, function (err, job) {
+management.jobs.get(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -1268,7 +1268,7 @@ get
- Get a job by its ID.
+ Given a job ID, retrieve the failed/errored items
@@ -1304,7 +1304,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.get(params, function (err, job) {
+management.jobs.errors(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -2198,7 +2198,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index be6183bb5..b5307d3f3 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
@@ -1286,7 +1286,7 @@ Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index 112165b2c..7fd390a6e 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -2301,7 +2301,7 @@ a
Source:
Source:
cre
Source:
Example
+
+
+
+
+ createEmailTemplate(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Create a new Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template data object.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.createEmailTemplate(data, function (err) {
+ if (err) {
+ // Handle error.
+ // Email Template created.
+});
+
+
+
+
+
+
@@ -5002,7 +5218,7 @@ Source:
Source:
Source:
c
Source:
createRole<
Source:
del
Source:
de
Source:
d
Source:
deleteRole<
Source:
dele
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
getEm
Source:
Example
- getGrants(params, cbopt) → {Promise|undefined}
+ getEmailTemplate(params, cbopt) → {Promise|undefined}
- Get all Auth0 Grants.
+ Get an Auth0 Email Template.
@@ -13945,7 +14161,7 @@ getGrantsSource:
Parameters:
- Grants parameters.
+ Email Template parameters.
@@ -14042,13 +14258,13 @@ Parameters:
- per_pagename
-Number
+String
@@ -14059,7 +14275,15 @@ Parameters:
- Number of results per page.
+ Template Name
+
+
+
+
+
+
+
+
@@ -14068,38 +14292,299 @@ Parameters:
- pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ Callback function.
+
+
-
-
- include_totals
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate);
+});
+
+
+
+
+
+
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
Boolean
@@ -14879,7 +15364,7 @@ getJobSource:
getLogSource:
getLogsSource:
g
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRul
Source:
getT
Source:
getUser
Source:
importUser
Source:
Source:
Source:
setRule
Source:
unblockUse
Source:
Parameters:
- identifierid
@@ -23716,7 +24201,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ The user id.
@@ -23811,7 +24296,7 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
diff --git a/docs/index.html b/docs/index.html
index 69267ff9f..3a4f8c030 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ License
diff --git a/docs/index.js.html b/docs/index.js.html
index a5c695cb3..b985f7bb8 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -24,7 +24,7 @@
@@ -61,7 +61,7 @@ index.js
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html
index 18c8b12d3..e7bc25fea 100644
--- a/docs/management_BlacklistedTokensManager.js.html
+++ b/docs/management_BlacklistedTokensManager.js.html
@@ -24,7 +24,7 @@
@@ -153,7 +153,7 @@ management/BlacklistedTokensManager.js
diff --git a/docs/management_BrandingManager.js.html b/docs/management_BrandingManager.js.html
index cf394d1b3..bf1dc88a4 100644
--- a/docs/management_BrandingManager.js.html
+++ b/docs/management_BrandingManager.js.html
@@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@ management/BrandingManager.js
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index e6dcde384..f930bb76d 100644
--- a/docs/management_ClientGrantsManager.js.html
+++ b/docs/management_ClientGrantsManager.js.html
@@ -24,7 +24,7 @@
@@ -216,7 +216,7 @@ management/ClientGrantsManager.js
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html
index 718043c3c..8d95cb7b6 100644
--- a/docs/management_ClientsManager.js.html
+++ b/docs/management_ClientsManager.js.html
@@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@ management/ClientsManager.js
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html
index 712848434..765102488 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index a382f144f..09c194bff 100644
--- a/docs/management_CustomDomainsManager.js.html
+++ b/docs/management_CustomDomainsManager.js.html
@@ -24,7 +24,7 @@
@@ -241,7 +241,7 @@ management/CustomDomainsManager.js
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
index 05ed896b3..1744f73d1 100644
--- a/docs/management_DeviceCredentialsManager.js.html
+++ b/docs/management_DeviceCredentialsManager.js.html
@@ -24,7 +24,7 @@
@@ -177,7 +177,7 @@ management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
index 687dbd736..6c0901e8f 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -198,7 +198,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index 95521b87a..48202748c 100644
--- a/docs/management_EmailTemplatesManager.js.html
+++ b/docs/management_EmailTemplatesManager.js.html
@@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@ management/EmailTemplatesManager.js
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html
index e1e0bb1ae..c01d116bc 100644
--- a/docs/management_GrantsManager.js.html
+++ b/docs/management_GrantsManager.js.html
@@ -24,7 +24,7 @@
@@ -170,7 +170,7 @@ management/GrantsManager.js
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index 59c9be7d3..96b17ee17 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index b7c0c404f..71ce6691b 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -413,7 +413,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 7b8b23d14..a32ec12bc 100644
--- a/docs/management_LogsManager.js.html
+++ b/docs/management_LogsManager.js.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ management/LogsManager.js
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html
index d2327a315..4bb10dba6 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -192,7 +192,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html
index 116f67b2f..cc059ef03 100644
--- a/docs/management_PromptsManager.js.html
+++ b/docs/management_PromptsManager.js.html
@@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@ management/PromptsManager.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index c4e8e3327..f69d6d479 100644
--- a/docs/management_ResourceServersManager.js.html
+++ b/docs/management_ResourceServersManager.js.html
@@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@ management/ResourceServersManager.js
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html
index 84e58474a..ab80951eb 100644
--- a/docs/management_RolesManager.js.html
+++ b/docs/management_RolesManager.js.html
@@ -24,7 +24,7 @@
@@ -453,7 +453,7 @@ management/RolesManager.js
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index 02eebf01f..f813f6be4 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 303791a96..65bb8954f 100644
--- a/docs/management_RulesManager.js.html
+++ b/docs/management_RulesManager.js.html
@@ -24,7 +24,7 @@
@@ -248,7 +248,7 @@ management/RulesManager.js
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html
index d6e64c8e3..b1a4f039f 100644
--- a/docs/management_StatsManager.js.html
+++ b/docs/management_StatsManager.js.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ management/StatsManager.js
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html
index 72dd36d02..34e16bd5f 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index e47b880bf..113d1bf3c 100644
--- a/docs/management_TicketsManager.js.html
+++ b/docs/management_TicketsManager.js.html
@@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@ management/TicketsManager.js
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html
index a6554e34b..95fcfd3d0 100644
--- a/docs/management_UserBlocksManager.js.html
+++ b/docs/management_UserBlocksManager.js.html
@@ -24,7 +24,7 @@
@@ -229,7 +229,7 @@ management/UserBlocksManager.js
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html
index 3cb6d7bde..832a49996 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -927,7 +927,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index abac30797..bd6156704 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -1753,6 +1753,76 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'blacklistToken', 'blacklistedTokens.add');
+/**
+ * Create a new Email Template.
+ *
+ * @method createEmailTemplate
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.createEmailTemplate(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * // Email Template created.
+ * });
+ *
+ * @param {Object} data Email Template data object.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'createEmailTemplate', 'emailTemplates.create');
+
+/**
+ * Get an Auth0 Email Template.
+ *
+ * @method getEmailTemplate
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(emailTemplate);
+ * });
+ *
+ * @param {Object} params Email Template parameters.
+ * @param {String} params.name Template Name
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getEmailTemplate', 'emailTemplates.get');
+
+/**
+ * Update an existing Email Template.
+ *
+ * @method updateEmailTemplates
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var data = { from: 'new@email.com' };
+ * var params = { name: EMAIL_TEMPLATE_NAME };
+ *
+ * management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(emailTemplate.from); // 'new@email.com'
+ * });
+ *
+ * @param {Object} params Email Template parameters.
+ * @param {String} params.name Template Name
+ * @param {Object} data Updated Email Template data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'updateEmailTemplate', 'emailTemplates.update');
+
/**
* Get the email provider.
*
@@ -2880,7 +2950,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 2318969f0..beaf697ed 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -3822,7 +3822,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index c958b6a9f..5cca41240 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index f4ca2c526..b8f357216 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -450,7 +450,7 @@ Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index b1081b4ec..fe6720748 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -102,7 +102,7 @@ new
Source:
(inner) Source:
Source:
password
Source:
refreshTo
Source:
signInSource:
socialSig
Source:
Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 2c7338b26..6b4dd491a 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index b90115d33..ecf882540 100644
--- a/docs/module-auth.TokensManager.html
+++ b/docs/module-auth.TokensManager.html
@@ -24,7 +24,7 @@
@@ -352,7 +352,7 @@ Parameters:
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html
index 1fb994b71..c6664357a 100644
--- a/docs/module-auth.UsersManager.html
+++ b/docs/module-auth.UsersManager.html
@@ -24,7 +24,7 @@
@@ -1009,7 +1009,7 @@ Example
diff --git a/docs/module-auth.html b/docs/module-auth.html
index 67edc6ef6..5f31661c2 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@ Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html
new file mode 100644
index 000000000..ba83f853f
--- /dev/null
+++ b/docs/module-errors.html
@@ -0,0 +1,263 @@
+
+
+
+
+
+ errors - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ errors
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ (static) SanitizedError()
+
+
+
+
+
+
+ Given an Api Error, modify the original error and sanitize
+sensitive information using sanitizeErrorRequestData
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 122846930..f69d82d5e 100644
--- a/docs/module-management.BlacklistedTokensManager.html
+++ b/docs/module-management.BlacklistedTokensManager.html
@@ -24,7 +24,7 @@
@@ -991,7 +991,7 @@ Example
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html
index b604f8895..401bda83e 100644
--- a/docs/module-management.BrandingManager.html
+++ b/docs/module-management.BrandingManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index de293e317..74e4efc91 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 81c75d824..a5d4b0146 100644
--- a/docs/module-management.ClientsManager.html
+++ b/docs/module-management.ClientsManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
index d246d9852..09313b8ba 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 33024c066..a2f58e6bf 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -1731,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index c50d0230e..8d5658130 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 85b48818c..98b68990c 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index aa2d4f718..cfe8647da 100644
--- a/docs/module-management.EmailTemplatesManager.html
+++ b/docs/module-management.EmailTemplatesManager.html
@@ -24,7 +24,7 @@
@@ -1304,7 +1304,7 @@ Example
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html
index 4e2f67aee..dfdbc7616 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -24,7 +24,7 @@
@@ -1515,7 +1515,7 @@ Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index fbb741e09..865df2f99 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 43f1c0d5d..cb838e052 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -994,7 +994,7 @@ get
- Given a job ID, retrieve the failed/errored items
+ Get a job by its ID.
@@ -1030,7 +1030,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.errors(params, function (err, job) {
+management.jobs.get(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -1268,7 +1268,7 @@ get
- Get a job by its ID.
+ Given a job ID, retrieve the failed/errored items
@@ -1304,7 +1304,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.get(params, function (err, job) {
+management.jobs.errors(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -2198,7 +2198,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index be6183bb5..b5307d3f3 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
@@ -1286,7 +1286,7 @@ Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index 112165b2c..7fd390a6e 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -2301,7 +2301,7 @@ a
Source:
Source:
cre
Source:
Example
+
+
+
+
+ createEmailTemplate(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Create a new Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template data object.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.createEmailTemplate(data, function (err) {
+ if (err) {
+ // Handle error.
+ // Email Template created.
+});
+
+
+
+
+
+
@@ -5002,7 +5218,7 @@ Source:
Source:
Source:
c
Source:
createRole<
Source:
del
Source:
de
Source:
d
Source:
deleteRole<
Source:
dele
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
getEm
Source:
Example
- getGrants(params, cbopt) → {Promise|undefined}
+ getEmailTemplate(params, cbopt) → {Promise|undefined}
- Get all Auth0 Grants.
+ Get an Auth0 Email Template.
@@ -13945,7 +14161,7 @@ getGrantsSource:
Parameters:
- Grants parameters.
+ Email Template parameters.
@@ -14042,13 +14258,13 @@ Parameters:
- per_pagename
-Number
+String
@@ -14059,7 +14275,15 @@ Parameters:
- Number of results per page.
+ Template Name
+
+
+
+
+
+
+
+
@@ -14068,38 +14292,299 @@ Parameters:
- pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ Callback function.
+
+
-
-
- include_totals
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate);
+});
+
+
+
+
+
+
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
Boolean
@@ -14879,7 +15364,7 @@ getJobSource:
getLogSource:
getLogsSource:
g
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRul
Source:
getT
Source:
getUser
Source:
importUser
Source:
Source:
Source:
setRule
Source:
unblockUse
Source:
Parameters:
- identifierid
@@ -23716,7 +24201,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ The user id.
@@ -23811,7 +24296,7 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)
Source:
Source:
Source:
Source:
Source:
Source:
diff --git a/docs/index.html b/docs/index.html
index 69267ff9f..3a4f8c030 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ License
diff --git a/docs/index.js.html b/docs/index.js.html
index a5c695cb3..b985f7bb8 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -24,7 +24,7 @@
@@ -61,7 +61,7 @@ index.js
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html
index 18c8b12d3..e7bc25fea 100644
--- a/docs/management_BlacklistedTokensManager.js.html
+++ b/docs/management_BlacklistedTokensManager.js.html
@@ -24,7 +24,7 @@
@@ -153,7 +153,7 @@ management/BlacklistedTokensManager.js
diff --git a/docs/management_BrandingManager.js.html b/docs/management_BrandingManager.js.html
index cf394d1b3..bf1dc88a4 100644
--- a/docs/management_BrandingManager.js.html
+++ b/docs/management_BrandingManager.js.html
@@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@ management/BrandingManager.js
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index e6dcde384..f930bb76d 100644
--- a/docs/management_ClientGrantsManager.js.html
+++ b/docs/management_ClientGrantsManager.js.html
@@ -24,7 +24,7 @@
@@ -216,7 +216,7 @@ management/ClientGrantsManager.js
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html
index 718043c3c..8d95cb7b6 100644
--- a/docs/management_ClientsManager.js.html
+++ b/docs/management_ClientsManager.js.html
@@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@ management/ClientsManager.js
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html
index 712848434..765102488 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index a382f144f..09c194bff 100644
--- a/docs/management_CustomDomainsManager.js.html
+++ b/docs/management_CustomDomainsManager.js.html
@@ -24,7 +24,7 @@
@@ -241,7 +241,7 @@ management/CustomDomainsManager.js
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
index 05ed896b3..1744f73d1 100644
--- a/docs/management_DeviceCredentialsManager.js.html
+++ b/docs/management_DeviceCredentialsManager.js.html
@@ -24,7 +24,7 @@
@@ -177,7 +177,7 @@ management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
index 687dbd736..6c0901e8f 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -198,7 +198,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index 95521b87a..48202748c 100644
--- a/docs/management_EmailTemplatesManager.js.html
+++ b/docs/management_EmailTemplatesManager.js.html
@@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@ management/EmailTemplatesManager.js
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html
index e1e0bb1ae..c01d116bc 100644
--- a/docs/management_GrantsManager.js.html
+++ b/docs/management_GrantsManager.js.html
@@ -24,7 +24,7 @@
@@ -170,7 +170,7 @@ management/GrantsManager.js
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index 59c9be7d3..96b17ee17 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index b7c0c404f..71ce6691b 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -413,7 +413,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 7b8b23d14..a32ec12bc 100644
--- a/docs/management_LogsManager.js.html
+++ b/docs/management_LogsManager.js.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ management/LogsManager.js
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html
index d2327a315..4bb10dba6 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -192,7 +192,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html
index 116f67b2f..cc059ef03 100644
--- a/docs/management_PromptsManager.js.html
+++ b/docs/management_PromptsManager.js.html
@@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@ management/PromptsManager.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index c4e8e3327..f69d6d479 100644
--- a/docs/management_ResourceServersManager.js.html
+++ b/docs/management_ResourceServersManager.js.html
@@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@ management/ResourceServersManager.js
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html
index 84e58474a..ab80951eb 100644
--- a/docs/management_RolesManager.js.html
+++ b/docs/management_RolesManager.js.html
@@ -24,7 +24,7 @@
@@ -453,7 +453,7 @@ management/RolesManager.js
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index 02eebf01f..f813f6be4 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 303791a96..65bb8954f 100644
--- a/docs/management_RulesManager.js.html
+++ b/docs/management_RulesManager.js.html
@@ -24,7 +24,7 @@
@@ -248,7 +248,7 @@ management/RulesManager.js
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html
index d6e64c8e3..b1a4f039f 100644
--- a/docs/management_StatsManager.js.html
+++ b/docs/management_StatsManager.js.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ management/StatsManager.js
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html
index 72dd36d02..34e16bd5f 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index e47b880bf..113d1bf3c 100644
--- a/docs/management_TicketsManager.js.html
+++ b/docs/management_TicketsManager.js.html
@@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@ management/TicketsManager.js
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html
index a6554e34b..95fcfd3d0 100644
--- a/docs/management_UserBlocksManager.js.html
+++ b/docs/management_UserBlocksManager.js.html
@@ -24,7 +24,7 @@
@@ -229,7 +229,7 @@ management/UserBlocksManager.js
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html
index 3cb6d7bde..832a49996 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -927,7 +927,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index abac30797..bd6156704 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -1753,6 +1753,76 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'blacklistToken', 'blacklistedTokens.add');
+/**
+ * Create a new Email Template.
+ *
+ * @method createEmailTemplate
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.createEmailTemplate(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * // Email Template created.
+ * });
+ *
+ * @param {Object} data Email Template data object.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'createEmailTemplate', 'emailTemplates.create');
+
+/**
+ * Get an Auth0 Email Template.
+ *
+ * @method getEmailTemplate
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(emailTemplate);
+ * });
+ *
+ * @param {Object} params Email Template parameters.
+ * @param {String} params.name Template Name
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getEmailTemplate', 'emailTemplates.get');
+
+/**
+ * Update an existing Email Template.
+ *
+ * @method updateEmailTemplates
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var data = { from: 'new@email.com' };
+ * var params = { name: EMAIL_TEMPLATE_NAME };
+ *
+ * management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(emailTemplate.from); // 'new@email.com'
+ * });
+ *
+ * @param {Object} params Email Template parameters.
+ * @param {String} params.name Template Name
+ * @param {Object} data Updated Email Template data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'updateEmailTemplate', 'emailTemplates.update');
+
/**
* Get the email provider.
*
@@ -2880,7 +2950,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 2318969f0..beaf697ed 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -3822,7 +3822,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index c958b6a9f..5cca41240 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index f4ca2c526..b8f357216 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -450,7 +450,7 @@ Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index b1081b4ec..fe6720748 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -102,7 +102,7 @@ new
Source:
(inner) Source:
Source:
password
Source:
refreshTo
Source:
signInSource:
socialSig
Source:
Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 2c7338b26..6b4dd491a 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index b90115d33..ecf882540 100644
--- a/docs/module-auth.TokensManager.html
+++ b/docs/module-auth.TokensManager.html
@@ -24,7 +24,7 @@
@@ -352,7 +352,7 @@ Parameters:
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html
index 1fb994b71..c6664357a 100644
--- a/docs/module-auth.UsersManager.html
+++ b/docs/module-auth.UsersManager.html
@@ -24,7 +24,7 @@
@@ -1009,7 +1009,7 @@ Example
diff --git a/docs/module-auth.html b/docs/module-auth.html
index 67edc6ef6..5f31661c2 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@ Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html
new file mode 100644
index 000000000..ba83f853f
--- /dev/null
+++ b/docs/module-errors.html
@@ -0,0 +1,263 @@
+
+
+
+
+
+ errors - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ errors
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ (static) SanitizedError()
+
+
+
+
+
+
+ Given an Api Error, modify the original error and sanitize
+sensitive information using sanitizeErrorRequestData
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 122846930..f69d82d5e 100644
--- a/docs/module-management.BlacklistedTokensManager.html
+++ b/docs/module-management.BlacklistedTokensManager.html
@@ -24,7 +24,7 @@
@@ -991,7 +991,7 @@ Example
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html
index b604f8895..401bda83e 100644
--- a/docs/module-management.BrandingManager.html
+++ b/docs/module-management.BrandingManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index de293e317..74e4efc91 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 81c75d824..a5d4b0146 100644
--- a/docs/module-management.ClientsManager.html
+++ b/docs/module-management.ClientsManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
index d246d9852..09313b8ba 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 33024c066..a2f58e6bf 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -1731,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index c50d0230e..8d5658130 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 85b48818c..98b68990c 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index aa2d4f718..cfe8647da 100644
--- a/docs/module-management.EmailTemplatesManager.html
+++ b/docs/module-management.EmailTemplatesManager.html
@@ -24,7 +24,7 @@
@@ -1304,7 +1304,7 @@ Example
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html
index 4e2f67aee..dfdbc7616 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -24,7 +24,7 @@
@@ -1515,7 +1515,7 @@ Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index fbb741e09..865df2f99 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 43f1c0d5d..cb838e052 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -994,7 +994,7 @@ get
- Given a job ID, retrieve the failed/errored items
+ Get a job by its ID.
@@ -1030,7 +1030,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.errors(params, function (err, job) {
+management.jobs.get(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -1268,7 +1268,7 @@ get
- Get a job by its ID.
+ Given a job ID, retrieve the failed/errored items
@@ -1304,7 +1304,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.get(params, function (err, job) {
+management.jobs.errors(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -2198,7 +2198,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index be6183bb5..b5307d3f3 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
@@ -1286,7 +1286,7 @@ Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index 112165b2c..7fd390a6e 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -2301,7 +2301,7 @@ a
Source:
Source:
cre
Source:
Example
+
+
+
+
+ createEmailTemplate(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Create a new Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template data object.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.createEmailTemplate(data, function (err) {
+ if (err) {
+ // Handle error.
+ // Email Template created.
+});
+
+
+
+
+
+
@@ -5002,7 +5218,7 @@ Source:
Source:
Source:
c
Source:
createRole<
Source:
del
Source:
de
Source:
d
Source:
deleteRole<
Source:
dele
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
getEm
Source:
Example
- getGrants(params, cbopt) → {Promise|undefined}
+ getEmailTemplate(params, cbopt) → {Promise|undefined}
- Get all Auth0 Grants.
+ Get an Auth0 Email Template.
@@ -13945,7 +14161,7 @@ getGrantsSource:
Parameters:
- Grants parameters.
+ Email Template parameters.
@@ -14042,13 +14258,13 @@ Parameters:
- per_pagename
-Number
+String
@@ -14059,7 +14275,15 @@ Parameters:
- Number of results per page.
+ Template Name
+
+
+
+
+
+
+
+
@@ -14068,38 +14292,299 @@ Parameters:
- pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ Callback function.
+
+
-
-
- include_totals
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate);
+});
+
+
+
+
+
+
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
Boolean
@@ -14879,7 +15364,7 @@ getJobSource:
getLogSource:
getLogsSource:
g
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRul
Source:
getT
Source:
getUser
Source:
importUser
Source:
Source:
Source:
setRule
Source:
unblockUse
Source:
Parameters:
- identifierid
@@ -23716,7 +24201,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ The user id.
@@ -23811,7 +24296,7 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)
Source:
Source:
Source:
Source:
diff --git a/docs/index.html b/docs/index.html
index 69267ff9f..3a4f8c030 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ License
diff --git a/docs/index.js.html b/docs/index.js.html
index a5c695cb3..b985f7bb8 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -24,7 +24,7 @@
@@ -61,7 +61,7 @@ index.js
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html
index 18c8b12d3..e7bc25fea 100644
--- a/docs/management_BlacklistedTokensManager.js.html
+++ b/docs/management_BlacklistedTokensManager.js.html
@@ -24,7 +24,7 @@
@@ -153,7 +153,7 @@ management/BlacklistedTokensManager.js
diff --git a/docs/management_BrandingManager.js.html b/docs/management_BrandingManager.js.html
index cf394d1b3..bf1dc88a4 100644
--- a/docs/management_BrandingManager.js.html
+++ b/docs/management_BrandingManager.js.html
@@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@ management/BrandingManager.js
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index e6dcde384..f930bb76d 100644
--- a/docs/management_ClientGrantsManager.js.html
+++ b/docs/management_ClientGrantsManager.js.html
@@ -24,7 +24,7 @@
@@ -216,7 +216,7 @@ management/ClientGrantsManager.js
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html
index 718043c3c..8d95cb7b6 100644
--- a/docs/management_ClientsManager.js.html
+++ b/docs/management_ClientsManager.js.html
@@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@ management/ClientsManager.js
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html
index 712848434..765102488 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index a382f144f..09c194bff 100644
--- a/docs/management_CustomDomainsManager.js.html
+++ b/docs/management_CustomDomainsManager.js.html
@@ -24,7 +24,7 @@
@@ -241,7 +241,7 @@ management/CustomDomainsManager.js
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
index 05ed896b3..1744f73d1 100644
--- a/docs/management_DeviceCredentialsManager.js.html
+++ b/docs/management_DeviceCredentialsManager.js.html
@@ -24,7 +24,7 @@
@@ -177,7 +177,7 @@ management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
index 687dbd736..6c0901e8f 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -198,7 +198,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index 95521b87a..48202748c 100644
--- a/docs/management_EmailTemplatesManager.js.html
+++ b/docs/management_EmailTemplatesManager.js.html
@@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@ management/EmailTemplatesManager.js
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html
index e1e0bb1ae..c01d116bc 100644
--- a/docs/management_GrantsManager.js.html
+++ b/docs/management_GrantsManager.js.html
@@ -24,7 +24,7 @@
@@ -170,7 +170,7 @@ management/GrantsManager.js
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index 59c9be7d3..96b17ee17 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index b7c0c404f..71ce6691b 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -413,7 +413,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 7b8b23d14..a32ec12bc 100644
--- a/docs/management_LogsManager.js.html
+++ b/docs/management_LogsManager.js.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ management/LogsManager.js
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html
index d2327a315..4bb10dba6 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -192,7 +192,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html
index 116f67b2f..cc059ef03 100644
--- a/docs/management_PromptsManager.js.html
+++ b/docs/management_PromptsManager.js.html
@@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@ management/PromptsManager.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index c4e8e3327..f69d6d479 100644
--- a/docs/management_ResourceServersManager.js.html
+++ b/docs/management_ResourceServersManager.js.html
@@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@ management/ResourceServersManager.js
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html
index 84e58474a..ab80951eb 100644
--- a/docs/management_RolesManager.js.html
+++ b/docs/management_RolesManager.js.html
@@ -24,7 +24,7 @@
@@ -453,7 +453,7 @@ management/RolesManager.js
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index 02eebf01f..f813f6be4 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 303791a96..65bb8954f 100644
--- a/docs/management_RulesManager.js.html
+++ b/docs/management_RulesManager.js.html
@@ -24,7 +24,7 @@
@@ -248,7 +248,7 @@ management/RulesManager.js
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html
index d6e64c8e3..b1a4f039f 100644
--- a/docs/management_StatsManager.js.html
+++ b/docs/management_StatsManager.js.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ management/StatsManager.js
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html
index 72dd36d02..34e16bd5f 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index e47b880bf..113d1bf3c 100644
--- a/docs/management_TicketsManager.js.html
+++ b/docs/management_TicketsManager.js.html
@@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@ management/TicketsManager.js
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html
index a6554e34b..95fcfd3d0 100644
--- a/docs/management_UserBlocksManager.js.html
+++ b/docs/management_UserBlocksManager.js.html
@@ -24,7 +24,7 @@
@@ -229,7 +229,7 @@ management/UserBlocksManager.js
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html
index 3cb6d7bde..832a49996 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -927,7 +927,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index abac30797..bd6156704 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -1753,6 +1753,76 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'blacklistToken', 'blacklistedTokens.add');
+/**
+ * Create a new Email Template.
+ *
+ * @method createEmailTemplate
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.createEmailTemplate(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * // Email Template created.
+ * });
+ *
+ * @param {Object} data Email Template data object.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'createEmailTemplate', 'emailTemplates.create');
+
+/**
+ * Get an Auth0 Email Template.
+ *
+ * @method getEmailTemplate
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(emailTemplate);
+ * });
+ *
+ * @param {Object} params Email Template parameters.
+ * @param {String} params.name Template Name
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getEmailTemplate', 'emailTemplates.get');
+
+/**
+ * Update an existing Email Template.
+ *
+ * @method updateEmailTemplates
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var data = { from: 'new@email.com' };
+ * var params = { name: EMAIL_TEMPLATE_NAME };
+ *
+ * management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(emailTemplate.from); // 'new@email.com'
+ * });
+ *
+ * @param {Object} params Email Template parameters.
+ * @param {String} params.name Template Name
+ * @param {Object} data Updated Email Template data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'updateEmailTemplate', 'emailTemplates.update');
+
/**
* Get the email provider.
*
@@ -2880,7 +2950,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 2318969f0..beaf697ed 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -3822,7 +3822,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index c958b6a9f..5cca41240 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index f4ca2c526..b8f357216 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -450,7 +450,7 @@ Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index b1081b4ec..fe6720748 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -102,7 +102,7 @@ new
Source:
(inner) Source:
Source:
password
Source:
refreshTo
Source:
signInSource:
socialSig
Source:
Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 2c7338b26..6b4dd491a 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index b90115d33..ecf882540 100644
--- a/docs/module-auth.TokensManager.html
+++ b/docs/module-auth.TokensManager.html
@@ -24,7 +24,7 @@
@@ -352,7 +352,7 @@ Parameters:
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html
index 1fb994b71..c6664357a 100644
--- a/docs/module-auth.UsersManager.html
+++ b/docs/module-auth.UsersManager.html
@@ -24,7 +24,7 @@
@@ -1009,7 +1009,7 @@ Example
diff --git a/docs/module-auth.html b/docs/module-auth.html
index 67edc6ef6..5f31661c2 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@ Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html
new file mode 100644
index 000000000..ba83f853f
--- /dev/null
+++ b/docs/module-errors.html
@@ -0,0 +1,263 @@
+
+
+
+
+
+ errors - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ errors
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ (static) SanitizedError()
+
+
+
+
+
+
+ Given an Api Error, modify the original error and sanitize
+sensitive information using sanitizeErrorRequestData
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 122846930..f69d82d5e 100644
--- a/docs/module-management.BlacklistedTokensManager.html
+++ b/docs/module-management.BlacklistedTokensManager.html
@@ -24,7 +24,7 @@
@@ -991,7 +991,7 @@ Example
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html
index b604f8895..401bda83e 100644
--- a/docs/module-management.BrandingManager.html
+++ b/docs/module-management.BrandingManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index de293e317..74e4efc91 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 81c75d824..a5d4b0146 100644
--- a/docs/module-management.ClientsManager.html
+++ b/docs/module-management.ClientsManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
index d246d9852..09313b8ba 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 33024c066..a2f58e6bf 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -1731,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index c50d0230e..8d5658130 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 85b48818c..98b68990c 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index aa2d4f718..cfe8647da 100644
--- a/docs/module-management.EmailTemplatesManager.html
+++ b/docs/module-management.EmailTemplatesManager.html
@@ -24,7 +24,7 @@
@@ -1304,7 +1304,7 @@ Example
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html
index 4e2f67aee..dfdbc7616 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -24,7 +24,7 @@
@@ -1515,7 +1515,7 @@ Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index fbb741e09..865df2f99 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 43f1c0d5d..cb838e052 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -994,7 +994,7 @@ get
- Given a job ID, retrieve the failed/errored items
+ Get a job by its ID.
@@ -1030,7 +1030,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.errors(params, function (err, job) {
+management.jobs.get(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -1268,7 +1268,7 @@ get
- Get a job by its ID.
+ Given a job ID, retrieve the failed/errored items
@@ -1304,7 +1304,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.get(params, function (err, job) {
+management.jobs.errors(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -2198,7 +2198,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index be6183bb5..b5307d3f3 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
@@ -1286,7 +1286,7 @@ Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index 112165b2c..7fd390a6e 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -2301,7 +2301,7 @@ a
Source:
Source:
cre
Source:
Example
+
+
+
+
+ createEmailTemplate(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Create a new Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template data object.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.createEmailTemplate(data, function (err) {
+ if (err) {
+ // Handle error.
+ // Email Template created.
+});
+
+
+
+
+
+
@@ -5002,7 +5218,7 @@ Source:
Source:
Source:
c
Source:
createRole<
Source:
del
Source:
de
Source:
d
Source:
deleteRole<
Source:
dele
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
getEm
Source:
Example
- getGrants(params, cbopt) → {Promise|undefined}
+ getEmailTemplate(params, cbopt) → {Promise|undefined}
- Get all Auth0 Grants.
+ Get an Auth0 Email Template.
@@ -13945,7 +14161,7 @@ getGrantsSource:
Parameters:
- Grants parameters.
+ Email Template parameters.
@@ -14042,13 +14258,13 @@ Parameters:
- per_pagename
-Number
+String
@@ -14059,7 +14275,15 @@ Parameters:
- Number of results per page.
+ Template Name
+
+
+
+
+
+
+
+
@@ -14068,38 +14292,299 @@ Parameters:
- pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ Callback function.
+
+
-
-
- include_totals
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate);
+});
+
+
+
+
+
+
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
Boolean
@@ -14879,7 +15364,7 @@ getJobSource:
getLogSource:
getLogsSource:
g
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRul
Source:
getT
Source:
getUser
Source:
importUser
Source:
Source:
Source:
setRule
Source:
unblockUse
Source:
Parameters:
- identifierid
@@ -23716,7 +24201,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ The user id.
@@ -23811,7 +24296,7 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)
Source:
Source:
diff --git a/docs/index.html b/docs/index.html
index 69267ff9f..3a4f8c030 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ License
diff --git a/docs/index.js.html b/docs/index.js.html
index a5c695cb3..b985f7bb8 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -24,7 +24,7 @@
@@ -61,7 +61,7 @@ index.js
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html
index 18c8b12d3..e7bc25fea 100644
--- a/docs/management_BlacklistedTokensManager.js.html
+++ b/docs/management_BlacklistedTokensManager.js.html
@@ -24,7 +24,7 @@
@@ -153,7 +153,7 @@ management/BlacklistedTokensManager.js
diff --git a/docs/management_BrandingManager.js.html b/docs/management_BrandingManager.js.html
index cf394d1b3..bf1dc88a4 100644
--- a/docs/management_BrandingManager.js.html
+++ b/docs/management_BrandingManager.js.html
@@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@ management/BrandingManager.js
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index e6dcde384..f930bb76d 100644
--- a/docs/management_ClientGrantsManager.js.html
+++ b/docs/management_ClientGrantsManager.js.html
@@ -24,7 +24,7 @@
@@ -216,7 +216,7 @@ management/ClientGrantsManager.js
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html
index 718043c3c..8d95cb7b6 100644
--- a/docs/management_ClientsManager.js.html
+++ b/docs/management_ClientsManager.js.html
@@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@ management/ClientsManager.js
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html
index 712848434..765102488 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index a382f144f..09c194bff 100644
--- a/docs/management_CustomDomainsManager.js.html
+++ b/docs/management_CustomDomainsManager.js.html
@@ -24,7 +24,7 @@
@@ -241,7 +241,7 @@ management/CustomDomainsManager.js
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
index 05ed896b3..1744f73d1 100644
--- a/docs/management_DeviceCredentialsManager.js.html
+++ b/docs/management_DeviceCredentialsManager.js.html
@@ -24,7 +24,7 @@
@@ -177,7 +177,7 @@ management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
index 687dbd736..6c0901e8f 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -198,7 +198,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index 95521b87a..48202748c 100644
--- a/docs/management_EmailTemplatesManager.js.html
+++ b/docs/management_EmailTemplatesManager.js.html
@@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@ management/EmailTemplatesManager.js
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html
index e1e0bb1ae..c01d116bc 100644
--- a/docs/management_GrantsManager.js.html
+++ b/docs/management_GrantsManager.js.html
@@ -24,7 +24,7 @@
@@ -170,7 +170,7 @@ management/GrantsManager.js
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index 59c9be7d3..96b17ee17 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index b7c0c404f..71ce6691b 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -413,7 +413,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 7b8b23d14..a32ec12bc 100644
--- a/docs/management_LogsManager.js.html
+++ b/docs/management_LogsManager.js.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ management/LogsManager.js
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html
index d2327a315..4bb10dba6 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -192,7 +192,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html
index 116f67b2f..cc059ef03 100644
--- a/docs/management_PromptsManager.js.html
+++ b/docs/management_PromptsManager.js.html
@@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@ management/PromptsManager.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index c4e8e3327..f69d6d479 100644
--- a/docs/management_ResourceServersManager.js.html
+++ b/docs/management_ResourceServersManager.js.html
@@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@ management/ResourceServersManager.js
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html
index 84e58474a..ab80951eb 100644
--- a/docs/management_RolesManager.js.html
+++ b/docs/management_RolesManager.js.html
@@ -24,7 +24,7 @@
@@ -453,7 +453,7 @@ management/RolesManager.js
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index 02eebf01f..f813f6be4 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 303791a96..65bb8954f 100644
--- a/docs/management_RulesManager.js.html
+++ b/docs/management_RulesManager.js.html
@@ -24,7 +24,7 @@
@@ -248,7 +248,7 @@ management/RulesManager.js
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html
index d6e64c8e3..b1a4f039f 100644
--- a/docs/management_StatsManager.js.html
+++ b/docs/management_StatsManager.js.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ management/StatsManager.js
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html
index 72dd36d02..34e16bd5f 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index e47b880bf..113d1bf3c 100644
--- a/docs/management_TicketsManager.js.html
+++ b/docs/management_TicketsManager.js.html
@@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@ management/TicketsManager.js
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html
index a6554e34b..95fcfd3d0 100644
--- a/docs/management_UserBlocksManager.js.html
+++ b/docs/management_UserBlocksManager.js.html
@@ -24,7 +24,7 @@
@@ -229,7 +229,7 @@ management/UserBlocksManager.js
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html
index 3cb6d7bde..832a49996 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -927,7 +927,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index abac30797..bd6156704 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -1753,6 +1753,76 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'blacklistToken', 'blacklistedTokens.add');
+/**
+ * Create a new Email Template.
+ *
+ * @method createEmailTemplate
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.createEmailTemplate(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * // Email Template created.
+ * });
+ *
+ * @param {Object} data Email Template data object.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'createEmailTemplate', 'emailTemplates.create');
+
+/**
+ * Get an Auth0 Email Template.
+ *
+ * @method getEmailTemplate
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(emailTemplate);
+ * });
+ *
+ * @param {Object} params Email Template parameters.
+ * @param {String} params.name Template Name
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getEmailTemplate', 'emailTemplates.get');
+
+/**
+ * Update an existing Email Template.
+ *
+ * @method updateEmailTemplates
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var data = { from: 'new@email.com' };
+ * var params = { name: EMAIL_TEMPLATE_NAME };
+ *
+ * management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(emailTemplate.from); // 'new@email.com'
+ * });
+ *
+ * @param {Object} params Email Template parameters.
+ * @param {String} params.name Template Name
+ * @param {Object} data Updated Email Template data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'updateEmailTemplate', 'emailTemplates.update');
+
/**
* Get the email provider.
*
@@ -2880,7 +2950,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 2318969f0..beaf697ed 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -3822,7 +3822,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index c958b6a9f..5cca41240 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index f4ca2c526..b8f357216 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -450,7 +450,7 @@ Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index b1081b4ec..fe6720748 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -102,7 +102,7 @@ new
Source:
(inner) Source:
Source:
password
Source:
refreshTo
Source:
signInSource:
socialSig
Source:
Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 2c7338b26..6b4dd491a 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index b90115d33..ecf882540 100644
--- a/docs/module-auth.TokensManager.html
+++ b/docs/module-auth.TokensManager.html
@@ -24,7 +24,7 @@
@@ -352,7 +352,7 @@ Parameters:
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html
index 1fb994b71..c6664357a 100644
--- a/docs/module-auth.UsersManager.html
+++ b/docs/module-auth.UsersManager.html
@@ -24,7 +24,7 @@
@@ -1009,7 +1009,7 @@ Example
diff --git a/docs/module-auth.html b/docs/module-auth.html
index 67edc6ef6..5f31661c2 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@ Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html
new file mode 100644
index 000000000..ba83f853f
--- /dev/null
+++ b/docs/module-errors.html
@@ -0,0 +1,263 @@
+
+
+
+
+
+ errors - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ errors
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ (static) SanitizedError()
+
+
+
+
+
+
+ Given an Api Error, modify the original error and sanitize
+sensitive information using sanitizeErrorRequestData
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 122846930..f69d82d5e 100644
--- a/docs/module-management.BlacklistedTokensManager.html
+++ b/docs/module-management.BlacklistedTokensManager.html
@@ -24,7 +24,7 @@
@@ -991,7 +991,7 @@ Example
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html
index b604f8895..401bda83e 100644
--- a/docs/module-management.BrandingManager.html
+++ b/docs/module-management.BrandingManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index de293e317..74e4efc91 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 81c75d824..a5d4b0146 100644
--- a/docs/module-management.ClientsManager.html
+++ b/docs/module-management.ClientsManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
index d246d9852..09313b8ba 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 33024c066..a2f58e6bf 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -1731,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index c50d0230e..8d5658130 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 85b48818c..98b68990c 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index aa2d4f718..cfe8647da 100644
--- a/docs/module-management.EmailTemplatesManager.html
+++ b/docs/module-management.EmailTemplatesManager.html
@@ -24,7 +24,7 @@
@@ -1304,7 +1304,7 @@ Example
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html
index 4e2f67aee..dfdbc7616 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -24,7 +24,7 @@
@@ -1515,7 +1515,7 @@ Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index fbb741e09..865df2f99 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 43f1c0d5d..cb838e052 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -994,7 +994,7 @@ get
- Given a job ID, retrieve the failed/errored items
+ Get a job by its ID.
@@ -1030,7 +1030,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.errors(params, function (err, job) {
+management.jobs.get(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -1268,7 +1268,7 @@ get
- Get a job by its ID.
+ Given a job ID, retrieve the failed/errored items
@@ -1304,7 +1304,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.get(params, function (err, job) {
+management.jobs.errors(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -2198,7 +2198,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index be6183bb5..b5307d3f3 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
@@ -1286,7 +1286,7 @@ Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index 112165b2c..7fd390a6e 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -2301,7 +2301,7 @@ a
Source:
Source:
cre
Source:
Example
+
+
+
+
+ createEmailTemplate(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Create a new Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template data object.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.createEmailTemplate(data, function (err) {
+ if (err) {
+ // Handle error.
+ // Email Template created.
+});
+
+
+
+
+
+
@@ -5002,7 +5218,7 @@ Source:
Source:
Source:
c
Source:
createRole<
Source:
del
Source:
de
Source:
d
Source:
deleteRole<
Source:
dele
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
getEm
Source:
Example
- getGrants(params, cbopt) → {Promise|undefined}
+ getEmailTemplate(params, cbopt) → {Promise|undefined}
- Get all Auth0 Grants.
+ Get an Auth0 Email Template.
@@ -13945,7 +14161,7 @@ getGrantsSource:
Parameters:
- Grants parameters.
+ Email Template parameters.
@@ -14042,13 +14258,13 @@ Parameters:
- per_pagename
-Number
+String
@@ -14059,7 +14275,15 @@ Parameters:
- Number of results per page.
+ Template Name
+
+
+
+
+
+
+
+
@@ -14068,38 +14292,299 @@ Parameters:
- pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ Callback function.
+
+
-
-
- include_totals
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate);
+});
+
+
+
+
+
+
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
Boolean
@@ -14879,7 +15364,7 @@ getJobSource:
getLogSource:
getLogsSource:
g
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRul
Source:
getT
Source:
getUser
Source:
importUser
Source:
Source:
Source:
setRule
Source:
unblockUse
Source:
Parameters:
- identifierid
@@ -23716,7 +24201,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ The user id.
@@ -23811,7 +24296,7 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)
diff --git a/docs/index.html b/docs/index.html
index 69267ff9f..3a4f8c030 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ License
diff --git a/docs/index.js.html b/docs/index.js.html
index a5c695cb3..b985f7bb8 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -24,7 +24,7 @@
@@ -61,7 +61,7 @@ index.js
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html
index 18c8b12d3..e7bc25fea 100644
--- a/docs/management_BlacklistedTokensManager.js.html
+++ b/docs/management_BlacklistedTokensManager.js.html
@@ -24,7 +24,7 @@
@@ -153,7 +153,7 @@ management/BlacklistedTokensManager.js
diff --git a/docs/management_BrandingManager.js.html b/docs/management_BrandingManager.js.html
index cf394d1b3..bf1dc88a4 100644
--- a/docs/management_BrandingManager.js.html
+++ b/docs/management_BrandingManager.js.html
@@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@ management/BrandingManager.js
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index e6dcde384..f930bb76d 100644
--- a/docs/management_ClientGrantsManager.js.html
+++ b/docs/management_ClientGrantsManager.js.html
@@ -24,7 +24,7 @@
@@ -216,7 +216,7 @@ management/ClientGrantsManager.js
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html
index 718043c3c..8d95cb7b6 100644
--- a/docs/management_ClientsManager.js.html
+++ b/docs/management_ClientsManager.js.html
@@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@ management/ClientsManager.js
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html
index 712848434..765102488 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index a382f144f..09c194bff 100644
--- a/docs/management_CustomDomainsManager.js.html
+++ b/docs/management_CustomDomainsManager.js.html
@@ -24,7 +24,7 @@
@@ -241,7 +241,7 @@ management/CustomDomainsManager.js
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
index 05ed896b3..1744f73d1 100644
--- a/docs/management_DeviceCredentialsManager.js.html
+++ b/docs/management_DeviceCredentialsManager.js.html
@@ -24,7 +24,7 @@
@@ -177,7 +177,7 @@ management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
index 687dbd736..6c0901e8f 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -198,7 +198,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index 95521b87a..48202748c 100644
--- a/docs/management_EmailTemplatesManager.js.html
+++ b/docs/management_EmailTemplatesManager.js.html
@@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@ management/EmailTemplatesManager.js
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html
index e1e0bb1ae..c01d116bc 100644
--- a/docs/management_GrantsManager.js.html
+++ b/docs/management_GrantsManager.js.html
@@ -24,7 +24,7 @@
@@ -170,7 +170,7 @@ management/GrantsManager.js
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index 59c9be7d3..96b17ee17 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index b7c0c404f..71ce6691b 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -413,7 +413,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 7b8b23d14..a32ec12bc 100644
--- a/docs/management_LogsManager.js.html
+++ b/docs/management_LogsManager.js.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ management/LogsManager.js
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html
index d2327a315..4bb10dba6 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -192,7 +192,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html
index 116f67b2f..cc059ef03 100644
--- a/docs/management_PromptsManager.js.html
+++ b/docs/management_PromptsManager.js.html
@@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@ management/PromptsManager.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index c4e8e3327..f69d6d479 100644
--- a/docs/management_ResourceServersManager.js.html
+++ b/docs/management_ResourceServersManager.js.html
@@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@ management/ResourceServersManager.js
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html
index 84e58474a..ab80951eb 100644
--- a/docs/management_RolesManager.js.html
+++ b/docs/management_RolesManager.js.html
@@ -24,7 +24,7 @@
@@ -453,7 +453,7 @@ management/RolesManager.js
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index 02eebf01f..f813f6be4 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 303791a96..65bb8954f 100644
--- a/docs/management_RulesManager.js.html
+++ b/docs/management_RulesManager.js.html
@@ -24,7 +24,7 @@
@@ -248,7 +248,7 @@ management/RulesManager.js
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html
index d6e64c8e3..b1a4f039f 100644
--- a/docs/management_StatsManager.js.html
+++ b/docs/management_StatsManager.js.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ management/StatsManager.js
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html
index 72dd36d02..34e16bd5f 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index e47b880bf..113d1bf3c 100644
--- a/docs/management_TicketsManager.js.html
+++ b/docs/management_TicketsManager.js.html
@@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@ management/TicketsManager.js
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html
index a6554e34b..95fcfd3d0 100644
--- a/docs/management_UserBlocksManager.js.html
+++ b/docs/management_UserBlocksManager.js.html
@@ -24,7 +24,7 @@
@@ -229,7 +229,7 @@ management/UserBlocksManager.js
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html
index 3cb6d7bde..832a49996 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -927,7 +927,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index abac30797..bd6156704 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -1753,6 +1753,76 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'blacklistToken', 'blacklistedTokens.add');
+/**
+ * Create a new Email Template.
+ *
+ * @method createEmailTemplate
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.createEmailTemplate(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * // Email Template created.
+ * });
+ *
+ * @param {Object} data Email Template data object.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'createEmailTemplate', 'emailTemplates.create');
+
+/**
+ * Get an Auth0 Email Template.
+ *
+ * @method getEmailTemplate
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(emailTemplate);
+ * });
+ *
+ * @param {Object} params Email Template parameters.
+ * @param {String} params.name Template Name
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getEmailTemplate', 'emailTemplates.get');
+
+/**
+ * Update an existing Email Template.
+ *
+ * @method updateEmailTemplates
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var data = { from: 'new@email.com' };
+ * var params = { name: EMAIL_TEMPLATE_NAME };
+ *
+ * management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(emailTemplate.from); // 'new@email.com'
+ * });
+ *
+ * @param {Object} params Email Template parameters.
+ * @param {String} params.name Template Name
+ * @param {Object} data Updated Email Template data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'updateEmailTemplate', 'emailTemplates.update');
+
/**
* Get the email provider.
*
@@ -2880,7 +2950,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 2318969f0..beaf697ed 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -3822,7 +3822,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index c958b6a9f..5cca41240 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index f4ca2c526..b8f357216 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -450,7 +450,7 @@ Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index b1081b4ec..fe6720748 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -102,7 +102,7 @@ new
Source:
(inner) Source:
Source:
password
Source:
refreshTo
Source:
signInSource:
socialSig
Source:
Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 2c7338b26..6b4dd491a 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index b90115d33..ecf882540 100644
--- a/docs/module-auth.TokensManager.html
+++ b/docs/module-auth.TokensManager.html
@@ -24,7 +24,7 @@
@@ -352,7 +352,7 @@ Parameters:
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html
index 1fb994b71..c6664357a 100644
--- a/docs/module-auth.UsersManager.html
+++ b/docs/module-auth.UsersManager.html
@@ -24,7 +24,7 @@
@@ -1009,7 +1009,7 @@ Example
diff --git a/docs/module-auth.html b/docs/module-auth.html
index 67edc6ef6..5f31661c2 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@ Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html
new file mode 100644
index 000000000..ba83f853f
--- /dev/null
+++ b/docs/module-errors.html
@@ -0,0 +1,263 @@
+
+
+
+
+
+ errors - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ errors
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ (static) SanitizedError()
+
+
+
+
+
+
+ Given an Api Error, modify the original error and sanitize
+sensitive information using sanitizeErrorRequestData
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 122846930..f69d82d5e 100644
--- a/docs/module-management.BlacklistedTokensManager.html
+++ b/docs/module-management.BlacklistedTokensManager.html
@@ -24,7 +24,7 @@
@@ -991,7 +991,7 @@ Example
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html
index b604f8895..401bda83e 100644
--- a/docs/module-management.BrandingManager.html
+++ b/docs/module-management.BrandingManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index de293e317..74e4efc91 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 81c75d824..a5d4b0146 100644
--- a/docs/module-management.ClientsManager.html
+++ b/docs/module-management.ClientsManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
index d246d9852..09313b8ba 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 33024c066..a2f58e6bf 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -1731,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index c50d0230e..8d5658130 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 85b48818c..98b68990c 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index aa2d4f718..cfe8647da 100644
--- a/docs/module-management.EmailTemplatesManager.html
+++ b/docs/module-management.EmailTemplatesManager.html
@@ -24,7 +24,7 @@
@@ -1304,7 +1304,7 @@ Example
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html
index 4e2f67aee..dfdbc7616 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -24,7 +24,7 @@
@@ -1515,7 +1515,7 @@ Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index fbb741e09..865df2f99 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 43f1c0d5d..cb838e052 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -994,7 +994,7 @@ get
- Given a job ID, retrieve the failed/errored items
+ Get a job by its ID.
@@ -1030,7 +1030,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.errors(params, function (err, job) {
+management.jobs.get(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -1268,7 +1268,7 @@ get
- Get a job by its ID.
+ Given a job ID, retrieve the failed/errored items
@@ -1304,7 +1304,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.get(params, function (err, job) {
+management.jobs.errors(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -2198,7 +2198,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index be6183bb5..b5307d3f3 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
@@ -1286,7 +1286,7 @@ Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index 112165b2c..7fd390a6e 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -2301,7 +2301,7 @@ a
Source:
Source:
cre
Source:
Example
+
+
+
+
+ createEmailTemplate(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Create a new Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template data object.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.createEmailTemplate(data, function (err) {
+ if (err) {
+ // Handle error.
+ // Email Template created.
+});
+
+
+
+
+
+
@@ -5002,7 +5218,7 @@ Source:
Source:
Source:
c
Source:
createRole<
Source:
del
Source:
de
Source:
d
Source:
deleteRole<
Source:
dele
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
getEm
Source:
Example
- getGrants(params, cbopt) → {Promise|undefined}
+ getEmailTemplate(params, cbopt) → {Promise|undefined}
- Get all Auth0 Grants.
+ Get an Auth0 Email Template.
@@ -13945,7 +14161,7 @@ getGrantsSource:
Parameters:
- Grants parameters.
+ Email Template parameters.
@@ -14042,13 +14258,13 @@ Parameters:
- per_pagename
-Number
+String
@@ -14059,7 +14275,15 @@ Parameters:
- Number of results per page.
+ Template Name
+
+
+
+
+
+
+
+
@@ -14068,38 +14292,299 @@ Parameters:
- pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ Callback function.
+
+
-
-
- include_totals
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate);
+});
+
+
+
+
+
+
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
Boolean
@@ -14879,7 +15364,7 @@ getJobSource:
getLogSource:
getLogsSource:
g
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRul
Source:
getT
Source:
getUser
Source:
importUser
Source:
Source:
Source:
setRule
Source:
unblockUse
Source:
Parameters:
- identifierid
@@ -23716,7 +24201,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ The user id.
@@ -23811,7 +24296,7 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)
License
diff --git a/docs/index.js.html b/docs/index.js.html index a5c695cb3..b985f7bb8 100644 --- a/docs/index.js.html +++ b/docs/index.js.html @@ -24,7 +24,7 @@
@@ -61,7 +61,7 @@
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html index 18c8b12d3..e7bc25fea 100644 --- a/docs/management_BlacklistedTokensManager.js.html +++ b/docs/management_BlacklistedTokensManager.js.html @@ -24,7 +24,7 @@
index.js
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html index 18c8b12d3..e7bc25fea 100644 --- a/docs/management_BlacklistedTokensManager.js.html +++ b/docs/management_BlacklistedTokensManager.js.html @@ -24,7 +24,7 @@
@@ -153,7 +153,7 @@
diff --git a/docs/management_BrandingManager.js.html b/docs/management_BrandingManager.js.html index cf394d1b3..bf1dc88a4 100644 --- a/docs/management_BrandingManager.js.html +++ b/docs/management_BrandingManager.js.html @@ -24,7 +24,7 @@
management/BlacklistedTokensManager.js
diff --git a/docs/management_BrandingManager.js.html b/docs/management_BrandingManager.js.html index cf394d1b3..bf1dc88a4 100644 --- a/docs/management_BrandingManager.js.html +++ b/docs/management_BrandingManager.js.html @@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html index e6dcde384..f930bb76d 100644 --- a/docs/management_ClientGrantsManager.js.html +++ b/docs/management_ClientGrantsManager.js.html @@ -24,7 +24,7 @@
management/BrandingManager.js
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html index e6dcde384..f930bb76d 100644 --- a/docs/management_ClientGrantsManager.js.html +++ b/docs/management_ClientGrantsManager.js.html @@ -24,7 +24,7 @@
@@ -216,7 +216,7 @@
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html index 718043c3c..8d95cb7b6 100644 --- a/docs/management_ClientsManager.js.html +++ b/docs/management_ClientsManager.js.html @@ -24,7 +24,7 @@
management/ClientGrantsManager.js
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html index 718043c3c..8d95cb7b6 100644 --- a/docs/management_ClientsManager.js.html +++ b/docs/management_ClientsManager.js.html @@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html index 712848434..765102488 100644 --- a/docs/management_ConnectionsManager.js.html +++ b/docs/management_ConnectionsManager.js.html @@ -24,7 +24,7 @@
management/ClientsManager.js
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html index 712848434..765102488 100644 --- a/docs/management_ConnectionsManager.js.html +++ b/docs/management_ConnectionsManager.js.html @@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html index a382f144f..09c194bff 100644 --- a/docs/management_CustomDomainsManager.js.html +++ b/docs/management_CustomDomainsManager.js.html @@ -24,7 +24,7 @@
management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html index a382f144f..09c194bff 100644 --- a/docs/management_CustomDomainsManager.js.html +++ b/docs/management_CustomDomainsManager.js.html @@ -24,7 +24,7 @@
@@ -241,7 +241,7 @@
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html index 05ed896b3..1744f73d1 100644 --- a/docs/management_DeviceCredentialsManager.js.html +++ b/docs/management_DeviceCredentialsManager.js.html @@ -24,7 +24,7 @@
management/CustomDomainsManager.js
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html index 05ed896b3..1744f73d1 100644 --- a/docs/management_DeviceCredentialsManager.js.html +++ b/docs/management_DeviceCredentialsManager.js.html @@ -24,7 +24,7 @@
@@ -177,7 +177,7 @@
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html index 687dbd736..6c0901e8f 100644 --- a/docs/management_EmailProviderManager.js.html +++ b/docs/management_EmailProviderManager.js.html @@ -24,7 +24,7 @@
management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html index 687dbd736..6c0901e8f 100644 --- a/docs/management_EmailProviderManager.js.html +++ b/docs/management_EmailProviderManager.js.html @@ -24,7 +24,7 @@
@@ -198,7 +198,7 @@
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html index 95521b87a..48202748c 100644 --- a/docs/management_EmailTemplatesManager.js.html +++ b/docs/management_EmailTemplatesManager.js.html @@ -24,7 +24,7 @@
management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html index 95521b87a..48202748c 100644 --- a/docs/management_EmailTemplatesManager.js.html +++ b/docs/management_EmailTemplatesManager.js.html @@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html index e1e0bb1ae..c01d116bc 100644 --- a/docs/management_GrantsManager.js.html +++ b/docs/management_GrantsManager.js.html @@ -24,7 +24,7 @@
management/EmailTemplatesManager.js
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html index e1e0bb1ae..c01d116bc 100644 --- a/docs/management_GrantsManager.js.html +++ b/docs/management_GrantsManager.js.html @@ -24,7 +24,7 @@
@@ -170,7 +170,7 @@
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html index 59c9be7d3..96b17ee17 100644 --- a/docs/management_GuardianManager.js.html +++ b/docs/management_GuardianManager.js.html @@ -24,7 +24,7 @@
management/GrantsManager.js
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html index 59c9be7d3..96b17ee17 100644 --- a/docs/management_GuardianManager.js.html +++ b/docs/management_GuardianManager.js.html @@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html index b7c0c404f..71ce6691b 100644 --- a/docs/management_JobsManager.js.html +++ b/docs/management_JobsManager.js.html @@ -24,7 +24,7 @@
management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html index b7c0c404f..71ce6691b 100644 --- a/docs/management_JobsManager.js.html +++ b/docs/management_JobsManager.js.html @@ -24,7 +24,7 @@
@@ -413,7 +413,7 @@
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html index 7b8b23d14..a32ec12bc 100644 --- a/docs/management_LogsManager.js.html +++ b/docs/management_LogsManager.js.html @@ -24,7 +24,7 @@
management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html index 7b8b23d14..a32ec12bc 100644 --- a/docs/management_LogsManager.js.html +++ b/docs/management_LogsManager.js.html @@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html index d2327a315..4bb10dba6 100644 --- a/docs/management_ManagementTokenProvider.js.html +++ b/docs/management_ManagementTokenProvider.js.html @@ -24,7 +24,7 @@
management/LogsManager.js
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html index d2327a315..4bb10dba6 100644 --- a/docs/management_ManagementTokenProvider.js.html +++ b/docs/management_ManagementTokenProvider.js.html @@ -24,7 +24,7 @@
@@ -192,7 +192,7 @@
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html index 116f67b2f..cc059ef03 100644 --- a/docs/management_PromptsManager.js.html +++ b/docs/management_PromptsManager.js.html @@ -24,7 +24,7 @@
management/ManagementTokenProvider.js
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html index 116f67b2f..cc059ef03 100644 --- a/docs/management_PromptsManager.js.html +++ b/docs/management_PromptsManager.js.html @@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html index c4e8e3327..f69d6d479 100644 --- a/docs/management_ResourceServersManager.js.html +++ b/docs/management_ResourceServersManager.js.html @@ -24,7 +24,7 @@
management/PromptsManager.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html index c4e8e3327..f69d6d479 100644 --- a/docs/management_ResourceServersManager.js.html +++ b/docs/management_ResourceServersManager.js.html @@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html index 84e58474a..ab80951eb 100644 --- a/docs/management_RolesManager.js.html +++ b/docs/management_RolesManager.js.html @@ -24,7 +24,7 @@
management/ResourceServersManager.js
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html index 84e58474a..ab80951eb 100644 --- a/docs/management_RolesManager.js.html +++ b/docs/management_RolesManager.js.html @@ -24,7 +24,7 @@
@@ -453,7 +453,7 @@
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html index 02eebf01f..f813f6be4 100644 --- a/docs/management_RulesConfigsManager.js.html +++ b/docs/management_RulesConfigsManager.js.html @@ -24,7 +24,7 @@
management/RolesManager.js
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html index 02eebf01f..f813f6be4 100644 --- a/docs/management_RulesConfigsManager.js.html +++ b/docs/management_RulesConfigsManager.js.html @@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html index 303791a96..65bb8954f 100644 --- a/docs/management_RulesManager.js.html +++ b/docs/management_RulesManager.js.html @@ -24,7 +24,7 @@
management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html index 303791a96..65bb8954f 100644 --- a/docs/management_RulesManager.js.html +++ b/docs/management_RulesManager.js.html @@ -24,7 +24,7 @@
@@ -248,7 +248,7 @@
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html index d6e64c8e3..b1a4f039f 100644 --- a/docs/management_StatsManager.js.html +++ b/docs/management_StatsManager.js.html @@ -24,7 +24,7 @@
management/RulesManager.js
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html index d6e64c8e3..b1a4f039f 100644 --- a/docs/management_StatsManager.js.html +++ b/docs/management_StatsManager.js.html @@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html index 72dd36d02..34e16bd5f 100644 --- a/docs/management_TenantManager.js.html +++ b/docs/management_TenantManager.js.html @@ -24,7 +24,7 @@
management/StatsManager.js
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html index 72dd36d02..34e16bd5f 100644 --- a/docs/management_TenantManager.js.html +++ b/docs/management_TenantManager.js.html @@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html index e47b880bf..113d1bf3c 100644 --- a/docs/management_TicketsManager.js.html +++ b/docs/management_TicketsManager.js.html @@ -24,7 +24,7 @@
management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html index e47b880bf..113d1bf3c 100644 --- a/docs/management_TicketsManager.js.html +++ b/docs/management_TicketsManager.js.html @@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html index a6554e34b..95fcfd3d0 100644 --- a/docs/management_UserBlocksManager.js.html +++ b/docs/management_UserBlocksManager.js.html @@ -24,7 +24,7 @@
management/TicketsManager.js
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html index a6554e34b..95fcfd3d0 100644 --- a/docs/management_UserBlocksManager.js.html +++ b/docs/management_UserBlocksManager.js.html @@ -24,7 +24,7 @@
@@ -229,7 +229,7 @@
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html index 3cb6d7bde..832a49996 100644 --- a/docs/management_UsersManager.js.html +++ b/docs/management_UsersManager.js.html @@ -24,7 +24,7 @@
management/UserBlocksManager.js
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html index 3cb6d7bde..832a49996 100644 --- a/docs/management_UsersManager.js.html +++ b/docs/management_UsersManager.js.html @@ -24,7 +24,7 @@
@@ -927,7 +927,7 @@
diff --git a/docs/management_index.js.html b/docs/management_index.js.html index abac30797..bd6156704 100644 --- a/docs/management_index.js.html +++ b/docs/management_index.js.html @@ -24,7 +24,7 @@
management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html index abac30797..bd6156704 100644 --- a/docs/management_index.js.html +++ b/docs/management_index.js.html @@ -24,7 +24,7 @@
@@ -1753,6 +1753,76 @@
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html index 2318969f0..beaf697ed 100644 --- a/docs/module-auth.AuthenticationClient.html +++ b/docs/module-auth.AuthenticationClient.html @@ -24,7 +24,7 @@
management/index.js
*/ utils.wrapPropertyMethod(ManagementClient, 'blacklistToken', 'blacklistedTokens.add'); +/** + * Create a new Email Template. + * + * @method createEmailTemplate + * @memberOf module:management.ManagementClient.prototype + * + * @example + * management.createEmailTemplate(data, function (err) { + * if (err) { + * // Handle error. + * // Email Template created. + * }); + * + * @param {Object} data Email Template data object. + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod(ManagementClient, 'createEmailTemplate', 'emailTemplates.create'); + +/** + * Get an Auth0 Email Template. + * + * @method getEmailTemplate + * @memberOf module:management.ManagementClient.prototype + * + * @example + * management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) { + * if (err) { + * // Handle error. + * } + * + * console.log(emailTemplate); + * }); + * + * @param {Object} params Email Template parameters. + * @param {String} params.name Template Name + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod(ManagementClient, 'getEmailTemplate', 'emailTemplates.get'); + +/** + * Update an existing Email Template. + * + * @method updateEmailTemplates + * @memberOf module:management.ManagementClient.prototype + * + * @example + * var data = { from: 'new@email.com' }; + * var params = { name: EMAIL_TEMPLATE_NAME }; + * + * management.updateEmailTemplates(params, data, function (err, emailTemplate) { + * if (err) { + * // Handle error. + * } + * + * console.log(emailTemplate.from); // 'new@email.com' + * }); + * + * @param {Object} params Email Template parameters. + * @param {String} params.name Template Name + * @param {Object} data Updated Email Template data. + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod(ManagementClient, 'updateEmailTemplate', 'emailTemplates.update'); + /** * Get the email provider. * @@ -2880,7 +2950,7 @@management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html index 2318969f0..beaf697ed 100644 --- a/docs/module-auth.AuthenticationClient.html +++ b/docs/module-auth.AuthenticationClient.html @@ -24,7 +24,7 @@
@@ -3822,7 +3822,7 @@
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html index c958b6a9f..5cca41240 100644 --- a/docs/module-auth.DatabaseAuthenticator.html +++ b/docs/module-auth.DatabaseAuthenticator.html @@ -24,7 +24,7 @@
Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html index c958b6a9f..5cca41240 100644 --- a/docs/module-auth.DatabaseAuthenticator.html +++ b/docs/module-auth.DatabaseAuthenticator.html @@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html index f4ca2c526..b8f357216 100644 --- a/docs/module-auth.OAUthWithIDTokenValidation.html +++ b/docs/module-auth.OAUthWithIDTokenValidation.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html index f4ca2c526..b8f357216 100644 --- a/docs/module-auth.OAUthWithIDTokenValidation.html +++ b/docs/module-auth.OAUthWithIDTokenValidation.html @@ -24,7 +24,7 @@
@@ -450,7 +450,7 @@
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html index b1081b4ec..fe6720748 100644 --- a/docs/module-auth.OAuthAuthenticator.html +++ b/docs/module-auth.OAuthAuthenticator.html @@ -24,7 +24,7 @@
Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html index b1081b4ec..fe6720748 100644 --- a/docs/module-auth.OAuthAuthenticator.html +++ b/docs/module-auth.OAuthAuthenticator.html @@ -24,7 +24,7 @@
@@ -102,7 +102,7 @@ new
new
Source:
(inner) Source:
Source:
password
Source:
refreshTo
Source:
signInSource:
socialSig
Source:
Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 2c7338b26..6b4dd491a 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index b90115d33..ecf882540 100644
--- a/docs/module-auth.TokensManager.html
+++ b/docs/module-auth.TokensManager.html
@@ -24,7 +24,7 @@
@@ -352,7 +352,7 @@ Parameters:
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html
index 1fb994b71..c6664357a 100644
--- a/docs/module-auth.UsersManager.html
+++ b/docs/module-auth.UsersManager.html
@@ -24,7 +24,7 @@
@@ -1009,7 +1009,7 @@ Example
diff --git a/docs/module-auth.html b/docs/module-auth.html
index 67edc6ef6..5f31661c2 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@ Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html
new file mode 100644
index 000000000..ba83f853f
--- /dev/null
+++ b/docs/module-errors.html
@@ -0,0 +1,263 @@
+
+
+
+
+
+ errors - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ errors
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ (static) SanitizedError()
+
+
+
+
+
+
+ Given an Api Error, modify the original error and sanitize
+sensitive information using sanitizeErrorRequestData
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 122846930..f69d82d5e 100644
--- a/docs/module-management.BlacklistedTokensManager.html
+++ b/docs/module-management.BlacklistedTokensManager.html
@@ -24,7 +24,7 @@
@@ -991,7 +991,7 @@ Example
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html
index b604f8895..401bda83e 100644
--- a/docs/module-management.BrandingManager.html
+++ b/docs/module-management.BrandingManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index de293e317..74e4efc91 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 81c75d824..a5d4b0146 100644
--- a/docs/module-management.ClientsManager.html
+++ b/docs/module-management.ClientsManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
index d246d9852..09313b8ba 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 33024c066..a2f58e6bf 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -1731,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index c50d0230e..8d5658130 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 85b48818c..98b68990c 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index aa2d4f718..cfe8647da 100644
--- a/docs/module-management.EmailTemplatesManager.html
+++ b/docs/module-management.EmailTemplatesManager.html
@@ -24,7 +24,7 @@
@@ -1304,7 +1304,7 @@ Example
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html
index 4e2f67aee..dfdbc7616 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -24,7 +24,7 @@
@@ -1515,7 +1515,7 @@ Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index fbb741e09..865df2f99 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 43f1c0d5d..cb838e052 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -994,7 +994,7 @@ get
- Given a job ID, retrieve the failed/errored items
+ Get a job by its ID.
@@ -1030,7 +1030,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.errors(params, function (err, job) {
+management.jobs.get(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -1268,7 +1268,7 @@ get
- Get a job by its ID.
+ Given a job ID, retrieve the failed/errored items
@@ -1304,7 +1304,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.get(params, function (err, job) {
+management.jobs.errors(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -2198,7 +2198,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index be6183bb5..b5307d3f3 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
@@ -1286,7 +1286,7 @@ Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index 112165b2c..7fd390a6e 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -2301,7 +2301,7 @@ a
Source:
Source:
cre
Source:
Example
+
+
+
+
+ createEmailTemplate(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Create a new Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template data object.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.createEmailTemplate(data, function (err) {
+ if (err) {
+ // Handle error.
+ // Email Template created.
+});
+
+
+
+
+
+
@@ -5002,7 +5218,7 @@ Source:
Source:
Source:
c
Source:
createRole<
Source:
del
Source:
de
Source:
d
Source:
deleteRole<
Source:
dele
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
getEm
Source:
Example
- getGrants(params, cbopt) → {Promise|undefined}
+ getEmailTemplate(params, cbopt) → {Promise|undefined}
- Get all Auth0 Grants.
+ Get an Auth0 Email Template.
@@ -13945,7 +14161,7 @@ getGrantsSource:
Parameters:
- Grants parameters.
+ Email Template parameters.
@@ -14042,13 +14258,13 @@ Parameters:
- per_pagename
-Number
+String
@@ -14059,7 +14275,15 @@ Parameters:
- Number of results per page.
+ Template Name
+
+
+
+
+
+
+
+
@@ -14068,38 +14292,299 @@ Parameters:
- pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ Callback function.
+
+
-
-
- include_totals
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate);
+});
+
+
+
+
+
+
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
Boolean
@@ -14879,7 +15364,7 @@ getJobSource:
getLogSource:
getLogsSource:
g
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRul
Source:
getT
Source:
getUser
Source:
importUser
Source:
Source:
Source:
setRule
Source:
unblockUse
Source:
Parameters:
- identifierid
@@ -23716,7 +24201,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ The user id.
@@ -23811,7 +24296,7 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)
Source:
password
Source:
refreshTo
Source:
signInSource:
socialSig
Source:
Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 2c7338b26..6b4dd491a 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index b90115d33..ecf882540 100644
--- a/docs/module-auth.TokensManager.html
+++ b/docs/module-auth.TokensManager.html
@@ -24,7 +24,7 @@
@@ -352,7 +352,7 @@ Parameters:
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html
index 1fb994b71..c6664357a 100644
--- a/docs/module-auth.UsersManager.html
+++ b/docs/module-auth.UsersManager.html
@@ -24,7 +24,7 @@
@@ -1009,7 +1009,7 @@ Example
diff --git a/docs/module-auth.html b/docs/module-auth.html
index 67edc6ef6..5f31661c2 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@ Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html
new file mode 100644
index 000000000..ba83f853f
--- /dev/null
+++ b/docs/module-errors.html
@@ -0,0 +1,263 @@
+
+
+
+
+
+ errors - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ errors
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ (static) SanitizedError()
+
+
+
+
+
+
+ Given an Api Error, modify the original error and sanitize
+sensitive information using sanitizeErrorRequestData
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 122846930..f69d82d5e 100644
--- a/docs/module-management.BlacklistedTokensManager.html
+++ b/docs/module-management.BlacklistedTokensManager.html
@@ -24,7 +24,7 @@
@@ -991,7 +991,7 @@ Example
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html
index b604f8895..401bda83e 100644
--- a/docs/module-management.BrandingManager.html
+++ b/docs/module-management.BrandingManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index de293e317..74e4efc91 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 81c75d824..a5d4b0146 100644
--- a/docs/module-management.ClientsManager.html
+++ b/docs/module-management.ClientsManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
index d246d9852..09313b8ba 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 33024c066..a2f58e6bf 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -1731,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index c50d0230e..8d5658130 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 85b48818c..98b68990c 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index aa2d4f718..cfe8647da 100644
--- a/docs/module-management.EmailTemplatesManager.html
+++ b/docs/module-management.EmailTemplatesManager.html
@@ -24,7 +24,7 @@
@@ -1304,7 +1304,7 @@ Example
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html
index 4e2f67aee..dfdbc7616 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -24,7 +24,7 @@
@@ -1515,7 +1515,7 @@ Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index fbb741e09..865df2f99 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 43f1c0d5d..cb838e052 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -994,7 +994,7 @@ get
- Given a job ID, retrieve the failed/errored items
+ Get a job by its ID.
@@ -1030,7 +1030,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.errors(params, function (err, job) {
+management.jobs.get(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -1268,7 +1268,7 @@ get
- Get a job by its ID.
+ Given a job ID, retrieve the failed/errored items
@@ -1304,7 +1304,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.get(params, function (err, job) {
+management.jobs.errors(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -2198,7 +2198,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index be6183bb5..b5307d3f3 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
@@ -1286,7 +1286,7 @@ Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index 112165b2c..7fd390a6e 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -2301,7 +2301,7 @@ a
Source:
Source:
cre
Source:
Example
+
+
+
+
+ createEmailTemplate(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Create a new Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template data object.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.createEmailTemplate(data, function (err) {
+ if (err) {
+ // Handle error.
+ // Email Template created.
+});
+
+
+
+
+
+
@@ -5002,7 +5218,7 @@ Source:
Source:
Source:
c
Source:
createRole<
Source:
del
Source:
de
Source:
d
Source:
deleteRole<
Source:
dele
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
getEm
Source:
Example
- getGrants(params, cbopt) → {Promise|undefined}
+ getEmailTemplate(params, cbopt) → {Promise|undefined}
- Get all Auth0 Grants.
+ Get an Auth0 Email Template.
@@ -13945,7 +14161,7 @@ getGrantsSource:
Parameters:
- Grants parameters.
+ Email Template parameters.
@@ -14042,13 +14258,13 @@ Parameters:
- per_pagename
-Number
+String
@@ -14059,7 +14275,15 @@ Parameters:
- Number of results per page.
+ Template Name
+
+
+
+
+
+
+
+
@@ -14068,38 +14292,299 @@ Parameters:
- pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ Callback function.
+
+
-
-
- include_totals
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate);
+});
+
+
+
+
+
+
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
Boolean
@@ -14879,7 +15364,7 @@ getJobSource:
getLogSource:
getLogsSource:
g
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRul
Source:
getT
Source:
getUser
Source:
importUser
Source:
Source:
Source:
setRule
Source:
unblockUse
Source:
Parameters:
- identifierid
@@ -23716,7 +24201,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ The user id.
@@ -23811,7 +24296,7 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)
refreshTo
Source:
signInSource:
socialSig
Source:
Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 2c7338b26..6b4dd491a 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index b90115d33..ecf882540 100644
--- a/docs/module-auth.TokensManager.html
+++ b/docs/module-auth.TokensManager.html
@@ -24,7 +24,7 @@
@@ -352,7 +352,7 @@ Parameters:
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html
index 1fb994b71..c6664357a 100644
--- a/docs/module-auth.UsersManager.html
+++ b/docs/module-auth.UsersManager.html
@@ -24,7 +24,7 @@
@@ -1009,7 +1009,7 @@ Example
diff --git a/docs/module-auth.html b/docs/module-auth.html
index 67edc6ef6..5f31661c2 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@ Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html
new file mode 100644
index 000000000..ba83f853f
--- /dev/null
+++ b/docs/module-errors.html
@@ -0,0 +1,263 @@
+
+
+
+
+
+ errors - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ errors
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ (static) SanitizedError()
+
+
+
+
+
+
+ Given an Api Error, modify the original error and sanitize
+sensitive information using sanitizeErrorRequestData
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 122846930..f69d82d5e 100644
--- a/docs/module-management.BlacklistedTokensManager.html
+++ b/docs/module-management.BlacklistedTokensManager.html
@@ -24,7 +24,7 @@
@@ -991,7 +991,7 @@ Example
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html
index b604f8895..401bda83e 100644
--- a/docs/module-management.BrandingManager.html
+++ b/docs/module-management.BrandingManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index de293e317..74e4efc91 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 81c75d824..a5d4b0146 100644
--- a/docs/module-management.ClientsManager.html
+++ b/docs/module-management.ClientsManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
index d246d9852..09313b8ba 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 33024c066..a2f58e6bf 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -1731,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index c50d0230e..8d5658130 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 85b48818c..98b68990c 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index aa2d4f718..cfe8647da 100644
--- a/docs/module-management.EmailTemplatesManager.html
+++ b/docs/module-management.EmailTemplatesManager.html
@@ -24,7 +24,7 @@
@@ -1304,7 +1304,7 @@ Example
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html
index 4e2f67aee..dfdbc7616 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -24,7 +24,7 @@
@@ -1515,7 +1515,7 @@ Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index fbb741e09..865df2f99 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 43f1c0d5d..cb838e052 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -994,7 +994,7 @@ get
- Given a job ID, retrieve the failed/errored items
+ Get a job by its ID.
@@ -1030,7 +1030,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.errors(params, function (err, job) {
+management.jobs.get(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -1268,7 +1268,7 @@ get
- Get a job by its ID.
+ Given a job ID, retrieve the failed/errored items
@@ -1304,7 +1304,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.get(params, function (err, job) {
+management.jobs.errors(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -2198,7 +2198,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index be6183bb5..b5307d3f3 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
@@ -1286,7 +1286,7 @@ Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index 112165b2c..7fd390a6e 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -2301,7 +2301,7 @@ a
Source:
Source:
cre
Source:
Example
+
+
+
+
+ createEmailTemplate(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Create a new Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template data object.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.createEmailTemplate(data, function (err) {
+ if (err) {
+ // Handle error.
+ // Email Template created.
+});
+
+
+
+
+
+
@@ -5002,7 +5218,7 @@ Source:
Source:
Source:
c
Source:
createRole<
Source:
del
Source:
de
Source:
d
Source:
deleteRole<
Source:
dele
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
getEm
Source:
Example
- getGrants(params, cbopt) → {Promise|undefined}
+ getEmailTemplate(params, cbopt) → {Promise|undefined}
- Get all Auth0 Grants.
+ Get an Auth0 Email Template.
@@ -13945,7 +14161,7 @@ getGrantsSource:
Parameters:
- Grants parameters.
+ Email Template parameters.
@@ -14042,13 +14258,13 @@ Parameters:
- per_pagename
-Number
+String
@@ -14059,7 +14275,15 @@ Parameters:
- Number of results per page.
+ Template Name
+
+
+
+
+
+
+
+
@@ -14068,38 +14292,299 @@ Parameters:
- pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ Callback function.
+
+
-
-
- include_totals
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate);
+});
+
+
+
+
+
+
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
Boolean
@@ -14879,7 +15364,7 @@ getJobSource:
getLogSource:
getLogsSource:
g
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRul
Source:
getT
Source:
getUser
Source:
importUser
Source:
Source:
Source:
setRule
Source:
unblockUse
Source:
Parameters:
- identifierid
@@ -23716,7 +24201,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ The user id.
@@ -23811,7 +24296,7 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)
socialSig
Source:
Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 2c7338b26..6b4dd491a 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index b90115d33..ecf882540 100644
--- a/docs/module-auth.TokensManager.html
+++ b/docs/module-auth.TokensManager.html
@@ -24,7 +24,7 @@
@@ -352,7 +352,7 @@ Parameters:
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html
index 1fb994b71..c6664357a 100644
--- a/docs/module-auth.UsersManager.html
+++ b/docs/module-auth.UsersManager.html
@@ -24,7 +24,7 @@
@@ -1009,7 +1009,7 @@ Example
diff --git a/docs/module-auth.html b/docs/module-auth.html
index 67edc6ef6..5f31661c2 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@ Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html
new file mode 100644
index 000000000..ba83f853f
--- /dev/null
+++ b/docs/module-errors.html
@@ -0,0 +1,263 @@
+
+
+
+
+
+ errors - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ errors
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ (static) SanitizedError()
+
+
+
+
+
+
+ Given an Api Error, modify the original error and sanitize
+sensitive information using sanitizeErrorRequestData
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 122846930..f69d82d5e 100644
--- a/docs/module-management.BlacklistedTokensManager.html
+++ b/docs/module-management.BlacklistedTokensManager.html
@@ -24,7 +24,7 @@
@@ -991,7 +991,7 @@ Example
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html
index b604f8895..401bda83e 100644
--- a/docs/module-management.BrandingManager.html
+++ b/docs/module-management.BrandingManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index de293e317..74e4efc91 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 81c75d824..a5d4b0146 100644
--- a/docs/module-management.ClientsManager.html
+++ b/docs/module-management.ClientsManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
index d246d9852..09313b8ba 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 33024c066..a2f58e6bf 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -1731,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index c50d0230e..8d5658130 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 85b48818c..98b68990c 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index aa2d4f718..cfe8647da 100644
--- a/docs/module-management.EmailTemplatesManager.html
+++ b/docs/module-management.EmailTemplatesManager.html
@@ -24,7 +24,7 @@
@@ -1304,7 +1304,7 @@ Example
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html
index 4e2f67aee..dfdbc7616 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -24,7 +24,7 @@
@@ -1515,7 +1515,7 @@ Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index fbb741e09..865df2f99 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 43f1c0d5d..cb838e052 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -994,7 +994,7 @@ get
- Given a job ID, retrieve the failed/errored items
+ Get a job by its ID.
@@ -1030,7 +1030,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.errors(params, function (err, job) {
+management.jobs.get(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -1268,7 +1268,7 @@ get
- Get a job by its ID.
+ Given a job ID, retrieve the failed/errored items
@@ -1304,7 +1304,7 @@ getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.get(params, function (err, job) {
+management.jobs.errors(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -2198,7 +2198,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index be6183bb5..b5307d3f3 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
@@ -1286,7 +1286,7 @@ Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index 112165b2c..7fd390a6e 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -2301,7 +2301,7 @@ a
Source:
Source:
cre
Source:
Example
+
+
+
+
+ createEmailTemplate(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Create a new Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template data object.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.createEmailTemplate(data, function (err) {
+ if (err) {
+ // Handle error.
+ // Email Template created.
+});
+
+
+
+
+
+
@@ -5002,7 +5218,7 @@ Source:
Source:
Source:
c
Source:
createRole<
Source:
del
Source:
de
Source:
d
Source:
deleteRole<
Source:
dele
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
getEm
Source:
Example
- getGrants(params, cbopt) → {Promise|undefined}
+ getEmailTemplate(params, cbopt) → {Promise|undefined}
- Get all Auth0 Grants.
+ Get an Auth0 Email Template.
@@ -13945,7 +14161,7 @@ getGrantsSource:
Parameters:
- Grants parameters.
+ Email Template parameters.
@@ -14042,13 +14258,13 @@ Parameters:
- per_pagename
-Number
+String
@@ -14059,7 +14275,15 @@ Parameters:
- Number of results per page.
+ Template Name
+
+
+
+
+
+
+
+
@@ -14068,38 +14292,299 @@ Parameters:
- pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ Callback function.
+
+
-
-
- include_totals
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate);
+});
+
+
+
+
+
+
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
Boolean
@@ -14879,7 +15364,7 @@ getJobSource:
getLogSource:
getLogsSource:
g
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRul
Source:
getT
Source:
getUser
Source:
importUser
Source:
Source:
Source:
setRule
Source:
unblockUse
Source:
Parameters:
- identifierid
@@ -23716,7 +24201,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ The user id.
@@ -23811,7 +24296,7 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)
Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html index b90115d33..ecf882540 100644 --- a/docs/module-auth.TokensManager.html +++ b/docs/module-auth.TokensManager.html @@ -24,7 +24,7 @@
@@ -352,7 +352,7 @@
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html index 1fb994b71..c6664357a 100644 --- a/docs/module-auth.UsersManager.html +++ b/docs/module-auth.UsersManager.html @@ -24,7 +24,7 @@
Parameters:
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html index 1fb994b71..c6664357a 100644 --- a/docs/module-auth.UsersManager.html +++ b/docs/module-auth.UsersManager.html @@ -24,7 +24,7 @@
@@ -1009,7 +1009,7 @@
diff --git a/docs/module-auth.html b/docs/module-auth.html index 67edc6ef6..5f31661c2 100644 --- a/docs/module-auth.html +++ b/docs/module-auth.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-auth.html b/docs/module-auth.html index 67edc6ef6..5f31661c2 100644 --- a/docs/module-auth.html +++ b/docs/module-auth.html @@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@
diff --git a/docs/module-errors.html b/docs/module-errors.html new file mode 100644 index 000000000..ba83f853f --- /dev/null +++ b/docs/module-errors.html @@ -0,0 +1,263 @@ + + + + + +errors - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + + + + + + \ No newline at end of file diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html index 122846930..f69d82d5e 100644 --- a/docs/module-management.BlacklistedTokensManager.html +++ b/docs/module-management.BlacklistedTokensManager.html @@ -24,7 +24,7 @@
Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html new file mode 100644 index 000000000..ba83f853f --- /dev/null +++ b/docs/module-errors.html @@ -0,0 +1,263 @@ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+errors
+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+ + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+(static) SanitizedError()
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Given an Api Error, modify the original error and sanitize +sensitive information using sanitizeErrorRequestData
++ + + + + + + \ No newline at end of file diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html index 122846930..f69d82d5e 100644 --- a/docs/module-management.BlacklistedTokensManager.html +++ b/docs/module-management.BlacklistedTokensManager.html @@ -24,7 +24,7 @@
@@ -991,7 +991,7 @@
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html index b604f8895..401bda83e 100644 --- a/docs/module-management.BrandingManager.html +++ b/docs/module-management.BrandingManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html index b604f8895..401bda83e 100644 --- a/docs/module-management.BrandingManager.html +++ b/docs/module-management.BrandingManager.html @@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html index de293e317..74e4efc91 100644 --- a/docs/module-management.ClientGrantsManager.html +++ b/docs/module-management.ClientGrantsManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html index de293e317..74e4efc91 100644 --- a/docs/module-management.ClientGrantsManager.html +++ b/docs/module-management.ClientGrantsManager.html @@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html index 81c75d824..a5d4b0146 100644 --- a/docs/module-management.ClientsManager.html +++ b/docs/module-management.ClientsManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html index 81c75d824..a5d4b0146 100644 --- a/docs/module-management.ClientsManager.html +++ b/docs/module-management.ClientsManager.html @@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html index d246d9852..09313b8ba 100644 --- a/docs/module-management.ConnectionsManager.html +++ b/docs/module-management.ConnectionsManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html index d246d9852..09313b8ba 100644 --- a/docs/module-management.ConnectionsManager.html +++ b/docs/module-management.ConnectionsManager.html @@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html index 33024c066..a2f58e6bf 100644 --- a/docs/module-management.CustomDomainsManager.html +++ b/docs/module-management.CustomDomainsManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html index 33024c066..a2f58e6bf 100644 --- a/docs/module-management.CustomDomainsManager.html +++ b/docs/module-management.CustomDomainsManager.html @@ -24,7 +24,7 @@
@@ -1731,7 +1731,7 @@
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html index c50d0230e..8d5658130 100644 --- a/docs/module-management.DeviceCredentialsManager.html +++ b/docs/module-management.DeviceCredentialsManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html index c50d0230e..8d5658130 100644 --- a/docs/module-management.DeviceCredentialsManager.html +++ b/docs/module-management.DeviceCredentialsManager.html @@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html index 85b48818c..98b68990c 100644 --- a/docs/module-management.EmailProviderManager.html +++ b/docs/module-management.EmailProviderManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html index 85b48818c..98b68990c 100644 --- a/docs/module-management.EmailProviderManager.html +++ b/docs/module-management.EmailProviderManager.html @@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html index aa2d4f718..cfe8647da 100644 --- a/docs/module-management.EmailTemplatesManager.html +++ b/docs/module-management.EmailTemplatesManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html index aa2d4f718..cfe8647da 100644 --- a/docs/module-management.EmailTemplatesManager.html +++ b/docs/module-management.EmailTemplatesManager.html @@ -24,7 +24,7 @@
@@ -1304,7 +1304,7 @@
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html index 4e2f67aee..dfdbc7616 100644 --- a/docs/module-management.GrantsManager.html +++ b/docs/module-management.GrantsManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html index 4e2f67aee..dfdbc7616 100644 --- a/docs/module-management.GrantsManager.html +++ b/docs/module-management.GrantsManager.html @@ -24,7 +24,7 @@
@@ -1515,7 +1515,7 @@
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html index fbb741e09..865df2f99 100644 --- a/docs/module-management.GuardianManager.html +++ b/docs/module-management.GuardianManager.html @@ -24,7 +24,7 @@getSource:
Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html index fbb741e09..865df2f99 100644 --- a/docs/module-management.GuardianManager.html +++ b/docs/module-management.GuardianManager.html @@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html index 43f1c0d5d..cb838e052 100644 --- a/docs/module-management.JobsManager.html +++ b/docs/module-management.JobsManager.html @@ -24,7 +24,7 @@getSource:
@@ -1304,7 +1304,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html index 43f1c0d5d..cb838e052 100644 --- a/docs/module-management.JobsManager.html +++ b/docs/module-management.JobsManager.html @@ -24,7 +24,7 @@
@@ -994,7 +994,7 @@ get
-
@@ -1030,7 +1030,7 @@ get
- Given a job ID, retrieve the failed/errored items
+ Get a job by its ID.
getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.errors(params, function (err, job) {
+management.jobs.get(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -1268,7 +1268,7 @@ get
- Get a job by its ID.
+ Given a job ID, retrieve the failed/errored items
Get a job by its ID.
+Given a job ID, retrieve the failed/errored items
getSource:
Example
id: '{JOB_ID}'
};
-management.jobs.get(params, function (err, job) {
+management.jobs.errors(params, function (err, job) {
if (err) {
// Handle error.
}
@@ -2198,7 +2198,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index be6183bb5..b5307d3f3 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
@@ -1286,7 +1286,7 @@ Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index 112165b2c..7fd390a6e 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -2301,7 +2301,7 @@ a
Source:
Source:
cre
Source:
Example
+
+
+
+
+ createEmailTemplate(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Create a new Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template data object.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.createEmailTemplate(data, function (err) {
+ if (err) {
+ // Handle error.
+ // Email Template created.
+});
+
+
+
+
+
+
@@ -5002,7 +5218,7 @@ Source:
Source:
Source:
c
Source:
createRole<
Source:
del
Source:
de
Source:
d
Source:
deleteRole<
Source:
dele
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
getEm
Source:
Example
- getGrants(params, cbopt) → {Promise|undefined}
+ getEmailTemplate(params, cbopt) → {Promise|undefined}
- Get all Auth0 Grants.
+ Get an Auth0 Email Template.
@@ -13945,7 +14161,7 @@ getGrantsSource:
Parameters:
- Grants parameters.
+ Email Template parameters.
@@ -14042,13 +14258,13 @@ Parameters:
- per_pagename
-Number
+String
@@ -14059,7 +14275,15 @@ Parameters:
- Number of results per page.
+ Template Name
+
+
+
+
+
+
+
+
@@ -14068,38 +14292,299 @@ Parameters:
- pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ Callback function.
+
+
-
-
- include_totals
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate);
+});
+
+
+
+
+
+
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
Boolean
@@ -14879,7 +15364,7 @@ getJobSource:
getLogSource:
getLogsSource:
g
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRul
Source:
getT
Source:
getUser
Source:
importUser
Source:
Source:
Source:
setRule
Source:
unblockUse
Source:
Parameters:
- identifierid
@@ -23716,7 +24201,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ The user id.
@@ -23811,7 +24296,7 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)
Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html index 112165b2c..7fd390a6e 100644 --- a/docs/module-management.ManagementClient.html +++ b/docs/module-management.ManagementClient.html @@ -24,7 +24,7 @@
@@ -2301,7 +2301,7 @@ a
+a
Source:
Source:
cre
Source:
Example
cre
Source:
Example
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
createEmailTemplate(data, cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Create a new Email Template.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +
|---|---|---|---|
data |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Email Template data object. + + |
+
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+Example
+ +management.createEmailTemplate(data, function (err) {
+ if (err) {
+ // Handle error.
+ // Email Template created.
+});
@@ -5002,7 +5218,7 @@ Source:
Source:
Source:
Source:
c
Source:
createRole<
Source:
del
Source:
de
Source:
d
Source:
deleteRole<
Source:
dele
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
getEm
Source:
Example
- getGrants(params, cbopt) → {Promise|undefined}
+ getEmailTemplate(params, cbopt) → {Promise|undefined}
- Get all Auth0 Grants.
+ Get an Auth0 Email Template.
@@ -13945,7 +14161,7 @@ getGrantsSource:
Parameters:
- Grants parameters.
+ Email Template parameters.
@@ -14042,13 +14258,13 @@ Parameters:
- per_pagename
-Number
+String
@@ -14059,7 +14275,15 @@ Parameters:
- Number of results per page.
+ Template Name
+
+
+
+
+
+
+
+
@@ -14068,38 +14292,299 @@ Parameters:
- pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ Callback function.
+
+
-
-
- include_totals
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate);
+});
+
+
+
+
+
+
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
Boolean
@@ -14879,7 +15364,7 @@ getJobSource:
getLogSource:
getLogsSource:
g
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRul
Source:
getT
Source:
getUser
Source:
importUser
Source:
Source:
Source:
setRule
Source:
unblockUse
Source:
Parameters:
- identifierid
@@ -23716,7 +24201,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ The user id.
@@ -23811,7 +24296,7 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)
Source:
c
Source:
createRole<
Source:
del
Source:
de
Source:
d
Source:
deleteRole<
Source:
dele
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
getEm
Source:
Example
- getGrants(params, cbopt) → {Promise|undefined}
+ getEmailTemplate(params, cbopt) → {Promise|undefined}
- Get all Auth0 Grants.
+ Get an Auth0 Email Template.
@@ -13945,7 +14161,7 @@ getGrantsSource:
Parameters:
- Grants parameters.
+ Email Template parameters.
@@ -14042,13 +14258,13 @@ Parameters:
- per_pagename
-Number
+String
@@ -14059,7 +14275,15 @@ Parameters:
- Number of results per page.
+ Template Name
+
+
+
+
+
+
+
+
@@ -14068,38 +14292,299 @@ Parameters:
- pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ Callback function.
+
+
-
-
- include_totals
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate);
+});
+
+
+
+
+
+
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
Boolean
@@ -14879,7 +15364,7 @@ getJobSource:
getLogSource:
getLogsSource:
g
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRul
Source:
getT
Source:
getUser
Source:
importUser
Source:
Source:
Source:
setRule
Source:
unblockUse
Source:
Parameters:
- identifierid
@@ -23716,7 +24201,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ The user id.
@@ -23811,7 +24296,7 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)
createRole<
Source:
del
Source:
de
Source:
d
Source:
deleteRole<
Source:
dele
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
getEm
Source:
Example
- getGrants(params, cbopt) → {Promise|undefined}
+ getEmailTemplate(params, cbopt) → {Promise|undefined}
- Get all Auth0 Grants.
+ Get an Auth0 Email Template.
@@ -13945,7 +14161,7 @@ getGrantsSource:
Parameters:
- Grants parameters.
+ Email Template parameters.
@@ -14042,13 +14258,13 @@ Parameters:
- per_pagename
-Number
+String
@@ -14059,7 +14275,15 @@ Parameters:
- Number of results per page.
+ Template Name
+
+
+
+
+
+
+
+
@@ -14068,38 +14292,299 @@ Parameters:
- pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ Callback function.
+
+
-
-
- include_totals
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate);
+});
+
+
+
+
+
+
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
Boolean
@@ -14879,7 +15364,7 @@ getJobSource:
getLogSource:
getLogsSource:
g
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRul
Source:
getT
Source:
getUser
Source:
importUser
Source:
Source:
Source:
setRule
Source:
unblockUse
Source:
Parameters:
- identifierid
@@ -23716,7 +24201,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ The user id.
@@ -23811,7 +24296,7 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)
de
Source:
d
Source:
deleteRole<
Source:
dele
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
getEm
Source:
Example
- getGrants(params, cbopt) → {Promise|undefined}
+ getEmailTemplate(params, cbopt) → {Promise|undefined}
- Get all Auth0 Grants.
+ Get an Auth0 Email Template.
@@ -13945,7 +14161,7 @@ getGrantsSource:
Parameters:
- Grants parameters.
+ Email Template parameters.
@@ -14042,13 +14258,13 @@ Parameters:
- per_pagename
-Number
+String
@@ -14059,7 +14275,15 @@ Parameters:
- Number of results per page.
+ Template Name
+
+
+
+
+
+
+
+
@@ -14068,38 +14292,299 @@ Parameters:
- pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ Callback function.
+
+
-
-
- include_totals
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate);
+});
+
+
+
+
+
+
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
Boolean
@@ -14879,7 +15364,7 @@ getJobSource:
getLogSource:
getLogsSource:
g
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRul
Source:
getT
Source:
getUser
Source:
importUser
Source:
Source:
Source:
setRule
Source:
unblockUse
Source:
Parameters:
- identifierid
@@ -23716,7 +24201,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ The user id.
@@ -23811,7 +24296,7 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)
deleteRole<
Source:
dele
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
getEm
Source:
Example
- getGrants(params, cbopt) → {Promise|undefined}
+ getEmailTemplate(params, cbopt) → {Promise|undefined}
- Get all Auth0 Grants.
+ Get an Auth0 Email Template.
@@ -13945,7 +14161,7 @@ getGrantsSource:
Parameters:
- Grants parameters.
+ Email Template parameters.
@@ -14042,13 +14258,13 @@ Parameters:
- per_pagename
-Number
+String
@@ -14059,7 +14275,15 @@ Parameters:
- Number of results per page.
+ Template Name
+
+
+
+
+
+
+
+
@@ -14068,38 +14292,299 @@ Parameters:
- pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ Callback function.
+
+
-
-
- include_totals
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate);
+});
+
+
+
+
+
+
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
Boolean
@@ -14879,7 +15364,7 @@ getJobSource:
getLogSource:
getLogsSource:
g
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRul
Source:
getT
Source:
getUser
Source:
importUser
Source:
Source:
Source:
setRule
Source:
unblockUse
Source:
Parameters:
- identifierid
@@ -23716,7 +24201,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ The user id.
@@ -23811,7 +24296,7 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)
exportUser
Source:
getAcce
Source:
ge
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
getEm
Source:
Example
- getGrants(params, cbopt) → {Promise|undefined}
+ getEmailTemplate(params, cbopt) → {Promise|undefined}
- Get all Auth0 Grants.
+ Get an Auth0 Email Template.
@@ -13945,7 +14161,7 @@ getGrantsSource:
Parameters:
- Grants parameters.
+ Email Template parameters.
@@ -14042,13 +14258,13 @@ Parameters:
- per_pagename
-Number
+String
@@ -14059,7 +14275,15 @@ Parameters:
- Number of results per page.
+ Template Name
+
+
+
+
+
+
+
+
@@ -14068,38 +14292,299 @@ Parameters:
- pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ Callback function.
+
+
-
-
- include_totals
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate);
+});
+
+
+
+
+
+
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
Boolean
@@ -14879,7 +15364,7 @@ getJobSource:
getLogSource:
getLogsSource:
g
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRul
Source:
getT
Source:
getUser
Source:
importUser
Source:
Source:
Source:
setRule
Source:
unblockUse
Source:
Parameters:
- identifierid
@@ -23716,7 +24201,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ The user id.
@@ -23811,7 +24296,7 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)
ge
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
getEm
Source:
Example
- getGrants(params, cbopt) → {Promise|undefined}
+ getEmailTemplate(params, cbopt) → {Promise|undefined}
- Get all Auth0 Grants.
+ Get an Auth0 Email Template.
@@ -13945,7 +14161,7 @@ getGrantsSource:
Parameters:
- Grants parameters.
+ Email Template parameters.
@@ -14042,13 +14258,13 @@ Parameters:
- per_pagename
-Number
+String
@@ -14059,7 +14275,15 @@ Parameters:
- Number of results per page.
+ Template Name
+
+
+
+
+
+
+
+
@@ -14068,38 +14292,299 @@ Parameters:
- pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ Callback function.
+
+
-
-
- include_totals
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate);
+});
+
+
+
+
+
+
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
Boolean
@@ -14879,7 +15364,7 @@ getJobSource:
getLogSource:
getLogsSource:
g
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRul
Source:
getT
Source:
getUser
Source:
importUser
Source:
Source:
Source:
setRule
Source:
unblockUse
Source:
Parameters:
- identifierid
@@ -23716,7 +24201,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ The user id.
@@ -23811,7 +24296,7 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)
getCu
Source:
getDaily
Source:
getEm
Source:
Example
- getGrants(params, cbopt) → {Promise|undefined}
+ getEmailTemplate(params, cbopt) → {Promise|undefined}
- Get all Auth0 Grants.
+ Get an Auth0 Email Template.
@@ -13945,7 +14161,7 @@ getGrantsSource:
Parameters:
- Grants parameters.
+ Email Template parameters.
@@ -14042,13 +14258,13 @@ Parameters:
- per_pagename
-Number
+String
@@ -14059,7 +14275,15 @@ Parameters:
- Number of results per page.
+ Template Name
+
+
+
+
+
+
+
+
@@ -14068,38 +14292,299 @@ Parameters:
- pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ Callback function.
+
+
-
-
- include_totals
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate);
+});
+
+
+
+
+
+
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
Boolean
@@ -14879,7 +15364,7 @@ getJobSource:
getLogSource:
getLogsSource:
g
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRul
Source:
getT
Source:
getUser
Source:
importUser
Source:
Source:
Source:
setRule
Source:
unblockUse
Source:
Parameters:
- identifierid
@@ -23716,7 +24201,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ The user id.
@@ -23811,7 +24296,7 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)
getEm
Source:
Example
- getGrants(params, cbopt) → {Promise|undefined}
+ getEmailTemplate(params, cbopt) → {Promise|undefined}
- Get all Auth0 Grants.
+ Get an Auth0 Email Template.
@@ -13945,7 +14161,7 @@ getGrantsSource:
Parameters:
- Grants parameters.
+ Email Template parameters.
@@ -14042,13 +14258,13 @@ Parameters:
- per_pagename
-Number
+String
@@ -14059,7 +14275,15 @@ Parameters:
- Number of results per page.
+ Template Name
+
+
+
+
+
+
+
+
@@ -14068,38 +14292,299 @@ Parameters:
- pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ Callback function.
+
+
-
-
- include_totals
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate);
+});
+
+
+
+
+
+
+
+
+
+
+ getGrants(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 Grants.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Grants parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ include_totals
+
+
Boolean
@@ -14879,7 +15364,7 @@ getJobSource:
getLogSource:
getLogsSource:
g
Source:
getR
Source:
get
Source:
getRoleSource:
getRolesSource:
getRul
Source:
getT
Source:
getUser
Source:
importUser
Source:
Source:
Source:
setRule
Source:
unblockUse
Source:
Parameters:
- identifierid
@@ -23716,7 +24201,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ The user id.
@@ -23811,7 +24296,7 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)
Get all Auth0 Grants.
+Get an Auth0 Email Template.
Parameters:
Grants parameters.
+Email Template parameters.
@@ -14042,13 +14258,13 @@Parameters:
per_pagenameNumber
+String
@@ -14059,7 +14275,15 @@ Parameters:
Number of results per page.
+Template Name
+ +Parameters:
pagecbNumber
+function
+ + + + + +
Page number, zero indexed.
+Callback function.
include_totals
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+
+
+
+Example
+ +management.getEmailTemplate({ name: EMAIL_TEMPLATE_NAME }, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate);
+});
+
+
+
+
+
+
getGrants(params, cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Get all Auth0 Grants.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +|||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Grants parameters. + + + +
|
setRule
Source:
unblockUse
Source:
Parameters:
- identifierid
@@ -23716,7 +24201,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ The user id.
@@ -23811,7 +24296,7 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)
Parameters:
identifieridParameters:
The user identifier, any of: username, phone_number, email.
+The user id.
Returns:
Example
-management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ management.unblockUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -23871,7 +24356,7 @@ unblockUse
Source:
Parameters:
- ididentifier
@@ -23985,7 +24470,7 @@ Parameters:
- The user id.
+ The user identifier, any of: username, phone_number, email.
@@ -24080,7 +24565,7 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -25694,7 +26179,7 @@ up
Source:
Example
+
+
+
+
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update an existing Email Template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Email Template data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(emailTemplate.from); // 'new@email.com'
+});
+
+
+
+
+
+
@@ -25947,7 +26738,7 @@ u
Source:
updateRole<
Source:
u
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index f4a7abdcb..0bc8a8c57 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index c8baa8ac0..2c1797c00 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 97f414bcb..baaa0ac04 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@ Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index abadeb01d..81528cc9f 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index 907bf7ac7..5ce3055a3 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index b70f317df..94b575198 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@ Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index 8dd772a41..960660cb2 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@ Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 681b49a53..e8b765825 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index c5f3b745a..32be39197 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6a2b32a39..8600f2c9f 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index ecb3c1352..e65dc5ff5 100644
--- a/docs/module-management.UserBlocksManager.html
+++ b/docs/module-management.UserBlocksManager.html
@@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@ Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 66bab6edc..8b693473a 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 8c1d3683e..ecf1efd0f 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 060f6ba15..8d919d4f5 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 2eee9fe8a..b71efcb9f 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@ utils.js
diff --git a/package.json b/package.json
index 9d3fdf185..a3c23cd91 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.19.0",
+ "version": "2.20.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/scripts/release.js b/scripts/release.js
index 6b02b4bf9..25825e495 100644
--- a/scripts/release.js
+++ b/scripts/release.js
@@ -24,7 +24,7 @@ const createChangelog = async () => {
'# Change Log',
`# Change Log
-## [v${pkg.version}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
+## [v${newVersion}](https://github.com/auth0/node-auth0/tree/v${newVersion}) (${today})
${changelog}
[Full Changelog](https://github.com/auth0/node-auth0/compare/v${pkg.version}...v${newVersion})`
)