RetryRestClient.js
diff --git a/docs/auth_DatabaseAuthenticator.js.html b/docs/auth_DatabaseAuthenticator.js.html index 1a517a33d..e58ed2c85 100644 --- a/docs/auth_DatabaseAuthenticator.js.html +++ b/docs/auth_DatabaseAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -348,7 +348,7 @@
diff --git a/docs/auth_OAUthWithIDTokenValidation.js.html b/docs/auth_OAUthWithIDTokenValidation.js.html index 8403edff6..24cb84b61 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 8403edff6..24cb84b61 100644 --- a/docs/auth_OAUthWithIDTokenValidation.js.html +++ b/docs/auth_OAUthWithIDTokenValidation.js.html @@ -24,7 +24,7 @@
@@ -175,7 +175,7 @@
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html index fa91f1d85..6d66b459d 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 fa91f1d85..6d66b459d 100644 --- a/docs/auth_OAuthAuthenticator.js.html +++ b/docs/auth_OAuthAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -461,7 +461,7 @@
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html index 771732e2b..8345970eb 100644 --- a/docs/auth_PasswordlessAuthenticator.js.html +++ b/docs/auth_PasswordlessAuthenticator.js.html @@ -24,7 +24,7 @@
auth/OAuthAuthenticator.js
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html index 771732e2b..8345970eb 100644 --- a/docs/auth_PasswordlessAuthenticator.js.html +++ b/docs/auth_PasswordlessAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -43,6 +43,20 @@
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html index c88ff1922..a78ed591d 100644 --- a/docs/auth_TokensManager.js.html +++ b/docs/auth_TokensManager.js.html @@ -24,7 +24,7 @@
auth/PasswordlessAuthenticator.js
var ArgumentError = require('rest-facade').ArgumentError; var RestClient = require('rest-facade').Client; +var sanitizeArguments = require('../utils').sanitizeArguments; + +function getParamsFromOptions(options) { + const params = {}; + if (!options || typeof options !== 'object') { + return params; + } + if (options.forwardedFor) { + params._requestCustomizer = function(req) { + req.set('auth0-forwarded-for', options.forwardedFor); + }; + } + return params; +} /** * @class @@ -134,11 +148,14 @@auth/PasswordlessAuthenticator.js
* @param {String} userData.username The user's phone number if realm=sms, or the user's email if realm=email * @param {String} userData.password [DEPRECATED] Password. * @param {String} [userData.connection=sms] [DEPRECATED] Connection string: "sms" or "email". + * @param {Object} [options] Additional options. + * @param {String} [options.forwardedFor] Value to be used for auth0-forwarded-for header * @param {Function} [cb] Method callback. * * @return {Promise|undefined} */ -PasswordlessAuthenticator.prototype.signIn = function(userData, cb) { +PasswordlessAuthenticator.prototype.signIn = function(userData, options, cb) { + var { options, cb } = sanitizeArguments(options, cb); var defaultFields = { client_id: this.clientId, client_secret: this.clientSecret @@ -159,7 +176,7 @@auth/PasswordlessAuthenticator.js
data.realm = 'sms'; } data.grant_type = 'http://auth0.com/oauth/grant-type/passwordless/otp'; - return this.oauth.signIn(data, { type: 'token' }, cb); + return this.oauth.signIn(data, extend({ type: 'token' }, options), cb); } // Don't let the user override the connection nor the grant type. @@ -175,8 +192,7 @@auth/PasswordlessAuthenticator.js
console.warn( 'The oauth/ro endpoint has been deprecated. Please use the realm and otp parameters in this function.' ); - - return this.oauth.signIn(data, cb); + return this.oauth.signIn(data, options, cb); }; /** @@ -220,15 +236,19 @@auth/PasswordlessAuthenticator.js
* @param {Object} userData User account data. * @param {String} userData.email User email address. * @param {String} userData.send The type of email to be sent. + * @param {Object} [options] Additional options. + * @param {String} [options.forwardedFor] Value to be used for auth0-forwarded-for header * @param {Function} [cb] Method callback. * * @return {Promise|undefined} */ -PasswordlessAuthenticator.prototype.sendEmail = function(userData, cb) { +PasswordlessAuthenticator.prototype.sendEmail = function(userData, options, cb) { + var { options, cb } = sanitizeArguments(options, cb); var defaultFields = { client_id: this.clientId, client_secret: this.clientSecret }; + var params = getParamsFromOptions(options); var data = extend(defaultFields, userData); // Don't let the user override the connection nor the grant type. @@ -247,10 +267,10 @@auth/PasswordlessAuthenticator.js
} if (cb && cb instanceof Function) { - return this.passwordless.create(data, cb); + return this.passwordless.create(params, data, cb); } - return this.passwordless.create(data); + return this.passwordless.create(params, data); }; /** @@ -278,15 +298,19 @@auth/PasswordlessAuthenticator.js
* * @param {Object} userData User account data. * @param {String} userData.phone_number User phone number. + * @param {Object} [options] Additional options. + * @param {String} [options.forwardedFor] Value to be used for auth0-forwarded-for header * @param {Function} [cb] Method callback. * * @return {Promise|undefined} */ -PasswordlessAuthenticator.prototype.sendSMS = function(userData, cb) { +PasswordlessAuthenticator.prototype.sendSMS = function(userData, options, cb) { + var { options, cb } = sanitizeArguments(options, cb); var defaultFields = { client_id: this.clientId, client_secret: this.clientSecret }; + var params = getParamsFromOptions(options); var data = extend(defaultFields, userData); // Don't let the user override the connection nor the grant type. @@ -301,10 +325,10 @@auth/PasswordlessAuthenticator.js
} if (cb && cb instanceof Function) { - return this.passwordless.create(data, cb); + return this.passwordless.create(params, data, cb); } - return this.passwordless.create(data); + return this.passwordless.create(params, data); }; module.exports = PasswordlessAuthenticator; @@ -320,7 +344,7 @@auth/PasswordlessAuthenticator.js
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html index c88ff1922..a78ed591d 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 3c16961c3..6abc53eac 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 3c16961c3..6abc53eac 100644 --- a/docs/auth_UsersManager.js.html +++ b/docs/auth_UsersManager.js.html @@ -24,7 +24,7 @@
@@ -223,7 +223,7 @@
diff --git a/docs/auth_idToken.js.html b/docs/auth_idToken.js.html index f19b993f7..be7028583 100644 --- a/docs/auth_idToken.js.html +++ b/docs/auth_idToken.js.html @@ -24,7 +24,7 @@
auth/UsersManager.js
diff --git a/docs/auth_idToken.js.html b/docs/auth_idToken.js.html index f19b993f7..be7028583 100644 --- a/docs/auth_idToken.js.html +++ b/docs/auth_idToken.js.html @@ -24,7 +24,7 @@
@@ -202,7 +202,7 @@
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html index 9c87db9d6..269ed19d9 100644 --- a/docs/auth_index.js.html +++ b/docs/auth_index.js.html @@ -24,7 +24,7 @@
auth/idToken.js
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html index 9c87db9d6..269ed19d9 100644 --- a/docs/auth_index.js.html +++ b/docs/auth_index.js.html @@ -24,7 +24,7 @@
@@ -615,7 +615,7 @@
diff --git a/docs/errors.js.html b/docs/errors.js.html index 222622d3b..729840725 100644 --- a/docs/errors.js.html +++ b/docs/errors.js.html @@ -24,7 +24,7 @@
auth/index.js
diff --git a/docs/errors.js.html b/docs/errors.js.html index 222622d3b..729840725 100644 --- a/docs/errors.js.html +++ b/docs/errors.js.html @@ -24,7 +24,7 @@
@@ -111,7 +111,7 @@
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html index 08f4074b0..c05a48ac1 100644 --- a/docs/external-RestClient.html +++ b/docs/external-RestClient.html @@ -24,7 +24,7 @@
errors.js
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html index 08f4074b0..c05a48ac1 100644 --- a/docs/external-RestClient.html +++ b/docs/external-RestClient.html @@ -24,7 +24,7 @@
@@ -1587,7 +1587,7 @@
Source:
diff --git a/docs/global.html b/docs/global.html
index 17caad953..c968ba37d 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -24,7 +24,7 @@
@@ -423,7 +423,7 @@ Returns:
diff --git a/docs/index.html b/docs/index.html
index d52401aa5..3e8a57857 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -176,7 +176,7 @@ License
diff --git a/docs/index.js.html b/docs/index.js.html
index 8cf330b4c..847cde28e 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 caf780a35..75d0ddf9a 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 3f507d607..2d5af4d8c 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 313cb862f..5164a0f47 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 3e4d75e7f..937827f39 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 c3be84314..0e0775215 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -284,7 +284,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index 2e4ba4804..ebe0700d3 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 c88a16cb6..0c87d4c1a 100644
--- a/docs/management_DeviceCredentialsManager.js.html
+++ b/docs/management_DeviceCredentialsManager.js.html
@@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@ management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
index b37bd9546..61fc666f7 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 7fb5964eb..82ad1b6bc 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 2e492fab2..468d4eebc 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 308ddb778..d23eeb8ae 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -116,6 +116,18 @@ management/GuardianManager.js
);
this.factors = new RetryRestClient(guardianFactorsAuth0RestClient, options.retry);
+ /**
+ * Provides an abstraction layer for configuring Factor settings
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorSettingsAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/:name/settings',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factorSettings = new RetryRestClient(guardianFactorSettingsAuth0RestClient, options.retry);
+
/**
* Provides an abstraction layer for retrieving Guardian factor templates.
*
@@ -261,6 +273,45 @@ management/GuardianManager.js
*/
utils.wrapPropertyMethod(GuardianManager, 'getFactors', 'factors.getAll');
+/**
+ * Get Guardian factor configuration
+ *
+ * @method getFactorSettings
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.guardian.getFactorSettings({ name: 'webauthn-roaming' }, function (err, settings) {
+ * console.log(settings);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'getFactorSettings', 'factorSettings.get');
+
+/**
+ * Update Guardian factor configuration
+ *
+ * @method updateFactorSettings
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.guardian.updateFactorSettings(
+ * { name: 'webauthn-roaming' },
+ * { userVerification: 'discouraged', overrideRelyingParty: false },
+ * function (err, settings) {
+ * console.log(settings);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'updateFactorSettings', 'factorSettings.update');
+
/**
* Get Guardian factor provider configuration
*
@@ -508,7 +559,7 @@ management/GuardianManager.js
diff --git a/docs/management_HooksManager.js.html b/docs/management_HooksManager.js.html
index 5e29bb560..33b9a8a63 100644
--- a/docs/management_HooksManager.js.html
+++ b/docs/management_HooksManager.js.html
@@ -24,7 +24,7 @@
@@ -419,7 +419,7 @@ management/HooksManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index f9aa922fb..3909c2f90 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -439,7 +439,7 @@ management/JobsManager.js
diff --git a/docs/management_LogStreamsManager.js.html b/docs/management_LogStreamsManager.js.html
index 764a1cb01..5d6889ca5 100644
--- a/docs/management_LogStreamsManager.js.html
+++ b/docs/management_LogStreamsManager.js.html
@@ -24,7 +24,7 @@
@@ -230,7 +230,7 @@ management/LogStreamsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 9e379af1b..047297000 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 fe2f9b3d6..76493f948 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -194,7 +194,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_MigrationsManager.js.html b/docs/management_MigrationsManager.js.html
index 2b794048d..f54356b8e 100644
--- a/docs/management_MigrationsManager.js.html
+++ b/docs/management_MigrationsManager.js.html
@@ -24,7 +24,7 @@
@@ -159,7 +159,7 @@ management/MigrationsManager.js
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html
index 71ef1eb82..9b7c12a3e 100644
--- a/docs/management_PromptsManager.js.html
+++ b/docs/management_PromptsManager.js.html
@@ -24,7 +24,7 @@
@@ -261,7 +261,7 @@ management/PromptsManager.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index 863d2bf15..24c182400 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 3e9912553..93997d82f 100644
--- a/docs/management_RolesManager.js.html
+++ b/docs/management_RolesManager.js.html
@@ -24,7 +24,7 @@
@@ -460,7 +460,7 @@ management/RolesManager.js
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index c2fc05926..83dad4887 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 adf9ff60d..633925ceb 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 a9c5970f8..0d1649234 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 3ff81bc64..25f38364d 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 18c4d7637..aab52fba0 100644
--- a/docs/management_TicketsManager.js.html
+++ b/docs/management_TicketsManager.js.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ management/TicketsManager.js
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html
index 8492126dd..64ef3b4ba 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 96d584a20..f6d5ad7a7 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -42,6 +42,7 @@ management/UsersManager.js
var ArgumentError = require('rest-facade').ArgumentError;
var Auth0RestClient = require('../Auth0RestClient');
var RetryRestClient = require('../RetryRestClient');
+var sanitizeArguments = require('../utils').sanitizeArguments;
/**
* Simple facade for consuming a REST API endpoint.
@@ -279,13 +280,18 @@ management/UsersManager.js
* console.log(users);
* });
*
- * @param {String} [email] Email address of user(s) to find
- * @param {Function} [cb] Callback function.
+ * @param {String} [email] Email address of user(s) to find
+ * @param {Object} [options] Additional options to pass to the endpoint
+ * @param {String} [options.fields] Comma-separated list of fields to include or exclude in the result
+ * @param {Boolean} [options.include_fields] Whether specified fields are to be included (true) or excluded (false). Defaults to true.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
-UsersManager.prototype.getByEmail = function(email, callback) {
- return this.usersByEmail.getAll({ email }, callback);
+UsersManager.prototype.getByEmail = function(email, options, cb) {
+ var { options, cb } = sanitizeArguments(options, cb);
+
+ return this.usersByEmail.getAll({ email, ...options }, cb);
};
/**
@@ -977,7 +983,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index 7a61a765f..f2e393233 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -1060,8 +1060,11 @@ management/index.js
* console.log(users);
* });
*
- * @param {String} [email] Email Address of users to locate
- * @param {Function} [cb] Callback function.
+ * @param {String} [email] Email address of user(s) to find
+ * @param {Object} [options] Additional options to pass to the endpoint
+ * @param {String} [options.fields] Comma-separated list of fields to include or exclude in the result
+ * @param {Boolean} [options.include_fields] Whether specified fields are to be included (true) or excluded (false). Defaults to true.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -2875,6 +2878,28 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'getGuardianFactors', 'guardian.getFactors');
+/**
+ * Get the settings of a Guardian factor.
+ *
+ * @method getGuardianFactorSettings
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.getGuardianFactorSettings({ name: 'duo' }, function (err, settings) {
+ * console.log(settings);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'getGuardianFactorSettings',
+ 'guardian.getFactorSettings'
+);
+
/**
* Get Guardian factor provider configuration
*
@@ -2924,6 +2949,32 @@ management/index.js
'guardian.updateFactorProvider'
);
+/**
+ * Update a Guardian's factor settings
+ *
+ * @method updateGuardianFactorSettings
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.updateGuardianFactorSettings(
+ * { name: 'webauthn-roaming' },
+ * { userVerification: 'discouraged', overrideRelyingParty: false },
+ * function (err, settings) {
+ * console.log(settings);
+ * })
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated Factor settings data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'updateGuardianFactorSettings',
+ 'guardian.updateFactorSettings'
+);
+
/**
* Get Guardian enrollment and verification factor templates
*
@@ -3806,7 +3857,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index e8b5d111d..03fa83391 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -4207,7 +4207,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index 99ffb9568..af91ea7a2 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1765,7 +1765,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index 6d53d0cb6..ac77381b5 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 59dd5da51..843904425 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -2050,7 +2050,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 4dfd5cd83..475d29bdb 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -101,7 +101,7 @@ Source:
(inner) Source:
Methods
- sendEmail(userData, cbopt) → {Promise|undefined}
+ sendEmail(userData, optionsopt, cbopt) → {Promise|undefined}
@@ -491,7 +491,7 @@ sendEmailSource:
Parameters:
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Additional options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ forwardedFor
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Value to be used for auth0-forwarded-for header
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbExample
- sendSMS(userData, cbopt) → {Promise|undefined}
+ sendSMS(userData, optionsopt, cbopt) → {Promise|undefined}
@@ -811,7 +910,7 @@ sendSMSSource:
Parameters:
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Additional options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ forwardedFor
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Value to be used for auth0-forwarded-for header
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbExample
- signIn(userData, cbopt) → {Promise|undefined}
+ signIn(userData, optionsopt, cbopt) → {Promise|undefined}
@@ -1089,7 +1287,7 @@ signInSource:
Parameters:
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Additional options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ forwardedFor
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Value to be used for auth0-forwarded-for header
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbExamples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index 8812d86f9..41fb67c4f 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 b53c258fe..388e4f3af 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 bad738bd4..d956457b4 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@ Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html
index dab1ef5b5..727f1203c 100644
--- a/docs/module-errors.html
+++ b/docs/module-errors.html
@@ -24,7 +24,7 @@
@@ -254,7 +254,7 @@ (st
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 0cf706701..68361d7a8 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 700c1597d..0c111be04 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 55282ae96..43b6235a6 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 2917e5aaa..53004a8a2 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 8085a325d..e86bf8710 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -2269,7 +2269,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 0f052956b..7e2713c00 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 6ba5d9fb7..56b5fcbae 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1215,7 +1215,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index b34aca674..efbd2c9c9 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 4fbe4db35..71b3cc382 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 af6e04e36..11018a156 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 56707c497..40074a738 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -464,6 +464,80 @@ external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorSettingsAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for configuring Factor settings
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
@@ -529,7 +603,7 @@ Source:
Source:
Source:
Source:
Source:
Source:
Source:
getF
Source:
getFactors<
Source:
Example
+
+
+
+
+ getFactorSettings(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get Guardian factor configuration
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor parameters.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getFactorSettings({ name: 'webauthn-roaming' }, function (err, settings) {
+ console.log(settings);
+});
+
+
+
+
+
+
@@ -1822,7 +2110,7 @@ get
Source:
Source:
Source:
Source:
getPolicie
Source:
updateFac
Source:
u
Source:
Example
+
+
+
+
+ updateFactorSettings(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian factor configuration
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor parameters.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updateFactorSettings(
+ { name: 'webauthn-roaming' },
+ { userVerification: 'discouraged', overrideRelyingParty: false },
+ function (err, settings) {
+ console.log(settings);
+});
+
+
+
+
+
+
@@ -3343,7 +3848,7 @@
Source:
Source:
Source:
updateP
Source:
Example
diff --git a/docs/module-management.HooksManager.html b/docs/module-management.HooksManager.html
index 6b2aa9c75..bad90e732 100644
--- a/docs/module-management.HooksManager.html
+++ b/docs/module-management.HooksManager.html
@@ -24,7 +24,7 @@
@@ -3099,7 +3099,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 2178b4a73..100dc7816 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -890,7 +890,7 @@ errorsSource:
Example
diff --git a/docs/module-management.LogStreamsManager.html b/docs/module-management.LogStreamsManager.html
index 9c98bbb38..d07a6fefa 100644
--- a/docs/module-management.LogStreamsManager.html
+++ b/docs/module-management.LogStreamsManager.html
@@ -24,7 +24,7 @@
@@ -1763,7 +1763,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index c6f6704db..d59f3ef23 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 b479a6092..35b1f52cd 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -2713,7 +2713,7 @@ addHookS
Source:
a
Source:
Source:
assi
Source:
assi
Source:
blackli
Source:
Source:
cre
Source:
cr
Source:
Source:
Source:
createHook<
Source:
create
Source:
Source:
c
Source:
createRole<
Source:
createUser<
Source:
deleteA
Source:
del
Source:
de
Source:
Source:
deleteHook<
Source:
delete
Source:
d
Source:
deleteRole<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
getEm
Source:
getEm
Source:
Source:
Source:
Source:
get
Source:
Example
- getGuardianFactorTemplates(params, cbopt) → {Promise|undefined}
+ getGuardianFactorSettings(params, cbopt) → {Promise|undefined}
- Get Guardian enrollment and verification factor templates
+ Get the settings of a Guardian factor.
@@ -18121,7 +18121,7 @@ Source:
Returns:
Example
- management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
- console.log(templates);
+ management.getGuardianFactorSettings({ name: 'duo' }, function (err, settings) {
+ console.log(settings);
});
@@ -18292,14 +18292,14 @@ Example
- getGuardianPhoneFactorMessageTypes(cbopt) → {Promise|undefined}
+ getGuardianFactorTemplates(params, cbopt) → {Promise|undefined}
- Get the Guardian phone factor's message types
+ Get Guardian enrollment and verification factor templates
@@ -18335,7 +18335,7 @@ Source:
Parameters:
- cbparams
-function
+Object
@@ -18396,8 +18396,6 @@ Parameters:
- <optional>
-
@@ -18408,156 +18406,12 @@ Parameters:
- Callback function.
+ Factor parameters.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.getGuardianPhoneFactorMessageTypes(function (err, messageTypes) {
- console.log(messageTypes);
-});
-
-
-
-
-
-
-
-
-
-
- getGuardianPhoneFactorSelectedProvider(cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get the Guardian phone factor's selected provider
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
@@ -18639,8 +18493,8 @@ Returns:
Example
- management.getGuardianPhoneFactorSelectedProvider(function (err, selectedProvider) {
- console.log(selectedProvider);
+ management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
+ console.log(templates);
});
@@ -18652,14 +18506,14 @@ Example
- getGuardianPolicies(cbopt) → {Promise|undefined}
+ getGuardianPhoneFactorMessageTypes(cbopt) → {Promise|undefined}
- Get enabled Guardian policies
+ Get the Guardian phone factor's message types
@@ -18695,7 +18549,7 @@ ge
Source:
Returns:
Example
- management.getGuardianPolicies(function (err, policies) {
- console.log(policies);
+ management.getGuardianPhoneFactorMessageTypes(function (err, messageTypes) {
+ console.log(messageTypes);
});
@@ -18832,14 +18686,14 @@ Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianPhoneFactorSelectedProvider(cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get the Guardian phone factor's selected provider
@@ -18875,7 +18729,7 @@ getHookSource:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Hook parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Hook ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
cbReturns:
Example
- management.getHook({ id: HOOK_ID }, function (err, hook) {
- if (err) {
- // Handle error.
- }
-
- console.log(hook);
+ management.getGuardianPhoneFactorSelectedProvider(function (err, selectedProvider) {
+ console.log(selectedProvider);
});
@@ -19101,14 +18866,14 @@ Example
- getHooks(paramsopt, cbopt) → {Promise|undefined}
+ getGuardianPolicies(cbopt) → {Promise|undefined}
- Get all hooks.
+ Get enabled Guardian policies
@@ -19144,7 +18909,7 @@ getHooksSource:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Hooks parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Page number, zero indexed.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
cbReturns:
Example
-
- This method takes an optional object as first argument that may be used to
- specify pagination settings. If pagination options are not present,
- the first page of a limited number of results will be returned.
-
-
- // Pagination settings.
-var params = {
- per_page: 10,
- page: 0
-};
-
-management.getHooks(params, function (err, hooks) {
- console.log(hooks.length);
+ management.getGuardianPolicies(function (err, policies) {
+ console.log(policies);
});
@@ -19428,14 +19046,14 @@ Example
- getHookSecrets(params, cbopt) → {Promise|undefined}
+ getHook(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook's secrets.
+ Get an Auth0 hook.
@@ -19471,7 +19089,7 @@ getHook
Source:
Returns:
Example
- var params = { id: HOOK_ID }
-management.getHookSecrets(params, function (err, secrets) {
+ management.getHook({ id: HOOK_ID }, function (err, hook) {
if (err) {
// Handle error.
}
- console.log(secrets);
+ console.log(hook);
});
@@ -19698,14 +19315,14 @@ Example
- getJob(params, cbopt) → {Promise|undefined}
+ getHooks(paramsopt, cbopt) → {Promise|undefined}
- Get a job by its ID.
+ Get all hooks.
@@ -19741,7 +19358,7 @@ getJobSource:
Parameters:
+ <optional>
+
@@ -19812,7 +19431,7 @@ Parameters:
- Job parameters.
+ Hooks parameters.
@@ -19826,6 +19445,8 @@ Parameters:
Type
+ Attributes
+
@@ -19838,24 +19459,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- Job ID.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -19950,17 +19617,20 @@ Returns:
Example
- var params = {
- id: '{JOB_ID}'
+
+ This method takes an optional object as first argument that may be used to
+ specify pagination settings. If pagination options are not present,
+ the first page of a limited number of results will be returned.
+
+
+ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
};
-management.getJob(params, function (err, job) {
- if (err) {
- // Handle error.
- }
-
- // Retrieved job.
- console.log(job);
+management.getHooks(params, function (err, hooks) {
+ console.log(hooks.length);
});
@@ -19972,14 +19642,14 @@ Example
- getLog(params, cbopt) → {Promise|undefined}
+ getHookSecrets(params, cbopt) → {Promise|undefined}
- Get an Auth0 log.
+ Get an Auth0 hook's secrets.
@@ -20015,7 +19685,7 @@ getLogSource:
Parameters:
- Log parameters.
+ Hook parameters.
@@ -20129,7 +19799,7 @@ Parameters:
- Event ID.
+ Hook ID.
@@ -20224,12 +19894,13 @@ Returns:
Example
- management.getLog({ id: EVENT_ID }, function (err, log) {
+ var params = { id: HOOK_ID }
+management.getHookSecrets(params, function (err, secrets) {
if (err) {
// Handle error.
}
- console.log(log);
+ console.log(secrets);
});
@@ -20241,14 +19912,14 @@ Example
- getLogs(paramsopt, cbopt) → {Promise|undefined}
+ getJob(params, cbopt) → {Promise|undefined}
- Get all logs.
+ Get a job by its ID.
@@ -20284,7 +19955,7 @@ getLogsSource:
Parameters:
- <optional>
-
@@ -20357,7 +20026,7 @@ Parameters:
- Logs params.
+ Job parameters.
@@ -20371,8 +20040,6 @@ Parameters:
Type
- Attributes
-
@@ -20385,151 +20052,7 @@ Parameters:
- q
-
-
-String
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Search Criteria using Query String Syntax
-
-
-
-
-
-
-
-
- page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Page number. Zero based
-
-
-
-
-
-
-
-
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The amount of entries per page
-
-
-
-
-
-
-
-
- sort
-
-
-String
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The field to use for sorting.
-
-
-
-
-
-
-
-
- fieldsid
@@ -20542,93 +20065,11 @@ Parameters:
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- A comma separated list of fields to include or exclude
-
-
-
-
-
-
-
-
- include_fields
-
-
-Boolean
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- true if the fields specified are to be included in the result, false otherwise.
-
-
-
-
-
-
-
-
- include_totals
-
-
-Boolean
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- true if a query summary must be included in the result, false otherwise. Default false
+ Job ID.
@@ -20723,20 +20164,17 @@ Returns:
Example
-
- This method takes an optional object as first argument that may be used to
- specify pagination settings and the search query. If pagination options are
- not present, the first page of a limited number of results will be returned.
-
-
- // Pagination settings.
-var params = {
- per_page: 10,
- page: 2
+ var params = {
+ id: '{JOB_ID}'
};
-management.getLogs(params, function (err, logs) {
- console.log(logs.length);
+management.getJob(params, function (err, job) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Retrieved job.
+ console.log(job);
});
@@ -20748,14 +20186,14 @@ Example
- getLogStream(params, cbopt) → {Promise|undefined}
+ getLog(params, cbopt) → {Promise|undefined}
- Get an Auth0 Log Stream.
+ Get an Auth0 log.
@@ -20791,7 +20229,7 @@ getLogStr
Source:
Parameters:
- Log Stream parameters.
+ Log parameters.
@@ -20905,7 +20343,7 @@ Parameters:
- Log Stream ID.
+ Event ID.
@@ -21000,12 +20438,12 @@ Returns:
Example
- management.getLogStream({ id: LOG_STREAM_ID }, function (err, logStream) {
+ management.getLog({ id: EVENT_ID }, function (err, log) {
if (err) {
// Handle error.
}
- console.log(logStream);
+ console.log(log);
});
@@ -21017,14 +20455,14 @@ Example
- getMigrations(cbopt) → {Promise|undefined}
+ getLogs(paramsopt, cbopt) → {Promise|undefined}
- Get migrations flags
+ Get all logs.
@@ -21060,7 +20498,7 @@ getMigra
Source:
Parameters:
- cbparams
-function
+Object
@@ -21133,171 +20571,257 @@ Parameters:
- Callback function.
+ Logs params.
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+ Name
+
+ Type
+
+ Attributes
+
+
+ Description
+
+
+
+
+
+
+ q
+
+
+String
-
-Returns:
-
+
+
-
- -
- Type:
-
- -
-
-
Promise
-|
+
+
+
+ <optional>
+
-undefined
+
+
+
+
-
-
+
+
+ Search Criteria using Query String Syntax
+
+
+
-
+
+
+ page
+
+
+Number
-
-Example
- management.getMigrations(function (err, migrations) {
- if (err) {
- // Handle error.
- }
+
+
-// Migration flags
- console.log(migrations.flags);
-});
+
+
+
+ <optional>
+
-
+
-
-
+
+
-
-
+
- getPermissionsInRole(roleIdopt, cbopt) → {Promise|undefined}
+
+ Page number. Zero based
+
+
+
+
+
+ per_page
+
+
+Number
-
- Get permissions for a given role
-
+
+
+
+
+
+ <optional>
+
+
+
+
+
-
+
-
+
+ The amount of entries per page
+
+
+
-
+
+
+ sort
+
+
+String
-
-
+
+
-
+
+
+
+ <optional>
+
-
+
-
+
+
+
-
+
-
+
+ The field to use for sorting.
+
+
+
-
- Source:
-
+
+ fields
+
+
+String
-
-
-
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+ A comma separated list of fields to include or exclude
+
+
+
+
+
+
+ include_fields
+
+
+Boolean
- Parameters:
-
-
-
-
-
- Name
-
+
+
- Type
+
+
+
+ <optional>
+
-
- Attributes
-
+
-
+
+
+
- Description
-
-
+
+
+
+ true if the fields specified are to be included in the result, false otherwise.
+
+
+
-
- roleIdinclude_totals
-String
+Boolean
@@ -21318,7 +20842,15 @@ Parameters:
- Id of the role
+ true if a query summary must be included in the result, false otherwise. Default false
+
+
+
+
+
+
+
+
@@ -21403,18 +20935,22 @@ Returns:
-Examples
-
- var params = { id :'ROLE_ID'};
+Example
- This method takes a roleId and
- returns all permissions within that role
-
+ This method takes an optional object as first argument that may be used to
+ specify pagination settings and the search query. If pagination options are
+ not present, the first page of a limited number of results will be returned.
- management.getPermissionsInRole(params, function (err, permissions) {
- console.log(permissions);
+ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 2
+};
+
+management.getLogs(params, function (err, logs) {
+ console.log(logs.length);
});
@@ -21426,14 +20962,14 @@ Examples
- getPromptsSettings(cbopt) → {Promise|undefined}
+ getLogStream(params, cbopt) → {Promise|undefined}
- Get prompts settings..
+ Get an Auth0 Log Stream.
@@ -21469,7 +21005,7 @@ get
Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Log Stream parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Log Stream ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.getPromptsSettings(function (err, settings) {
+ management.getLogStream({ id: LOG_STREAM_ID }, function (err, logStream) {
if (err) {
// Handle error.
}
- console.log(settings);
+ console.log(logStream);
});
@@ -21610,14 +21231,14 @@ Example
- getResourceServer(params, cbopt) → {Promise|undefined}
+ getMigrations(cbopt) → {Promise|undefined}
- Get a Resource Server.
+ Get migrations flags
@@ -21653,7 +21274,7 @@ getR
Source:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Resource Server parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Resource Server ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
cbReturns:
Example
- management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+ management.getMigrations(function (err, migrations) {
if (err) {
// Handle error.
}
- console.log(resourceServer);
+// Migration flags
+ console.log(migrations.flags);
});
@@ -21879,14 +21416,14 @@ Example
- getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+ getPermissionsInRole(roleIdopt, cbopt) → {Promise|undefined}
- Get all resource servers.
+ Get permissions for a given role
@@ -21922,7 +21459,7 @@ get
Source:
Parameters:
- params
-
-
-Object
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Resource Servers parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageroleId
-Number
+String
@@ -22086,15 +21532,7 @@ Parameters:
- Page number, zero indexed.
-
-
-
-
-
-
-
-
+ Id of the role
@@ -22179,22 +21617,18 @@ Returns:
-Example
+Examples
+
+ var params = { id :'ROLE_ID'};
- This method takes an optional object as first argument that may be used to
- specify pagination settings. If pagination options are not present,
- the first page of a limited number of results will be returned.
+ This method takes a roleId and
+ returns all permissions within that role
+
- // Pagination settings.
-var params = {
- per_page: 10,
- page: 0
-};
-
-management.getResourceServers(params, function (err, resourceServers) {
- console.log(resourceServers.length);
+ management.getPermissionsInRole(params, function (err, permissions) {
+ console.log(permissions);
});
@@ -22206,14 +21640,14 @@ Example
- getRole(params, cbopt) → {Promise|undefined}
+ getPromptsSettings(cbopt) → {Promise|undefined}
- Get an Auth0 role.
+ Get prompts settings..
@@ -22249,7 +21683,7 @@ getRoleSource:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Role parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Role ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
cbReturns:
Example
- management.getRole({ id: ROLE_ID }, function (err, role) {
+ management.getPromptsSettings(function (err, settings) {
if (err) {
// Handle error.
}
- console.log(role);
+ console.log(settings);
});
@@ -22475,14 +21824,14 @@ Example
- getRoles(paramsopt, cbopt) → {Promise|undefined}
+ getResourceServer(params, cbopt) → {Promise|undefined}
- Get all roles.
+ Get a Resource Server.
@@ -22518,7 +21867,7 @@ getRolesSource:
Parameters:
- <optional>
-
@@ -22591,7 +21938,7 @@ Parameters:
- Roles parameters.
+ Resource Server parameters.
@@ -22605,8 +21952,6 @@ Parameters:
Type
- Attributes
-
@@ -22619,70 +21964,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ Resource Server ID.
@@ -22777,20 +22076,12 @@ Returns:
Example
-
- This method takes an optional object as first argument that may be used to
- specify pagination settings. If pagination options are not present,
- the first page of a limited number of results will be returned.
-
-
- // Pagination settings.
-var params = {
- per_page: 10,
- page: 0
-};
+ management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+ if (err) {
+ // Handle error.
+ }
-management.getRoles(params, function (err, roles) {
- console.log(roles.length);
+ console.log(resourceServer);
});
@@ -22802,14 +22093,14 @@ Example
- getRule(params, cbopt) → {Promise|undefined}
+ getResourceServers(paramsopt, cbopt) → {Promise|undefined}
- Get an Auth0 rule.
+ Get all resource servers.
@@ -22845,7 +22136,7 @@ getRuleSource:
Parameters:
+ <optional>
+
@@ -22916,7 +22209,7 @@ Parameters:
- Rule parameters.
+ Resource Servers parameters.
@@ -22930,6 +22223,8 @@ Parameters:
Type
+ Attributes
+
@@ -22942,24 +22237,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- Rule ID.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -23054,12 +22395,20 @@ Returns:
Example
- management.getRule({ id: RULE_ID }, function (err, rule) {
- if (err) {
- // Handle error.
- }
+
+ This method takes an optional object as first argument that may be used to
+ specify pagination settings. If pagination options are not present,
+ the first page of a limited number of results will be returned.
+
+
+ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
+};
- console.log(rule);
+management.getResourceServers(params, function (err, resourceServers) {
+ console.log(resourceServers.length);
});
@@ -23071,14 +22420,14 @@ Example
- getRules(paramsopt, cbopt) → {Promise|undefined}
+ getRole(params, cbopt) → {Promise|undefined}
- Get all rules.
+ Get an Auth0 role.
@@ -23114,7 +22463,7 @@ getRulesSource:
Parameters:
- <optional>
-
@@ -23187,7 +22534,7 @@ Parameters:
- Rules parameters.
+ Role parameters.
@@ -23201,8 +22548,6 @@ Parameters:
Type
- Attributes
-
@@ -23215,70 +22560,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ Role ID.
@@ -23373,20 +22672,12 @@ Returns:
Example
-
- This method takes an optional object as first argument that may be used to
- specify pagination settings. If pagination options are not present,
- the first page of a limited number of results will be returned.
-
-
- // Pagination settings.
-var params = {
- per_page: 10,
- page: 0
-};
+ management.getRole({ id: ROLE_ID }, function (err, role) {
+ if (err) {
+ // Handle error.
+ }
-management.getRules(params, function (err, rules) {
- console.log(rules.length);
+ console.log(role);
});
@@ -23398,14 +22689,14 @@ Example
- getRulesConfigs(cbopt) → {Promise|undefined}
+ getRoles(paramsopt, cbopt) → {Promise|undefined}
- Get rules config.
+ Get all roles.
@@ -23441,7 +22732,7 @@ getRul
Source:
Parameters:
- cbparams
-function
+Object
@@ -23514,159 +22805,110 @@ Parameters:
- Callback function.
+ Roles parameters.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
+
+
+
+
-
-
- -
- Type:
-
- -
+
Name
-Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
- management.getRulesConfigs(function (err, rulesConfigs) {
- if (err) {
- // Handle error.
- }
-
- // Get Rules Configs.
-});
-
-
+ Type
-
-
-
-
-
-
- getTenantSettings(cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get the tenant settings..
-
-
-
-
-
-
-
-
-
-
-
+ Attributes
+
-
+
-
+ Description
+
+
+
-
+
+
+ per_page
+
+
+Number
-
-
+
+
-
+
+
+
+ <optional>
+
-
+
-
+
+
+
-
- Source:
-
+ Number of results per page.
+
+
+
-
-
+
+
+ page
+
+
+Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
- Parameters:
+
+
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+
+
+
-
@@ -23749,12 +22991,20 @@ Returns:
Example
- management.getSettings(function (err, settings) {
- if (err) {
- // Handle error.
- }
+
+ This method takes an optional object as first argument that may be used to
+ specify pagination settings. If pagination options are not present,
+ the first page of a limited number of results will be returned.
+
+
+ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
+};
- console.log(settings);
+management.getRoles(params, function (err, roles) {
+ console.log(roles.length);
});
@@ -23766,14 +23016,14 @@ Example
- getUser(data, cbopt) → {Promise|undefined}
+ getRule(params, cbopt) → {Promise|undefined}
- Get a user by its id.
+ Get an Auth0 rule.
@@ -23809,7 +23059,7 @@ getUserSource:
Parameters:
- dataparams
@@ -23880,7 +23130,7 @@ Parameters:
- The user data object.
+ Rule parameters.
@@ -23923,7 +23173,7 @@ Parameters:
- The user id.
+ Rule ID.
@@ -24018,8 +23268,12 @@ Returns:
Example
- management.getUser({ id: USER_ID }, function (err, user) {
- console.log(user);
+ management.getRule({ id: RULE_ID }, function (err, rule) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(rule);
});
@@ -24031,14 +23285,14 @@ Example
- getUserBlocks(params, cbopt) → {Promise|undefined}
+ getRules(paramsopt, cbopt) → {Promise|undefined}
- Get user blocks by its id.
+ Get all rules.
@@ -24074,7 +23328,7 @@ getUserB
Source:
Parameters:
+ <optional>
+
@@ -24145,7 +23401,7 @@ Parameters:
- The user data object..
+ Rules parameters.
@@ -24159,6 +23415,8 @@ Parameters:
Type
+ Attributes
+
@@ -24171,24 +23429,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
- The user id.
+ Page number, zero indexed.
@@ -24232,7 +23536,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -24283,12 +23587,20 @@ Returns:
Example
- management.getUserBlocks({ id: USER_ID }, function (err, blocks) {
- if (err) {
- // Handle error.
- }
+
+ This method takes an optional object as first argument that may be used to
+ specify pagination settings. If pagination options are not present,
+ the first page of a limited number of results will be returned.
+
+
+ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
+};
- console.log(blocks);
+management.getRules(params, function (err, rules) {
+ console.log(rules.length);
});
@@ -24300,14 +23612,14 @@ Example
- getUserBlocksByIdentifier(params, cbopt) → {Promise|undefined}
+ getRulesConfigs(cbopt) → {Promise|undefined}
- Get user blocks by its identifier.
+ Get rules config.
@@ -24343,7 +23655,7 @@ Source:
Parameters:
- paramscb
-Object
+function
@@ -24404,6 +23716,8 @@ Parameters:
+ <optional>
+
@@ -24414,62 +23728,159 @@ Parameters:
- The user data object..
+ Callback function.
-
+
+
-
-
-
-
- Name
-
+
+
+
- Type
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+ -
+ Type:
+
+ -
+
Promise
+|
+
+undefined
+
+
+
+
- Description
-
-
-
+
-
-
- identifier
-
-
-String
+
+Example
-
-
+ management.getRulesConfigs(function (err, rulesConfigs) {
+ if (err) {
+ // Handle error.
+ }
-
+ // Get Rules Configs.
+});
+
+
+
+
+
-
- The user identifier, any of: username, phone_number, email.
-
-
-
+
+
+ getTenantSettings(cbopt) → {Promise|undefined}
-
-
-
-
-
+
+
+ Get the tenant settings..
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
@@ -24501,7 +23912,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -24552,12 +23963,12 @@ Returns:
Example
- management.getUserBlocksByIdentifier({ identifier: USER_ID }, function (err, blocks) {
+ management.getSettings(function (err, settings) {
if (err) {
// Handle error.
}
- console.log(blocks);
+ console.log(settings);
});
@@ -24569,14 +23980,14 @@ Example
- getUserLogs(params, cbopt) → {Promise|undefined}
+ getUser(data, cbopt) → {Promise|undefined}
- Get user's log events.
+ Get a user by its id.
@@ -24612,7 +24023,7 @@ getUserLog
Source:
Parameters:
- paramsdata
@@ -24683,7 +24094,7 @@ Parameters:
- Get logs data.
+ The user data object.
@@ -24726,111 +24137,7 @@ Parameters:
- User id.
-
-
-
-
-
-
-
-
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- page
-
-
-Number
-
-
-
-
-
-
-
-
-
-
- Page number, zero indexed.
-
-
-
-
-
-
-
-
- sort
-
-
-String
-
-
-
-
-
-
-
-
-
-
- The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
-
-
-
-
-
-
-
-
- include_totals
-
-
-Boolean
-
-
-
-
-
-
-
-
-
-
- true if a query summary must be included in the result, false otherwise. Default false;
+ The user id.
@@ -24925,14 +24232,8 @@ Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-
-management.getUserLogs(params, function (err, logs) {
- if (err) {
- // Handle error.
- }
-
- console.log(logs);
+ management.getUser({ id: USER_ID }, function (err, user) {
+ console.log(user);
});
@@ -24944,14 +24245,14 @@ Example
- getUserPermissions(params, cbopt) → {Promise|undefined}
+ getUserBlocks(params, cbopt) → {Promise|undefined}
- Get user's permissions
+ Get user blocks by its id.
@@ -24987,7 +24288,7 @@ get
Source:
Parameters:
- Get permissions data.
+ The user data object..
@@ -25101,7 +24402,15 @@ Parameters:
- User id.
+ The user id.
+
+
+
+
+
+
+
+
@@ -25110,91 +24419,248 @@ Parameters:
- per_pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Number of results per page.
+ Callback function
+
+
+
+
-
-
- page
-
-
-Number
-
-
-
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getUserBlocks({ id: USER_ID }, function (err, blocks) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(blocks);
+});
+
+
+
+
+
+
-
- Page number, zero indexed.
-
-
-
+
+
+ getUserBlocksByIdentifier(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get user blocks by its identifier.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
- sortparams
-String
+Object
+
+
+
+
+
+
+
+
- The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+ The user data object..
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+ Description
+
+
+
+
- include_totalsidentifier
-Boolean
+String
@@ -25205,7 +24671,7 @@ Parameters:
- true if a query summary must be included in the result, false otherwise. Default false;
+ The user identifier, any of: username, phone_number, email.
@@ -25249,7 +24715,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -25300,14 +24766,12 @@ Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-
-management.getUserPermissions(params, function (err, logs) {
+ management.getUserBlocksByIdentifier({ identifier: USER_ID }, function (err, blocks) {
if (err) {
// Handle error.
}
- console.log(logs);
+ console.log(blocks);
});
@@ -25319,14 +24783,14 @@ Example
- getUserRoles(params, cbopt) → {Promise|undefined}
+ getUserLogs(params, cbopt) → {Promise|undefined}
- Get user's roles
+ Get user's log events.
@@ -25362,7 +24826,7 @@ getUserRo
Source:
Parameters:
- Get roles data.
+ Get logs data.
@@ -25677,7 +25141,7 @@ Example
var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-management.getUserRoles(params, function (err, logs) {
+management.getUserLogs(params, function (err, logs) {
if (err) {
// Handle error.
}
@@ -25694,14 +25158,14 @@ Example
- getUsers(paramsopt, cbopt) → {Promise|undefined}
+ getUserPermissions(params, cbopt) → {Promise|undefined}
- Get all users.
+ Get user's permissions
@@ -25737,7 +25201,757 @@ getUsersSource:
Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Get permissions data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ User id.
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ sort
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+
+management.getUserPermissions(params, function (err, logs) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logs);
+});
+
+
+
+
+
+
+
+
+
+
+ getUserRoles(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get user's roles
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Get roles data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ User id.
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ sort
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+
+management.getUserRoles(params, function (err, logs) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logs);
+});
+
+
+
+
+
+
+
+
+
+
+ getUsers(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all users.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ Example
- getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+ getUsersByEmail(emailopt, optionsopt, cbopt) → {Promise|undefined}
@@ -26211,7 +26425,142 @@ Parameters:
- Email Address of users to locate
+ Email address of user(s) to find
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Additional options to pass to the endpoint
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ fields
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Comma-separated list of fields to include or exclude in the result
+
+
+
+
+
+
+
+
+ include_fields
+
+
+Boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Whether specified fields are to be included (true) or excluded (false). Defaults to true.
+
+
+
+
+
+
+
+
@@ -26359,7 +26708,7 @@ getUser
- Source:
importUser
- Source:
importU
- Source:
Source:
linkUsersSource:
Source:
remo
- Source:
Source:
Source:
re
- Source:
- Source:
setRule
- Source:
unblockUse
- Source:
unblockUse
- Source:
Parameters:
- identifieridentifier
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user identifier, any of: username, phone_number, email.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // User unblocked.
+});
+
+
+
+
+
+
+
+
+
+
+ unlinkUsers(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Unlink the given accounts.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Linked users data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
@@ -30843,7 +31461,59 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ Primary user ID.
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Identity provider in use.
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Secondary user ID.
@@ -30887,7 +31557,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -30938,12 +31608,14 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
+
+management.unlinkUsers(params, function (err, user) {
if (err) {
// Handle error.
}
- // User unblocked.
+ // Users accounts unlinked.
});
@@ -30955,14 +31627,14 @@ Example
- unlinkUsers(params, cbopt) → {Promise|undefined}
+ updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
- Unlink the given accounts.
+ Update the app metadata for a user.
@@ -30998,7 +31670,7 @@ unlinkUser
Source:
Parameters:
- Linked users data.
+ The user data object..
@@ -31112,33 +31784,15 @@ Parameters:
- Primary user ID.
+ The user id.
+
+
-
-
- provider
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Identity provider in use.
@@ -31147,32 +31801,32 @@ Parameters:
- user_idmetadata
-String
+Object
+
+
-
+
-
- Secondary user ID.
-
-
+
+
-
-
-
+
+
+ New app metadata.
@@ -31208,7 +31862,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -31259,14 +31913,18 @@ Returns:
Example
- var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
+ var params = { id: USER_ID };
+var metadata = {
+ foo: 'bar'
+};
-management.unlinkUsers(params, function (err, user) {
+management.updateAppMetadata(params, metadata, function (err, user) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // Updated user.
+ console.log(user);
});
@@ -31278,14 +31936,14 @@ Example
- updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
+ updateBrandingSettings(params, data, cbopt) → {Promise|undefined}
- Update the app metadata for a user.
+ Update the branding settings.
@@ -31321,7 +31979,7 @@ upda
Source:
Parameters:
- The user data object..
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- The user id.
-
-
-
-
-
-
-
-
+ Branding parameters.
@@ -31452,7 +32059,7 @@ Parameters:
- metadatadata
@@ -31477,7 +32084,7 @@ Parameters:
- New app metadata.
+ Updated branding data.
@@ -31513,7 +32120,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -31564,18 +32171,13 @@ Returns:
Example
- var params = { id: USER_ID };
-var metadata = {
- foo: 'bar'
-};
-
-management.updateAppMetadata(params, metadata, function (err, user) {
+ management.updateBrandingSettings(data, function (err, branding) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+// Updated branding
+ console.log(branding);
});
@@ -31587,14 +32189,14 @@ Example
- updateBrandingSettings(params, data, cbopt) → {Promise|undefined}
+ updateClient(params, data, cbopt) → {Promise|undefined}
- Update the branding settings.
+ Update an Auth0 client.
@@ -31630,7 +32232,7 @@ Source:
Parameters:
- Branding parameters.
+ Client parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Application client ID.
+
+
+
+
+
+
+
+
@@ -31735,7 +32388,7 @@ Parameters:
- Updated branding data.
+ Updated client data.
@@ -31822,13 +32475,15 @@ Returns:
Example
- management.updateBrandingSettings(data, function (err, branding) {
+ var data = { name: 'newClientName' };
+var params = { client_id: CLIENT_ID };
+
+management.updateClient(params, data, function (err, client) {
if (err) {
// Handle error.
}
-// Updated branding
- console.log(branding);
+ console.log(client.name); // 'newClientName'
});
@@ -31840,14 +32495,14 @@ Example
- updateClient(params, data, cbopt) → {Promise|undefined}
+ updateClientGrant(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client.
+ Update an Auth0 client grant.
@@ -31883,7 +32538,7 @@ updateCli
Source:
Parameters:
- client_idid
@@ -31997,7 +32652,7 @@ Parameters:
- Application client ID.
+ Client grant ID.
@@ -32126,15 +32781,19 @@ Returns:
Example
- var data = { name: 'newClientName' };
-var params = { client_id: CLIENT_ID };
+ var data = {
+ client_id: CLIENT_ID,
+ audience: AUDIENCE,
+ scope: []
+};
+var params = { id: CLIENT_GRANT_ID };
-management.updateClient(params, data, function (err, client) {
+management.clientGrants.update(params, data, function (err, grant) {
if (err) {
// Handle error.
}
- console.log(client.name); // 'newClientName'
+ console.log(grant.id);
});
@@ -32146,14 +32805,14 @@ Example
- updateClientGrant(params, data, cbopt) → {Promise|undefined}
+ updateConnection(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client grant.
+ Update an existing connection.
@@ -32189,7 +32848,7 @@ upda
Source:
Parameters:
- Client parameters.
+ Connection parameters.
@@ -32303,7 +32962,7 @@ Parameters:
- Client grant ID.
+ Connection ID.
@@ -32345,7 +33004,7 @@ Parameters:
- Updated client data.
+ Updated connection data.
@@ -32432,19 +33091,15 @@ Returns:
Example
- var data = {
- client_id: CLIENT_ID,
- audience: AUDIENCE,
- scope: []
-};
-var params = { id: CLIENT_GRANT_ID };
+ var data = { name: 'newConnectionName' };
+var params = { id: CONNECTION_ID };
-management.clientGrants.update(params, data, function (err, grant) {
+management.updateConnection(params, data, function (err, connection) {
if (err) {
// Handle error.
}
- console.log(grant.id);
+ console.log(connection.name); // 'newConnectionName'
});
@@ -32456,14 +33111,14 @@ Example
- updateConnection(params, data, cbopt) → {Promise|undefined}
+ updateEmailProvider(params, data, cbopt) → {Promise|undefined}
- Update an existing connection.
+ Update the email provider.
@@ -32499,7 +33154,7 @@ updat
Source:
Parameters:
- Connection parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Connection ID.
-
-
-
-
-
-
-
-
+ Email provider parameters.
@@ -32655,7 +33259,7 @@ Parameters:
- Updated connection data.
+ Updated email provider data.
@@ -32742,15 +33346,13 @@ Returns:
Example
- var data = { name: 'newConnectionName' };
-var params = { id: CONNECTION_ID };
-
-management.updateConnection(params, data, function (err, connection) {
+ management.updateEmailProvider(params, data, function (err, provider) {
if (err) {
// Handle error.
}
- console.log(connection.name); // 'newConnectionName'
+ // Updated email provider.
+ console.log(provider);
});
@@ -32762,14 +33364,14 @@ Example
- updateEmailProvider(params, data, cbopt) → {Promise|undefined}
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
- Update the email provider.
+ Update an existing Email Template.
@@ -32805,7 +33407,7 @@ up
Source:
Parameters:
- Email provider parameters.
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
@@ -32910,7 +33563,7 @@ Parameters:
- Updated email provider data.
+ Updated Email Template data.
@@ -32997,13 +33650,15 @@ Returns:
Example
- management.updateEmailProvider(params, data, function (err, provider) {
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
if (err) {
// Handle error.
}
- // Updated email provider.
- console.log(provider);
+ console.log(emailTemplate.from); // 'new@email.com'
});
@@ -33015,14 +33670,14 @@ Example
- updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+ updateFactorProvider(params, data, cbopt) → {Promise|undefined}
- Update an existing Email Template.
+ Update Guardian's factor provider
@@ -33058,7 +33713,7 @@ u
Source:
Parameters:
- Email Template parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- name
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Template Name
-
-
-
-
-
-
-
-
+ Factor provider parameters.
@@ -33214,7 +33818,7 @@ Parameters:
- Updated Email Template data.
+ Updated Factor provider data.
@@ -33301,15 +33905,12 @@ Returns:
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'
+ management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ messaging_service_sid: 'XXXXXXXXXXXXXX',
+ auth_token: 'XXXXXXXXXXXXXX',
+ sid: 'XXXXXXXXXXXXXX'
+}, function (err, provider) {
+ console.log(provider);
});
@@ -33321,14 +33922,14 @@ Example
- updateFactorProvider(params, data, cbopt) → {Promise|undefined}
+ updateGuardianFactor(params, data, cbopt) → {Promise|undefined}
- Update Guardian's factor provider
+ Update Guardian Factor
@@ -33364,7 +33965,7 @@ u
Source:
Parameters:
- Factor provider parameters.
+ Factor parameters.
@@ -33469,7 +34070,7 @@ Parameters:
- Updated Factor provider data.
+ Updated factor data.
@@ -33556,12 +34157,10 @@ Returns:
Example
- management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
- messaging_service_sid: 'XXXXXXXXXXXXXX',
- auth_token: 'XXXXXXXXXXXXXX',
- sid: 'XXXXXXXXXXXXXX'
-}, function (err, provider) {
- console.log(provider);
+ management.updateGuardianFactor({ name: 'sms' }, {
+ enabled: true
+}, function (err, factor) {
+ console.log(factor);
});
@@ -33573,14 +34172,14 @@ Example
- updateGuardianFactor(params, data, cbopt) → {Promise|undefined}
+ updateGuardianFactorSettings(params, data, cbopt) → {Promise|undefined}
- Update Guardian Factor
+ Update a Guardian's factor settings
@@ -33616,7 +34215,7 @@ u
Source:
Parameters:
- Updated factor data.
+ Updated Factor settings data.
@@ -33808,11 +34407,12 @@ Returns:
Example
- management.updateGuardianFactor({ name: 'sms' }, {
- enabled: true
-}, function (err, factor) {
- console.log(factor);
-});
+ management.updateGuardianFactorSettings(
+ { name: 'webauthn-roaming' },
+ { userVerification: 'discouraged', overrideRelyingParty: false },
+ function (err, settings) {
+ console.log(settings);
+})
@@ -33866,7 +34466,7 @@ Source:
Source:
Source:
Source:
updateHook<
Source:
upda
Source:
update
Source:
updat
Source:
Source:
u
Source:
updateRole<
Source:
u
Source:
updateUser<
Source:
upd
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index b621b25e3..4919f9306 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -673,7 +673,7 @@ Returns:
diff --git a/docs/module-management.MigrationsManager.html b/docs/module-management.MigrationsManager.html
index 38b1f4a2a..900408b09 100644
--- a/docs/module-management.MigrationsManager.html
+++ b/docs/module-management.MigrationsManager.html
@@ -24,7 +24,7 @@
@@ -885,7 +885,7 @@ Example
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index d4fbcdb43..ab697a17e 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -839,7 +839,7 @@ Source:
Source:
Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 28b71a9cc..4ad894547 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 823c01c7a..aea29a357 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -417,7 +417,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index b9ad9ff84..3f16d41df 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -925,7 +925,7 @@ assignRole
Source:
removeRole
Source:
Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index cab403ecf..18a1e2279 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 4ffc27c2c..2cecbae76 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 131f017f9..3c0ff047c 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 d34535860..605faa889 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 48cd03071..4c5ef7eec 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -1121,7 +1121,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index 052151bb2..1fa15aa21 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 88cca3bac..3de798f41 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -101,7 +101,7 @@ new Users
Source:
(
Source:
(i
Source:
Source:
(
Source:
Source:
(inn
Source:
(inner
Source:
(inner) Source:
(inner) <
Source:
createSource:
deleteSource:
deleteAllSource:
Source:
getSource:
getAllSource:
Example
- getByEmail(emailopt, cbopt) → {Promise|undefined}
+ getByEmail(emailopt, optionsopt, cbopt) → {Promise|undefined}
@@ -2620,7 +2620,7 @@ getByEmail<
Source:
Parameters:
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Additional options to pass to the endpoint
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ fields
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Comma-separated list of fields to include or exclude in the result
+
+
+
+
+
+
+
+
+ include_fields
+
+
+Boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Whether specified fields are to be included (true) or excluded (false). Defaults to true.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbSource:
getPerm
Source:
getUserRo
Source:
Source:
linkSource:
logsSource:
Source:
unlinkSource:
updateSource:
upda
Source:
upd
Source:
Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 5f2c56522..aebe1ff30 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index b0cb3d289..ada534b97 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -363,7 +363,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index d8f70666d..6fce3ff1d 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -140,7 +140,7 @@ utils.js
diff --git a/package.json b/package.json
index 52e46fd35..3b5bac15a 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.31.1",
+ "version": "2.32.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
diff --git a/docs/global.html b/docs/global.html index 17caad953..c968ba37d 100644 --- a/docs/global.html +++ b/docs/global.html @@ -24,7 +24,7 @@
@@ -423,7 +423,7 @@
diff --git a/docs/index.html b/docs/index.html index d52401aa5..3e8a57857 100644 --- a/docs/index.html +++ b/docs/index.html @@ -24,7 +24,7 @@
Returns:
diff --git a/docs/index.html b/docs/index.html index d52401aa5..3e8a57857 100644 --- a/docs/index.html +++ b/docs/index.html @@ -24,7 +24,7 @@
@@ -176,7 +176,7 @@
diff --git a/docs/index.js.html b/docs/index.js.html index 8cf330b4c..847cde28e 100644 --- a/docs/index.js.html +++ b/docs/index.js.html @@ -24,7 +24,7 @@
License
diff --git a/docs/index.js.html b/docs/index.js.html index 8cf330b4c..847cde28e 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 caf780a35..75d0ddf9a 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 caf780a35..75d0ddf9a 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 3f507d607..2d5af4d8c 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 3f507d607..2d5af4d8c 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 313cb862f..5164a0f47 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 313cb862f..5164a0f47 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 3e4d75e7f..937827f39 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 3e4d75e7f..937827f39 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 c3be84314..0e0775215 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 c3be84314..0e0775215 100644 --- a/docs/management_ConnectionsManager.js.html +++ b/docs/management_ConnectionsManager.js.html @@ -24,7 +24,7 @@
@@ -284,7 +284,7 @@
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html index 2e4ba4804..ebe0700d3 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 2e4ba4804..ebe0700d3 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 c88a16cb6..0c87d4c1a 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 c88a16cb6..0c87d4c1a 100644 --- a/docs/management_DeviceCredentialsManager.js.html +++ b/docs/management_DeviceCredentialsManager.js.html @@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html index b37bd9546..61fc666f7 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 b37bd9546..61fc666f7 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 7fb5964eb..82ad1b6bc 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 7fb5964eb..82ad1b6bc 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 2e492fab2..468d4eebc 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 2e492fab2..468d4eebc 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 308ddb778..d23eeb8ae 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 308ddb778..d23eeb8ae 100644 --- a/docs/management_GuardianManager.js.html +++ b/docs/management_GuardianManager.js.html @@ -24,7 +24,7 @@
@@ -116,6 +116,18 @@
diff --git a/docs/management_HooksManager.js.html b/docs/management_HooksManager.js.html index 5e29bb560..33b9a8a63 100644 --- a/docs/management_HooksManager.js.html +++ b/docs/management_HooksManager.js.html @@ -24,7 +24,7 @@
management/GuardianManager.js
); this.factors = new RetryRestClient(guardianFactorsAuth0RestClient, options.retry); + /** + * Provides an abstraction layer for configuring Factor settings + * + * @type {external:RestClient} + */ + var guardianFactorSettingsAuth0RestClient = new Auth0RestClient( + options.baseUrl + '/guardian/factors/:name/settings', + clientOptions, + options.tokenProvider + ); + this.factorSettings = new RetryRestClient(guardianFactorSettingsAuth0RestClient, options.retry); + /** * Provides an abstraction layer for retrieving Guardian factor templates. * @@ -261,6 +273,45 @@management/GuardianManager.js
*/ utils.wrapPropertyMethod(GuardianManager, 'getFactors', 'factors.getAll'); +/** + * Get Guardian factor configuration + * + * @method getFactorSettings + * @memberOf module:management.GuardianManager.prototype + * + * @example + * management.guardian.getFactorSettings({ name: 'webauthn-roaming' }, function (err, settings) { + * console.log(settings); + * }); + * + * @param {Object} params Factor parameters. + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod(GuardianManager, 'getFactorSettings', 'factorSettings.get'); + +/** + * Update Guardian factor configuration + * + * @method updateFactorSettings + * @memberOf module:management.GuardianManager.prototype + * + * @example + * management.guardian.updateFactorSettings( + * { name: 'webauthn-roaming' }, + * { userVerification: 'discouraged', overrideRelyingParty: false }, + * function (err, settings) { + * console.log(settings); + * }); + * + * @param {Object} params Factor parameters. + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod(GuardianManager, 'updateFactorSettings', 'factorSettings.update'); + /** * Get Guardian factor provider configuration * @@ -508,7 +559,7 @@management/GuardianManager.js
diff --git a/docs/management_HooksManager.js.html b/docs/management_HooksManager.js.html index 5e29bb560..33b9a8a63 100644 --- a/docs/management_HooksManager.js.html +++ b/docs/management_HooksManager.js.html @@ -24,7 +24,7 @@
@@ -419,7 +419,7 @@
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html index f9aa922fb..3909c2f90 100644 --- a/docs/management_JobsManager.js.html +++ b/docs/management_JobsManager.js.html @@ -24,7 +24,7 @@
management/HooksManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html index f9aa922fb..3909c2f90 100644 --- a/docs/management_JobsManager.js.html +++ b/docs/management_JobsManager.js.html @@ -24,7 +24,7 @@
@@ -439,7 +439,7 @@
diff --git a/docs/management_LogStreamsManager.js.html b/docs/management_LogStreamsManager.js.html index 764a1cb01..5d6889ca5 100644 --- a/docs/management_LogStreamsManager.js.html +++ b/docs/management_LogStreamsManager.js.html @@ -24,7 +24,7 @@
management/JobsManager.js
diff --git a/docs/management_LogStreamsManager.js.html b/docs/management_LogStreamsManager.js.html index 764a1cb01..5d6889ca5 100644 --- a/docs/management_LogStreamsManager.js.html +++ b/docs/management_LogStreamsManager.js.html @@ -24,7 +24,7 @@
@@ -230,7 +230,7 @@
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html index 9e379af1b..047297000 100644 --- a/docs/management_LogsManager.js.html +++ b/docs/management_LogsManager.js.html @@ -24,7 +24,7 @@
management/LogStreamsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html index 9e379af1b..047297000 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 fe2f9b3d6..76493f948 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 fe2f9b3d6..76493f948 100644 --- a/docs/management_ManagementTokenProvider.js.html +++ b/docs/management_ManagementTokenProvider.js.html @@ -24,7 +24,7 @@
@@ -194,7 +194,7 @@
diff --git a/docs/management_MigrationsManager.js.html b/docs/management_MigrationsManager.js.html index 2b794048d..f54356b8e 100644 --- a/docs/management_MigrationsManager.js.html +++ b/docs/management_MigrationsManager.js.html @@ -24,7 +24,7 @@
management/ManagementTokenProvider.js
diff --git a/docs/management_MigrationsManager.js.html b/docs/management_MigrationsManager.js.html index 2b794048d..f54356b8e 100644 --- a/docs/management_MigrationsManager.js.html +++ b/docs/management_MigrationsManager.js.html @@ -24,7 +24,7 @@
@@ -159,7 +159,7 @@
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html index 71ef1eb82..9b7c12a3e 100644 --- a/docs/management_PromptsManager.js.html +++ b/docs/management_PromptsManager.js.html @@ -24,7 +24,7 @@
management/MigrationsManager.js
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html index 71ef1eb82..9b7c12a3e 100644 --- a/docs/management_PromptsManager.js.html +++ b/docs/management_PromptsManager.js.html @@ -24,7 +24,7 @@
@@ -261,7 +261,7 @@
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html index 863d2bf15..24c182400 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 863d2bf15..24c182400 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 3e9912553..93997d82f 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 3e9912553..93997d82f 100644 --- a/docs/management_RolesManager.js.html +++ b/docs/management_RolesManager.js.html @@ -24,7 +24,7 @@
@@ -460,7 +460,7 @@
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html index c2fc05926..83dad4887 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 c2fc05926..83dad4887 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 adf9ff60d..633925ceb 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 adf9ff60d..633925ceb 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 a9c5970f8..0d1649234 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 a9c5970f8..0d1649234 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 3ff81bc64..25f38364d 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 3ff81bc64..25f38364d 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 18c4d7637..aab52fba0 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 18c4d7637..aab52fba0 100644 --- a/docs/management_TicketsManager.js.html +++ b/docs/management_TicketsManager.js.html @@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html index 8492126dd..64ef3b4ba 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 8492126dd..64ef3b4ba 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 96d584a20..f6d5ad7a7 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 96d584a20..f6d5ad7a7 100644 --- a/docs/management_UsersManager.js.html +++ b/docs/management_UsersManager.js.html @@ -24,7 +24,7 @@
@@ -42,6 +42,7 @@
management/UsersManager.js
var ArgumentError = require('rest-facade').ArgumentError;
var Auth0RestClient = require('../Auth0RestClient');
var RetryRestClient = require('../RetryRestClient');
+var sanitizeArguments = require('../utils').sanitizeArguments;
/**
* Simple facade for consuming a REST API endpoint.
@@ -279,13 +280,18 @@ management/UsersManager.js
* console.log(users);
* });
*
- * @param {String} [email] Email address of user(s) to find
- * @param {Function} [cb] Callback function.
+ * @param {String} [email] Email address of user(s) to find
+ * @param {Object} [options] Additional options to pass to the endpoint
+ * @param {String} [options.fields] Comma-separated list of fields to include or exclude in the result
+ * @param {Boolean} [options.include_fields] Whether specified fields are to be included (true) or excluded (false). Defaults to true.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
-UsersManager.prototype.getByEmail = function(email, callback) {
- return this.usersByEmail.getAll({ email }, callback);
+UsersManager.prototype.getByEmail = function(email, options, cb) {
+ var { options, cb } = sanitizeArguments(options, cb);
+
+ return this.usersByEmail.getAll({ email, ...options }, cb);
};
/**
@@ -977,7 +983,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index 7a61a765f..f2e393233 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -1060,8 +1060,11 @@ management/index.js
* console.log(users);
* });
*
- * @param {String} [email] Email Address of users to locate
- * @param {Function} [cb] Callback function.
+ * @param {String} [email] Email address of user(s) to find
+ * @param {Object} [options] Additional options to pass to the endpoint
+ * @param {String} [options.fields] Comma-separated list of fields to include or exclude in the result
+ * @param {Boolean} [options.include_fields] Whether specified fields are to be included (true) or excluded (false). Defaults to true.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -2875,6 +2878,28 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'getGuardianFactors', 'guardian.getFactors');
+/**
+ * Get the settings of a Guardian factor.
+ *
+ * @method getGuardianFactorSettings
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.getGuardianFactorSettings({ name: 'duo' }, function (err, settings) {
+ * console.log(settings);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'getGuardianFactorSettings',
+ 'guardian.getFactorSettings'
+);
+
/**
* Get Guardian factor provider configuration
*
@@ -2924,6 +2949,32 @@ management/index.js
'guardian.updateFactorProvider'
);
+/**
+ * Update a Guardian's factor settings
+ *
+ * @method updateGuardianFactorSettings
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.updateGuardianFactorSettings(
+ * { name: 'webauthn-roaming' },
+ * { userVerification: 'discouraged', overrideRelyingParty: false },
+ * function (err, settings) {
+ * console.log(settings);
+ * })
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated Factor settings data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'updateGuardianFactorSettings',
+ 'guardian.updateFactorSettings'
+);
+
/**
* Get Guardian enrollment and verification factor templates
*
@@ -3806,7 +3857,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index e8b5d111d..03fa83391 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -4207,7 +4207,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index 99ffb9568..af91ea7a2 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1765,7 +1765,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index 6d53d0cb6..ac77381b5 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 59dd5da51..843904425 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -2050,7 +2050,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 4dfd5cd83..475d29bdb 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -101,7 +101,7 @@ Source:
(inner) Source:
Methods
- sendEmail(userData, cbopt) → {Promise|undefined}
+ sendEmail(userData, optionsopt, cbopt) → {Promise|undefined}
@@ -491,7 +491,7 @@ sendEmailSource:
Parameters:
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Additional options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ forwardedFor
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Value to be used for auth0-forwarded-for header
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbExample
- sendSMS(userData, cbopt) → {Promise|undefined}
+ sendSMS(userData, optionsopt, cbopt) → {Promise|undefined}
@@ -811,7 +910,7 @@ sendSMSSource:
Parameters:
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Additional options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ forwardedFor
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Value to be used for auth0-forwarded-for header
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbExample
- signIn(userData, cbopt) → {Promise|undefined}
+ signIn(userData, optionsopt, cbopt) → {Promise|undefined}
@@ -1089,7 +1287,7 @@ signInSource:
Parameters:
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Additional options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ forwardedFor
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Value to be used for auth0-forwarded-for header
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbExamples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index 8812d86f9..41fb67c4f 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 b53c258fe..388e4f3af 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 bad738bd4..d956457b4 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@ Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html
index dab1ef5b5..727f1203c 100644
--- a/docs/module-errors.html
+++ b/docs/module-errors.html
@@ -24,7 +24,7 @@
@@ -254,7 +254,7 @@ (st
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 0cf706701..68361d7a8 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 700c1597d..0c111be04 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 55282ae96..43b6235a6 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 2917e5aaa..53004a8a2 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 8085a325d..e86bf8710 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -2269,7 +2269,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 0f052956b..7e2713c00 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 6ba5d9fb7..56b5fcbae 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1215,7 +1215,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index b34aca674..efbd2c9c9 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 4fbe4db35..71b3cc382 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 af6e04e36..11018a156 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 56707c497..40074a738 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -464,6 +464,80 @@ external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorSettingsAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for configuring Factor settings
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
@@ -529,7 +603,7 @@ Source:
Source:
Source:
Source:
Source:
Source:
Source:
getF
Source:
getFactors<
Source:
Example
+
+
+
+
+ getFactorSettings(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get Guardian factor configuration
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor parameters.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getFactorSettings({ name: 'webauthn-roaming' }, function (err, settings) {
+ console.log(settings);
+});
+
+
+
+
+
+
@@ -1822,7 +2110,7 @@ get
Source:
Source:
Source:
Source:
getPolicie
Source:
updateFac
Source:
u
Source:
Example
+
+
+
+
+ updateFactorSettings(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian factor configuration
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor parameters.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updateFactorSettings(
+ { name: 'webauthn-roaming' },
+ { userVerification: 'discouraged', overrideRelyingParty: false },
+ function (err, settings) {
+ console.log(settings);
+});
+
+
+
+
+
+
@@ -3343,7 +3848,7 @@
Source:
Source:
Source:
updateP
Source:
Example
diff --git a/docs/module-management.HooksManager.html b/docs/module-management.HooksManager.html
index 6b2aa9c75..bad90e732 100644
--- a/docs/module-management.HooksManager.html
+++ b/docs/module-management.HooksManager.html
@@ -24,7 +24,7 @@
@@ -3099,7 +3099,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 2178b4a73..100dc7816 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -890,7 +890,7 @@ errorsSource:
Example
diff --git a/docs/module-management.LogStreamsManager.html b/docs/module-management.LogStreamsManager.html
index 9c98bbb38..d07a6fefa 100644
--- a/docs/module-management.LogStreamsManager.html
+++ b/docs/module-management.LogStreamsManager.html
@@ -24,7 +24,7 @@
@@ -1763,7 +1763,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index c6f6704db..d59f3ef23 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 b479a6092..35b1f52cd 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -2713,7 +2713,7 @@ addHookS
Source:
a
Source:
Source:
assi
Source:
assi
Source:
blackli
Source:
Source:
cre
Source:
cr
Source:
Source:
Source:
createHook<
Source:
create
Source:
Source:
c
Source:
createRole<
Source:
createUser<
Source:
deleteA
Source:
del
Source:
de
Source:
Source:
deleteHook<
Source:
delete
Source:
d
Source:
deleteRole<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
getEm
Source:
getEm
Source:
Source:
Source:
Source:
get
Source:
Example
- getGuardianFactorTemplates(params, cbopt) → {Promise|undefined}
+ getGuardianFactorSettings(params, cbopt) → {Promise|undefined}
- Get Guardian enrollment and verification factor templates
+ Get the settings of a Guardian factor.
@@ -18121,7 +18121,7 @@ Source:
Returns:
Example
- management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
- console.log(templates);
+ management.getGuardianFactorSettings({ name: 'duo' }, function (err, settings) {
+ console.log(settings);
});
@@ -18292,14 +18292,14 @@ Example
- getGuardianPhoneFactorMessageTypes(cbopt) → {Promise|undefined}
+ getGuardianFactorTemplates(params, cbopt) → {Promise|undefined}
- Get the Guardian phone factor's message types
+ Get Guardian enrollment and verification factor templates
@@ -18335,7 +18335,7 @@ Source:
Parameters:
- cbparams
-function
+Object
@@ -18396,8 +18396,6 @@ Parameters:
- <optional>
-
@@ -18408,156 +18406,12 @@ Parameters:
- Callback function.
+ Factor parameters.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.getGuardianPhoneFactorMessageTypes(function (err, messageTypes) {
- console.log(messageTypes);
-});
-
-
-
-
-
-
-
-
-
-
- getGuardianPhoneFactorSelectedProvider(cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get the Guardian phone factor's selected provider
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
@@ -18639,8 +18493,8 @@ Returns:
Example
- management.getGuardianPhoneFactorSelectedProvider(function (err, selectedProvider) {
- console.log(selectedProvider);
+ management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
+ console.log(templates);
});
@@ -18652,14 +18506,14 @@ Example
- getGuardianPolicies(cbopt) → {Promise|undefined}
+ getGuardianPhoneFactorMessageTypes(cbopt) → {Promise|undefined}
- Get enabled Guardian policies
+ Get the Guardian phone factor's message types
@@ -18695,7 +18549,7 @@ ge
Source:
Returns:
Example
- management.getGuardianPolicies(function (err, policies) {
- console.log(policies);
+ management.getGuardianPhoneFactorMessageTypes(function (err, messageTypes) {
+ console.log(messageTypes);
});
@@ -18832,14 +18686,14 @@ Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianPhoneFactorSelectedProvider(cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get the Guardian phone factor's selected provider
@@ -18875,7 +18729,7 @@ getHookSource:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Hook parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Hook ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
cbReturns:
Example
- management.getHook({ id: HOOK_ID }, function (err, hook) {
- if (err) {
- // Handle error.
- }
-
- console.log(hook);
+ management.getGuardianPhoneFactorSelectedProvider(function (err, selectedProvider) {
+ console.log(selectedProvider);
});
@@ -19101,14 +18866,14 @@ Example
- getHooks(paramsopt, cbopt) → {Promise|undefined}
+ getGuardianPolicies(cbopt) → {Promise|undefined}
- Get all hooks.
+ Get enabled Guardian policies
@@ -19144,7 +18909,7 @@ getHooksSource:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Hooks parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Page number, zero indexed.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
cbReturns:
Example
-
- This method takes an optional object as first argument that may be used to
- specify pagination settings. If pagination options are not present,
- the first page of a limited number of results will be returned.
-
-
- // Pagination settings.
-var params = {
- per_page: 10,
- page: 0
-};
-
-management.getHooks(params, function (err, hooks) {
- console.log(hooks.length);
+ management.getGuardianPolicies(function (err, policies) {
+ console.log(policies);
});
@@ -19428,14 +19046,14 @@ Example
- getHookSecrets(params, cbopt) → {Promise|undefined}
+ getHook(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook's secrets.
+ Get an Auth0 hook.
@@ -19471,7 +19089,7 @@ getHook
Source:
Returns:
Example
- var params = { id: HOOK_ID }
-management.getHookSecrets(params, function (err, secrets) {
+ management.getHook({ id: HOOK_ID }, function (err, hook) {
if (err) {
// Handle error.
}
- console.log(secrets);
+ console.log(hook);
});
@@ -19698,14 +19315,14 @@ Example
- getJob(params, cbopt) → {Promise|undefined}
+ getHooks(paramsopt, cbopt) → {Promise|undefined}
- Get a job by its ID.
+ Get all hooks.
@@ -19741,7 +19358,7 @@ getJobSource:
Parameters:
+ <optional>
+
@@ -19812,7 +19431,7 @@ Parameters:
- Job parameters.
+ Hooks parameters.
@@ -19826,6 +19445,8 @@ Parameters:
Type
+ Attributes
+
@@ -19838,24 +19459,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- Job ID.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -19950,17 +19617,20 @@ Returns:
Example
- var params = {
- id: '{JOB_ID}'
+
+ This method takes an optional object as first argument that may be used to
+ specify pagination settings. If pagination options are not present,
+ the first page of a limited number of results will be returned.
+
+
+ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
};
-management.getJob(params, function (err, job) {
- if (err) {
- // Handle error.
- }
-
- // Retrieved job.
- console.log(job);
+management.getHooks(params, function (err, hooks) {
+ console.log(hooks.length);
});
@@ -19972,14 +19642,14 @@ Example
- getLog(params, cbopt) → {Promise|undefined}
+ getHookSecrets(params, cbopt) → {Promise|undefined}
- Get an Auth0 log.
+ Get an Auth0 hook's secrets.
@@ -20015,7 +19685,7 @@ getLogSource:
Parameters:
- Log parameters.
+ Hook parameters.
@@ -20129,7 +19799,7 @@ Parameters:
- Event ID.
+ Hook ID.
@@ -20224,12 +19894,13 @@ Returns:
Example
- management.getLog({ id: EVENT_ID }, function (err, log) {
+ var params = { id: HOOK_ID }
+management.getHookSecrets(params, function (err, secrets) {
if (err) {
// Handle error.
}
- console.log(log);
+ console.log(secrets);
});
@@ -20241,14 +19912,14 @@ Example
- getLogs(paramsopt, cbopt) → {Promise|undefined}
+ getJob(params, cbopt) → {Promise|undefined}
- Get all logs.
+ Get a job by its ID.
@@ -20284,7 +19955,7 @@ getLogsSource:
Parameters:
- <optional>
-
@@ -20357,7 +20026,7 @@ Parameters:
- Logs params.
+ Job parameters.
@@ -20371,8 +20040,6 @@ Parameters:
Type
- Attributes
-
@@ -20385,151 +20052,7 @@ Parameters:
- q
-
-
-String
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Search Criteria using Query String Syntax
-
-
-
-
-
-
-
-
- page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Page number. Zero based
-
-
-
-
-
-
-
-
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The amount of entries per page
-
-
-
-
-
-
-
-
- sort
-
-
-String
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The field to use for sorting.
-
-
-
-
-
-
-
-
- fieldsid
@@ -20542,93 +20065,11 @@ Parameters:
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- A comma separated list of fields to include or exclude
-
-
-
-
-
-
-
-
- include_fields
-
-
-Boolean
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- true if the fields specified are to be included in the result, false otherwise.
-
-
-
-
-
-
-
-
- include_totals
-
-
-Boolean
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- true if a query summary must be included in the result, false otherwise. Default false
+ Job ID.
@@ -20723,20 +20164,17 @@ Returns:
Example
-
- This method takes an optional object as first argument that may be used to
- specify pagination settings and the search query. If pagination options are
- not present, the first page of a limited number of results will be returned.
-
-
- // Pagination settings.
-var params = {
- per_page: 10,
- page: 2
+ var params = {
+ id: '{JOB_ID}'
};
-management.getLogs(params, function (err, logs) {
- console.log(logs.length);
+management.getJob(params, function (err, job) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Retrieved job.
+ console.log(job);
});
@@ -20748,14 +20186,14 @@ Example
- getLogStream(params, cbopt) → {Promise|undefined}
+ getLog(params, cbopt) → {Promise|undefined}
- Get an Auth0 Log Stream.
+ Get an Auth0 log.
@@ -20791,7 +20229,7 @@ getLogStr
Source:
Parameters:
- Log Stream parameters.
+ Log parameters.
@@ -20905,7 +20343,7 @@ Parameters:
- Log Stream ID.
+ Event ID.
@@ -21000,12 +20438,12 @@ Returns:
Example
- management.getLogStream({ id: LOG_STREAM_ID }, function (err, logStream) {
+ management.getLog({ id: EVENT_ID }, function (err, log) {
if (err) {
// Handle error.
}
- console.log(logStream);
+ console.log(log);
});
@@ -21017,14 +20455,14 @@ Example
- getMigrations(cbopt) → {Promise|undefined}
+ getLogs(paramsopt, cbopt) → {Promise|undefined}
- Get migrations flags
+ Get all logs.
@@ -21060,7 +20498,7 @@ getMigra
Source:
Parameters:
- cbparams
-function
+Object
@@ -21133,171 +20571,257 @@ Parameters:
- Callback function.
+ Logs params.
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+ Name
+
+ Type
+
+ Attributes
+
+
+ Description
+
+
+
+
+
+
+ q
+
+
+String
-
-Returns:
-
+
+
-
- -
- Type:
-
- -
-
-
Promise
-|
+
+
+
+ <optional>
+
-undefined
+
+
+
+
-
-
+
+
+ Search Criteria using Query String Syntax
+
+
+
-
+
+
+ page
+
+
+Number
-
-Example
- management.getMigrations(function (err, migrations) {
- if (err) {
- // Handle error.
- }
+
+
-// Migration flags
- console.log(migrations.flags);
-});
+
+
+
+ <optional>
+
-
+
-
-
+
+
-
-
+
- getPermissionsInRole(roleIdopt, cbopt) → {Promise|undefined}
+
+ Page number. Zero based
+
+
+
+
+
+ per_page
+
+
+Number
-
- Get permissions for a given role
-
+
+
+
+
+
+ <optional>
+
+
+
+
+
-
+
-
+
+ The amount of entries per page
+
+
+
-
+
+
+ sort
+
+
+String
-
-
+
+
-
+
+
+
+ <optional>
+
-
+
-
+
+
+
-
+
-
+
+ The field to use for sorting.
+
+
+
-
- Source:
-
+
+ fields
+
+
+String
-
-
-
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+ A comma separated list of fields to include or exclude
+
+
+
+
+
+
+ include_fields
+
+
+Boolean
- Parameters:
-
-
-
-
-
- Name
-
+
+
- Type
+
+
+
+ <optional>
+
-
- Attributes
-
+
-
+
+
+
- Description
-
-
+
+
+
+ true if the fields specified are to be included in the result, false otherwise.
+
+
+
-
- roleIdinclude_totals
-String
+Boolean
@@ -21318,7 +20842,15 @@ Parameters:
- Id of the role
+ true if a query summary must be included in the result, false otherwise. Default false
+
+
+
+
+
+
+
+
@@ -21403,18 +20935,22 @@ Returns:
-Examples
-
- var params = { id :'ROLE_ID'};
+Example
- This method takes a roleId and
- returns all permissions within that role
-
+ This method takes an optional object as first argument that may be used to
+ specify pagination settings and the search query. If pagination options are
+ not present, the first page of a limited number of results will be returned.
- management.getPermissionsInRole(params, function (err, permissions) {
- console.log(permissions);
+ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 2
+};
+
+management.getLogs(params, function (err, logs) {
+ console.log(logs.length);
});
@@ -21426,14 +20962,14 @@ Examples
- getPromptsSettings(cbopt) → {Promise|undefined}
+ getLogStream(params, cbopt) → {Promise|undefined}
- Get prompts settings..
+ Get an Auth0 Log Stream.
@@ -21469,7 +21005,7 @@ get
Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Log Stream parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Log Stream ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.getPromptsSettings(function (err, settings) {
+ management.getLogStream({ id: LOG_STREAM_ID }, function (err, logStream) {
if (err) {
// Handle error.
}
- console.log(settings);
+ console.log(logStream);
});
@@ -21610,14 +21231,14 @@ Example
- getResourceServer(params, cbopt) → {Promise|undefined}
+ getMigrations(cbopt) → {Promise|undefined}
- Get a Resource Server.
+ Get migrations flags
@@ -21653,7 +21274,7 @@ getR
Source:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Resource Server parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Resource Server ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
cbReturns:
Example
- management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+ management.getMigrations(function (err, migrations) {
if (err) {
// Handle error.
}
- console.log(resourceServer);
+// Migration flags
+ console.log(migrations.flags);
});
@@ -21879,14 +21416,14 @@ Example
- getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+ getPermissionsInRole(roleIdopt, cbopt) → {Promise|undefined}
- Get all resource servers.
+ Get permissions for a given role
@@ -21922,7 +21459,7 @@ get
Source:
Parameters:
- params
-
-
-Object
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Resource Servers parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageroleId
-Number
+String
@@ -22086,15 +21532,7 @@ Parameters:
- Page number, zero indexed.
-
-
-
-
-
-
-
-
+ Id of the role
@@ -22179,22 +21617,18 @@ Returns:
-Example
+Examples
+
+ var params = { id :'ROLE_ID'};
- This method takes an optional object as first argument that may be used to
- specify pagination settings. If pagination options are not present,
- the first page of a limited number of results will be returned.
+ This method takes a roleId and
+ returns all permissions within that role
+
- // Pagination settings.
-var params = {
- per_page: 10,
- page: 0
-};
-
-management.getResourceServers(params, function (err, resourceServers) {
- console.log(resourceServers.length);
+ management.getPermissionsInRole(params, function (err, permissions) {
+ console.log(permissions);
});
@@ -22206,14 +21640,14 @@ Example
- getRole(params, cbopt) → {Promise|undefined}
+ getPromptsSettings(cbopt) → {Promise|undefined}
- Get an Auth0 role.
+ Get prompts settings..
@@ -22249,7 +21683,7 @@ getRoleSource:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Role parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Role ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
cbReturns:
Example
- management.getRole({ id: ROLE_ID }, function (err, role) {
+ management.getPromptsSettings(function (err, settings) {
if (err) {
// Handle error.
}
- console.log(role);
+ console.log(settings);
});
@@ -22475,14 +21824,14 @@ Example
- getRoles(paramsopt, cbopt) → {Promise|undefined}
+ getResourceServer(params, cbopt) → {Promise|undefined}
- Get all roles.
+ Get a Resource Server.
@@ -22518,7 +21867,7 @@ getRolesSource:
Parameters:
- <optional>
-
@@ -22591,7 +21938,7 @@ Parameters:
- Roles parameters.
+ Resource Server parameters.
@@ -22605,8 +21952,6 @@ Parameters:
Type
- Attributes
-
@@ -22619,70 +21964,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ Resource Server ID.
@@ -22777,20 +22076,12 @@ Returns:
Example
-
- This method takes an optional object as first argument that may be used to
- specify pagination settings. If pagination options are not present,
- the first page of a limited number of results will be returned.
-
-
- // Pagination settings.
-var params = {
- per_page: 10,
- page: 0
-};
+ management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+ if (err) {
+ // Handle error.
+ }
-management.getRoles(params, function (err, roles) {
- console.log(roles.length);
+ console.log(resourceServer);
});
@@ -22802,14 +22093,14 @@ Example
- getRule(params, cbopt) → {Promise|undefined}
+ getResourceServers(paramsopt, cbopt) → {Promise|undefined}
- Get an Auth0 rule.
+ Get all resource servers.
@@ -22845,7 +22136,7 @@ getRuleSource:
Parameters:
+ <optional>
+
@@ -22916,7 +22209,7 @@ Parameters:
- Rule parameters.
+ Resource Servers parameters.
@@ -22930,6 +22223,8 @@ Parameters:
Type
+ Attributes
+
@@ -22942,24 +22237,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- Rule ID.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -23054,12 +22395,20 @@ Returns:
Example
- management.getRule({ id: RULE_ID }, function (err, rule) {
- if (err) {
- // Handle error.
- }
+
+ This method takes an optional object as first argument that may be used to
+ specify pagination settings. If pagination options are not present,
+ the first page of a limited number of results will be returned.
+
+
+ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
+};
- console.log(rule);
+management.getResourceServers(params, function (err, resourceServers) {
+ console.log(resourceServers.length);
});
@@ -23071,14 +22420,14 @@ Example
- getRules(paramsopt, cbopt) → {Promise|undefined}
+ getRole(params, cbopt) → {Promise|undefined}
- Get all rules.
+ Get an Auth0 role.
@@ -23114,7 +22463,7 @@ getRulesSource:
Parameters:
- <optional>
-
@@ -23187,7 +22534,7 @@ Parameters:
- Rules parameters.
+ Role parameters.
@@ -23201,8 +22548,6 @@ Parameters:
Type
- Attributes
-
@@ -23215,70 +22560,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ Role ID.
@@ -23373,20 +22672,12 @@ Returns:
Example
-
- This method takes an optional object as first argument that may be used to
- specify pagination settings. If pagination options are not present,
- the first page of a limited number of results will be returned.
-
-
- // Pagination settings.
-var params = {
- per_page: 10,
- page: 0
-};
+ management.getRole({ id: ROLE_ID }, function (err, role) {
+ if (err) {
+ // Handle error.
+ }
-management.getRules(params, function (err, rules) {
- console.log(rules.length);
+ console.log(role);
});
@@ -23398,14 +22689,14 @@ Example
- getRulesConfigs(cbopt) → {Promise|undefined}
+ getRoles(paramsopt, cbopt) → {Promise|undefined}
- Get rules config.
+ Get all roles.
@@ -23441,7 +22732,7 @@ getRul
Source:
Parameters:
- cbparams
-function
+Object
@@ -23514,159 +22805,110 @@ Parameters:
- Callback function.
+ Roles parameters.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
+
+
+
+
-
-
- -
- Type:
-
- -
+
Name
-Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
- management.getRulesConfigs(function (err, rulesConfigs) {
- if (err) {
- // Handle error.
- }
-
- // Get Rules Configs.
-});
-
-
+ Type
-
-
-
-
-
-
- getTenantSettings(cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get the tenant settings..
-
-
-
-
-
-
-
-
-
-
-
+ Attributes
+
-
+
-
+ Description
+
+
+
-
+
+
+ per_page
+
+
+Number
-
-
+
+
-
+
+
+
+ <optional>
+
-
+
-
+
+
+
-
- Source:
-
+ Number of results per page.
+
+
+
-
-
+
+
+ page
+
+
+Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
- Parameters:
+
+
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+
+
+
-
@@ -23749,12 +22991,20 @@ Returns:
Example
- management.getSettings(function (err, settings) {
- if (err) {
- // Handle error.
- }
+
+ This method takes an optional object as first argument that may be used to
+ specify pagination settings. If pagination options are not present,
+ the first page of a limited number of results will be returned.
+
+
+ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
+};
- console.log(settings);
+management.getRoles(params, function (err, roles) {
+ console.log(roles.length);
});
@@ -23766,14 +23016,14 @@ Example
- getUser(data, cbopt) → {Promise|undefined}
+ getRule(params, cbopt) → {Promise|undefined}
- Get a user by its id.
+ Get an Auth0 rule.
@@ -23809,7 +23059,7 @@ getUserSource:
Parameters:
- dataparams
@@ -23880,7 +23130,7 @@ Parameters:
- The user data object.
+ Rule parameters.
@@ -23923,7 +23173,7 @@ Parameters:
- The user id.
+ Rule ID.
@@ -24018,8 +23268,12 @@ Returns:
Example
- management.getUser({ id: USER_ID }, function (err, user) {
- console.log(user);
+ management.getRule({ id: RULE_ID }, function (err, rule) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(rule);
});
@@ -24031,14 +23285,14 @@ Example
- getUserBlocks(params, cbopt) → {Promise|undefined}
+ getRules(paramsopt, cbopt) → {Promise|undefined}
- Get user blocks by its id.
+ Get all rules.
@@ -24074,7 +23328,7 @@ getUserB
Source:
Parameters:
+ <optional>
+
@@ -24145,7 +23401,7 @@ Parameters:
- The user data object..
+ Rules parameters.
@@ -24159,6 +23415,8 @@ Parameters:
Type
+ Attributes
+
@@ -24171,24 +23429,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
- The user id.
+ Page number, zero indexed.
@@ -24232,7 +23536,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -24283,12 +23587,20 @@ Returns:
Example
- management.getUserBlocks({ id: USER_ID }, function (err, blocks) {
- if (err) {
- // Handle error.
- }
+
+ This method takes an optional object as first argument that may be used to
+ specify pagination settings. If pagination options are not present,
+ the first page of a limited number of results will be returned.
+
+
+ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
+};
- console.log(blocks);
+management.getRules(params, function (err, rules) {
+ console.log(rules.length);
});
@@ -24300,14 +23612,14 @@ Example
- getUserBlocksByIdentifier(params, cbopt) → {Promise|undefined}
+ getRulesConfigs(cbopt) → {Promise|undefined}
- Get user blocks by its identifier.
+ Get rules config.
@@ -24343,7 +23655,7 @@ Source:
Parameters:
- paramscb
-Object
+function
@@ -24404,6 +23716,8 @@ Parameters:
+ <optional>
+
@@ -24414,62 +23728,159 @@ Parameters:
- The user data object..
+ Callback function.
-
+
+
-
-
-
-
- Name
-
+
+
+
- Type
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+ -
+ Type:
+
+ -
+
Promise
+|
+
+undefined
+
+
+
+
- Description
-
-
-
+
-
-
- identifier
-
-
-String
+
+Example
-
-
+ management.getRulesConfigs(function (err, rulesConfigs) {
+ if (err) {
+ // Handle error.
+ }
-
+ // Get Rules Configs.
+});
+
+
+
+
+
-
- The user identifier, any of: username, phone_number, email.
-
-
-
+
+
+ getTenantSettings(cbopt) → {Promise|undefined}
-
-
-
-
-
+
+
+ Get the tenant settings..
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
@@ -24501,7 +23912,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -24552,12 +23963,12 @@ Returns:
Example
- management.getUserBlocksByIdentifier({ identifier: USER_ID }, function (err, blocks) {
+ management.getSettings(function (err, settings) {
if (err) {
// Handle error.
}
- console.log(blocks);
+ console.log(settings);
});
@@ -24569,14 +23980,14 @@ Example
- getUserLogs(params, cbopt) → {Promise|undefined}
+ getUser(data, cbopt) → {Promise|undefined}
- Get user's log events.
+ Get a user by its id.
@@ -24612,7 +24023,7 @@ getUserLog
Source:
Parameters:
- paramsdata
@@ -24683,7 +24094,7 @@ Parameters:
- Get logs data.
+ The user data object.
@@ -24726,111 +24137,7 @@ Parameters:
- User id.
-
-
-
-
-
-
-
-
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- page
-
-
-Number
-
-
-
-
-
-
-
-
-
-
- Page number, zero indexed.
-
-
-
-
-
-
-
-
- sort
-
-
-String
-
-
-
-
-
-
-
-
-
-
- The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
-
-
-
-
-
-
-
-
- include_totals
-
-
-Boolean
-
-
-
-
-
-
-
-
-
-
- true if a query summary must be included in the result, false otherwise. Default false;
+ The user id.
@@ -24925,14 +24232,8 @@ Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-
-management.getUserLogs(params, function (err, logs) {
- if (err) {
- // Handle error.
- }
-
- console.log(logs);
+ management.getUser({ id: USER_ID }, function (err, user) {
+ console.log(user);
});
@@ -24944,14 +24245,14 @@ Example
- getUserPermissions(params, cbopt) → {Promise|undefined}
+ getUserBlocks(params, cbopt) → {Promise|undefined}
- Get user's permissions
+ Get user blocks by its id.
@@ -24987,7 +24288,7 @@ get
Source:
Parameters:
- Get permissions data.
+ The user data object..
@@ -25101,7 +24402,15 @@ Parameters:
- User id.
+ The user id.
+
+
+
+
+
+
+
+
@@ -25110,91 +24419,248 @@ Parameters:
- per_pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Number of results per page.
+ Callback function
+
+
+
+
-
-
- page
-
-
-Number
-
-
-
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getUserBlocks({ id: USER_ID }, function (err, blocks) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(blocks);
+});
+
+
+
+
+
+
-
- Page number, zero indexed.
-
-
-
+
+
+ getUserBlocksByIdentifier(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get user blocks by its identifier.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
- sortparams
-String
+Object
+
+
+
+
+
+
+
+
- The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+ The user data object..
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+ Description
+
+
+
+
- include_totalsidentifier
-Boolean
+String
@@ -25205,7 +24671,7 @@ Parameters:
- true if a query summary must be included in the result, false otherwise. Default false;
+ The user identifier, any of: username, phone_number, email.
@@ -25249,7 +24715,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -25300,14 +24766,12 @@ Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-
-management.getUserPermissions(params, function (err, logs) {
+ management.getUserBlocksByIdentifier({ identifier: USER_ID }, function (err, blocks) {
if (err) {
// Handle error.
}
- console.log(logs);
+ console.log(blocks);
});
@@ -25319,14 +24783,14 @@ Example
- getUserRoles(params, cbopt) → {Promise|undefined}
+ getUserLogs(params, cbopt) → {Promise|undefined}
- Get user's roles
+ Get user's log events.
@@ -25362,7 +24826,7 @@ getUserRo
Source:
Parameters:
- Get roles data.
+ Get logs data.
@@ -25677,7 +25141,7 @@ Example
var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-management.getUserRoles(params, function (err, logs) {
+management.getUserLogs(params, function (err, logs) {
if (err) {
// Handle error.
}
@@ -25694,14 +25158,14 @@ Example
- getUsers(paramsopt, cbopt) → {Promise|undefined}
+ getUserPermissions(params, cbopt) → {Promise|undefined}
- Get all users.
+ Get user's permissions
@@ -25737,7 +25201,757 @@ getUsersSource:
Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Get permissions data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ User id.
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ sort
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+
+management.getUserPermissions(params, function (err, logs) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logs);
+});
+
+
+
+
+
+
+
+
+
+
+ getUserRoles(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get user's roles
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Get roles data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ User id.
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ sort
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+
+management.getUserRoles(params, function (err, logs) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logs);
+});
+
+
+
+
+
+
+
+
+
+
+ getUsers(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all users.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ Example
- getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+ getUsersByEmail(emailopt, optionsopt, cbopt) → {Promise|undefined}
@@ -26211,7 +26425,142 @@ Parameters:
- Email Address of users to locate
+ Email address of user(s) to find
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Additional options to pass to the endpoint
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ fields
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Comma-separated list of fields to include or exclude in the result
+
+
+
+
+
+
+
+
+ include_fields
+
+
+Boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Whether specified fields are to be included (true) or excluded (false). Defaults to true.
+
+
+
+
+
+
+
+
@@ -26359,7 +26708,7 @@ getUser
- Source:
importUser
- Source:
importU
- Source:
Source:
linkUsersSource:
Source:
remo
- Source:
Source:
Source:
re
- Source:
- Source:
setRule
- Source:
unblockUse
- Source:
unblockUse
- Source:
Parameters:
- identifieridentifier
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user identifier, any of: username, phone_number, email.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // User unblocked.
+});
+
+
+
+
+
+
+
+
+
+
+ unlinkUsers(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Unlink the given accounts.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Linked users data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
@@ -30843,7 +31461,59 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ Primary user ID.
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Identity provider in use.
+
+
+
+
+
+
+
+
+ user_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Secondary user ID.
@@ -30887,7 +31557,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -30938,12 +31608,14 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
+
+management.unlinkUsers(params, function (err, user) {
if (err) {
// Handle error.
}
- // User unblocked.
+ // Users accounts unlinked.
});
@@ -30955,14 +31627,14 @@ Example
- unlinkUsers(params, cbopt) → {Promise|undefined}
+ updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
- Unlink the given accounts.
+ Update the app metadata for a user.
@@ -30998,7 +31670,7 @@ unlinkUser
Source:
Parameters:
- Linked users data.
+ The user data object..
@@ -31112,33 +31784,15 @@ Parameters:
- Primary user ID.
+ The user id.
+
+
-
-
- provider
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Identity provider in use.
@@ -31147,32 +31801,32 @@ Parameters:
- user_idmetadata
-String
+Object
+
+
-
+
-
- Secondary user ID.
-
-
+
+
-
-
-
+
+
+ New app metadata.
@@ -31208,7 +31862,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -31259,14 +31913,18 @@ Returns:
Example
- var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
+ var params = { id: USER_ID };
+var metadata = {
+ foo: 'bar'
+};
-management.unlinkUsers(params, function (err, user) {
+management.updateAppMetadata(params, metadata, function (err, user) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // Updated user.
+ console.log(user);
});
@@ -31278,14 +31936,14 @@ Example
- updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
+ updateBrandingSettings(params, data, cbopt) → {Promise|undefined}
- Update the app metadata for a user.
+ Update the branding settings.
@@ -31321,7 +31979,7 @@ upda
Source:
Parameters:
- The user data object..
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- The user id.
-
-
-
-
-
-
-
-
+ Branding parameters.
@@ -31452,7 +32059,7 @@ Parameters:
- metadatadata
@@ -31477,7 +32084,7 @@ Parameters:
- New app metadata.
+ Updated branding data.
@@ -31513,7 +32120,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -31564,18 +32171,13 @@ Returns:
Example
- var params = { id: USER_ID };
-var metadata = {
- foo: 'bar'
-};
-
-management.updateAppMetadata(params, metadata, function (err, user) {
+ management.updateBrandingSettings(data, function (err, branding) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+// Updated branding
+ console.log(branding);
});
@@ -31587,14 +32189,14 @@ Example
- updateBrandingSettings(params, data, cbopt) → {Promise|undefined}
+ updateClient(params, data, cbopt) → {Promise|undefined}
- Update the branding settings.
+ Update an Auth0 client.
@@ -31630,7 +32232,7 @@ Source:
Parameters:
- Branding parameters.
+ Client parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Application client ID.
+
+
+
+
+
+
+
+
@@ -31735,7 +32388,7 @@ Parameters:
- Updated branding data.
+ Updated client data.
@@ -31822,13 +32475,15 @@ Returns:
Example
- management.updateBrandingSettings(data, function (err, branding) {
+ var data = { name: 'newClientName' };
+var params = { client_id: CLIENT_ID };
+
+management.updateClient(params, data, function (err, client) {
if (err) {
// Handle error.
}
-// Updated branding
- console.log(branding);
+ console.log(client.name); // 'newClientName'
});
@@ -31840,14 +32495,14 @@ Example
- updateClient(params, data, cbopt) → {Promise|undefined}
+ updateClientGrant(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client.
+ Update an Auth0 client grant.
@@ -31883,7 +32538,7 @@ updateCli
Source:
Parameters:
- client_idid
@@ -31997,7 +32652,7 @@ Parameters:
- Application client ID.
+ Client grant ID.
@@ -32126,15 +32781,19 @@ Returns:
Example
- var data = { name: 'newClientName' };
-var params = { client_id: CLIENT_ID };
+ var data = {
+ client_id: CLIENT_ID,
+ audience: AUDIENCE,
+ scope: []
+};
+var params = { id: CLIENT_GRANT_ID };
-management.updateClient(params, data, function (err, client) {
+management.clientGrants.update(params, data, function (err, grant) {
if (err) {
// Handle error.
}
- console.log(client.name); // 'newClientName'
+ console.log(grant.id);
});
@@ -32146,14 +32805,14 @@ Example
- updateClientGrant(params, data, cbopt) → {Promise|undefined}
+ updateConnection(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client grant.
+ Update an existing connection.
@@ -32189,7 +32848,7 @@ upda
Source:
Parameters:
- Client parameters.
+ Connection parameters.
@@ -32303,7 +32962,7 @@ Parameters:
- Client grant ID.
+ Connection ID.
@@ -32345,7 +33004,7 @@ Parameters:
- Updated client data.
+ Updated connection data.
@@ -32432,19 +33091,15 @@ Returns:
Example
- var data = {
- client_id: CLIENT_ID,
- audience: AUDIENCE,
- scope: []
-};
-var params = { id: CLIENT_GRANT_ID };
+ var data = { name: 'newConnectionName' };
+var params = { id: CONNECTION_ID };
-management.clientGrants.update(params, data, function (err, grant) {
+management.updateConnection(params, data, function (err, connection) {
if (err) {
// Handle error.
}
- console.log(grant.id);
+ console.log(connection.name); // 'newConnectionName'
});
@@ -32456,14 +33111,14 @@ Example
- updateConnection(params, data, cbopt) → {Promise|undefined}
+ updateEmailProvider(params, data, cbopt) → {Promise|undefined}
- Update an existing connection.
+ Update the email provider.
@@ -32499,7 +33154,7 @@ updat
Source:
Parameters:
- Connection parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Connection ID.
-
-
-
-
-
-
-
-
+ Email provider parameters.
@@ -32655,7 +33259,7 @@ Parameters:
- Updated connection data.
+ Updated email provider data.
@@ -32742,15 +33346,13 @@ Returns:
Example
- var data = { name: 'newConnectionName' };
-var params = { id: CONNECTION_ID };
-
-management.updateConnection(params, data, function (err, connection) {
+ management.updateEmailProvider(params, data, function (err, provider) {
if (err) {
// Handle error.
}
- console.log(connection.name); // 'newConnectionName'
+ // Updated email provider.
+ console.log(provider);
});
@@ -32762,14 +33364,14 @@ Example
- updateEmailProvider(params, data, cbopt) → {Promise|undefined}
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
- Update the email provider.
+ Update an existing Email Template.
@@ -32805,7 +33407,7 @@ up
Source:
Parameters:
- Email provider parameters.
+ Email Template parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Template Name
+
+
+
+
+
+
+
+
@@ -32910,7 +33563,7 @@ Parameters:
- Updated email provider data.
+ Updated Email Template data.
@@ -32997,13 +33650,15 @@ Returns:
Example
- management.updateEmailProvider(params, data, function (err, provider) {
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
+
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
if (err) {
// Handle error.
}
- // Updated email provider.
- console.log(provider);
+ console.log(emailTemplate.from); // 'new@email.com'
});
@@ -33015,14 +33670,14 @@ Example
- updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+ updateFactorProvider(params, data, cbopt) → {Promise|undefined}
- Update an existing Email Template.
+ Update Guardian's factor provider
@@ -33058,7 +33713,7 @@ u
Source:
Parameters:
- Email Template parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- name
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Template Name
-
-
-
-
-
-
-
-
+ Factor provider parameters.
@@ -33214,7 +33818,7 @@ Parameters:
- Updated Email Template data.
+ Updated Factor provider data.
@@ -33301,15 +33905,12 @@ Returns:
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'
+ management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ messaging_service_sid: 'XXXXXXXXXXXXXX',
+ auth_token: 'XXXXXXXXXXXXXX',
+ sid: 'XXXXXXXXXXXXXX'
+}, function (err, provider) {
+ console.log(provider);
});
@@ -33321,14 +33922,14 @@ Example
- updateFactorProvider(params, data, cbopt) → {Promise|undefined}
+ updateGuardianFactor(params, data, cbopt) → {Promise|undefined}
- Update Guardian's factor provider
+ Update Guardian Factor
@@ -33364,7 +33965,7 @@ u
Source:
Parameters:
- Factor provider parameters.
+ Factor parameters.
@@ -33469,7 +34070,7 @@ Parameters:
- Updated Factor provider data.
+ Updated factor data.
@@ -33556,12 +34157,10 @@ Returns:
Example
- management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
- messaging_service_sid: 'XXXXXXXXXXXXXX',
- auth_token: 'XXXXXXXXXXXXXX',
- sid: 'XXXXXXXXXXXXXX'
-}, function (err, provider) {
- console.log(provider);
+ management.updateGuardianFactor({ name: 'sms' }, {
+ enabled: true
+}, function (err, factor) {
+ console.log(factor);
});
@@ -33573,14 +34172,14 @@ Example
- updateGuardianFactor(params, data, cbopt) → {Promise|undefined}
+ updateGuardianFactorSettings(params, data, cbopt) → {Promise|undefined}
- Update Guardian Factor
+ Update a Guardian's factor settings
@@ -33616,7 +34215,7 @@ u
Source:
Parameters:
- Updated factor data.
+ Updated Factor settings data.
@@ -33808,11 +34407,12 @@ Returns:
Example
- management.updateGuardianFactor({ name: 'sms' }, {
- enabled: true
-}, function (err, factor) {
- console.log(factor);
-});
+ management.updateGuardianFactorSettings(
+ { name: 'webauthn-roaming' },
+ { userVerification: 'discouraged', overrideRelyingParty: false },
+ function (err, settings) {
+ console.log(settings);
+})
@@ -33866,7 +34466,7 @@ Source:
Source:
Source:
Source:
updateHook<
Source:
upda
Source:
update
Source:
updat
Source:
Source:
u
Source:
updateRole<
Source:
u
Source:
updateUser<
Source:
upd
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index b621b25e3..4919f9306 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -673,7 +673,7 @@ Returns:
diff --git a/docs/module-management.MigrationsManager.html b/docs/module-management.MigrationsManager.html
index 38b1f4a2a..900408b09 100644
--- a/docs/module-management.MigrationsManager.html
+++ b/docs/module-management.MigrationsManager.html
@@ -24,7 +24,7 @@
@@ -885,7 +885,7 @@ Example
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index d4fbcdb43..ab697a17e 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -839,7 +839,7 @@ Source:
Source:
Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 28b71a9cc..4ad894547 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 823c01c7a..aea29a357 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -417,7 +417,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index b9ad9ff84..3f16d41df 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -925,7 +925,7 @@ assignRole
Source:
removeRole
Source:
Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index cab403ecf..18a1e2279 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 4ffc27c2c..2cecbae76 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 131f017f9..3c0ff047c 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 d34535860..605faa889 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 48cd03071..4c5ef7eec 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -1121,7 +1121,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index 052151bb2..1fa15aa21 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 88cca3bac..3de798f41 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -101,7 +101,7 @@ new Users
Source:
(
Source:
(i
Source:
Source:
(
Source:
Source:
(inn
Source:
(inner
Source:
(inner) Source:
(inner) <
Source:
createSource:
deleteSource:
deleteAllSource:
Source:
getSource:
getAllSource:
Example
- getByEmail(emailopt, cbopt) → {Promise|undefined}
+ getByEmail(emailopt, optionsopt, cbopt) → {Promise|undefined}
@@ -2620,7 +2620,7 @@ getByEmail<
Source:
Parameters:
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Additional options to pass to the endpoint
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ fields
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Comma-separated list of fields to include or exclude in the result
+
+
+
+
+
+
+
+
+ include_fields
+
+
+Boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Whether specified fields are to be included (true) or excluded (false). Defaults to true.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbSource:
getPerm
Source:
getUserRo
Source:
Source:
linkSource:
logsSource:
Source:
unlinkSource:
updateSource:
upda
Source:
upd
Source:
Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 5f2c56522..aebe1ff30 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index b0cb3d289..ada534b97 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -363,7 +363,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index d8f70666d..6fce3ff1d 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -140,7 +140,7 @@ utils.js
diff --git a/package.json b/package.json
index 52e46fd35..3b5bac15a 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.31.1",
+ "version": "2.32.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [