var ArgumentError = require('rest-facade').ArgumentError;
+var Auth0RestClient = require('../Auth0RestClient');
+var RetryRestClient = require('../RetryRestClient');
+
+/**
+ * @class
+ * Abstracts interaction with the migrations endpoint.
+ * @constructor
+ * @memberOf module:management
+ *
+ * @param {Object} options The client options.
+ * @param {String} options.baseUrl The URL of the API.
+ * @param {Object} [options.headers] Headers to be included in all requests.
+ * @param {Object} [options.retry] Retry Policy Config
+ */
+var MigrationsManager = function(options) {
+ if (options === null || typeof options !== 'object') {
+ throw new ArgumentError('Must provide manager options');
+ }
+
+ if (options.baseUrl === null || options.baseUrl === undefined) {
+ throw new ArgumentError('Must provide a base URL for the API');
+ }
+
+ if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
+ throw new ArgumentError('The provided base URL is invalid');
+ }
+
+ var clientOptions = {
+ errorFormatter: { message: 'message', name: 'error' },
+ headers: options.headers,
+ query: { repeatParams: false }
+ };
+
+ /**
+ * Provides an abstraction layer for consuming the migrations endpoint
+ *
+ * @type {external:RestClient}
+ */
+ var auth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/migrations',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.resource = new RetryRestClient(auth0RestClient, options.retry);
+};
+
+/**
+ * Update the tenant migrations.
+ *
+ * @method updateMigrations
+ * @memberOf module:management.MigrationsManager.prototype
+ *
+ * @example
+ * management.migrations.updateMigrations(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ * });
+ *
+ * @param {Object} data The tenant migrations to be updated
+ * @param {Object} data.flags The tenant migrations flags to be updated
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+MigrationsManager.prototype.updateMigrations = function(data, cb) {
+ if (cb && cb instanceof Function) {
+ return this.resource.patch({}, data, cb);
+ }
+
+ // Return a promise.
+ return this.resource.patch({}, data);
+};
+
+/**
+ * Get the tenant migrations.
+ *
+ * @method getMigrations
+ * @memberOf module:management.MigrationsManager.prototype
+ *
+ * @example
+ * management.migrations.getMigrations(function (err, migrations) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(migrations.flags);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+MigrationsManager.prototype.getMigrations = function(data, cb) {
+ if (data instanceof Function && !cb) {
+ cb = data;
+ data = {};
+ }
+ if (cb && cb instanceof Function) {
+ return this.resource.get(data, cb);
+ }
+
+ // Return a promise.
+ return this.resource.get(data);
+};
+
+module.exports = MigrationsManager;
+RetryRestClient.js
diff --git a/docs/auth_DatabaseAuthenticator.js.html b/docs/auth_DatabaseAuthenticator.js.html index 78562fd6f..50c2691f8 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 e8bf02cfe..1d7edecad 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 e8bf02cfe..1d7edecad 100644 --- a/docs/auth_OAUthWithIDTokenValidation.js.html +++ b/docs/auth_OAUthWithIDTokenValidation.js.html @@ -24,7 +24,7 @@
@@ -176,7 +176,7 @@
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html index 43a35860d..196538ac2 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 43a35860d..196538ac2 100644 --- a/docs/auth_OAuthAuthenticator.js.html +++ b/docs/auth_OAuthAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -455,7 +455,7 @@
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html index 48e468483..2ea3f28c3 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 48e468483..2ea3f28c3 100644 --- a/docs/auth_PasswordlessAuthenticator.js.html +++ b/docs/auth_PasswordlessAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -290,7 +290,7 @@
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html index 8ca8fa23e..a17deb0eb 100644 --- a/docs/auth_TokensManager.js.html +++ b/docs/auth_TokensManager.js.html @@ -24,7 +24,7 @@
auth/PasswordlessAuthenticator.js
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html index 8ca8fa23e..a17deb0eb 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 599c3cb7e..7966009b0 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 599c3cb7e..7966009b0 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 ef2bfa39e..78bc14975 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 ef2bfa39e..78bc14975 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 49a38a2c6..fe59b56e5 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 49a38a2c6..fe59b56e5 100644 --- a/docs/auth_index.js.html +++ b/docs/auth_index.js.html @@ -24,7 +24,7 @@
@@ -616,7 +616,7 @@
diff --git a/docs/errors.js.html b/docs/errors.js.html index 6edf5d72f..8d857b02f 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 6edf5d72f..8d857b02f 100644 --- a/docs/errors.js.html +++ b/docs/errors.js.html @@ -24,7 +24,7 @@
@@ -98,7 +98,7 @@
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html index 3930cff30..367c4fd95 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 3930cff30..367c4fd95 100644 --- a/docs/external-RestClient.html +++ b/docs/external-RestClient.html @@ -24,7 +24,7 @@
@@ -1639,7 +1639,7 @@
diff --git a/docs/global.html b/docs/global.html
index bb94f4083..556f24c64 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 768f89694..bb6079b43 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@ License
diff --git a/docs/index.js.html b/docs/index.js.html
index 5bb5b704e..cfe718959 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 565a071bb..c06071bf7 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 f532a24db..1911f0890 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 1cea85dd3..7eb5c7028 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 e464f8b7b..fe89b2a6c 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 4ebb02ff7..7158c8534 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -91,6 +91,20 @@ management/ConnectionsManager.js
options.tokenProvider
);
this.resource = new RetryRestClient(auth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for consuming the
+ * {@link https://auth0.com/docs/api/management/v2#!/Connections/delete_users_by_email
+ * endpoint}.
+ *
+ * @type {external:RestClient}
+ */
+ var userAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/connections/:id/users',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.user = new RetryRestClient(userAuth0RestClient, options.retry);
};
/**
@@ -219,6 +233,44 @@ management/ConnectionsManager.js
*/
utils.wrapPropertyMethod(ConnectionsManager, 'delete', 'resource.delete');
+/**
+ * Delete a connection user by email.
+ *
+ * @method delete
+ * @memberOf module:management.ConnectionsManager.prototype
+ *
+ * @example
+ * management.connections.deleteUserByEmail({ id: CONNECTION_ID, email:USER_EMAIL }, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // User deleted.
+ * });
+ *
+ * @param {Object} params Connection parameters.
+ * @param {String} params.id Connection ID.
+ * @param {String} params.email User Email.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+ConnectionsManager.prototype.deleteUserByEmail = function(params, cb) {
+ if (typeof params !== 'object' || typeof params.email !== 'string' || params.email.length < 1) {
+ throw new ArgumentError('You must provide an email for the deleteUserByEmail method');
+ }
+
+ if (!params.id) {
+ throw new ArgumentError('The connection id cannot be null or undefined');
+ }
+
+ if (cb && cb instanceof Function) {
+ return this.user.delete(params, {}, cb);
+ }
+
+ return this.user.delete(params, {});
+};
+
module.exports = ConnectionsManager;
@@ -232,7 +284,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index 4bac7dbf5..a9300b0ac 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 53e57c86a..848f2a5b1 100644
--- a/docs/management_DeviceCredentialsManager.js.html
+++ b/docs/management_DeviceCredentialsManager.js.html
@@ -24,7 +24,7 @@
@@ -177,7 +177,7 @@ management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
index dc419b218..24f773e06 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 ebc3cd703..e2d4179f0 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 ce44bde42..cb016f847 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 118ac3d2f..6778a9939 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -117,7 +117,7 @@ management/GuardianManager.js
this.factors = new RetryRestClient(guardianFactorsAuth0RestClient, options.retry);
/**
- * Provides an abstraction layer for retrieving Guardian factors.
+ * Provides an abstraction layer for retrieving Guardian factor templates.
*
* @type {external:RestClient}
*/
@@ -145,6 +145,48 @@ management/GuardianManager.js
guardianFactorsProvidersAuth0RestClient,
options.retry
);
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian policies.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianPoliciesAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/policies',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.policies = new RetryRestClient(guardianPoliciesAuth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian phone factor selected provider.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorsPhoneSelectedProviderAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/sms/selected-provider',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factorsPhoneSelectedProvider = new RetryRestClient(
+ guardianFactorsPhoneSelectedProviderAuth0RestClient,
+ options.retry
+ );
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian phone factor message types.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorsPhoneMessageTypesAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/phone/message-types',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factorsPhoneMessageTypes = new RetryRestClient(
+ guardianFactorsPhoneMessageTypesAuth0RestClient,
+ options.retry
+ );
};
/**
@@ -208,6 +250,7 @@ management/GuardianManager.js
* @method getFactors
* @memberOf module:management.GuardianManager.prototype
*
+ * @example
* management.guardian.getFactors(function (err, factors) {
* console.log(factors.length);
* });
@@ -224,6 +267,7 @@ management/GuardianManager.js
* @method getFactorProvider
* @memberOf module:management.GuardianManager.prototype
*
+ * @example
* management.guardian.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
* console.log(provider);
* });
@@ -241,12 +285,13 @@ management/GuardianManager.js
* @method updateFactorProvider
* @memberOf module:management.GuardianManager.prototype
*
+ * @example
* management.guardian.updateFactorProvider({ name: 'sms', provider: 'twilio' }, {
- * messaging_service_sid: 'XXXXXXXXXXXXXX',
- * auth_token: 'XXXXXXXXXXXXXX',
- * sid: 'XXXXXXXXXXXXXX'
- * }, function(err, provider) {
- * console.log(provider);
+ * messaging_service_sid: 'XXXXXXXXXXXXXX',
+ * auth_token: 'XXXXXXXXXXXXXX',
+ * sid: 'XXXXXXXXXXXXXX'
+ * }, function (err, provider) {
+ * console.log(provider);
* });
*
* @param {Object} params Factor provider parameters.
@@ -263,6 +308,7 @@ management/GuardianManager.js
* @method getFactorTemplates
* @memberOf module:management.GuardianManager.prototype
*
+ * @example
* management.guardian.getFactorTemplates({ name: 'sms' }, function (err, templates) {
* console.log(templates);
* });
@@ -280,11 +326,12 @@ management/GuardianManager.js
* @method updateFactorTemplates
* @memberOf module:management.GuardianManager.prototype
*
+ * @example
* management.guardian.updateFactorProvider({ name: 'sms' }, {
- * enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
- * verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
- * }, function(err, templates) {
- * console.log(templates);
+ * enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ * verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+ * }, function (err, templates) {
+ * console.log(templates);
* });
*
* @param {Object} params Factor parameters.
@@ -301,10 +348,11 @@ management/GuardianManager.js
* @method updateFactor
* @memberOf module:management.GuardianManager.prototype
*
+ * @example
* management.guardian.updateFactor({ name: 'sms' }, {
- * enabled: true
- * }, function(err, factor) {
- * console.log(factor);
+ * enabled: true
+ * }, function (err, factor) {
+ * console.log(factor);
* });
*
* @param {Object} params Factor parameters.
@@ -315,6 +363,138 @@ management/GuardianManager.js
*/
utils.wrapPropertyMethod(GuardianManager, 'updateFactor', 'factors.update');
+/**
+ * Get enabled Guardian policies
+ *
+ * @method getPolicies
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.guardian.getPolicies(function (err, policies) {
+ * console.log(policies);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'getPolicies', 'policies.get');
+
+/**
+ * Update enabled Guardian policies
+ *
+ * @method updatePolicies
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.guardian.updatePolicies({}, [
+ * 'all-applications'
+ * ], function (err, policies) {
+ * console.log(policies);
+ * });
+ *
+ * @param {Object} params Parameters.
+ * @param {String[]} data Policies to enable. Empty array disables all policies.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'updatePolicies', 'policies.update');
+
+/**
+ * Get the Guardian phone factor's selected provider
+ *
+ * @method getPhoneFactorSelectedProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.guardian.getPhoneFactorSelectedProvider(function (err, selectedProvider) {
+ * console.log(selectedProvider);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ GuardianManager,
+ 'getPhoneFactorSelectedProvider',
+ 'factorsPhoneSelectedProvider.get'
+);
+
+/**
+ * Update the Guardian phone factor's selected provider
+ *
+ * @method updatePhoneFactorSelectedProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.guardian.updatePhoneFactorSelectedProvider({}, {
+ * provider: 'twilio'
+ * }, function (err, factor) {
+ * console.log(factor);
+ * });
+ *
+ * @param {Object} params Parameters.
+ * @param {Object} data Updated selected provider data.
+ * @param {String} data.provider Name of the selected provider
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ GuardianManager,
+ 'updatePhoneFactorSelectedProvider',
+ 'factorsPhoneSelectedProvider.update'
+);
+
+/**
+ * Get the Guardian phone factor's message types
+ *
+ * @method getPhoneFactorMessageTypes
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.guardian.getPhoneFactorMessageTypes(function (err, messageTypes) {
+ * console.log(messageTypes);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ GuardianManager,
+ 'getPhoneFactorMessageTypes',
+ 'factorsPhoneMessageTypes.get'
+);
+
+/**
+ * Update the Guardian phone factor's message types
+ *
+ * @method updatePhoneFactorMessageTypes
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.guardian.updatePhoneFactorMessageTypes({}, {
+ * message_types: ['sms', 'voice']
+ * }, function (err, factor) {
+ * console.log(factor);
+ * });
+ *
+ * @param {Object} params Parameters.
+ * @param {Object} data Updated selected provider data.
+ * @param {String[]} data.message_types Message types (only `"sms"` and `"voice"` are supported).
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ GuardianManager,
+ 'updatePhoneFactorMessageTypes',
+ 'factorsPhoneMessageTypes.update'
+);
+
module.exports = GuardianManager;
@@ -328,7 +508,7 @@ management/GuardianManager.js
diff --git a/docs/management_HooksManager.js.html b/docs/management_HooksManager.js.html
index ecdf7d6dc..52592eb2e 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 c9177f7bc..5cfbf6a29 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -433,7 +433,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 8a4bceca0..686faeace 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 72b15b63e..8c4b3a446 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -192,7 +192,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_MigrationsManager.js.html b/docs/management_MigrationsManager.js.html
new file mode 100644
index 000000000..ba5a95915
--- /dev/null
+++ b/docs/management_MigrationsManager.js.html
@@ -0,0 +1,168 @@
+
+
+
+
+
+ management/MigrationsManager.js - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ management/MigrationsManager.js
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html
index b18c1a38f..123d6c069 100644
--- a/docs/management_PromptsManager.js.html
+++ b/docs/management_PromptsManager.js.html
@@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@ management/PromptsManager.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index e1b3ec326..41bb4610a 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 80cc164c7..5584a7771 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 acb2b2484..ac7d0ba88 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 de0cea670..9c61f6235 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 172d03431..97756bc56 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 27f725980..633e4790d 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 56ce24fd8..39ce3ee0f 100644
--- a/docs/management_TicketsManager.js.html
+++ b/docs/management_TicketsManager.js.html
@@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@ management/TicketsManager.js
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html
index c08308c17..0a846aed4 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 8841c2eec..59b1756af 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -927,7 +927,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index 7e588c5eb..2db99c597 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -73,6 +73,7 @@ management/index.js
var RolesManager = require('./RolesManager');
var HooksManager = require('./HooksManager');
var BrandingManager = require('./BrandingManager');
+var MigrationsManager = require('./MigrationsManager');
var BASE_URL_FORMAT = 'https://%s/api/v2';
var MANAGEMENT_API_AUD_FORMAT = 'https://%s/api/v2/';
@@ -368,6 +369,13 @@ management/index.js
* @type {HooksManager}
*/
this.branding = new BrandingManager(managerOptions);
+
+ /**
+ * ManagementClient migrations manager.
+ *
+ * @type {MigrationsManager}
+ */
+ this.migrations = new MigrationsManager(managerOptions);
};
/**
@@ -2599,7 +2607,7 @@ management/index.js
utils.wrapPropertyMethod(
ManagementClient,
'createGuardianEnrollmentTicket',
- 'guardian.tickets.create'
+ 'guardian.createEnrollmentTicket'
);
/**
@@ -2608,6 +2616,7 @@ management/index.js
* @method getGuardianFactors
* @memberOf module:management.ManagementClient.prototype
*
+ * @example
* management.getGuardianFactors(function (err, factors) {
* console.log(factors.length);
* });
@@ -2616,7 +2625,7 @@ management/index.js
*
* @return {Promise|undefined}
*/
-utils.wrapPropertyMethod(ManagementClient, 'getGuardianFactors', 'guardian.factors.getAll');
+utils.wrapPropertyMethod(ManagementClient, 'getGuardianFactors', 'guardian.getFactors');
/**
* Get Guardian factor provider configuration
@@ -2624,6 +2633,7 @@ management/index.js
* @method getGuardianFactorProvider
* @memberOf module:management.ManagementClient.prototype
*
+ * @example
* management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
* console.log(provider);
* });
@@ -2636,7 +2646,7 @@ management/index.js
utils.wrapPropertyMethod(
ManagementClient,
'getGuardianFactorProvider',
- 'guardian.factorsProviders.get'
+ 'guardian.getFactorProvider'
);
/**
@@ -2645,12 +2655,13 @@ management/index.js
* @method updateFactorProvider
* @memberOf module:management.ManagementClient.prototype
*
+ * @example
* management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
- * messaging_service_sid: 'XXXXXXXXXXXXXX',
- * auth_token: 'XXXXXXXXXXXXXX',
- * sid: 'XXXXXXXXXXXXXX'
- * }, function(err, provider) {
- * console.log(provider);
+ * messaging_service_sid: 'XXXXXXXXXXXXXX',
+ * auth_token: 'XXXXXXXXXXXXXX',
+ * sid: 'XXXXXXXXXXXXXX'
+ * }, function (err, provider) {
+ * console.log(provider);
* });
*
* @param {Object} params Factor provider parameters.
@@ -2662,7 +2673,7 @@ management/index.js
utils.wrapPropertyMethod(
ManagementClient,
'updateGuardianFactorProvider',
- 'guardian.factorsProviders.update'
+ 'guardian.updateFactorProvider'
);
/**
@@ -2671,6 +2682,7 @@ management/index.js
* @method getGuardianFactorTemplates
* @memberOf module:management.ManagementClient.prototype
*
+ * @example
* management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
* console.log(templates);
* });
@@ -2683,7 +2695,7 @@ management/index.js
utils.wrapPropertyMethod(
ManagementClient,
'getGuardianFactorTemplates',
- 'guardian.factorsTemplates.get'
+ 'guardian.getFactorTemplates'
);
/**
@@ -2692,11 +2704,12 @@ management/index.js
* @method updateGuardianFactorTemplates
* @memberOf module:management.ManagementClient.prototype
*
+ * @example
* management.updateGuardianFactorTemplates({ name: 'sms' }, {
- * enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
- * verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
- * }, function(err, templates) {
- * console.log(templates);
+ * enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ * verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+ * }, function (err, templates) {
+ * console.log(templates);
* });
*
* @param {Object} params Factor parameters.
@@ -2708,7 +2721,7 @@ management/index.js
utils.wrapPropertyMethod(
ManagementClient,
'updateGuardianFactorTemplates',
- 'guardian.factorsTemplates.update'
+ 'guardian.updateFactorTemplates'
);
/**
@@ -2717,10 +2730,11 @@ management/index.js
* @method updateGuardianFactor
* @memberOf module:management.ManagementClient.prototype
*
+ * @example
* management.updateGuardianFactor({ name: 'sms' }, {
- * enabled: true
- * }, function(err, factor) {
- * console.log(factor);
+ * enabled: true
+ * }, function (err, factor) {
+ * console.log(factor);
* });
*
* @param {Object} params Factor parameters.
@@ -2729,7 +2743,139 @@ management/index.js
*
* @return {Promise|undefined}
*/
-utils.wrapPropertyMethod(ManagementClient, 'updateGuardianFactor', 'guardian.factors.update');
+utils.wrapPropertyMethod(ManagementClient, 'updateGuardianFactor', 'guardian.updateFactor');
+
+/**
+ * Get enabled Guardian policies
+ *
+ * @method getGuardianPolicies
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.getGuardianPolicies(function (err, policies) {
+ * console.log(policies);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getGuardianPolicies', 'guardian.getPolicies');
+
+/**
+ * Update enabled Guardian policies
+ *
+ * @method updateGuardianPolicies
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.updateGuardianPolicies({}, [
+ * 'all-applications'
+ * ], function (err, policies) {
+ * console.log(policies);
+ * });
+ *
+ * @param {Object} params Parameters.
+ * @param {String[]} data Policies to enable. Empty array disables all policies.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'updateGuardianPolicies', 'guardian.updatePolicies');
+
+/**
+ * Get the Guardian phone factor's selected provider
+ *
+ * @method getGuardianPhoneFactorSelectedProvider
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.getGuardianPhoneFactorSelectedProvider(function (err, selectedProvider) {
+ * console.log(selectedProvider);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'getGuardianPhoneFactorSelectedProvider',
+ 'guardian.getPhoneFactorSelectedProvider'
+);
+
+/**
+ * Update the Guardian phone factor's selected provider
+ *
+ * @method updateGuardianPhoneFactorSelectedProvider
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.updateGuardianPhoneFactorSelectedProvider({}, {
+ * provider: 'twilio'
+ * }, function (err, factor) {
+ * console.log(factor);
+ * });
+ *
+ * @param {Object} params Parameters.
+ * @param {Object} data Updated selected provider data.
+ * @param {String} data.provider Name of the selected provider
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'updateGuardianPhoneFactorSelectedProvider',
+ 'guardian.updatePhoneFactorSelectedProvider'
+);
+
+/**
+ * Get the Guardian phone factor's message types
+ *
+ * @method getGuardianPhoneFactorMessageTypes
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.getGuardianPhoneFactorMessageTypes(function (err, messageTypes) {
+ * console.log(messageTypes);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'getGuardianPhoneFactorMessageTypes',
+ 'guardian.getPhoneFactorMessageTypes'
+);
+
+/**
+ * Update the Guardian phone factor's message types
+ *
+ * @method updateGuardianPhoneFactorMessageTypes
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.updateGuardianPhoneFactorMessageTypes({}, {
+ * message_types: ['sms', 'voice']
+ * }, function (err, factor) {
+ * console.log(factor);
+ * });
+ *
+ * @param {Object} params Parameters.
+ * @param {Object} data Updated selected provider data.
+ * @param {String[]} data.message_types Message types (only `"sms"` and `"voice"` are supported).
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'updateGuardianPhoneFactorMessageTypes',
+ 'guardian.updatePhoneFactorMessageTypes'
+);
/**
* Get all roles.
@@ -3247,6 +3393,52 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'getBrandingSettings', 'branding.getSettings');
+/**
+ * Update the tenant migrations.
+ *
+ * @method updateMigrations
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * data = { flags: { migration: true } };
+ * management.updateMigrations(data, function (err, migrations) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Updated migrations flags
+ * console.log(migrations.flags);
+ * });
+ *
+ * @param {Object} data Updated migrations data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'updateMigrations', 'migrations.updateMigrations');
+
+/**
+ * Get migrations flags
+ *
+ * @method getMigrations
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.getMigrations(function (err, migrations) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Migration flags
+ * console.log(migrations.flags);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getMigrations', 'migrations.getMigrations');
+
module.exports = ManagementClient;
@@ -3260,7 +3452,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index c4319b5ee..af6ccbe6c 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 b5f950710..0c5ab04f4 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 7ed87cdf9..1b380ad43 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 3b4b8ff4e..d83585d87 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 eaa3a4d56..af4ec6aa9 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1442,7 +1442,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index faa106317..67f4453c4 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 2db164ef0..25fbfac3d 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 10c177b4b..9dbcb7f98 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 587ea3600..6338e1f35 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 2135922ef..95464f08e 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 87e242ebd..60363e269 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 0b34dccea..4e2ab855e 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 fde48120a..163a612ed 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 bc6bdcb9b..95e8ee063 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -484,6 +484,81 @@ Type:
+
+
+
+
+
+(inner) userAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the
+endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
@@ -541,7 +616,7 @@ createSource:
deleteSource:
Example
+
+
+
+
+ delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete a connection user by email.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Connection parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Connection ID.
+
+
+
+
+
+
+
+
+ email
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ User Email.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.connections.deleteUserByEmail({ id: CONNECTION_ID, email:USER_EMAIL }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // User deleted.
+});
+
+
+
+
+
+
@@ -1028,7 +1398,7 @@ getSource:
getAllSource:
updateSource:
Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 03ffd315c..0f056861a 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 ebd9db73e..852d95b86 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 41f18b371..695997f42 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 27ad509a8..19caed12c 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 fa71e19f3..a47960d4e 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -24,7 +24,7 @@
@@ -842,7 +842,7 @@ deleteGran
Source:
Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index f77df6f02..ec3e5a723 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -464,6 +464,154 @@ external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorsPhoneMessageTypesAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian phone factor message types.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorsPhoneSelectedProviderAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian phone factor selected provider.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
@@ -567,7 +715,7 @@
- Provides an abstraction layer for retrieving Guardian factors.
+ Provides an abstraction layer for retrieving Guardian factor templates.
@@ -612,6 +760,80 @@ external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianPoliciesAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian policies.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
@@ -761,7 +983,7 @@ Source:
Source:
Example
- getGuardianEnrollment(data, cbopt) → {Promise|undefined}
+ getFactorProvider(params, cbopt) → {Promise|undefined}
- Get a single Guardian enrollment.
+ Get Guardian factor provider configuration
@@ -1206,7 +1428,7 @@
Source:
Parameters:
- dataparams
@@ -1277,50 +1499,43 @@ Parameters:
- The user data object.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- The user id.
+ Callback function.
@@ -1329,7 +1544,2515 @@ Parameters:
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
+
+
+
+
+
+
+ getFactors(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a list of factors and statuses.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getFactors(function (err, factors) {
+ console.log(factors.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getFactorTemplates(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get Guardian enrollment and verification factor templates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor parameters.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getFactorTemplates({ name: 'sms' }, function (err, templates) {
+ console.log(templates);
+});
+
+
+
+
+
+
+
+
+
+
+ getGuardianEnrollment(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a single Guardian enrollment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The user data object.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ console.log(enrollment);
+});
+
+
+
+
+
+
+
+
+
+
+ getPhoneFactorMessageTypes(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the Guardian phone factor's message types
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getPhoneFactorMessageTypes(function (err, messageTypes) {
+ console.log(messageTypes);
+});
+
+
+
+
+
+
+
+
+
+
+ getPhoneFactorSelectedProvider(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the Guardian phone factor's selected provider
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getPhoneFactorSelectedProvider(function (err, selectedProvider) {
+ console.log(selectedProvider);
+});
+
+
+
+
+
+
+
+
+
+
+ getPolicies(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get enabled Guardian policies
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getPolicies(function (err, policies) {
+ console.log(policies);
+});
+
+
+
+
+
+
+
+
+
+
+ updateFactor(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian Factor
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated factor data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updateFactor({ name: 'sms' }, {
+ enabled: true
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updateFactorProvider(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian's factor provider
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor provider parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Factor provider data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updateFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ messaging_service_sid: 'XXXXXXXXXXXXXX',
+ auth_token: 'XXXXXXXXXXXXXX',
+ sid: 'XXXXXXXXXXXXXX'
+}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
+
+
+
+
+
+
+ updateFactorTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian enrollment and verification factor templates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated factor templates data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updateFactorProvider({ name: 'sms' }, {
+ enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+}, function (err, templates) {
+ console.log(templates);
+});
+
+
+
+
+
+
+
+
+
+
+ updatePhoneFactorMessageTypes(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the Guardian phone factor's message types
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ message_types
+
+
+Array.<String>
+
+
+
+
+
+
+
+
+
+
+ Message types (only "sms" and "voice" are supported).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updatePhoneFactorMessageTypes({}, {
+ message_types: ['sms', 'voice']
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updatePhoneFactorSelectedProvider(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the Guardian phone factor's selected provider
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Name of the selected provider
+
+
+
+
+
+
+
+
+
@@ -1415,8 +4138,260 @@ Returns:
Example
- management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
- console.log(enrollment);
+ management.guardian.updatePhoneFactorSelectedProvider({}, {
+ provider: 'twilio'
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updatePolicies(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update enabled Guardian policies
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Array.<String>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Policies to enable. Empty array disables all policies.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updatePolicies({}, [
+ 'all-applications'
+], function (err, policies) {
+ console.log(policies);
});
@@ -1440,7 +4415,7 @@ Example
diff --git a/docs/module-management.HooksManager.html b/docs/module-management.HooksManager.html
index 9facca9da..dcf47a8d6 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 b489005bd..debe93a8b 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -2676,7 +2676,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index ee8687280..084e7a64d 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 700e3ee3e..7767f2f9c 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -106,7 +106,7 @@ new M
Source:
blac
Source:
brandingSource:
clientGra
Source:
clientsSource:
connection
Source:
customDo
Source:
devi
Source:
emailPro
Source:
emailTe
Source:
grantsSource:
guardianSource:
hooksSource:
jobsSource:
logsSource:
Type:
+
+
+
+
+
+migrations :MigrationsManager
+
+
+
+
+
+ ManagementClient migrations manager.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
MigrationsManager
+
+
+
+
+
+
+
+
+
@@ -1811,7 +1885,7 @@ resour
Source:
rolesSource:
rulesSource:
rulesConf
Source:
statsSource:
tenantSource:
ticketsSource:
userBlocks<
Source:
usersSource:
addHookS
Source:
a
Source:
Source:
assi
Source:
blackli
Source:
Source:
createCli
Source:
crea
Source:
creat
Source:
cre
Source:
Source:
cr
Source:
Source:
Source:
createHook<
Source:
Source:
c
Source:
createRole<
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
+
+
+
+
+
+
+ getGuardianFactors(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a list of Guardian factors and statuses.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
cbReturns:
Example
- management.getHook({ id: HOOK_ID }, function (err, hook) {
- if (err) {
- // Handle error.
- }
-
- console.log(hook);
+ management.getGuardianFactors(function (err, factors) {
+ console.log(factors.length);
});
@@ -16825,14 +17024,14 @@ Example
- getHooks(paramsopt, cbopt) → {Promise|undefined}
+ getGuardianFactorTemplates(params, cbopt) → {Promise|undefined}
- Get all hooks.
+ Get Guardian enrollment and verification factor templates
@@ -16868,7 +17067,7 @@ getHooksSource:
Parameters:
- <optional>
-
@@ -16941,41 +17138,22 @@ Parameters:
- Hooks parameters.
+ Factor parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+
+
-
- per_pagecb
-Number
+function
@@ -16996,57 +17174,157 @@ Parameters:
- Number of results per page.
+ Callback function.
+
+
-
-
- page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
+ console.log(templates);
+});
+
+
+
+
+
+
-
- Page number, zero indexed.
-
-
-
+
+
+ getGuardianPhoneFactorMessageTypes(cbopt) → {Promise|undefined}
-
-
-
-
-
+
+
+
+ Get the Guardian phone factor's message types
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
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.getGuardianPhoneFactorMessageTypes(function (err, messageTypes) {
+ console.log(messageTypes);
});
@@ -17152,14 +17418,14 @@ Example
- getHookSecrets(params, cbopt) → {Promise|undefined}
+ getGuardianPhoneFactorSelectedProvider(cbopt) → {Promise|undefined}
- Get an Auth0 hook's secrets.
+ Get the Guardian phone factor's selected provider
@@ -17195,7 +17461,7 @@ getHook
Source:
Parameters:
- paramscb
-Object
+function
@@ -17256,6 +17522,8 @@ Parameters:
+ <optional>
+
@@ -17266,64 +17534,157 @@ Parameters:
- Hook parameters.
+ Callback function.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
- Name
-
- Type
+
+
+
+Returns:
+
+ -
+ Type:
+
+ -
+
Promise
+|
+
+undefined
+
+
+
+
- Description
-
-
-
+
-
-
- id
-
-
-String
+
+Example
-
-
+ management.getGuardianPhoneFactorSelectedProvider(function (err, selectedProvider) {
+ console.log(selectedProvider);
+});
-
+
+
+
+
-
- Hook ID.
-
-
-
+
+
+ getGuardianPolicies(cbopt) → {Promise|undefined}
-
-
-
-
-
+
+
+
+ Get enabled Guardian policies
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
cbReturns:
Example
- var params = { id: HOOK_ID }
-management.getHookSecrets(params, function (err, secrets) {
- if (err) {
- // Handle error.
- }
-
- console.log(secrets);
+ management.getGuardianPolicies(function (err, policies) {
+ console.log(policies);
});
@@ -17422,14 +17778,14 @@ Example
- getJob(params, cbopt) → {Promise|undefined}
+ getHook(params, cbopt) → {Promise|undefined}
- Get a job by its ID.
+ Get an Auth0 hook.
@@ -17465,7 +17821,7 @@ getJobSource:
Parameters:
- Job parameters.
+ Hook parameters.
@@ -17579,7 +17935,7 @@ Parameters:
- Job ID.
+ Hook ID.
@@ -17674,17 +18030,12 @@ Returns:
Example
- var params = {
- id: '{JOB_ID}'
-};
-
-management.getJob(params, function (err, job) {
+ management.getHook({ id: HOOK_ID }, function (err, hook) {
if (err) {
// Handle error.
}
- // Retrieved job.
- console.log(job);
+ console.log(hook);
});
@@ -17696,14 +18047,14 @@ Example
- getLog(params, cbopt) → {Promise|undefined}
+ getHooks(paramsopt, cbopt) → {Promise|undefined}
- Get an Auth0 log.
+ Get all hooks.
@@ -17739,7 +18090,7 @@ getLogSource:
Parameters:
+ <optional>
+
@@ -17810,7 +18163,7 @@ Parameters:
- Log parameters.
+ Hooks parameters.
@@ -17824,6 +18177,8 @@ Parameters:
Type
+ Attributes
+
@@ -17836,24 +18191,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- Event ID.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -17948,12 +18349,20 @@ Returns:
Example
- management.getLog({ id: EVENT_ID }, function (err, log) {
- 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(log);
+management.getHooks(params, function (err, hooks) {
+ console.log(hooks.length);
});
@@ -17965,14 +18374,14 @@ Example
- getLogs(paramsopt, cbopt) → {Promise|undefined}
+ getHookSecrets(params, cbopt) → {Promise|undefined}
- Get all logs.
+ Get an Auth0 hook's secrets.
@@ -18008,7 +18417,7 @@ getLogsSource:
Parameters:
- <optional>
-
@@ -18081,7 +18488,7 @@ Parameters:
- Logs params.
+ Hook parameters.
@@ -18095,8 +18502,6 @@ Parameters:
Type
- Attributes
-
@@ -18109,7 +18514,7 @@ Parameters:
- qid
@@ -18122,21 +18527,19 @@ Parameters:
-
-
- <optional>
-
-
+
+
+ Hook ID.
-
-
+
+
-
+
+
+
-
- Search Criteria using Query String Syntax
@@ -18145,13 +18548,13 @@ Parameters:
- pagecb
-Number
+function
@@ -18172,130 +18575,171 @@ Parameters:
- Page number. Zero based
+ Callback function.
+
+
-
-
- per_page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- The amount of entries per page
-
-
-
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
-
-
- sort
-
-
-String
+
+Example
-
-
+ var params = { id: HOOK_ID }
+management.getHookSecrets(params, function (err, secrets) {
+ if (err) {
+ // Handle error.
+ }
-
-
-
- <optional>
-
+ console.log(secrets);
+});
-
+
-
-
+
+
+
-
+
-
- The field to use for sorting.
-
-
-
+ getJob(params, cbopt) → {Promise|undefined}
-
-
- fields
-
-
-String
+
+ Get a job by its ID.
+
-
-
-
-
-
- <optional>
-
-
-
-
-
-
+
-
- A comma separated list of fields to include or exclude
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
- include_fieldsparams
-Boolean
+Object
@@ -18304,8 +18748,6 @@ Parameters:
- <optional>
-
@@ -18316,43 +18758,50 @@ Parameters:
- true if the fields specified are to be included in the result, false otherwise.
+ Job parameters.
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+ Description
+
+
+
+
- include_totalsid
-Boolean
+String
-
-
- <optional>
-
-
-
-
-
-
-
- true if a query summary must be included in the result, false otherwise. Default false
+ Job ID.
@@ -18447,20 +18896,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);
});
@@ -18472,14 +18918,14 @@ Example
- getPermissionsInRole(roleIdopt, cbopt) → {Promise|undefined}
+ getLog(params, cbopt) → {Promise|undefined}
- Get permissions for a given role
+ Get an Auth0 log.
@@ -18515,7 +18961,7 @@ g
Source:
Parameters:
- roleIdparams
-String
+Object
@@ -18576,8 +19022,6 @@ Parameters:
- <optional>
-
@@ -18588,7 +19032,58 @@ Parameters:
- Id of the role
+ Log parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Event ID.
+
+
+
+
+
+
+
+
@@ -18673,18 +19168,14 @@ Returns:
-Examples
-
- var params = { id :'ROLE_ID'};
+Example
-
- This method takes a roleId and
- returns all permissions within that role
+
management.getLog({ id: EVENT_ID }, function (err, log) {
+ if (err) {
+ // Handle error.
+ }
-
-
- management.getPermissionsInRole(params, function (err, permissions) {
- console.log(permissions);
+ console.log(log);
});
@@ -18696,14 +19187,14 @@ Examples
- getResourceServer(params, cbopt) → {Promise|undefined}
+ getLogs(paramsopt, cbopt) → {Promise|undefined}
- Get a Resource Server.
+ Get all logs.
@@ -18739,7 +19230,7 @@ getR
Source:
Parameters:
+ <optional>
+
@@ -18810,7 +19303,7 @@ Parameters:
- Resource Server parameters.
+ Logs params.
@@ -18824,6 +19317,8 @@ Parameters:
Type
+ Attributes
+
@@ -18836,7 +19331,7 @@ Parameters:
- idq
@@ -18849,11 +19344,237 @@ Parameters:
+
+
+ <optional>
+
+
+
+
+
+
+
- Resource Server ID.
+ 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.
+
+
+
+
+
+
+
+
+ fields
+
+
+String
+
+
+
+
+
+
+
+
+ <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
@@ -18948,12 +19669,205 @@ Returns:
Example
- management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+
+ 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
+};
+
+management.getLogs(params, function (err, logs) {
+ console.log(logs.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getMigrations(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get migrations flags
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getMigrations(function (err, migrations) {
if (err) {
// Handle error.
}
- console.log(resourceServer);
+// Migration flags
+ console.log(migrations.flags);
});
@@ -18965,14 +19879,2210 @@ Example
- getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+ getPermissionsInRole(roleIdopt, cbopt) → {Promise|undefined}
- Get all resource servers.
+ Get permissions for a given role
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ roleId
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Id of the role
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Examples
+
+ var params = { id :'ROLE_ID'};
+
+
+ This method takes a roleId and
+ returns all permissions within that role
+
+
+
+ management.getPermissionsInRole(params, function (err, permissions) {
+ console.log(permissions);
+});
+
+
+
+
+
+
+
+
+
+
+ getResourceServer(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a Resource Server.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Resource Server parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Resource Server ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(resourceServer);
+});
+
+
+
+
+
+
+
+
+
+
+ getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all resource servers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Resource Servers parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.getResourceServers(params, function (err, resourceServers) {
+ console.log(resourceServers.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getRole(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get an Auth0 role.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Role parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Role ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getRole({ id: ROLE_ID }, function (err, role) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(role);
+});
+
+
+
+
+
+
+
+
+
+
+ getRoles(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all roles.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Roles parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.getRoles(params, function (err, roles) {
+ console.log(roles.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getRule(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get an Auth0 rule.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rule parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getRule({ id: RULE_ID }, function (err, rule) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(rule);
+});
+
+
+
+
+
+
+
+
+
+
+ getRules(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all rules.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Rules parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.getRules(params, function (err, rules) {
+ console.log(rules.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getRulesConfigs(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get rules config.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getRulesConfigs(function (err, rulesConfigs) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Get Rules Configs.
+});
+
+
+
+
+
+
+
+
+
+
+ getTenantSettings(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the tenant settings..
@@ -19008,7 +22118,7 @@ get
Source:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Resource Servers 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.getSettings(function (err, settings) {
+ if (err) {
+ // Handle error.
+ }
-management.getResourceServers(params, function (err, resourceServers) {
- console.log(resourceServers.length);
+ console.log(settings);
});
@@ -19292,14 +22259,14 @@ Example
- getRole(params, cbopt) → {Promise|undefined}
+ getUser(data, cbopt) → {Promise|undefined}
- Get an Auth0 role.
+ Get a user by its id.
@@ -19335,7 +22302,7 @@ getRoleSource:
Parameters:
- paramsdata
@@ -19406,7 +22373,7 @@ Parameters:
- Role parameters.
+ The user data object.
@@ -19449,7 +22416,7 @@ Parameters:
- Role ID.
+ The user id.
@@ -19544,12 +22511,8 @@ Returns:
Example
- management.getRole({ id: ROLE_ID }, function (err, role) {
- if (err) {
- // Handle error.
- }
-
- console.log(role);
+ management.getUser({ id: USER_ID }, function (err, user) {
+ console.log(user);
});
@@ -19561,14 +22524,14 @@ Example
- getRoles(paramsopt, cbopt) → {Promise|undefined}
+ getUserBlocks(params, cbopt) → {Promise|undefined}
- Get all roles.
+ Get user blocks by its id.
@@ -19604,7 +22567,7 @@ getRolesSource:
Parameters:
- <optional>
-
@@ -19677,7 +22638,7 @@ Parameters:
- Roles parameters.
+ The user data object..
@@ -19691,8 +22652,6 @@ Parameters:
Type
- Attributes
-
@@ -19705,70 +22664,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ The user id.
@@ -19812,7 +22725,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -19863,20 +22776,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.getUserBlocks({ id: USER_ID }, function (err, blocks) {
+ if (err) {
+ // Handle error.
+ }
-management.getRoles(params, function (err, roles) {
- console.log(roles.length);
+ console.log(blocks);
});
@@ -19888,14 +22793,14 @@ Example
- getRule(params, cbopt) → {Promise|undefined}
+ getUserBlocksByIdentifier(params, cbopt) → {Promise|undefined}
- Get an Auth0 rule.
+ Get user blocks by its identifier.
@@ -19931,7 +22836,7 @@ getRuleSource:
Parameters:
- Rule parameters.
+ The user data object..
@@ -20028,7 +22933,7 @@ Parameters:
- ididentifier
@@ -20045,7 +22950,7 @@ Parameters:
- Rule ID.
+ The user identifier, any of: username, phone_number, email.
@@ -20089,7 +22994,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -20140,12 +23045,12 @@ Returns:
Example
- management.getRule({ id: RULE_ID }, function (err, rule) {
+ management.getUserBlocksByIdentifier({ identifier: USER_ID }, function (err, blocks) {
if (err) {
// Handle error.
}
- console.log(rule);
+ console.log(blocks);
});
@@ -20157,14 +23062,14 @@ Example
- getRules(paramsopt, cbopt) → {Promise|undefined}
+ getUserLogs(params, cbopt) → {Promise|undefined}
- Get all rules.
+ Get user's log events.
@@ -20200,7 +23105,7 @@ getRulesSource:
Parameters:
- <optional>
-
@@ -20273,7 +23176,7 @@ Parameters:
- Rules parameters.
+ Get logs data.
@@ -20287,8 +23190,6 @@ Parameters:
Type
- Attributes
-
@@ -20301,28 +23202,44 @@ Parameters:
- per_pageid
-Number
+String
-
-
- <optional>
-
+
+
+
+ User id.
+
+
+
+
+
+
+ per_page
+
-
+Number
+
+
+
+
+
@@ -20350,21 +23267,63 @@ Parameters:
-
+
+
+
+
+ Page number, zero indexed.
- <optional>
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
- Page number, zero indexed.
+ true if a query summary must be included in the result, false otherwise. Default false;
@@ -20459,20 +23418,14 @@ 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
-};
+ var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-management.getRules(params, function (err, rules) {
- console.log(rules.length);
+management.getUserLogs(params, function (err, logs) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logs);
});
@@ -20484,14 +23437,14 @@ Example
- getRulesConfigs(cbopt) → {Promise|undefined}
+ getUserPermissions(params, cbopt) → {Promise|undefined}
- Get rules config.
+ Get user's permissions
@@ -20527,7 +23480,7 @@ getRul
Source:
Parameters:
- cbparams
-function
+Object
@@ -20588,8 +23541,6 @@ Parameters:
- <optional>
-
@@ -20600,159 +23551,166 @@ Parameters:
- Callback function.
+ Get permissions data.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
+
+
+
+
-
-
- -
- Type:
-
- -
+
Name
-Promise
-|
-undefined
+ Type
+
-
-
+
+ Description
+
+
+
-
-
+
+
+ idExample
-
- management.getRulesConfigs(function (err, rulesConfigs) {
- if (err) {
- // Handle error.
- }
+
+
+
+String
- // Get Rules Configs.
-});
-
+
+
-
-
-
-
+
- getTenantSettings(cbopt) → {Promise|undefined}
+
+ User id.
+
+
+
+
+
+ per_pageGet the tenant settings..
-
+
+
+
+Number
+
+
+
+
-
+
+ Number of results per page.
+
+
+
-
+
+
+ page
+
+
+Number
-
-
+
+
-
+
-
+
-
+
+ Page number, zero indexed.
+
+
+
-
+
+
+ sort
+
+
+String
-
-
- Source:
-
-
+
-
+
-
-
+
+ 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;
+
+
+
- Parameters:
+
+
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+
+
+
-
@@ -20835,12 +23793,14 @@ Returns:
Example
- management.getSettings(function (err, settings) {
+ 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(settings);
+ console.log(logs);
});
@@ -20852,14 +23812,14 @@ Example
- getUser(data, cbopt) → {Promise|undefined}
+ getUserRoles(params, cbopt) → {Promise|undefined}
- Get a user by its id.
+ Get user's roles
@@ -20895,7 +23855,7 @@ getUserSource:
Parameters:
- dataparams
@@ -20966,7 +23926,7 @@ Parameters:
- The user data object.
+ Get roles data.
@@ -21009,7 +23969,111 @@ Parameters:
- The user id.
+ 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;
@@ -21104,8 +24168,14 @@ Returns:
Example
- management.getUser({ id: USER_ID }, function (err, user) {
- console.log(user);
+ 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);
});
@@ -21117,14 +24187,14 @@ Example
- getUserBlocks(params, cbopt) → {Promise|undefined}
+ getUsers(paramsopt, cbopt) → {Promise|undefined}
- Get user blocks by its id.
+ Get all users.
@@ -21160,7 +24230,7 @@ getUserB
Source:
Parameters:
+ <optional>
+
@@ -21231,7 +24303,7 @@ Parameters:
- The user data object..
+ Users params.
@@ -21245,6 +24317,8 @@ Parameters:
Type
+ Attributes
+
@@ -21257,7 +24331,43 @@ Parameters:
- idsearch_engine
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The version of the search engine to use.
+
+
+
+
+
+
+
+
+ q
@@ -21270,11 +24380,93 @@ Parameters:
+
+
+ <optional>
+
+
+
+
+
+
+
- The user id.
+ User Search string to filter which users are returned. Follows Lucene query string syntax as documented at https://auth0.com/docs/api/management/v2#!/Users/get_users.
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -21318,7 +24510,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -21369,12 +24561,22 @@ 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 = {
+ search_engine: 'v3',
+ q: 'name:*jane*',
+ per_page: 10,
+ page: 0
+};
- console.log(blocks);
+auth0.getUsers(params, function (err, users) {
+ console.log(users.length);
});
@@ -21386,14 +24588,14 @@ Example
- getUserBlocksByIdentifier(params, cbopt) → {Promise|undefined}
+ getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
- Get user blocks by its identifier.
+ Get users for a given email address
@@ -21429,7 +24631,7 @@ Source:
Parameters:
- paramsemail
-Object
+String
@@ -21490,68 +24692,19 @@ Parameters:
-
-
-
+ <optional>
-
-
-
-
-
- The user data object..
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- identifier
-
-String
-
-
-
-
-
+
- The user identifier, any of: username, phone_number, email.
-
-
-
-
-
-
-
-
+ Email Address of users to locate
@@ -21587,7 +24740,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -21638,12 +24791,13 @@ Returns:
Example
- management.getUserBlocksByIdentifier({ identifier: USER_ID }, function (err, blocks) {
- if (err) {
- // Handle error.
- }
-
- console.log(blocks);
+
+ This method takes an email address as the first argument,
+ and returns all users with that email address
+
+
+ auth0.getUsersByEmail(email, function (err, users) {
+ console.log(users);
});
@@ -21655,14 +24809,14 @@ Example
- getUserLogs(params, cbopt) → {Promise|undefined}
+ getUsersInRole(idopt, cbopt) → {Promise|undefined}
- Get user's log events.
+ Get users in a given role
@@ -21698,7 +24852,7 @@ getUserLog
Source:
Parameters:
- paramsid
-Object
+String
@@ -21759,6 +24913,8 @@ Parameters:
+ <optional>
+
@@ -21769,70 +24925,37 @@ Parameters:
- Get logs data.
+ Id of the role
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idparams.per_page
-String
+Number
-
-
-
-
- User id.
+
-
-
-
-
-
-
-
- per_page
-
+ <optional>
-Number
-
-
-
+
+
+
@@ -21847,7 +24970,7 @@ Parameters:
- pageparams.page
@@ -21860,71 +24983,21 @@ Parameters:
-
-
-
-
- Page number, zero indexed.
+
-
-
-
-
-
-
-
- sort
-
+ <optional>
-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;
-
-
-
-
-
-
-
-
+ Page number, zero indexed.
@@ -22009,16 +25082,20 @@ Returns:
-Example
-
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+Examples
-management.getUserLogs(params, function (err, logs) {
- if (err) {
- // Handle error.
- }
+ var params = {
+ id: 'ROLE_ID'
+ per_page: 50,
+ page: 0
+};
- console.log(logs);
+
+ This method takes a roleId and returns all users within that role
+
+
+ management.getUsersInRole(params, function (err, users) {
+ console.log(users);
});
@@ -22030,14 +25107,16 @@ Example
- getUserPermissions(params, cbopt) → {Promise|undefined}
+ importUsers(data, cbopt) → {Promise|undefined}
- Get user's permissions
+ Given a path to a file and a connection id, create a new job that imports the
+users contained in the file or JSON string and associate them with the given
+connection.
@@ -22073,7 +25152,7 @@ get
Source:
Parameters:
- paramsdata
@@ -22144,7 +25223,7 @@ Parameters:
- Get permissions data.
+ Users import data.
@@ -22158,6 +25237,8 @@ Parameters:
Type
+ Attributes
+
@@ -22170,7 +25251,7 @@ Parameters:
- idconnection_id
@@ -22183,11 +25264,19 @@ Parameters:
+
+
+
+
+
+
+
+
- User id.
+ connection_id of the connection to which users will be imported.
@@ -22196,24 +25285,34 @@ Parameters:
- per_pageusers
-Number
+String
+
+
+ <optional>
+
+
+
+
+
+
+
- Number of results per page.
+ Path to the users data file. Either users or users_json is mandatory.
@@ -22222,24 +25321,34 @@ Parameters:
- pageusers_json
-Number
+String
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ JSON data for the users.
@@ -22248,24 +25357,34 @@ Parameters:
- sortupsert
-String
+Boolean
+
+
+ <optional>
+
+
+
+
+
+
+
- The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+ Whether to update users if they already exist (true) or to ignore them (false).
@@ -22274,7 +25393,7 @@ Parameters:
- include_totalssend_completion_email
@@ -22287,11 +25406,21 @@ Parameters:
+
+
+ <optional>
+
+
+
+
+
+
+
- true if a query summary must be included in the result, false otherwise. Default false;
+ Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
@@ -22386,14 +25515,15 @@ Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+ var params = {
+ connection_id: '{CONNECTION_ID}',
+ users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}'
+};
-management.getUserPermissions(params, function (err, logs) {
+management.importUsers(params, function (err) {
if (err) {
// Handle error.
}
-
- console.log(logs);
});
@@ -22405,14 +25535,14 @@ Example
- getUserRoles(params, cbopt) → {Promise|undefined}
+ linkUsers(userId, params, cbopt) → {Promise|undefined}
- Get user's roles
+ Link the user with another account.
@@ -22448,7 +25578,7 @@ getUserRo
Source:
Parameters:
- paramsuserId
-Object
+String
@@ -22519,111 +25649,67 @@ Parameters:
- Get roles data.
+ ID of the primary user.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idparams
-String
+Object
-
-
-
-
- User id.
+
-
-
-
-
-
-
- per_page
-
-Number
-
-
-
-
+
+
- Number of results per page.
-
-
-
-
-
-
-
-
- page
-
+ Secondary user data.
-Number
+
+
+
+
+
+ Name
+
-
-
+ Type
-
+
-
+
-
- Page number, zero indexed.
-
-
-
+ Description
+
+
+
- sortuser_id
@@ -22640,7 +25726,7 @@ Parameters:
- The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+ ID of the user to be linked.
@@ -22649,13 +25735,13 @@ Parameters:
- include_totalsconnection_id
-Boolean
+String
@@ -22666,7 +25752,7 @@ Parameters:
- true if a query summary must be included in the result, false otherwise. Default false;
+ ID of the connection to be used.
@@ -22761,14 +25847,18 @@ Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+ var userId = 'USER_ID';
+var params = {
+ user_id: 'OTHER_USER_ID',
+ connection_id: 'CONNECTION_ID'
+};
-management.getUserRoles(params, function (err, logs) {
+management.linkUsers(userId, params, function (err, user) {
if (err) {
// Handle error.
}
- console.log(logs);
+ // Users linked.
});
@@ -22780,14 +25870,14 @@ Example
- getUsers(paramsopt, cbopt) → {Promise|undefined}
+ regenerateRecoveryCode(data, cbopt) → {Promise|undefined}
- Get all users.
+ Generate new Guardian recovery code.
@@ -22823,7 +25913,7 @@ getUsersSource:
Parameters:
- paramsdata
@@ -22884,8 +25974,6 @@ Parameters:
- <optional>
-
@@ -22896,7 +25984,7 @@ Parameters:
- Users params.
+ The user data object.
@@ -22910,8 +25998,6 @@ Parameters:
Type
- Attributes
-
@@ -22924,43 +26010,7 @@ Parameters:
- search_engine
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The version of the search engine to use.
-
-
-
-
-
-
-
-
- qid
@@ -22973,93 +26023,11 @@ Parameters:
-
-
- <optional>
-
-
-
-
-
-
-
- User Search string to filter which users are returned. Follows Lucene query string syntax as documented at https://auth0.com/docs/api/management/v2#!/Users/get_users.
-
-
-
-
-
-
-
-
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Page number, zero indexed.
+ The user id.
@@ -23154,22 +26122,8 @@ 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 = {
- search_engine: 'v3',
- q: 'name:*jane*',
- per_page: 10,
- page: 0
-};
-
-auth0.getUsers(params, function (err, users) {
- console.log(users.length);
+ management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
+ console.log(newRecoveryCode);
});
@@ -23181,14 +26135,14 @@ Example
- getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+ removeHookSecrets(params, data, cbopt) → {Promise|undefined}
- Get users for a given email address
+ Delete an existing hook.
@@ -23224,7 +26178,7 @@ getUse
Source:
Parameters:
- emailparams
-String
+Object
@@ -23285,7 +26239,90 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+
+ Hook parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Hook ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
@@ -23297,7 +26334,7 @@ Parameters:
- Email Address of users to locate
+ Secrets key/value pairs
@@ -23384,13 +26421,14 @@ Returns:
Example
-
- This method takes an email address as the first argument,
- and returns all users with that email address
-
-
- auth0.getUsersByEmail(email, function (err, users) {
- console.log(users);
+ var params = { id: HOOK_ID }
+var data = ['API_TOKEN', 'DB_PASSWORD']
+auth0.removeHookSecrets(params, data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Hook deleted.
});
@@ -23402,14 +26440,14 @@ Example
- getUsersInRole(idopt, cbopt) → {Promise|undefined}
+ removePermissionsFromRole(data, cbopt) → {Promise|undefined}
- Get users in a given role
+ Remove permissions from a role
@@ -23445,7 +26483,7 @@ getUser
Source:
Parameters:
- idparams.id
@@ -23506,8 +26544,6 @@ Parameters:
- <optional>
-
@@ -23518,7 +26554,7 @@ Parameters:
- Id of the role
+ ID of the Role.
@@ -23527,13 +26563,13 @@ Parameters:
- params.per_pagedata
-Number
+Object
@@ -23542,8 +26578,6 @@ Parameters:
- <optional>
-
@@ -23554,43 +26588,135 @@ Parameters:
- Number of results per page.
+ permissions data
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+ Description
+
+
+
+
- params.pagepermissions
-Number
+String
-
+
+
+
+
+ Array of permissions
- <optional>
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ permission_name
+
+String
+
+
+
+
+
+
+
+
+
+ Name of a permission
+
+
+
+
+
+
+ resource_server_identifier
+
-
+String
+
+
+
+
+
- Page number, zero indexed.
+ Identifier for a resource
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -23675,20 +26801,13 @@ Returns:
-Examples
+Example
- var params = {
- id: 'ROLE_ID'
- per_page: 50,
- page: 0
-};
+ var params = { id :'ROLE_ID'};
+var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
-
- This method takes a roleId and returns all users within that role
-
-
- management.getUsersInRole(params, function (err, users) {
- console.log(users);
+management.removePermissionsFromRole(params, data, function (err, permissions) {
+ console.log(permissions);
});
@@ -23700,16 +26819,14 @@ Examples
- importUsers(data, cbopt) → {Promise|undefined}
+ removePermissionsFromUser(params, data, cbopt) → {Promise|undefined}
- Given a path to a file and a connection id, create a new job that imports the
-users contained in the file or JSON string and associate them with the given
-connection.
+ Remove permissions from a user
@@ -23745,7 +26862,7 @@ importUser
Source:
Parameters:
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Users import data.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- connection_idparams
-String
+Object
@@ -23869,16 +26933,33 @@ Parameters:
- connection_id of the connection to which users will be imported.
+ params object
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+ Description
+
+
+
+
- usersid
@@ -23891,21 +26972,19 @@ Parameters:
-
-
- <optional>
-
-
+
+
+ user_id
-
-
+
+
-
+
+
+
-
- Path to the users data file. Either users or users_json is mandatory.
@@ -23914,7 +26993,7 @@ Parameters:
- users_jsondata
@@ -23929,8 +27008,6 @@ Parameters:
- <optional>
-
@@ -23941,79 +27018,50 @@ Parameters:
- JSON data for the users.
-
-
-
-
-
-
-
-
- upsert
-
+ data object containing list of permission IDs
-Boolean
-
-
-
-
+
-
-
-
- <optional>
-
+
+
+
+
+ Name
+
-
+ Type
-
-
-
+
-
+
-
- Whether to update users if they already exist (true) or to ignore them (false).
-
-
-
+ Description
+
+
+
- send_completion_emailpermissions
-Boolean
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
+ Array of permission IDs
@@ -24108,15 +27156,15 @@ Returns:
Example
- var params = {
- connection_id: '{CONNECTION_ID}',
- users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}'
-};
+ var parms = { id : 'USER_ID'};
+var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
-management.importUsers(params, function (err) {
+management.removePermissionsFromUser(params, data, function (err) {
if (err) {
// Handle error.
}
+
+ // User assigned permissions.
});
@@ -24128,14 +27176,14 @@ Example
- linkUsers(userId, params, cbopt) → {Promise|undefined}
+ removeRolesFromUser(params, data, cbopt) → {Promise|undefined}
- Link the user with another account.
+ Remove roles from a user
@@ -24171,7 +27219,7 @@ linkUsersSource:
Parameters:
- userIdparams
-String
+Object
@@ -24242,7 +27290,58 @@ Parameters:
- ID of the primary user.
+ params object
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ user_id
+
+
+
+
+
+
+
+
@@ -24251,13 +27350,13 @@ Parameters:
- paramsdata
-Object
+String
@@ -24276,7 +27375,7 @@ Parameters:
- Secondary user data.
+ data object containing list of role IDs
@@ -24302,33 +27401,7 @@ Parameters:
- user_id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- ID of the user to be linked.
-
-
-
-
-
-
-
-
- connection_idroles
@@ -24345,7 +27418,7 @@ Parameters:
- ID of the connection to be used.
+ Array of role IDs
@@ -24440,18 +27513,15 @@ Returns:
Example
- var userId = 'USER_ID';
-var params = {
- user_id: 'OTHER_USER_ID',
- connection_id: 'CONNECTION_ID'
-};
+ var parms = { id : 'USER_ID'};
+var data = { "roles" :["role1"]};
-management.linkUsers(userId, params, function (err, user) {
+management.removeRolesFromUser(params, data, function (err) {
if (err) {
// Handle error.
}
- // Users linked.
+ // User assigned roles.
});
@@ -24463,14 +27533,14 @@ Example
- regenerateRecoveryCode(data, cbopt) → {Promise|undefined}
+ sendEmailVerification(data, cbopt) → {Promise|undefined}
- Generate new Guardian recovery code.
+ Send a verification email to a user.
@@ -24506,7 +27576,7 @@ Source:
Parameters:
- The user data object.
+ User data object.
@@ -24603,7 +27673,7 @@ Parameters:
- iduser_id
@@ -24620,7 +27690,7 @@ Parameters:
- The user id.
+ ID of the user to be verified.
@@ -24715,8 +27785,14 @@ Returns:
Example
- management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
- console.log(newRecoveryCode);
+ var params = {
+ user_id: '{USER_ID}'
+};
+
+management.sendEmailVerification(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
});
@@ -24728,14 +27804,14 @@ Example
- removeHookSecrets(params, data, cbopt) → {Promise|undefined}
+ setRulesConfig(params, data, cbopt) → {Promise|undefined}
- Delete an existing hook.
+ Set a new rules config.
@@ -24771,7 +27847,7 @@ remo
Source:
Parameters:
- Hook parameters.
+ Rule Config parameters.
@@ -24868,7 +27944,7 @@ Parameters:
- idkey
@@ -24885,7 +27961,7 @@ Parameters:
- Hook ID.
+ Rule Config key.
@@ -24927,7 +28003,58 @@ Parameters:
- Secrets key/value pairs
+ Rule Config Data parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ value
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule Config Data value.
+
+
+
+
+
+
+
+
@@ -25014,14 +28141,15 @@ Returns:
Example
- var params = { id: HOOK_ID }
-var data = ['API_TOKEN', 'DB_PASSWORD']
-auth0.removeHookSecrets(params, data, function (err) {
+ var params = { key: RULE_CONFIG_KEY };
+var data = { value: RULES_CONFIG_VALUE };
+
+management.setRulesConfig(params, data, function (err, rulesConfig) {
if (err) {
// Handle error.
}
- // Hook deleted.
+ // Rules Config set.
});
@@ -25033,14 +28161,14 @@ Example
- removePermissionsFromRole(data, cbopt) → {Promise|undefined}
+ unblockUser(params, cbopt) → {Promise|undefined}
- Remove permissions from a role
+ Unblock an user by its id.
@@ -25076,7 +28204,7 @@ Source:
Parameters:
- params.idparams
-String
+Object
@@ -25147,7 +28275,58 @@ Parameters:
- ID of the Role.
+ The user data object..
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
@@ -25156,13 +28335,13 @@ Parameters:
- datacb
-Object
+function
@@ -25171,6 +28350,8 @@ Parameters:
+ <optional>
+
@@ -25181,9 +28362,138 @@ Parameters:
- permissions data
+ Callback function
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.unblockUser({ id: USER_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // User unblocked.
+});
+
+
+
+
+
+
+
+
+
+
+ unblockUser(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Unblock an user by its id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
@@ -25195,6 +28505,8 @@ Parameters:
Type
+ Attributes
+
@@ -25207,24 +28519,32 @@ Parameters:
- permissionsparams
-String
+Object
+
+
+
+
+
+
+
+
- Array of permissions
+ The user data object..
@@ -25250,33 +28570,7 @@ Parameters:
- permission_name
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Name of a permission
-
-
-
-
-
-
-
-
- resource_server_identifieridentifier
@@ -25293,15 +28587,7 @@ Parameters:
- Identifier for a resource
-
-
-
-
-
-
-
-
+ The user identifier, any of: username, phone_number, email.
@@ -25345,7 +28631,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -25396,11 +28682,12 @@ Returns:
Example
- var params = { id :'ROLE_ID'};
-var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
-management.removePermissionsFromRole(params, data, function (err, permissions) {
- console.log(permissions);
+ // User unblocked.
});
@@ -25412,14 +28699,14 @@ Example
- removePermissionsFromUser(params, data, cbopt) → {Promise|undefined}
+ unlinkUsers(params, cbopt) → {Promise|undefined}
- Remove permissions from a user
+ Unlink the given accounts.
@@ -25455,7 +28742,7 @@ Source:
Parameters:
- params object
+ Linked users data.
@@ -25569,15 +28856,7 @@ Parameters:
- user_id
-
-
-
-
-
-
-
-
+ Primary user ID.
@@ -25586,7 +28865,7 @@ Parameters:
- dataprovider
@@ -25599,45 +28878,20 @@ Parameters:
-
-
-
-
-
-
-
-
- data object containing list of permission IDs
+ Identity provider in use.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- permissionsuser_id
@@ -25654,7 +28908,7 @@ Parameters:
- Array of permission IDs
+ Secondary user ID.
@@ -25749,15 +29003,14 @@ Returns:
Example
- var parms = { id : 'USER_ID'};
-var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
+ var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
-management.removePermissionsFromUser(params, data, function (err) {
+management.unlinkUsers(params, function (err, user) {
if (err) {
// Handle error.
}
- // User assigned permissions.
+ // Users accounts unlinked.
});
@@ -25769,14 +29022,14 @@ Example
- removeRolesFromUser(params, data, cbopt) → {Promise|undefined}
+ updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
- Remove roles from a user
+ Update the app metadata for a user.
@@ -25812,7 +29065,7 @@ re
Source:
Parameters:
- params object
+ The user data object..
@@ -25926,7 +29179,7 @@ Parameters:
- user_id
+ The user id.
@@ -25943,13 +29196,13 @@ Parameters:
- datametadata
-String
+Object
@@ -25968,58 +29221,7 @@ Parameters:
- data object containing list of role IDs
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- roles
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Array of role IDs
-
-
-
-
-
-
-
-
+ New app metadata.
@@ -26055,7 +29257,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -26106,15 +29308,18 @@ Returns:
Example
- var parms = { id : 'USER_ID'};
-var data = { "roles" :["role1"]};
+ var params = { id: USER_ID };
+var metadata = {
+ foo: 'bar'
+};
-management.removeRolesFromUser(params, data, function (err) {
+management.updateAppMetadata(params, metadata, function (err, user) {
if (err) {
// Handle error.
}
- // User assigned roles.
+ // Updated user.
+ console.log(user);
});
@@ -26126,14 +29331,14 @@ Example
- sendEmailVerification(data, cbopt) → {Promise|undefined}
+ updateBrandingSettings(params, data, cbopt) → {Promise|undefined}
- Send a verification email to a user.
+ Update the branding settings.
@@ -26169,7 +29374,7 @@
Source:
Parameters:
- dataparams
@@ -26240,58 +29445,41 @@ Parameters:
- User data object.
+ Branding parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- user_iddata
-String
+Object
+
+
-
+
-
- ID of the user to be verified.
-
-
+
+
-
-
-
+
+
+ Updated branding data.
@@ -26378,14 +29566,13 @@ Returns:
Example
- var params = {
- user_id: '{USER_ID}'
-};
-
-management.sendEmailVerification(params, function (err) {
+ management.updateBrandingSettings(data, function (err, branding) {
if (err) {
// Handle error.
}
+
+// Updated branding
+ console.log(branding);
});
@@ -26397,14 +29584,14 @@ Example
- setRulesConfig(params, data, cbopt) → {Promise|undefined}
+ updateClient(params, data, cbopt) → {Promise|undefined}
- Set a new rules config.
+ Update an Auth0 client.
@@ -26440,7 +29627,7 @@ setRule
Source:
Parameters:
- Rule Config parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- key
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Rule Config key.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Rule Config Data parameters.
+ Client parameters.
@@ -26622,7 +29724,7 @@ Parameters:
- valueclient_id
@@ -26639,7 +29741,7 @@ Parameters:
- Rule Config Data value.
+ Application client ID.
@@ -26654,6 +29756,40 @@ Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated client data.
+
+
+
+
+
+
cbReturns:
Example
- var params = { key: RULE_CONFIG_KEY };
-var data = { value: RULES_CONFIG_VALUE };
+ var data = { name: 'newClientName' };
+var params = { client_id: CLIENT_ID };
-management.setRulesConfig(params, data, function (err, rulesConfig) {
+management.updateClient(params, data, function (err, client) {
if (err) {
// Handle error.
}
- // Rules Config set.
+ console.log(client.name); // 'newClientName'
});
@@ -26754,14 +29890,14 @@ Example
- unblockUser(params, cbopt) → {Promise|undefined}
+ updateClientGrant(params, data, cbopt) → {Promise|undefined}
- Unblock an user by its id.
+ Update an Auth0 client grant.
@@ -26797,7 +29933,7 @@ unblockUse
Source:
Parameters:
- The user data object..
+ Client parameters.
@@ -26911,7 +30047,7 @@ Parameters:
- The user id.
+ Client grant ID.
@@ -26926,6 +30062,40 @@ Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated client data.
+
+
+
+
+
+
cbParameters:
- Callback function
+ Callback function.
@@ -27006,12 +30176,19 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ var data = {
+ client_id: CLIENT_ID,
+ audience: AUDIENCE,
+ scope: []
+};
+var params = { id: CLIENT_GRANT_ID };
+
+management.clientGrants.update(params, data, function (err, grant) {
if (err) {
// Handle error.
}
- // User unblocked.
+ console.log(grant.id);
});
@@ -27023,14 +30200,14 @@ Example
- unblockUser(params, cbopt) → {Promise|undefined}
+ updateConnection(params, data, cbopt) → {Promise|undefined}
- Unblock an user by its id.
+ Update an existing connection.
@@ -27066,7 +30243,7 @@ unblockUse
Source:
Parameters:
- The user data object..
+ Connection parameters.
@@ -27163,7 +30340,7 @@ Parameters:
- identifierid
@@ -27180,7 +30357,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ Connection ID.
@@ -27195,6 +30372,40 @@ Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated connection data.
+
+
+
+
+
+
cbParameters:
- Callback function
+ Callback function.
@@ -27275,12 +30486,15 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ var data = { name: 'newConnectionName' };
+var params = { id: CONNECTION_ID };
+
+management.updateConnection(params, data, function (err, connection) {
if (err) {
// Handle error.
}
- // User unblocked.
+ console.log(connection.name); // 'newConnectionName'
});
@@ -27292,14 +30506,14 @@ Example
- unlinkUsers(params, cbopt) → {Promise|undefined}
+ updateEmailProvider(params, data, cbopt) → {Promise|undefined}
- Unlink the given accounts.
+ Update the email provider.
@@ -27335,7 +30549,7 @@ unlinkUser
Source:
Parameters:
- Linked users data.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Primary user ID.
+ Email provider parameters.
@@ -27458,58 +30629,32 @@ Parameters:
- providerdata
-String
+Object
-
-
-
-
- Identity provider in use.
+
-
-
-
-
-
-
-
- user_id
-
-String
-
-
-
-
+
+
- Secondary user ID.
-
-
-
-
-
-
-
-
+ Updated email provider data.
@@ -27596,14 +30741,13 @@ Returns:
Example
- var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
-
-management.unlinkUsers(params, function (err, user) {
+ management.updateEmailProvider(params, data, function (err, provider) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // Updated email provider.
+ console.log(provider);
});
@@ -27615,14 +30759,14 @@ Example
- updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
- Update the app metadata for a user.
+ Update an existing Email Template.
@@ -27658,7 +30802,7 @@ upda
Source:
Parameters:
- The user data object..
+ Email Template parameters.
@@ -27755,7 +30899,7 @@ Parameters:
- idname
@@ -27772,7 +30916,7 @@ Parameters:
- The user id.
+ Template Name
@@ -27789,7 +30933,7 @@ Parameters:
- metadatadata
@@ -27814,7 +30958,7 @@ Parameters:
- New app metadata.
+ Updated Email Template data.
@@ -27850,7 +30994,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -27901,18 +31045,15 @@ Returns:
Example
- var params = { id: USER_ID };
-var metadata = {
- foo: 'bar'
-};
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
-management.updateAppMetadata(params, metadata, function (err, user) {
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+ console.log(emailTemplate.from); // 'new@email.com'
});
@@ -27924,14 +31065,14 @@ Example
- updateBrandingSettings(params, data, cbopt) → {Promise|undefined}
+ updateFactorProvider(params, data, cbopt) → {Promise|undefined}
- Update the branding settings.
+ Update Guardian's factor provider
@@ -27967,7 +31108,7 @@ Source:
Parameters:
- Branding parameters.
+ Factor provider parameters.
@@ -28072,7 +31213,7 @@ Parameters:
- Updated branding data.
+ Updated Factor provider data.
@@ -28159,13 +31300,12 @@ Returns:
Example
- management.updateBrandingSettings(data, function (err, branding) {
- if (err) {
- // Handle error.
- }
-
-// Updated branding
- console.log(branding);
+ management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ messaging_service_sid: 'XXXXXXXXXXXXXX',
+ auth_token: 'XXXXXXXXXXXXXX',
+ sid: 'XXXXXXXXXXXXXX'
+}, function (err, provider) {
+ console.log(provider);
});
@@ -28177,14 +31317,14 @@ Example
- updateClient(params, data, cbopt) → {Promise|undefined}
+ updateGuardianFactor(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client.
+ Update Guardian Factor
@@ -28220,7 +31360,7 @@ updateCli
Source:
Parameters:
- Client parameters.
+ Factor parameters.
-
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated factor data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.updateGuardianFactor({ name: 'sms' }, {
+ enabled: true
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updateGuardianFactorTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian enrollment and verification factor templates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
@@ -28305,6 +31642,8 @@ Parameters:
Type
+ Attributes
+
@@ -28317,32 +31656,32 @@ Parameters:
- client_idparams
-String
+Object
+
+
-
+
-
- Application client ID.
-
-
+
+
-
-
-
+
+
+ Factor parameters.
@@ -28376,7 +31715,7 @@ Parameters:
- Updated client data.
+ Updated factor templates data.
@@ -28463,15 +31802,11 @@ Returns:
Example
- var data = { name: 'newClientName' };
-var params = { client_id: CLIENT_ID };
-
-management.updateClient(params, data, function (err, client) {
- if (err) {
- // Handle error.
- }
-
- console.log(client.name); // 'newClientName'
+ management.updateGuardianFactorTemplates({ name: 'sms' }, {
+ enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+}, function (err, templates) {
+ console.log(templates);
});
@@ -28483,14 +31818,14 @@ Example
- updateClientGrant(params, data, cbopt) → {Promise|undefined}
+ updateGuardianPhoneFactorMessageTypes(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client grant.
+ Update the Guardian phone factor's message types
@@ -28526,7 +31861,7 @@ upda
Source:
Parameters:
- Client parameters.
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
@@ -28623,13 +31992,13 @@ Parameters:
- idmessage_types
-String
+Array.<String>
@@ -28640,7 +32009,7 @@ Parameters:
- Client grant ID.
+ Message types (only "sms" and "voice" are supported).
@@ -28655,40 +32024,6 @@ Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Updated client data.
-
-
-
-
-
-
cbReturns:
Example
- var data = {
- client_id: CLIENT_ID,
- audience: AUDIENCE,
- scope: []
-};
-var params = { id: CLIENT_GRANT_ID };
-
-management.clientGrants.update(params, data, function (err, grant) {
- if (err) {
- // Handle error.
- }
-
- console.log(grant.id);
+ management.updateGuardianPhoneFactorMessageTypes({}, {
+ message_types: ['sms', 'voice']
+}, function (err, factor) {
+ console.log(factor);
});
@@ -28793,14 +32119,14 @@ Example
- updateConnection(params, data, cbopt) → {Promise|undefined}
+ updateGuardianPhoneFactorSelectedProvider(params, data, cbopt) → {Promise|undefined}
- Update an existing connection.
+ Update the Guardian phone factor's selected provider
@@ -28836,7 +32162,7 @@ updat
Source:
Parameters:
- Connection parameters.
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
@@ -28933,7 +32293,7 @@ Parameters:
- idprovider
@@ -28950,7 +32310,7 @@ Parameters:
- Connection ID.
+ Name of the selected provider
@@ -28965,40 +32325,6 @@ Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Updated connection data.
-
-
-
-
-
-
cbReturns:
Example
- var data = { name: 'newConnectionName' };
-var params = { id: CONNECTION_ID };
-
-management.updateConnection(params, data, function (err, connection) {
- if (err) {
- // Handle error.
- }
-
- console.log(connection.name); // 'newConnectionName'
+ management.updateGuardianPhoneFactorSelectedProvider({}, {
+ provider: 'twilio'
+}, function (err, factor) {
+ console.log(factor);
});
@@ -29099,14 +32420,14 @@ Example
- updateEmailProvider(params, data, cbopt) → {Promise|undefined}
+ updateGuardianPolicies(params, data, cbopt) → {Promise|undefined}
- Update the email provider.
+ Update enabled Guardian policies
@@ -29142,7 +32463,7 @@ up
Source:
Parameters:
- Email provider parameters.
+ Parameters.
@@ -29228,7 +32549,7 @@ Parameters:
-Object
+Array.<String>
@@ -29247,7 +32568,7 @@ Parameters:
- Updated email provider data.
+ Policies to enable. Empty array disables all policies.
@@ -29334,13 +32655,10 @@ Returns:
Example
- management.updateEmailProvider(params, data, function (err, provider) {
- if (err) {
- // Handle error.
- }
-
- // Updated email provider.
- console.log(provider);
+ management.updateGuardianPolicies({}, [
+ 'all-applications'
+], function (err, policies) {
+ console.log(policies);
});
@@ -29352,14 +32670,14 @@ Example
- updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+ updateHook(params, data, cbopt) → {Promise|undefined}
- Update an existing Email Template.
+ Update an existing hook.
@@ -29395,7 +32713,7 @@ u
Source:
Parameters:
- Email Template parameters.
+ Hook parameters.
@@ -29492,7 +32810,7 @@ Parameters:
- nameid
@@ -29509,7 +32827,7 @@ Parameters:
- Template Name
+ Hook ID.
@@ -29551,7 +32869,7 @@ Parameters:
- Updated Email Template data.
+ Updated hook data.
@@ -29638,15 +32956,14 @@ Returns:
Example
- var data = { from: 'new@email.com' };
-var params = { name: EMAIL_TEMPLATE_NAME };
-
-management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ var params = { id: HOOK_ID };
+var data = { name: 'my-hook'};
+management.updateHook(params, data, function (err, hook) {
if (err) {
// Handle error.
}
- console.log(emailTemplate.from); // 'new@email.com'
+ console.log(hook.name); // 'my-hook'.
});
@@ -29658,7 +32975,7 @@ Example
- updateHook(params, data, cbopt) → {Promise|undefined}
+ updateHookSecrets(params, data, cbopt) → {Promise|undefined}
@@ -29701,7 +33018,7 @@ updateHook<
Source:
Parameters:
- Updated hook data.
+ Secrets key/value pairs
@@ -29945,13 +33262,13 @@ Returns:
Example
var params = { id: HOOK_ID };
-var data = { name: 'my-hook'};
-management.updateHook(params, data, function (err, hook) {
+var data = { API_TOKEN: 'updated-secret'};
+management.updateHookSecrets(params, data, function (err, secrets) {
if (err) {
// Handle error.
}
- console.log(hook.name); // 'my-hook'.
+ console.log(secrets)
});
@@ -29963,14 +33280,14 @@ Example
- updateHookSecrets(params, data, cbopt) → {Promise|undefined}
+ updateMigrations(data, cbopt) → {Promise|undefined}
- Update an existing hook.
+ Update the tenant migrations.
@@ -30006,7 +33323,7 @@ upda
Source:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Hook parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Hook ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
dataParameters:
- Secrets key/value pairs
+ Updated migrations data.
@@ -30249,14 +33481,14 @@ Returns:
Example
- var params = { id: HOOK_ID };
-var data = { API_TOKEN: 'updated-secret'};
-management.updateHookSecrets(params, data, function (err, secrets) {
+ data = { flags: { migration: true } };
+management.updateMigrations(data, function (err, migrations) {
if (err) {
// Handle error.
}
- console.log(secrets)
+// Updated migrations flags
+ console.log(migrations.flags);
});
@@ -30311,7 +33543,7 @@ u
Source:
updateRole<
Source:
updateRule<
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 76a32b605..f8ce1198e 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.MigrationsManager.html b/docs/module-management.MigrationsManager.html
new file mode 100644
index 000000000..97c347c60
--- /dev/null
+++ b/docs/module-management.MigrationsManager.html
@@ -0,0 +1,894 @@
+
+
+
+
+
+ MigrationsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MigrationsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ MigrationsManager
+
+
+ Abstracts interaction with the migrations endpoint.
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new MigrationsManager(options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The client options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ baseUrl
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The URL of the API.
+
+
+
+
+
+
+
+
+ headers
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Headers to be included in all requests.
+
+
+
+
+
+
+
+
+ retry
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Retry Policy Config
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+
+(inner) auth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the migrations endpoint
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ getMigrations(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the tenant migrations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.migrations.getMigrations(function (err, migrations) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(migrations.flags);
+});
+
+
+
+
+
+
+
+
+
+
+ updateMigrations(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the tenant migrations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The tenant migrations to be updated
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ flags
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The tenant migrations flags to be updated
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.migrations.updateMigrations(data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index d450ac7fd..21d4124ea 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index fb5b1d27f..5a3fc2b55 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 961843c93..97ba3fa94 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index f6980c26f..4929adc05 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4293,7 +4293,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 838527adc..c27870d41 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 6dbd96b97..622494998 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 3555a998f..32b369ef9 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 2b6bee0fb..912072b15 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 7d1f5730b..82d4e1e47 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index 8543b95d7..87627110d 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 4f4e00d83..2c8b117f7 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index fb60127dd..6b0291d80 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -110,6 +110,9 @@ Classes
ManagementTokenProvider
+ MigrationsManager
+
+
PromptsManager
@@ -168,7 +171,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 12e5b188c..ee686ea37 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 8106671bc..d316de5ca 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -91,6 +91,9 @@ utils.js
*/
utils.wrapPropertyMethod = function(Parent, name, propertyMethod) {
var path = propertyMethod.split('.');
+ if (path.length > 2) {
+ throw new Error('wrapPropertyMethod() only supports one level of nesting for propertyMethod');
+ }
var property = path.shift();
var method = path.pop();
@@ -138,7 +141,7 @@ utils.js
diff --git a/package.json b/package.json
index c6cecbc29..8461fcac2 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.26.0",
+ "version": "2.27.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
Returns:
diff --git a/docs/index.html b/docs/index.html index 768f89694..bb6079b43 100644 --- a/docs/index.html +++ b/docs/index.html @@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@
diff --git a/docs/index.js.html b/docs/index.js.html index 5bb5b704e..cfe718959 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 5bb5b704e..cfe718959 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 565a071bb..c06071bf7 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 565a071bb..c06071bf7 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 f532a24db..1911f0890 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 f532a24db..1911f0890 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 1cea85dd3..7eb5c7028 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 1cea85dd3..7eb5c7028 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 e464f8b7b..fe89b2a6c 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 e464f8b7b..fe89b2a6c 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 4ebb02ff7..7158c8534 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 4ebb02ff7..7158c8534 100644 --- a/docs/management_ConnectionsManager.js.html +++ b/docs/management_ConnectionsManager.js.html @@ -24,7 +24,7 @@
@@ -91,6 +91,20 @@
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html index 4bac7dbf5..a9300b0ac 100644 --- a/docs/management_CustomDomainsManager.js.html +++ b/docs/management_CustomDomainsManager.js.html @@ -24,7 +24,7 @@
management/ConnectionsManager.js
options.tokenProvider ); this.resource = new RetryRestClient(auth0RestClient, options.retry); + + /** + * Provides an abstraction layer for consuming the + * {@link https://auth0.com/docs/api/management/v2#!/Connections/delete_users_by_email + * endpoint}. + * + * @type {external:RestClient} + */ + var userAuth0RestClient = new Auth0RestClient( + options.baseUrl + '/connections/:id/users', + clientOptions, + options.tokenProvider + ); + this.user = new RetryRestClient(userAuth0RestClient, options.retry); }; /** @@ -219,6 +233,44 @@management/ConnectionsManager.js
*/ utils.wrapPropertyMethod(ConnectionsManager, 'delete', 'resource.delete'); +/** + * Delete a connection user by email. + * + * @method delete + * @memberOf module:management.ConnectionsManager.prototype + * + * @example + * management.connections.deleteUserByEmail({ id: CONNECTION_ID, email:USER_EMAIL }, function (err) { + * if (err) { + * // Handle error. + * } + * + * // User deleted. + * }); + * + * @param {Object} params Connection parameters. + * @param {String} params.id Connection ID. + * @param {String} params.email User Email. + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +ConnectionsManager.prototype.deleteUserByEmail = function(params, cb) { + if (typeof params !== 'object' || typeof params.email !== 'string' || params.email.length < 1) { + throw new ArgumentError('You must provide an email for the deleteUserByEmail method'); + } + + if (!params.id) { + throw new ArgumentError('The connection id cannot be null or undefined'); + } + + if (cb && cb instanceof Function) { + return this.user.delete(params, {}, cb); + } + + return this.user.delete(params, {}); +}; + module.exports = ConnectionsManager; @@ -232,7 +284,7 @@management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html index 4bac7dbf5..a9300b0ac 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 53e57c86a..848f2a5b1 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 53e57c86a..848f2a5b1 100644 --- a/docs/management_DeviceCredentialsManager.js.html +++ b/docs/management_DeviceCredentialsManager.js.html @@ -24,7 +24,7 @@
@@ -177,7 +177,7 @@
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html index dc419b218..24f773e06 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 dc419b218..24f773e06 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 ebc3cd703..e2d4179f0 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 ebc3cd703..e2d4179f0 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 ce44bde42..cb016f847 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 ce44bde42..cb016f847 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 118ac3d2f..6778a9939 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 118ac3d2f..6778a9939 100644 --- a/docs/management_GuardianManager.js.html +++ b/docs/management_GuardianManager.js.html @@ -24,7 +24,7 @@
@@ -117,7 +117,7 @@
diff --git a/docs/management_HooksManager.js.html b/docs/management_HooksManager.js.html index ecdf7d6dc..52592eb2e 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 retrieving Guardian factors. + * Provides an abstraction layer for retrieving Guardian factor templates. * * @type {external:RestClient} */ @@ -145,6 +145,48 @@management/GuardianManager.js
guardianFactorsProvidersAuth0RestClient, options.retry ); + + /** + * Provides an abstraction layer for retrieving Guardian policies. + * + * @type {external:RestClient} + */ + var guardianPoliciesAuth0RestClient = new Auth0RestClient( + options.baseUrl + '/guardian/policies', + clientOptions, + options.tokenProvider + ); + this.policies = new RetryRestClient(guardianPoliciesAuth0RestClient, options.retry); + + /** + * Provides an abstraction layer for retrieving Guardian phone factor selected provider. + * + * @type {external:RestClient} + */ + var guardianFactorsPhoneSelectedProviderAuth0RestClient = new Auth0RestClient( + options.baseUrl + '/guardian/factors/sms/selected-provider', + clientOptions, + options.tokenProvider + ); + this.factorsPhoneSelectedProvider = new RetryRestClient( + guardianFactorsPhoneSelectedProviderAuth0RestClient, + options.retry + ); + + /** + * Provides an abstraction layer for retrieving Guardian phone factor message types. + * + * @type {external:RestClient} + */ + var guardianFactorsPhoneMessageTypesAuth0RestClient = new Auth0RestClient( + options.baseUrl + '/guardian/factors/phone/message-types', + clientOptions, + options.tokenProvider + ); + this.factorsPhoneMessageTypes = new RetryRestClient( + guardianFactorsPhoneMessageTypesAuth0RestClient, + options.retry + ); }; /** @@ -208,6 +250,7 @@management/GuardianManager.js
* @method getFactors * @memberOf module:management.GuardianManager.prototype * + * @example * management.guardian.getFactors(function (err, factors) { * console.log(factors.length); * }); @@ -224,6 +267,7 @@management/GuardianManager.js
* @method getFactorProvider * @memberOf module:management.GuardianManager.prototype * + * @example * management.guardian.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) { * console.log(provider); * }); @@ -241,12 +285,13 @@management/GuardianManager.js
* @method updateFactorProvider * @memberOf module:management.GuardianManager.prototype * + * @example * management.guardian.updateFactorProvider({ name: 'sms', provider: 'twilio' }, { - * messaging_service_sid: 'XXXXXXXXXXXXXX', - * auth_token: 'XXXXXXXXXXXXXX', - * sid: 'XXXXXXXXXXXXXX' - * }, function(err, provider) { - * console.log(provider); + * messaging_service_sid: 'XXXXXXXXXXXXXX', + * auth_token: 'XXXXXXXXXXXXXX', + * sid: 'XXXXXXXXXXXXXX' + * }, function (err, provider) { + * console.log(provider); * }); * * @param {Object} params Factor provider parameters. @@ -263,6 +308,7 @@management/GuardianManager.js
* @method getFactorTemplates * @memberOf module:management.GuardianManager.prototype * + * @example * management.guardian.getFactorTemplates({ name: 'sms' }, function (err, templates) { * console.log(templates); * }); @@ -280,11 +326,12 @@management/GuardianManager.js
* @method updateFactorTemplates * @memberOf module:management.GuardianManager.prototype * + * @example * management.guardian.updateFactorProvider({ name: 'sms' }, { - * enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.", - * verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}" - * }, function(err, templates) { - * console.log(templates); + * enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.", + * verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}" + * }, function (err, templates) { + * console.log(templates); * }); * * @param {Object} params Factor parameters. @@ -301,10 +348,11 @@management/GuardianManager.js
* @method updateFactor * @memberOf module:management.GuardianManager.prototype * + * @example * management.guardian.updateFactor({ name: 'sms' }, { - * enabled: true - * }, function(err, factor) { - * console.log(factor); + * enabled: true + * }, function (err, factor) { + * console.log(factor); * }); * * @param {Object} params Factor parameters. @@ -315,6 +363,138 @@management/GuardianManager.js
*/ utils.wrapPropertyMethod(GuardianManager, 'updateFactor', 'factors.update'); +/** + * Get enabled Guardian policies + * + * @method getPolicies + * @memberOf module:management.GuardianManager.prototype + * + * @example + * management.guardian.getPolicies(function (err, policies) { + * console.log(policies); + * }); + * + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod(GuardianManager, 'getPolicies', 'policies.get'); + +/** + * Update enabled Guardian policies + * + * @method updatePolicies + * @memberOf module:management.GuardianManager.prototype + * + * @example + * management.guardian.updatePolicies({}, [ + * 'all-applications' + * ], function (err, policies) { + * console.log(policies); + * }); + * + * @param {Object} params Parameters. + * @param {String[]} data Policies to enable. Empty array disables all policies. + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod(GuardianManager, 'updatePolicies', 'policies.update'); + +/** + * Get the Guardian phone factor's selected provider + * + * @method getPhoneFactorSelectedProvider + * @memberOf module:management.GuardianManager.prototype + * + * @example + * management.guardian.getPhoneFactorSelectedProvider(function (err, selectedProvider) { + * console.log(selectedProvider); + * }); + * + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod( + GuardianManager, + 'getPhoneFactorSelectedProvider', + 'factorsPhoneSelectedProvider.get' +); + +/** + * Update the Guardian phone factor's selected provider + * + * @method updatePhoneFactorSelectedProvider + * @memberOf module:management.GuardianManager.prototype + * + * @example + * management.guardian.updatePhoneFactorSelectedProvider({}, { + * provider: 'twilio' + * }, function (err, factor) { + * console.log(factor); + * }); + * + * @param {Object} params Parameters. + * @param {Object} data Updated selected provider data. + * @param {String} data.provider Name of the selected provider + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod( + GuardianManager, + 'updatePhoneFactorSelectedProvider', + 'factorsPhoneSelectedProvider.update' +); + +/** + * Get the Guardian phone factor's message types + * + * @method getPhoneFactorMessageTypes + * @memberOf module:management.GuardianManager.prototype + * + * @example + * management.guardian.getPhoneFactorMessageTypes(function (err, messageTypes) { + * console.log(messageTypes); + * }); + * + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod( + GuardianManager, + 'getPhoneFactorMessageTypes', + 'factorsPhoneMessageTypes.get' +); + +/** + * Update the Guardian phone factor's message types + * + * @method updatePhoneFactorMessageTypes + * @memberOf module:management.GuardianManager.prototype + * + * @example + * management.guardian.updatePhoneFactorMessageTypes({}, { + * message_types: ['sms', 'voice'] + * }, function (err, factor) { + * console.log(factor); + * }); + * + * @param {Object} params Parameters. + * @param {Object} data Updated selected provider data. + * @param {String[]} data.message_types Message types (only `"sms"` and `"voice"` are supported). + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod( + GuardianManager, + 'updatePhoneFactorMessageTypes', + 'factorsPhoneMessageTypes.update' +); + module.exports = GuardianManager; @@ -328,7 +508,7 @@management/GuardianManager.js
diff --git a/docs/management_HooksManager.js.html b/docs/management_HooksManager.js.html index ecdf7d6dc..52592eb2e 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 c9177f7bc..5cfbf6a29 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 c9177f7bc..5cfbf6a29 100644 --- a/docs/management_JobsManager.js.html +++ b/docs/management_JobsManager.js.html @@ -24,7 +24,7 @@
@@ -433,7 +433,7 @@
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html index 8a4bceca0..686faeace 100644 --- a/docs/management_LogsManager.js.html +++ b/docs/management_LogsManager.js.html @@ -24,7 +24,7 @@
management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html index 8a4bceca0..686faeace 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 72b15b63e..8c4b3a446 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 72b15b63e..8c4b3a446 100644 --- a/docs/management_ManagementTokenProvider.js.html +++ b/docs/management_ManagementTokenProvider.js.html @@ -24,7 +24,7 @@
@@ -192,7 +192,7 @@
diff --git a/docs/management_MigrationsManager.js.html b/docs/management_MigrationsManager.js.html new file mode 100644 index 000000000..ba5a95915 --- /dev/null +++ b/docs/management_MigrationsManager.js.html @@ -0,0 +1,168 @@ + + + + + +management/MigrationsManager.js - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + + + + + + diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html index b18c1a38f..123d6c069 100644 --- a/docs/management_PromptsManager.js.html +++ b/docs/management_PromptsManager.js.html @@ -24,7 +24,7 @@
management/ManagementTokenProvider.js
diff --git a/docs/management_MigrationsManager.js.html b/docs/management_MigrationsManager.js.html new file mode 100644 index 000000000..ba5a95915 --- /dev/null +++ b/docs/management_MigrationsManager.js.html @@ -0,0 +1,168 @@ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+management/MigrationsManager.js
+ + + + + + + ++ + + + + + + diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html index b18c1a38f..123d6c069 100644 --- a/docs/management_PromptsManager.js.html +++ b/docs/management_PromptsManager.js.html @@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html index e1b3ec326..41bb4610a 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 e1b3ec326..41bb4610a 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 80cc164c7..5584a7771 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 80cc164c7..5584a7771 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 acb2b2484..ac7d0ba88 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 acb2b2484..ac7d0ba88 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 de0cea670..9c61f6235 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 de0cea670..9c61f6235 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 172d03431..97756bc56 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 172d03431..97756bc56 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 27f725980..633e4790d 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 27f725980..633e4790d 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 56ce24fd8..39ce3ee0f 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 56ce24fd8..39ce3ee0f 100644 --- a/docs/management_TicketsManager.js.html +++ b/docs/management_TicketsManager.js.html @@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html index c08308c17..0a846aed4 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 c08308c17..0a846aed4 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 8841c2eec..59b1756af 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 8841c2eec..59b1756af 100644 --- a/docs/management_UsersManager.js.html +++ b/docs/management_UsersManager.js.html @@ -24,7 +24,7 @@
@@ -927,7 +927,7 @@
diff --git a/docs/management_index.js.html b/docs/management_index.js.html index 7e588c5eb..2db99c597 100644 --- a/docs/management_index.js.html +++ b/docs/management_index.js.html @@ -24,7 +24,7 @@
management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html index 7e588c5eb..2db99c597 100644 --- a/docs/management_index.js.html +++ b/docs/management_index.js.html @@ -24,7 +24,7 @@
@@ -73,6 +73,7 @@
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html index c4319b5ee..af6ccbe6c 100644 --- a/docs/module-auth.AuthenticationClient.html +++ b/docs/module-auth.AuthenticationClient.html @@ -24,7 +24,7 @@
management/index.js
var RolesManager = require('./RolesManager'); var HooksManager = require('./HooksManager'); var BrandingManager = require('./BrandingManager'); +var MigrationsManager = require('./MigrationsManager'); var BASE_URL_FORMAT = 'https://%s/api/v2'; var MANAGEMENT_API_AUD_FORMAT = 'https://%s/api/v2/'; @@ -368,6 +369,13 @@management/index.js
* @type {HooksManager} */ this.branding = new BrandingManager(managerOptions); + + /** + * ManagementClient migrations manager. + * + * @type {MigrationsManager} + */ + this.migrations = new MigrationsManager(managerOptions); }; /** @@ -2599,7 +2607,7 @@management/index.js
utils.wrapPropertyMethod( ManagementClient, 'createGuardianEnrollmentTicket', - 'guardian.tickets.create' + 'guardian.createEnrollmentTicket' ); /** @@ -2608,6 +2616,7 @@management/index.js
* @method getGuardianFactors * @memberOf module:management.ManagementClient.prototype * + * @example * management.getGuardianFactors(function (err, factors) { * console.log(factors.length); * }); @@ -2616,7 +2625,7 @@management/index.js
* * @return {Promise|undefined} */ -utils.wrapPropertyMethod(ManagementClient, 'getGuardianFactors', 'guardian.factors.getAll'); +utils.wrapPropertyMethod(ManagementClient, 'getGuardianFactors', 'guardian.getFactors'); /** * Get Guardian factor provider configuration @@ -2624,6 +2633,7 @@management/index.js
* @method getGuardianFactorProvider * @memberOf module:management.ManagementClient.prototype * + * @example * management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) { * console.log(provider); * }); @@ -2636,7 +2646,7 @@management/index.js
utils.wrapPropertyMethod( ManagementClient, 'getGuardianFactorProvider', - 'guardian.factorsProviders.get' + 'guardian.getFactorProvider' ); /** @@ -2645,12 +2655,13 @@management/index.js
* @method updateFactorProvider * @memberOf module:management.ManagementClient.prototype * + * @example * management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, { - * messaging_service_sid: 'XXXXXXXXXXXXXX', - * auth_token: 'XXXXXXXXXXXXXX', - * sid: 'XXXXXXXXXXXXXX' - * }, function(err, provider) { - * console.log(provider); + * messaging_service_sid: 'XXXXXXXXXXXXXX', + * auth_token: 'XXXXXXXXXXXXXX', + * sid: 'XXXXXXXXXXXXXX' + * }, function (err, provider) { + * console.log(provider); * }); * * @param {Object} params Factor provider parameters. @@ -2662,7 +2673,7 @@management/index.js
utils.wrapPropertyMethod( ManagementClient, 'updateGuardianFactorProvider', - 'guardian.factorsProviders.update' + 'guardian.updateFactorProvider' ); /** @@ -2671,6 +2682,7 @@management/index.js
* @method getGuardianFactorTemplates * @memberOf module:management.ManagementClient.prototype * + * @example * management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) { * console.log(templates); * }); @@ -2683,7 +2695,7 @@management/index.js
utils.wrapPropertyMethod( ManagementClient, 'getGuardianFactorTemplates', - 'guardian.factorsTemplates.get' + 'guardian.getFactorTemplates' ); /** @@ -2692,11 +2704,12 @@management/index.js
* @method updateGuardianFactorTemplates * @memberOf module:management.ManagementClient.prototype * + * @example * management.updateGuardianFactorTemplates({ name: 'sms' }, { - * enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.", - * verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}" - * }, function(err, templates) { - * console.log(templates); + * enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.", + * verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}" + * }, function (err, templates) { + * console.log(templates); * }); * * @param {Object} params Factor parameters. @@ -2708,7 +2721,7 @@management/index.js
utils.wrapPropertyMethod( ManagementClient, 'updateGuardianFactorTemplates', - 'guardian.factorsTemplates.update' + 'guardian.updateFactorTemplates' ); /** @@ -2717,10 +2730,11 @@management/index.js
* @method updateGuardianFactor * @memberOf module:management.ManagementClient.prototype * + * @example * management.updateGuardianFactor({ name: 'sms' }, { - * enabled: true - * }, function(err, factor) { - * console.log(factor); + * enabled: true + * }, function (err, factor) { + * console.log(factor); * }); * * @param {Object} params Factor parameters. @@ -2729,7 +2743,139 @@management/index.js
* * @return {Promise|undefined} */ -utils.wrapPropertyMethod(ManagementClient, 'updateGuardianFactor', 'guardian.factors.update'); +utils.wrapPropertyMethod(ManagementClient, 'updateGuardianFactor', 'guardian.updateFactor'); + +/** + * Get enabled Guardian policies + * + * @method getGuardianPolicies + * @memberOf module:management.ManagementClient.prototype + * + * @example + * management.getGuardianPolicies(function (err, policies) { + * console.log(policies); + * }); + * + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod(ManagementClient, 'getGuardianPolicies', 'guardian.getPolicies'); + +/** + * Update enabled Guardian policies + * + * @method updateGuardianPolicies + * @memberOf module:management.ManagementClient.prototype + * + * @example + * management.updateGuardianPolicies({}, [ + * 'all-applications' + * ], function (err, policies) { + * console.log(policies); + * }); + * + * @param {Object} params Parameters. + * @param {String[]} data Policies to enable. Empty array disables all policies. + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod(ManagementClient, 'updateGuardianPolicies', 'guardian.updatePolicies'); + +/** + * Get the Guardian phone factor's selected provider + * + * @method getGuardianPhoneFactorSelectedProvider + * @memberOf module:management.ManagementClient.prototype + * + * @example + * management.getGuardianPhoneFactorSelectedProvider(function (err, selectedProvider) { + * console.log(selectedProvider); + * }); + * + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod( + ManagementClient, + 'getGuardianPhoneFactorSelectedProvider', + 'guardian.getPhoneFactorSelectedProvider' +); + +/** + * Update the Guardian phone factor's selected provider + * + * @method updateGuardianPhoneFactorSelectedProvider + * @memberOf module:management.ManagementClient.prototype + * + * @example + * management.updateGuardianPhoneFactorSelectedProvider({}, { + * provider: 'twilio' + * }, function (err, factor) { + * console.log(factor); + * }); + * + * @param {Object} params Parameters. + * @param {Object} data Updated selected provider data. + * @param {String} data.provider Name of the selected provider + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod( + ManagementClient, + 'updateGuardianPhoneFactorSelectedProvider', + 'guardian.updatePhoneFactorSelectedProvider' +); + +/** + * Get the Guardian phone factor's message types + * + * @method getGuardianPhoneFactorMessageTypes + * @memberOf module:management.ManagementClient.prototype + * + * @example + * management.getGuardianPhoneFactorMessageTypes(function (err, messageTypes) { + * console.log(messageTypes); + * }); + * + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod( + ManagementClient, + 'getGuardianPhoneFactorMessageTypes', + 'guardian.getPhoneFactorMessageTypes' +); + +/** + * Update the Guardian phone factor's message types + * + * @method updateGuardianPhoneFactorMessageTypes + * @memberOf module:management.ManagementClient.prototype + * + * @example + * management.updateGuardianPhoneFactorMessageTypes({}, { + * message_types: ['sms', 'voice'] + * }, function (err, factor) { + * console.log(factor); + * }); + * + * @param {Object} params Parameters. + * @param {Object} data Updated selected provider data. + * @param {String[]} data.message_types Message types (only `"sms"` and `"voice"` are supported). + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod( + ManagementClient, + 'updateGuardianPhoneFactorMessageTypes', + 'guardian.updatePhoneFactorMessageTypes' +); /** * Get all roles. @@ -3247,6 +3393,52 @@management/index.js
*/ utils.wrapPropertyMethod(ManagementClient, 'getBrandingSettings', 'branding.getSettings'); +/** + * Update the tenant migrations. + * + * @method updateMigrations + * @memberOf module:management.ManagementClient.prototype + * + * @example + * data = { flags: { migration: true } }; + * management.updateMigrations(data, function (err, migrations) { + * if (err) { + * // Handle error. + * } + * + * // Updated migrations flags + * console.log(migrations.flags); + * }); + * + * @param {Object} data Updated migrations data. + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod(ManagementClient, 'updateMigrations', 'migrations.updateMigrations'); + +/** + * Get migrations flags + * + * @method getMigrations + * @memberOf module:management.ManagementClient.prototype + * + * @example + * management.getMigrations(function (err, migrations) { + * if (err) { + * // Handle error. + * } + * + * // Migration flags + * console.log(migrations.flags); + * }); + * + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod(ManagementClient, 'getMigrations', 'migrations.getMigrations'); + module.exports = ManagementClient; @@ -3260,7 +3452,7 @@management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html index c4319b5ee..af6ccbe6c 100644 --- a/docs/module-auth.AuthenticationClient.html +++ b/docs/module-auth.AuthenticationClient.html @@ -24,7 +24,7 @@
@@ -4207,7 +4207,7 @@
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html index b5f950710..0c5ab04f4 100644 --- a/docs/module-auth.DatabaseAuthenticator.html +++ b/docs/module-auth.DatabaseAuthenticator.html @@ -24,7 +24,7 @@
Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html index b5f950710..0c5ab04f4 100644 --- a/docs/module-auth.DatabaseAuthenticator.html +++ b/docs/module-auth.DatabaseAuthenticator.html @@ -24,7 +24,7 @@
@@ -1765,7 +1765,7 @@
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html index 7ed87cdf9..1b380ad43 100644 --- a/docs/module-auth.OAUthWithIDTokenValidation.html +++ b/docs/module-auth.OAUthWithIDTokenValidation.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html index 7ed87cdf9..1b380ad43 100644 --- a/docs/module-auth.OAUthWithIDTokenValidation.html +++ b/docs/module-auth.OAUthWithIDTokenValidation.html @@ -24,7 +24,7 @@
@@ -450,7 +450,7 @@
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html index 3b4b8ff4e..d83585d87 100644 --- a/docs/module-auth.OAuthAuthenticator.html +++ b/docs/module-auth.OAuthAuthenticator.html @@ -24,7 +24,7 @@
Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html index 3b4b8ff4e..d83585d87 100644 --- a/docs/module-auth.OAuthAuthenticator.html +++ b/docs/module-auth.OAuthAuthenticator.html @@ -24,7 +24,7 @@
@@ -2050,7 +2050,7 @@
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html index eaa3a4d56..af4ec6aa9 100644 --- a/docs/module-auth.PasswordlessAuthenticator.html +++ b/docs/module-auth.PasswordlessAuthenticator.html @@ -24,7 +24,7 @@
Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html index eaa3a4d56..af4ec6aa9 100644 --- a/docs/module-auth.PasswordlessAuthenticator.html +++ b/docs/module-auth.PasswordlessAuthenticator.html @@ -24,7 +24,7 @@
@@ -1442,7 +1442,7 @@
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html index faa106317..67f4453c4 100644 --- a/docs/module-auth.TokensManager.html +++ b/docs/module-auth.TokensManager.html @@ -24,7 +24,7 @@
Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html index faa106317..67f4453c4 100644 --- a/docs/module-auth.TokensManager.html +++ b/docs/module-auth.TokensManager.html @@ -24,7 +24,7 @@
@@ -352,7 +352,7 @@
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html index 2db164ef0..25fbfac3d 100644 --- a/docs/module-auth.UsersManager.html +++ b/docs/module-auth.UsersManager.html @@ -24,7 +24,7 @@
Parameters:
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html index 2db164ef0..25fbfac3d 100644 --- a/docs/module-auth.UsersManager.html +++ b/docs/module-auth.UsersManager.html @@ -24,7 +24,7 @@
@@ -1009,7 +1009,7 @@
diff --git a/docs/module-auth.html b/docs/module-auth.html index 10c177b4b..9dbcb7f98 100644 --- a/docs/module-auth.html +++ b/docs/module-auth.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-auth.html b/docs/module-auth.html index 10c177b4b..9dbcb7f98 100644 --- a/docs/module-auth.html +++ b/docs/module-auth.html @@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@
diff --git a/docs/module-errors.html b/docs/module-errors.html index 587ea3600..6338e1f35 100644 --- a/docs/module-errors.html +++ b/docs/module-errors.html @@ -24,7 +24,7 @@
Classes
diff --git a/docs/module-errors.html b/docs/module-errors.html index 587ea3600..6338e1f35 100644 --- a/docs/module-errors.html +++ b/docs/module-errors.html @@ -24,7 +24,7 @@
@@ -254,7 +254,7 @@ (st
(st
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 2135922ef..95464f08e 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 87e242ebd..60363e269 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 0b34dccea..4e2ab855e 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 fde48120a..163a612ed 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 bc6bdcb9b..95e8ee063 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -484,6 +484,81 @@ Type:
+
+
+
+
+
+(inner) userAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the
+endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
@@ -541,7 +616,7 @@ createSource:
deleteSource:
Example
+
+
+
+
+ delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete a connection user by email.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Connection parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Connection ID.
+
+
+
+
+
+
+
+
+ email
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ User Email.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.connections.deleteUserByEmail({ id: CONNECTION_ID, email:USER_EMAIL }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // User deleted.
+});
+
+
+
+
+
+
@@ -1028,7 +1398,7 @@ getSource:
getAllSource:
updateSource:
Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 03ffd315c..0f056861a 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 ebd9db73e..852d95b86 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 41f18b371..695997f42 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 27ad509a8..19caed12c 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 fa71e19f3..a47960d4e 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -24,7 +24,7 @@
@@ -842,7 +842,7 @@ deleteGran
Source:
Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index f77df6f02..ec3e5a723 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -464,6 +464,154 @@ external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorsPhoneMessageTypesAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian phone factor message types.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorsPhoneSelectedProviderAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian phone factor selected provider.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
@@ -567,7 +715,7 @@
- Provides an abstraction layer for retrieving Guardian factors.
+ Provides an abstraction layer for retrieving Guardian factor templates.
@@ -612,6 +760,80 @@ external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianPoliciesAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian policies.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
@@ -761,7 +983,7 @@ Source:
Source:
Example
- getGuardianEnrollment(data, cbopt) → {Promise|undefined}
+ getFactorProvider(params, cbopt) → {Promise|undefined}
- Get a single Guardian enrollment.
+ Get Guardian factor provider configuration
@@ -1206,7 +1428,7 @@
Source:
Parameters:
- dataparams
@@ -1277,50 +1499,43 @@ Parameters:
- The user data object.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- The user id.
+ Callback function.
@@ -1329,7 +1544,2515 @@ Parameters:
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
+
+
+
+
+
+
+ getFactors(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a list of factors and statuses.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getFactors(function (err, factors) {
+ console.log(factors.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getFactorTemplates(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get Guardian enrollment and verification factor templates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor parameters.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getFactorTemplates({ name: 'sms' }, function (err, templates) {
+ console.log(templates);
+});
+
+
+
+
+
+
+
+
+
+
+ getGuardianEnrollment(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a single Guardian enrollment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The user data object.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ console.log(enrollment);
+});
+
+
+
+
+
+
+
+
+
+
+ getPhoneFactorMessageTypes(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the Guardian phone factor's message types
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getPhoneFactorMessageTypes(function (err, messageTypes) {
+ console.log(messageTypes);
+});
+
+
+
+
+
+
+
+
+
+
+ getPhoneFactorSelectedProvider(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the Guardian phone factor's selected provider
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getPhoneFactorSelectedProvider(function (err, selectedProvider) {
+ console.log(selectedProvider);
+});
+
+
+
+
+
+
+
+
+
+
+ getPolicies(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get enabled Guardian policies
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getPolicies(function (err, policies) {
+ console.log(policies);
+});
+
+
+
+
+
+
+
+
+
+
+ updateFactor(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian Factor
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated factor data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updateFactor({ name: 'sms' }, {
+ enabled: true
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updateFactorProvider(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian's factor provider
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor provider parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Factor provider data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updateFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ messaging_service_sid: 'XXXXXXXXXXXXXX',
+ auth_token: 'XXXXXXXXXXXXXX',
+ sid: 'XXXXXXXXXXXXXX'
+}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
+
+
+
+
+
+
+ updateFactorTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian enrollment and verification factor templates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated factor templates data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updateFactorProvider({ name: 'sms' }, {
+ enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+}, function (err, templates) {
+ console.log(templates);
+});
+
+
+
+
+
+
+
+
+
+
+ updatePhoneFactorMessageTypes(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the Guardian phone factor's message types
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ message_types
+
+
+Array.<String>
+
+
+
+
+
+
+
+
+
+
+ Message types (only "sms" and "voice" are supported).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updatePhoneFactorMessageTypes({}, {
+ message_types: ['sms', 'voice']
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updatePhoneFactorSelectedProvider(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the Guardian phone factor's selected provider
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Name of the selected provider
+
+
+
+
+
+
+
+
+
@@ -1415,8 +4138,260 @@ Returns:
Example
- management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
- console.log(enrollment);
+ management.guardian.updatePhoneFactorSelectedProvider({}, {
+ provider: 'twilio'
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updatePolicies(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update enabled Guardian policies
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Array.<String>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Policies to enable. Empty array disables all policies.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updatePolicies({}, [
+ 'all-applications'
+], function (err, policies) {
+ console.log(policies);
});
@@ -1440,7 +4415,7 @@ Example
diff --git a/docs/module-management.HooksManager.html b/docs/module-management.HooksManager.html
index 9facca9da..dcf47a8d6 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 b489005bd..debe93a8b 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -2676,7 +2676,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index ee8687280..084e7a64d 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 700e3ee3e..7767f2f9c 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -106,7 +106,7 @@ new M
Source:
blac
Source:
brandingSource:
clientGra
Source:
clientsSource:
connection
Source:
customDo
Source:
devi
Source:
emailPro
Source:
emailTe
Source:
grantsSource:
guardianSource:
hooksSource:
jobsSource:
logsSource:
Type:
+
+
+
+
+
+migrations :MigrationsManager
+
+
+
+
+
+ ManagementClient migrations manager.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
MigrationsManager
+
+
+
+
+
+
+
+
+
@@ -1811,7 +1885,7 @@ resour
Source:
rolesSource:
rulesSource:
rulesConf
Source:
statsSource:
tenantSource:
ticketsSource:
userBlocks<
Source:
usersSource:
addHookS
Source:
a
Source:
Source:
assi
Source:
blackli
Source:
Source:
createCli
Source:
crea
Source:
creat
Source:
cre
Source:
Source:
cr
Source:
Source:
Source:
createHook<
Source:
Source:
c
Source:
createRole<
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
+
+
+
+
+
+
+ getGuardianFactors(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a list of Guardian factors and statuses.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
cbReturns:
Example
- management.getHook({ id: HOOK_ID }, function (err, hook) {
- if (err) {
- // Handle error.
- }
-
- console.log(hook);
+ management.getGuardianFactors(function (err, factors) {
+ console.log(factors.length);
});
@@ -16825,14 +17024,14 @@ Example
- getHooks(paramsopt, cbopt) → {Promise|undefined}
+ getGuardianFactorTemplates(params, cbopt) → {Promise|undefined}
- Get all hooks.
+ Get Guardian enrollment and verification factor templates
@@ -16868,7 +17067,7 @@ getHooksSource:
Parameters:
- <optional>
-
@@ -16941,41 +17138,22 @@ Parameters:
- Hooks parameters.
+ Factor parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+
+
-
- per_pagecb
-Number
+function
@@ -16996,57 +17174,157 @@ Parameters:
- Number of results per page.
+ Callback function.
+
+
-
-
- page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
+ console.log(templates);
+});
+
+
+
+
+
+
-
- Page number, zero indexed.
-
-
-
+
+
+ getGuardianPhoneFactorMessageTypes(cbopt) → {Promise|undefined}
-
-
-
-
-
+
+
+
+ Get the Guardian phone factor's message types
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
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.getGuardianPhoneFactorMessageTypes(function (err, messageTypes) {
+ console.log(messageTypes);
});
@@ -17152,14 +17418,14 @@ Example
- getHookSecrets(params, cbopt) → {Promise|undefined}
+ getGuardianPhoneFactorSelectedProvider(cbopt) → {Promise|undefined}
- Get an Auth0 hook's secrets.
+ Get the Guardian phone factor's selected provider
@@ -17195,7 +17461,7 @@ getHook
Source:
Parameters:
- paramscb
-Object
+function
@@ -17256,6 +17522,8 @@ Parameters:
+ <optional>
+
@@ -17266,64 +17534,157 @@ Parameters:
- Hook parameters.
+ Callback function.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
- Name
-
- Type
+
+
+
+Returns:
+
+ -
+ Type:
+
+ -
+
Promise
+|
+
+undefined
+
+
+
+
- Description
-
-
-
+
-
-
- id
-
-
-String
+
+Example
-
-
+ management.getGuardianPhoneFactorSelectedProvider(function (err, selectedProvider) {
+ console.log(selectedProvider);
+});
-
+
+
+
+
-
- Hook ID.
-
-
-
+
+
+ getGuardianPolicies(cbopt) → {Promise|undefined}
-
-
-
-
-
+
+
+
+ Get enabled Guardian policies
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
cbReturns:
Example
- var params = { id: HOOK_ID }
-management.getHookSecrets(params, function (err, secrets) {
- if (err) {
- // Handle error.
- }
-
- console.log(secrets);
+ management.getGuardianPolicies(function (err, policies) {
+ console.log(policies);
});
@@ -17422,14 +17778,14 @@ Example
- getJob(params, cbopt) → {Promise|undefined}
+ getHook(params, cbopt) → {Promise|undefined}
- Get a job by its ID.
+ Get an Auth0 hook.
@@ -17465,7 +17821,7 @@ getJobSource:
Parameters:
- Job parameters.
+ Hook parameters.
@@ -17579,7 +17935,7 @@ Parameters:
- Job ID.
+ Hook ID.
@@ -17674,17 +18030,12 @@ Returns:
Example
- var params = {
- id: '{JOB_ID}'
-};
-
-management.getJob(params, function (err, job) {
+ management.getHook({ id: HOOK_ID }, function (err, hook) {
if (err) {
// Handle error.
}
- // Retrieved job.
- console.log(job);
+ console.log(hook);
});
@@ -17696,14 +18047,14 @@ Example
- getLog(params, cbopt) → {Promise|undefined}
+ getHooks(paramsopt, cbopt) → {Promise|undefined}
- Get an Auth0 log.
+ Get all hooks.
@@ -17739,7 +18090,7 @@ getLogSource:
Parameters:
+ <optional>
+
@@ -17810,7 +18163,7 @@ Parameters:
- Log parameters.
+ Hooks parameters.
@@ -17824,6 +18177,8 @@ Parameters:
Type
+ Attributes
+
@@ -17836,24 +18191,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- Event ID.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -17948,12 +18349,20 @@ Returns:
Example
- management.getLog({ id: EVENT_ID }, function (err, log) {
- 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(log);
+management.getHooks(params, function (err, hooks) {
+ console.log(hooks.length);
});
@@ -17965,14 +18374,14 @@ Example
- getLogs(paramsopt, cbopt) → {Promise|undefined}
+ getHookSecrets(params, cbopt) → {Promise|undefined}
- Get all logs.
+ Get an Auth0 hook's secrets.
@@ -18008,7 +18417,7 @@ getLogsSource:
Parameters:
- <optional>
-
@@ -18081,7 +18488,7 @@ Parameters:
- Logs params.
+ Hook parameters.
@@ -18095,8 +18502,6 @@ Parameters:
Type
- Attributes
-
@@ -18109,7 +18514,7 @@ Parameters:
- qid
@@ -18122,21 +18527,19 @@ Parameters:
-
-
- <optional>
-
-
+
+
+ Hook ID.
-
-
+
+
-
+
+
+
-
- Search Criteria using Query String Syntax
@@ -18145,13 +18548,13 @@ Parameters:
- pagecb
-Number
+function
@@ -18172,130 +18575,171 @@ Parameters:
- Page number. Zero based
+ Callback function.
+
+
-
-
- per_page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- The amount of entries per page
-
-
-
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
-
-
- sort
-
-
-String
+
+Example
-
-
+ var params = { id: HOOK_ID }
+management.getHookSecrets(params, function (err, secrets) {
+ if (err) {
+ // Handle error.
+ }
-
-
-
- <optional>
-
+ console.log(secrets);
+});
-
+
-
-
+
+
+
-
+
-
- The field to use for sorting.
-
-
-
+ getJob(params, cbopt) → {Promise|undefined}
-
-
- fields
-
-
-String
+
+ Get a job by its ID.
+
-
-
-
-
-
- <optional>
-
-
-
-
-
-
+
-
- A comma separated list of fields to include or exclude
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
- include_fieldsparams
-Boolean
+Object
@@ -18304,8 +18748,6 @@ Parameters:
- <optional>
-
@@ -18316,43 +18758,50 @@ Parameters:
- true if the fields specified are to be included in the result, false otherwise.
+ Job parameters.
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+ Description
+
+
+
+
- include_totalsid
-Boolean
+String
-
-
- <optional>
-
-
-
-
-
-
-
- true if a query summary must be included in the result, false otherwise. Default false
+ Job ID.
@@ -18447,20 +18896,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);
});
@@ -18472,14 +18918,14 @@ Example
- getPermissionsInRole(roleIdopt, cbopt) → {Promise|undefined}
+ getLog(params, cbopt) → {Promise|undefined}
- Get permissions for a given role
+ Get an Auth0 log.
@@ -18515,7 +18961,7 @@ g
Source:
Parameters:
- roleIdparams
-String
+Object
@@ -18576,8 +19022,6 @@ Parameters:
- <optional>
-
@@ -18588,7 +19032,58 @@ Parameters:
- Id of the role
+ Log parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Event ID.
+
+
+
+
+
+
+
+
@@ -18673,18 +19168,14 @@ Returns:
-Examples
-
- var params = { id :'ROLE_ID'};
+Example
-
- This method takes a roleId and
- returns all permissions within that role
+
management.getLog({ id: EVENT_ID }, function (err, log) {
+ if (err) {
+ // Handle error.
+ }
-
-
- management.getPermissionsInRole(params, function (err, permissions) {
- console.log(permissions);
+ console.log(log);
});
@@ -18696,14 +19187,14 @@ Examples
- getResourceServer(params, cbopt) → {Promise|undefined}
+ getLogs(paramsopt, cbopt) → {Promise|undefined}
- Get a Resource Server.
+ Get all logs.
@@ -18739,7 +19230,7 @@ getR
Source:
Parameters:
+ <optional>
+
@@ -18810,7 +19303,7 @@ Parameters:
- Resource Server parameters.
+ Logs params.
@@ -18824,6 +19317,8 @@ Parameters:
Type
+ Attributes
+
@@ -18836,7 +19331,7 @@ Parameters:
- idq
@@ -18849,11 +19344,237 @@ Parameters:
+
+
+ <optional>
+
+
+
+
+
+
+
- Resource Server ID.
+ 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.
+
+
+
+
+
+
+
+
+ fields
+
+
+String
+
+
+
+
+
+
+
+
+ <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
@@ -18948,12 +19669,205 @@ Returns:
Example
- management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+
+ 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
+};
+
+management.getLogs(params, function (err, logs) {
+ console.log(logs.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getMigrations(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get migrations flags
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getMigrations(function (err, migrations) {
if (err) {
// Handle error.
}
- console.log(resourceServer);
+// Migration flags
+ console.log(migrations.flags);
});
@@ -18965,14 +19879,2210 @@ Example
- getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+ getPermissionsInRole(roleIdopt, cbopt) → {Promise|undefined}
- Get all resource servers.
+ Get permissions for a given role
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ roleId
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Id of the role
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Examples
+
+ var params = { id :'ROLE_ID'};
+
+
+ This method takes a roleId and
+ returns all permissions within that role
+
+
+
+ management.getPermissionsInRole(params, function (err, permissions) {
+ console.log(permissions);
+});
+
+
+
+
+
+
+
+
+
+
+ getResourceServer(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a Resource Server.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Resource Server parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Resource Server ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(resourceServer);
+});
+
+
+
+
+
+
+
+
+
+
+ getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all resource servers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Resource Servers parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.getResourceServers(params, function (err, resourceServers) {
+ console.log(resourceServers.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getRole(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get an Auth0 role.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Role parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Role ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getRole({ id: ROLE_ID }, function (err, role) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(role);
+});
+
+
+
+
+
+
+
+
+
+
+ getRoles(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all roles.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Roles parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.getRoles(params, function (err, roles) {
+ console.log(roles.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getRule(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get an Auth0 rule.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rule parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getRule({ id: RULE_ID }, function (err, rule) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(rule);
+});
+
+
+
+
+
+
+
+
+
+
+ getRules(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all rules.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Rules parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.getRules(params, function (err, rules) {
+ console.log(rules.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getRulesConfigs(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get rules config.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getRulesConfigs(function (err, rulesConfigs) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Get Rules Configs.
+});
+
+
+
+
+
+
+
+
+
+
+ getTenantSettings(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the tenant settings..
@@ -19008,7 +22118,7 @@ get
Source:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Resource Servers 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.getSettings(function (err, settings) {
+ if (err) {
+ // Handle error.
+ }
-management.getResourceServers(params, function (err, resourceServers) {
- console.log(resourceServers.length);
+ console.log(settings);
});
@@ -19292,14 +22259,14 @@ Example
- getRole(params, cbopt) → {Promise|undefined}
+ getUser(data, cbopt) → {Promise|undefined}
- Get an Auth0 role.
+ Get a user by its id.
@@ -19335,7 +22302,7 @@ getRoleSource:
Parameters:
- paramsdata
@@ -19406,7 +22373,7 @@ Parameters:
- Role parameters.
+ The user data object.
@@ -19449,7 +22416,7 @@ Parameters:
- Role ID.
+ The user id.
@@ -19544,12 +22511,8 @@ Returns:
Example
- management.getRole({ id: ROLE_ID }, function (err, role) {
- if (err) {
- // Handle error.
- }
-
- console.log(role);
+ management.getUser({ id: USER_ID }, function (err, user) {
+ console.log(user);
});
@@ -19561,14 +22524,14 @@ Example
- getRoles(paramsopt, cbopt) → {Promise|undefined}
+ getUserBlocks(params, cbopt) → {Promise|undefined}
- Get all roles.
+ Get user blocks by its id.
@@ -19604,7 +22567,7 @@ getRolesSource:
Parameters:
- <optional>
-
@@ -19677,7 +22638,7 @@ Parameters:
- Roles parameters.
+ The user data object..
@@ -19691,8 +22652,6 @@ Parameters:
Type
- Attributes
-
@@ -19705,70 +22664,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ The user id.
@@ -19812,7 +22725,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -19863,20 +22776,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.getUserBlocks({ id: USER_ID }, function (err, blocks) {
+ if (err) {
+ // Handle error.
+ }
-management.getRoles(params, function (err, roles) {
- console.log(roles.length);
+ console.log(blocks);
});
@@ -19888,14 +22793,14 @@ Example
- getRule(params, cbopt) → {Promise|undefined}
+ getUserBlocksByIdentifier(params, cbopt) → {Promise|undefined}
- Get an Auth0 rule.
+ Get user blocks by its identifier.
@@ -19931,7 +22836,7 @@ getRuleSource:
Parameters:
- Rule parameters.
+ The user data object..
@@ -20028,7 +22933,7 @@ Parameters:
- ididentifier
@@ -20045,7 +22950,7 @@ Parameters:
- Rule ID.
+ The user identifier, any of: username, phone_number, email.
@@ -20089,7 +22994,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -20140,12 +23045,12 @@ Returns:
Example
- management.getRule({ id: RULE_ID }, function (err, rule) {
+ management.getUserBlocksByIdentifier({ identifier: USER_ID }, function (err, blocks) {
if (err) {
// Handle error.
}
- console.log(rule);
+ console.log(blocks);
});
@@ -20157,14 +23062,14 @@ Example
- getRules(paramsopt, cbopt) → {Promise|undefined}
+ getUserLogs(params, cbopt) → {Promise|undefined}
- Get all rules.
+ Get user's log events.
@@ -20200,7 +23105,7 @@ getRulesSource:
Parameters:
- <optional>
-
@@ -20273,7 +23176,7 @@ Parameters:
- Rules parameters.
+ Get logs data.
@@ -20287,8 +23190,6 @@ Parameters:
Type
- Attributes
-
@@ -20301,28 +23202,44 @@ Parameters:
- per_pageid
-Number
+String
-
-
- <optional>
-
+
+
+
+ User id.
+
+
+
+
+
+
+ per_page
+
-
+Number
+
+
+
+
+
@@ -20350,21 +23267,63 @@ Parameters:
-
+
+
+
+
+ Page number, zero indexed.
- <optional>
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
- Page number, zero indexed.
+ true if a query summary must be included in the result, false otherwise. Default false;
@@ -20459,20 +23418,14 @@ 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
-};
+ var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-management.getRules(params, function (err, rules) {
- console.log(rules.length);
+management.getUserLogs(params, function (err, logs) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logs);
});
@@ -20484,14 +23437,14 @@ Example
- getRulesConfigs(cbopt) → {Promise|undefined}
+ getUserPermissions(params, cbopt) → {Promise|undefined}
- Get rules config.
+ Get user's permissions
@@ -20527,7 +23480,7 @@ getRul
Source:
Parameters:
- cbparams
-function
+Object
@@ -20588,8 +23541,6 @@ Parameters:
- <optional>
-
@@ -20600,159 +23551,166 @@ Parameters:
- Callback function.
+ Get permissions data.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
+
+
+
+
-
-
- -
- Type:
-
- -
+
Name
-Promise
-|
-undefined
+ Type
+
-
-
+
+ Description
+
+
+
-
-
+
+
+ idExample
-
- management.getRulesConfigs(function (err, rulesConfigs) {
- if (err) {
- // Handle error.
- }
+
+
+
+String
- // Get Rules Configs.
-});
-
+
+
-
-
-
-
+
- getTenantSettings(cbopt) → {Promise|undefined}
+
+ User id.
+
+
+
+
+
+ per_pageGet the tenant settings..
-
+
+
+
+Number
+
+
+
+
-
+
+ Number of results per page.
+
+
+
-
+
+
+ page
+
+
+Number
-
-
+
+
-
+
-
+
-
+
+ Page number, zero indexed.
+
+
+
-
+
+
+ sort
+
+
+String
-
-
- Source:
-
-
+
-
+
-
-
+
+ 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;
+
+
+
- Parameters:
+
+
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+
+
+
-
@@ -20835,12 +23793,14 @@ Returns:
Example
- management.getSettings(function (err, settings) {
+ 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(settings);
+ console.log(logs);
});
@@ -20852,14 +23812,14 @@ Example
- getUser(data, cbopt) → {Promise|undefined}
+ getUserRoles(params, cbopt) → {Promise|undefined}
- Get a user by its id.
+ Get user's roles
@@ -20895,7 +23855,7 @@ getUserSource:
Parameters:
- dataparams
@@ -20966,7 +23926,7 @@ Parameters:
- The user data object.
+ Get roles data.
@@ -21009,7 +23969,111 @@ Parameters:
- The user id.
+ 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;
@@ -21104,8 +24168,14 @@ Returns:
Example
- management.getUser({ id: USER_ID }, function (err, user) {
- console.log(user);
+ 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);
});
@@ -21117,14 +24187,14 @@ Example
- getUserBlocks(params, cbopt) → {Promise|undefined}
+ getUsers(paramsopt, cbopt) → {Promise|undefined}
- Get user blocks by its id.
+ Get all users.
@@ -21160,7 +24230,7 @@ getUserB
Source:
Parameters:
+ <optional>
+
@@ -21231,7 +24303,7 @@ Parameters:
- The user data object..
+ Users params.
@@ -21245,6 +24317,8 @@ Parameters:
Type
+ Attributes
+
@@ -21257,7 +24331,43 @@ Parameters:
- idsearch_engine
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The version of the search engine to use.
+
+
+
+
+
+
+
+
+ q
@@ -21270,11 +24380,93 @@ Parameters:
+
+
+ <optional>
+
+
+
+
+
+
+
- The user id.
+ User Search string to filter which users are returned. Follows Lucene query string syntax as documented at https://auth0.com/docs/api/management/v2#!/Users/get_users.
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -21318,7 +24510,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -21369,12 +24561,22 @@ 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 = {
+ search_engine: 'v3',
+ q: 'name:*jane*',
+ per_page: 10,
+ page: 0
+};
- console.log(blocks);
+auth0.getUsers(params, function (err, users) {
+ console.log(users.length);
});
@@ -21386,14 +24588,14 @@ Example
- getUserBlocksByIdentifier(params, cbopt) → {Promise|undefined}
+ getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
- Get user blocks by its identifier.
+ Get users for a given email address
@@ -21429,7 +24631,7 @@ Source:
Parameters:
- paramsemail
-Object
+String
@@ -21490,68 +24692,19 @@ Parameters:
-
-
-
+ <optional>
-
-
-
-
-
- The user data object..
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- identifier
-
-String
-
-
-
-
-
+
- The user identifier, any of: username, phone_number, email.
-
-
-
-
-
-
-
-
+ Email Address of users to locate
@@ -21587,7 +24740,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -21638,12 +24791,13 @@ Returns:
Example
- management.getUserBlocksByIdentifier({ identifier: USER_ID }, function (err, blocks) {
- if (err) {
- // Handle error.
- }
-
- console.log(blocks);
+
+ This method takes an email address as the first argument,
+ and returns all users with that email address
+
+
+ auth0.getUsersByEmail(email, function (err, users) {
+ console.log(users);
});
@@ -21655,14 +24809,14 @@ Example
- getUserLogs(params, cbopt) → {Promise|undefined}
+ getUsersInRole(idopt, cbopt) → {Promise|undefined}
- Get user's log events.
+ Get users in a given role
@@ -21698,7 +24852,7 @@ getUserLog
Source:
Parameters:
- paramsid
-Object
+String
@@ -21759,6 +24913,8 @@ Parameters:
+ <optional>
+
@@ -21769,70 +24925,37 @@ Parameters:
- Get logs data.
+ Id of the role
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idparams.per_page
-String
+Number
-
-
-
-
- User id.
+
-
-
-
-
-
-
-
- per_page
-
+ <optional>
-Number
-
-
-
+
+
+
@@ -21847,7 +24970,7 @@ Parameters:
- pageparams.page
@@ -21860,71 +24983,21 @@ Parameters:
-
-
-
-
- Page number, zero indexed.
+
-
-
-
-
-
-
-
- sort
-
+ <optional>
-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;
-
-
-
-
-
-
-
-
+ Page number, zero indexed.
@@ -22009,16 +25082,20 @@ Returns:
-Example
-
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+Examples
-management.getUserLogs(params, function (err, logs) {
- if (err) {
- // Handle error.
- }
+ var params = {
+ id: 'ROLE_ID'
+ per_page: 50,
+ page: 0
+};
- console.log(logs);
+
+ This method takes a roleId and returns all users within that role
+
+
+ management.getUsersInRole(params, function (err, users) {
+ console.log(users);
});
@@ -22030,14 +25107,16 @@ Example
- getUserPermissions(params, cbopt) → {Promise|undefined}
+ importUsers(data, cbopt) → {Promise|undefined}
- Get user's permissions
+ Given a path to a file and a connection id, create a new job that imports the
+users contained in the file or JSON string and associate them with the given
+connection.
@@ -22073,7 +25152,7 @@ get
Source:
Parameters:
- paramsdata
@@ -22144,7 +25223,7 @@ Parameters:
- Get permissions data.
+ Users import data.
@@ -22158,6 +25237,8 @@ Parameters:
Type
+ Attributes
+
@@ -22170,7 +25251,7 @@ Parameters:
- idconnection_id
@@ -22183,11 +25264,19 @@ Parameters:
+
+
+
+
+
+
+
+
- User id.
+ connection_id of the connection to which users will be imported.
@@ -22196,24 +25285,34 @@ Parameters:
- per_pageusers
-Number
+String
+
+
+ <optional>
+
+
+
+
+
+
+
- Number of results per page.
+ Path to the users data file. Either users or users_json is mandatory.
@@ -22222,24 +25321,34 @@ Parameters:
- pageusers_json
-Number
+String
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ JSON data for the users.
@@ -22248,24 +25357,34 @@ Parameters:
- sortupsert
-String
+Boolean
+
+
+ <optional>
+
+
+
+
+
+
+
- The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+ Whether to update users if they already exist (true) or to ignore them (false).
@@ -22274,7 +25393,7 @@ Parameters:
- include_totalssend_completion_email
@@ -22287,11 +25406,21 @@ Parameters:
+
+
+ <optional>
+
+
+
+
+
+
+
- true if a query summary must be included in the result, false otherwise. Default false;
+ Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
@@ -22386,14 +25515,15 @@ Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+ var params = {
+ connection_id: '{CONNECTION_ID}',
+ users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}'
+};
-management.getUserPermissions(params, function (err, logs) {
+management.importUsers(params, function (err) {
if (err) {
// Handle error.
}
-
- console.log(logs);
});
@@ -22405,14 +25535,14 @@ Example
- getUserRoles(params, cbopt) → {Promise|undefined}
+ linkUsers(userId, params, cbopt) → {Promise|undefined}
- Get user's roles
+ Link the user with another account.
@@ -22448,7 +25578,7 @@ getUserRo
Source:
Parameters:
- paramsuserId
-Object
+String
@@ -22519,111 +25649,67 @@ Parameters:
- Get roles data.
+ ID of the primary user.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idparams
-String
+Object
-
-
-
-
- User id.
+
-
-
-
-
-
-
- per_page
-
-Number
-
-
-
-
+
+
- Number of results per page.
-
-
-
-
-
-
-
-
- page
-
+ Secondary user data.
-Number
+
+
+
+
+
+ Name
+
-
-
+ Type
-
+
-
+
-
- Page number, zero indexed.
-
-
-
+ Description
+
+
+
- sortuser_id
@@ -22640,7 +25726,7 @@ Parameters:
- The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+ ID of the user to be linked.
@@ -22649,13 +25735,13 @@ Parameters:
- include_totalsconnection_id
-Boolean
+String
@@ -22666,7 +25752,7 @@ Parameters:
- true if a query summary must be included in the result, false otherwise. Default false;
+ ID of the connection to be used.
@@ -22761,14 +25847,18 @@ Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+ var userId = 'USER_ID';
+var params = {
+ user_id: 'OTHER_USER_ID',
+ connection_id: 'CONNECTION_ID'
+};
-management.getUserRoles(params, function (err, logs) {
+management.linkUsers(userId, params, function (err, user) {
if (err) {
// Handle error.
}
- console.log(logs);
+ // Users linked.
});
@@ -22780,14 +25870,14 @@ Example
- getUsers(paramsopt, cbopt) → {Promise|undefined}
+ regenerateRecoveryCode(data, cbopt) → {Promise|undefined}
- Get all users.
+ Generate new Guardian recovery code.
@@ -22823,7 +25913,7 @@ getUsersSource:
Parameters:
- paramsdata
@@ -22884,8 +25974,6 @@ Parameters:
- <optional>
-
@@ -22896,7 +25984,7 @@ Parameters:
- Users params.
+ The user data object.
@@ -22910,8 +25998,6 @@ Parameters:
Type
- Attributes
-
@@ -22924,43 +26010,7 @@ Parameters:
- search_engine
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The version of the search engine to use.
-
-
-
-
-
-
-
-
- qid
@@ -22973,93 +26023,11 @@ Parameters:
-
-
- <optional>
-
-
-
-
-
-
-
- User Search string to filter which users are returned. Follows Lucene query string syntax as documented at https://auth0.com/docs/api/management/v2#!/Users/get_users.
-
-
-
-
-
-
-
-
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Page number, zero indexed.
+ The user id.
@@ -23154,22 +26122,8 @@ 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 = {
- search_engine: 'v3',
- q: 'name:*jane*',
- per_page: 10,
- page: 0
-};
-
-auth0.getUsers(params, function (err, users) {
- console.log(users.length);
+ management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
+ console.log(newRecoveryCode);
});
@@ -23181,14 +26135,14 @@ Example
- getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+ removeHookSecrets(params, data, cbopt) → {Promise|undefined}
- Get users for a given email address
+ Delete an existing hook.
@@ -23224,7 +26178,7 @@ getUse
Source:
Parameters:
- emailparams
-String
+Object
@@ -23285,7 +26239,90 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+
+ Hook parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Hook ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
@@ -23297,7 +26334,7 @@ Parameters:
- Email Address of users to locate
+ Secrets key/value pairs
@@ -23384,13 +26421,14 @@ Returns:
Example
-
- This method takes an email address as the first argument,
- and returns all users with that email address
-
-
- auth0.getUsersByEmail(email, function (err, users) {
- console.log(users);
+ var params = { id: HOOK_ID }
+var data = ['API_TOKEN', 'DB_PASSWORD']
+auth0.removeHookSecrets(params, data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Hook deleted.
});
@@ -23402,14 +26440,14 @@ Example
- getUsersInRole(idopt, cbopt) → {Promise|undefined}
+ removePermissionsFromRole(data, cbopt) → {Promise|undefined}
- Get users in a given role
+ Remove permissions from a role
@@ -23445,7 +26483,7 @@ getUser
Source:
Parameters:
- idparams.id
@@ -23506,8 +26544,6 @@ Parameters:
- <optional>
-
@@ -23518,7 +26554,7 @@ Parameters:
- Id of the role
+ ID of the Role.
@@ -23527,13 +26563,13 @@ Parameters:
- params.per_pagedata
-Number
+Object
@@ -23542,8 +26578,6 @@ Parameters:
- <optional>
-
@@ -23554,43 +26588,135 @@ Parameters:
- Number of results per page.
+ permissions data
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+ Description
+
+
+
+
- params.pagepermissions
-Number
+String
-
+
+
+
+
+ Array of permissions
- <optional>
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ permission_name
+
+String
+
+
+
+
+
+
+
+
+
+ Name of a permission
+
+
+
+
+
+
+ resource_server_identifier
+
-
+String
+
+
+
+
+
- Page number, zero indexed.
+ Identifier for a resource
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -23675,20 +26801,13 @@ Returns:
-Examples
+Example
- var params = {
- id: 'ROLE_ID'
- per_page: 50,
- page: 0
-};
+ var params = { id :'ROLE_ID'};
+var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
-
- This method takes a roleId and returns all users within that role
-
-
- management.getUsersInRole(params, function (err, users) {
- console.log(users);
+management.removePermissionsFromRole(params, data, function (err, permissions) {
+ console.log(permissions);
});
@@ -23700,16 +26819,14 @@ Examples
- importUsers(data, cbopt) → {Promise|undefined}
+ removePermissionsFromUser(params, data, cbopt) → {Promise|undefined}
- Given a path to a file and a connection id, create a new job that imports the
-users contained in the file or JSON string and associate them with the given
-connection.
+ Remove permissions from a user
@@ -23745,7 +26862,7 @@ importUser
Source:
Parameters:
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Users import data.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- connection_idparams
-String
+Object
@@ -23869,16 +26933,33 @@ Parameters:
- connection_id of the connection to which users will be imported.
+ params object
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+ Description
+
+
+
+
- usersid
@@ -23891,21 +26972,19 @@ Parameters:
-
-
- <optional>
-
-
+
+
+ user_id
-
-
+
+
-
+
+
+
-
- Path to the users data file. Either users or users_json is mandatory.
@@ -23914,7 +26993,7 @@ Parameters:
- users_jsondata
@@ -23929,8 +27008,6 @@ Parameters:
- <optional>
-
@@ -23941,79 +27018,50 @@ Parameters:
- JSON data for the users.
-
-
-
-
-
-
-
-
- upsert
-
+ data object containing list of permission IDs
-Boolean
-
-
-
-
+
-
-
-
- <optional>
-
+
+
+
+
+ Name
+
-
+ Type
-
-
-
+
-
+
-
- Whether to update users if they already exist (true) or to ignore them (false).
-
-
-
+ Description
+
+
+
- send_completion_emailpermissions
-Boolean
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
+ Array of permission IDs
@@ -24108,15 +27156,15 @@ Returns:
Example
- var params = {
- connection_id: '{CONNECTION_ID}',
- users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}'
-};
+ var parms = { id : 'USER_ID'};
+var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
-management.importUsers(params, function (err) {
+management.removePermissionsFromUser(params, data, function (err) {
if (err) {
// Handle error.
}
+
+ // User assigned permissions.
});
@@ -24128,14 +27176,14 @@ Example
- linkUsers(userId, params, cbopt) → {Promise|undefined}
+ removeRolesFromUser(params, data, cbopt) → {Promise|undefined}
- Link the user with another account.
+ Remove roles from a user
@@ -24171,7 +27219,7 @@ linkUsersSource:
Parameters:
- userIdparams
-String
+Object
@@ -24242,7 +27290,58 @@ Parameters:
- ID of the primary user.
+ params object
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ user_id
+
+
+
+
+
+
+
+
@@ -24251,13 +27350,13 @@ Parameters:
- paramsdata
-Object
+String
@@ -24276,7 +27375,7 @@ Parameters:
- Secondary user data.
+ data object containing list of role IDs
@@ -24302,33 +27401,7 @@ Parameters:
- user_id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- ID of the user to be linked.
-
-
-
-
-
-
-
-
- connection_idroles
@@ -24345,7 +27418,7 @@ Parameters:
- ID of the connection to be used.
+ Array of role IDs
@@ -24440,18 +27513,15 @@ Returns:
Example
- var userId = 'USER_ID';
-var params = {
- user_id: 'OTHER_USER_ID',
- connection_id: 'CONNECTION_ID'
-};
+ var parms = { id : 'USER_ID'};
+var data = { "roles" :["role1"]};
-management.linkUsers(userId, params, function (err, user) {
+management.removeRolesFromUser(params, data, function (err) {
if (err) {
// Handle error.
}
- // Users linked.
+ // User assigned roles.
});
@@ -24463,14 +27533,14 @@ Example
- regenerateRecoveryCode(data, cbopt) → {Promise|undefined}
+ sendEmailVerification(data, cbopt) → {Promise|undefined}
- Generate new Guardian recovery code.
+ Send a verification email to a user.
@@ -24506,7 +27576,7 @@ Source:
Parameters:
- The user data object.
+ User data object.
@@ -24603,7 +27673,7 @@ Parameters:
- iduser_id
@@ -24620,7 +27690,7 @@ Parameters:
- The user id.
+ ID of the user to be verified.
@@ -24715,8 +27785,14 @@ Returns:
Example
- management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
- console.log(newRecoveryCode);
+ var params = {
+ user_id: '{USER_ID}'
+};
+
+management.sendEmailVerification(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
});
@@ -24728,14 +27804,14 @@ Example
- removeHookSecrets(params, data, cbopt) → {Promise|undefined}
+ setRulesConfig(params, data, cbopt) → {Promise|undefined}
- Delete an existing hook.
+ Set a new rules config.
@@ -24771,7 +27847,7 @@ remo
Source:
Parameters:
- Hook parameters.
+ Rule Config parameters.
@@ -24868,7 +27944,7 @@ Parameters:
- idkey
@@ -24885,7 +27961,7 @@ Parameters:
- Hook ID.
+ Rule Config key.
@@ -24927,7 +28003,58 @@ Parameters:
- Secrets key/value pairs
+ Rule Config Data parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ value
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule Config Data value.
+
+
+
+
+
+
+
+
@@ -25014,14 +28141,15 @@ Returns:
Example
- var params = { id: HOOK_ID }
-var data = ['API_TOKEN', 'DB_PASSWORD']
-auth0.removeHookSecrets(params, data, function (err) {
+ var params = { key: RULE_CONFIG_KEY };
+var data = { value: RULES_CONFIG_VALUE };
+
+management.setRulesConfig(params, data, function (err, rulesConfig) {
if (err) {
// Handle error.
}
- // Hook deleted.
+ // Rules Config set.
});
@@ -25033,14 +28161,14 @@ Example
- removePermissionsFromRole(data, cbopt) → {Promise|undefined}
+ unblockUser(params, cbopt) → {Promise|undefined}
- Remove permissions from a role
+ Unblock an user by its id.
@@ -25076,7 +28204,7 @@ Source:
Parameters:
- params.idparams
-String
+Object
@@ -25147,7 +28275,58 @@ Parameters:
- ID of the Role.
+ The user data object..
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
@@ -25156,13 +28335,13 @@ Parameters:
- datacb
-Object
+function
@@ -25171,6 +28350,8 @@ Parameters:
+ <optional>
+
@@ -25181,9 +28362,138 @@ Parameters:
- permissions data
+ Callback function
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.unblockUser({ id: USER_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // User unblocked.
+});
+
+
+
+
+
+
+
+
+
+
+ unblockUser(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Unblock an user by its id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
@@ -25195,6 +28505,8 @@ Parameters:
Type
+ Attributes
+
@@ -25207,24 +28519,32 @@ Parameters:
- permissionsparams
-String
+Object
+
+
+
+
+
+
+
+
- Array of permissions
+ The user data object..
@@ -25250,33 +28570,7 @@ Parameters:
- permission_name
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Name of a permission
-
-
-
-
-
-
-
-
- resource_server_identifieridentifier
@@ -25293,15 +28587,7 @@ Parameters:
- Identifier for a resource
-
-
-
-
-
-
-
-
+ The user identifier, any of: username, phone_number, email.
@@ -25345,7 +28631,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -25396,11 +28682,12 @@ Returns:
Example
- var params = { id :'ROLE_ID'};
-var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
-management.removePermissionsFromRole(params, data, function (err, permissions) {
- console.log(permissions);
+ // User unblocked.
});
@@ -25412,14 +28699,14 @@ Example
- removePermissionsFromUser(params, data, cbopt) → {Promise|undefined}
+ unlinkUsers(params, cbopt) → {Promise|undefined}
- Remove permissions from a user
+ Unlink the given accounts.
@@ -25455,7 +28742,7 @@ Source:
Parameters:
- params object
+ Linked users data.
@@ -25569,15 +28856,7 @@ Parameters:
- user_id
-
-
-
-
-
-
-
-
+ Primary user ID.
@@ -25586,7 +28865,7 @@ Parameters:
- dataprovider
@@ -25599,45 +28878,20 @@ Parameters:
-
-
-
-
-
-
-
-
- data object containing list of permission IDs
+ Identity provider in use.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- permissionsuser_id
@@ -25654,7 +28908,7 @@ Parameters:
- Array of permission IDs
+ Secondary user ID.
@@ -25749,15 +29003,14 @@ Returns:
Example
- var parms = { id : 'USER_ID'};
-var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
+ var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
-management.removePermissionsFromUser(params, data, function (err) {
+management.unlinkUsers(params, function (err, user) {
if (err) {
// Handle error.
}
- // User assigned permissions.
+ // Users accounts unlinked.
});
@@ -25769,14 +29022,14 @@ Example
- removeRolesFromUser(params, data, cbopt) → {Promise|undefined}
+ updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
- Remove roles from a user
+ Update the app metadata for a user.
@@ -25812,7 +29065,7 @@ re
Source:
Parameters:
- params object
+ The user data object..
@@ -25926,7 +29179,7 @@ Parameters:
- user_id
+ The user id.
@@ -25943,13 +29196,13 @@ Parameters:
- datametadata
-String
+Object
@@ -25968,58 +29221,7 @@ Parameters:
- data object containing list of role IDs
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- roles
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Array of role IDs
-
-
-
-
-
-
-
-
+ New app metadata.
@@ -26055,7 +29257,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -26106,15 +29308,18 @@ Returns:
Example
- var parms = { id : 'USER_ID'};
-var data = { "roles" :["role1"]};
+ var params = { id: USER_ID };
+var metadata = {
+ foo: 'bar'
+};
-management.removeRolesFromUser(params, data, function (err) {
+management.updateAppMetadata(params, metadata, function (err, user) {
if (err) {
// Handle error.
}
- // User assigned roles.
+ // Updated user.
+ console.log(user);
});
@@ -26126,14 +29331,14 @@ Example
- sendEmailVerification(data, cbopt) → {Promise|undefined}
+ updateBrandingSettings(params, data, cbopt) → {Promise|undefined}
- Send a verification email to a user.
+ Update the branding settings.
@@ -26169,7 +29374,7 @@
Source:
Parameters:
- dataparams
@@ -26240,58 +29445,41 @@ Parameters:
- User data object.
+ Branding parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- user_iddata
-String
+Object
+
+
-
+
-
- ID of the user to be verified.
-
-
+
+
-
-
-
+
+
+ Updated branding data.
@@ -26378,14 +29566,13 @@ Returns:
Example
- var params = {
- user_id: '{USER_ID}'
-};
-
-management.sendEmailVerification(params, function (err) {
+ management.updateBrandingSettings(data, function (err, branding) {
if (err) {
// Handle error.
}
+
+// Updated branding
+ console.log(branding);
});
@@ -26397,14 +29584,14 @@ Example
- setRulesConfig(params, data, cbopt) → {Promise|undefined}
+ updateClient(params, data, cbopt) → {Promise|undefined}
- Set a new rules config.
+ Update an Auth0 client.
@@ -26440,7 +29627,7 @@ setRule
Source:
Parameters:
- Rule Config parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- key
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Rule Config key.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Rule Config Data parameters.
+ Client parameters.
@@ -26622,7 +29724,7 @@ Parameters:
- valueclient_id
@@ -26639,7 +29741,7 @@ Parameters:
- Rule Config Data value.
+ Application client ID.
@@ -26654,6 +29756,40 @@ Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated client data.
+
+
+
+
+
+
cbReturns:
Example
- var params = { key: RULE_CONFIG_KEY };
-var data = { value: RULES_CONFIG_VALUE };
+ var data = { name: 'newClientName' };
+var params = { client_id: CLIENT_ID };
-management.setRulesConfig(params, data, function (err, rulesConfig) {
+management.updateClient(params, data, function (err, client) {
if (err) {
// Handle error.
}
- // Rules Config set.
+ console.log(client.name); // 'newClientName'
});
@@ -26754,14 +29890,14 @@ Example
- unblockUser(params, cbopt) → {Promise|undefined}
+ updateClientGrant(params, data, cbopt) → {Promise|undefined}
- Unblock an user by its id.
+ Update an Auth0 client grant.
@@ -26797,7 +29933,7 @@ unblockUse
Source:
Parameters:
- The user data object..
+ Client parameters.
@@ -26911,7 +30047,7 @@ Parameters:
- The user id.
+ Client grant ID.
@@ -26926,6 +30062,40 @@ Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated client data.
+
+
+
+
+
+
cbParameters:
- Callback function
+ Callback function.
@@ -27006,12 +30176,19 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ var data = {
+ client_id: CLIENT_ID,
+ audience: AUDIENCE,
+ scope: []
+};
+var params = { id: CLIENT_GRANT_ID };
+
+management.clientGrants.update(params, data, function (err, grant) {
if (err) {
// Handle error.
}
- // User unblocked.
+ console.log(grant.id);
});
@@ -27023,14 +30200,14 @@ Example
- unblockUser(params, cbopt) → {Promise|undefined}
+ updateConnection(params, data, cbopt) → {Promise|undefined}
- Unblock an user by its id.
+ Update an existing connection.
@@ -27066,7 +30243,7 @@ unblockUse
Source:
Parameters:
- The user data object..
+ Connection parameters.
@@ -27163,7 +30340,7 @@ Parameters:
- identifierid
@@ -27180,7 +30357,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ Connection ID.
@@ -27195,6 +30372,40 @@ Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated connection data.
+
+
+
+
+
+
cbParameters:
- Callback function
+ Callback function.
@@ -27275,12 +30486,15 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ var data = { name: 'newConnectionName' };
+var params = { id: CONNECTION_ID };
+
+management.updateConnection(params, data, function (err, connection) {
if (err) {
// Handle error.
}
- // User unblocked.
+ console.log(connection.name); // 'newConnectionName'
});
@@ -27292,14 +30506,14 @@ Example
- unlinkUsers(params, cbopt) → {Promise|undefined}
+ updateEmailProvider(params, data, cbopt) → {Promise|undefined}
- Unlink the given accounts.
+ Update the email provider.
@@ -27335,7 +30549,7 @@ unlinkUser
Source:
Parameters:
- Linked users data.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Primary user ID.
+ Email provider parameters.
@@ -27458,58 +30629,32 @@ Parameters:
- providerdata
-String
+Object
-
-
-
-
- Identity provider in use.
+
-
-
-
-
-
-
-
- user_id
-
-String
-
-
-
-
+
+
- Secondary user ID.
-
-
-
-
-
-
-
-
+ Updated email provider data.
@@ -27596,14 +30741,13 @@ Returns:
Example
- var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
-
-management.unlinkUsers(params, function (err, user) {
+ management.updateEmailProvider(params, data, function (err, provider) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // Updated email provider.
+ console.log(provider);
});
@@ -27615,14 +30759,14 @@ Example
- updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
- Update the app metadata for a user.
+ Update an existing Email Template.
@@ -27658,7 +30802,7 @@ upda
Source:
Parameters:
- The user data object..
+ Email Template parameters.
@@ -27755,7 +30899,7 @@ Parameters:
- idname
@@ -27772,7 +30916,7 @@ Parameters:
- The user id.
+ Template Name
@@ -27789,7 +30933,7 @@ Parameters:
- metadatadata
@@ -27814,7 +30958,7 @@ Parameters:
- New app metadata.
+ Updated Email Template data.
@@ -27850,7 +30994,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -27901,18 +31045,15 @@ Returns:
Example
- var params = { id: USER_ID };
-var metadata = {
- foo: 'bar'
-};
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
-management.updateAppMetadata(params, metadata, function (err, user) {
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+ console.log(emailTemplate.from); // 'new@email.com'
});
@@ -27924,14 +31065,14 @@ Example
- updateBrandingSettings(params, data, cbopt) → {Promise|undefined}
+ updateFactorProvider(params, data, cbopt) → {Promise|undefined}
- Update the branding settings.
+ Update Guardian's factor provider
@@ -27967,7 +31108,7 @@ Source:
Parameters:
- Branding parameters.
+ Factor provider parameters.
@@ -28072,7 +31213,7 @@ Parameters:
- Updated branding data.
+ Updated Factor provider data.
@@ -28159,13 +31300,12 @@ Returns:
Example
- management.updateBrandingSettings(data, function (err, branding) {
- if (err) {
- // Handle error.
- }
-
-// Updated branding
- console.log(branding);
+ management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ messaging_service_sid: 'XXXXXXXXXXXXXX',
+ auth_token: 'XXXXXXXXXXXXXX',
+ sid: 'XXXXXXXXXXXXXX'
+}, function (err, provider) {
+ console.log(provider);
});
@@ -28177,14 +31317,14 @@ Example
- updateClient(params, data, cbopt) → {Promise|undefined}
+ updateGuardianFactor(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client.
+ Update Guardian Factor
@@ -28220,7 +31360,7 @@ updateCli
Source:
Parameters:
- Client parameters.
+ Factor parameters.
-
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated factor data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.updateGuardianFactor({ name: 'sms' }, {
+ enabled: true
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updateGuardianFactorTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian enrollment and verification factor templates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
@@ -28305,6 +31642,8 @@ Parameters:
Type
+ Attributes
+
@@ -28317,32 +31656,32 @@ Parameters:
- client_idparams
-String
+Object
+
+
-
+
-
- Application client ID.
-
-
+
+
-
-
-
+
+
+ Factor parameters.
@@ -28376,7 +31715,7 @@ Parameters:
- Updated client data.
+ Updated factor templates data.
@@ -28463,15 +31802,11 @@ Returns:
Example
- var data = { name: 'newClientName' };
-var params = { client_id: CLIENT_ID };
-
-management.updateClient(params, data, function (err, client) {
- if (err) {
- // Handle error.
- }
-
- console.log(client.name); // 'newClientName'
+ management.updateGuardianFactorTemplates({ name: 'sms' }, {
+ enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+}, function (err, templates) {
+ console.log(templates);
});
@@ -28483,14 +31818,14 @@ Example
- updateClientGrant(params, data, cbopt) → {Promise|undefined}
+ updateGuardianPhoneFactorMessageTypes(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client grant.
+ Update the Guardian phone factor's message types
@@ -28526,7 +31861,7 @@ upda
Source:
Parameters:
- Client parameters.
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
@@ -28623,13 +31992,13 @@ Parameters:
- idmessage_types
-String
+Array.<String>
@@ -28640,7 +32009,7 @@ Parameters:
- Client grant ID.
+ Message types (only "sms" and "voice" are supported).
@@ -28655,40 +32024,6 @@ Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Updated client data.
-
-
-
-
-
-
cbReturns:
Example
- var data = {
- client_id: CLIENT_ID,
- audience: AUDIENCE,
- scope: []
-};
-var params = { id: CLIENT_GRANT_ID };
-
-management.clientGrants.update(params, data, function (err, grant) {
- if (err) {
- // Handle error.
- }
-
- console.log(grant.id);
+ management.updateGuardianPhoneFactorMessageTypes({}, {
+ message_types: ['sms', 'voice']
+}, function (err, factor) {
+ console.log(factor);
});
@@ -28793,14 +32119,14 @@ Example
- updateConnection(params, data, cbopt) → {Promise|undefined}
+ updateGuardianPhoneFactorSelectedProvider(params, data, cbopt) → {Promise|undefined}
- Update an existing connection.
+ Update the Guardian phone factor's selected provider
@@ -28836,7 +32162,7 @@ updat
Source:
Parameters:
- Connection parameters.
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
@@ -28933,7 +32293,7 @@ Parameters:
- idprovider
@@ -28950,7 +32310,7 @@ Parameters:
- Connection ID.
+ Name of the selected provider
@@ -28965,40 +32325,6 @@ Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Updated connection data.
-
-
-
-
-
-
cbReturns:
Example
- var data = { name: 'newConnectionName' };
-var params = { id: CONNECTION_ID };
-
-management.updateConnection(params, data, function (err, connection) {
- if (err) {
- // Handle error.
- }
-
- console.log(connection.name); // 'newConnectionName'
+ management.updateGuardianPhoneFactorSelectedProvider({}, {
+ provider: 'twilio'
+}, function (err, factor) {
+ console.log(factor);
});
@@ -29099,14 +32420,14 @@ Example
- updateEmailProvider(params, data, cbopt) → {Promise|undefined}
+ updateGuardianPolicies(params, data, cbopt) → {Promise|undefined}
- Update the email provider.
+ Update enabled Guardian policies
@@ -29142,7 +32463,7 @@ up
Source:
Parameters:
- Email provider parameters.
+ Parameters.
@@ -29228,7 +32549,7 @@ Parameters:
-Object
+Array.<String>
@@ -29247,7 +32568,7 @@ Parameters:
- Updated email provider data.
+ Policies to enable. Empty array disables all policies.
@@ -29334,13 +32655,10 @@ Returns:
Example
- management.updateEmailProvider(params, data, function (err, provider) {
- if (err) {
- // Handle error.
- }
-
- // Updated email provider.
- console.log(provider);
+ management.updateGuardianPolicies({}, [
+ 'all-applications'
+], function (err, policies) {
+ console.log(policies);
});
@@ -29352,14 +32670,14 @@ Example
- updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+ updateHook(params, data, cbopt) → {Promise|undefined}
- Update an existing Email Template.
+ Update an existing hook.
@@ -29395,7 +32713,7 @@ u
Source:
Parameters:
- Email Template parameters.
+ Hook parameters.
@@ -29492,7 +32810,7 @@ Parameters:
- nameid
@@ -29509,7 +32827,7 @@ Parameters:
- Template Name
+ Hook ID.
@@ -29551,7 +32869,7 @@ Parameters:
- Updated Email Template data.
+ Updated hook data.
@@ -29638,15 +32956,14 @@ Returns:
Example
- var data = { from: 'new@email.com' };
-var params = { name: EMAIL_TEMPLATE_NAME };
-
-management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ var params = { id: HOOK_ID };
+var data = { name: 'my-hook'};
+management.updateHook(params, data, function (err, hook) {
if (err) {
// Handle error.
}
- console.log(emailTemplate.from); // 'new@email.com'
+ console.log(hook.name); // 'my-hook'.
});
@@ -29658,7 +32975,7 @@ Example
- updateHook(params, data, cbopt) → {Promise|undefined}
+ updateHookSecrets(params, data, cbopt) → {Promise|undefined}
@@ -29701,7 +33018,7 @@ updateHook<
Source:
Parameters:
- Updated hook data.
+ Secrets key/value pairs
@@ -29945,13 +33262,13 @@ Returns:
Example
var params = { id: HOOK_ID };
-var data = { name: 'my-hook'};
-management.updateHook(params, data, function (err, hook) {
+var data = { API_TOKEN: 'updated-secret'};
+management.updateHookSecrets(params, data, function (err, secrets) {
if (err) {
// Handle error.
}
- console.log(hook.name); // 'my-hook'.
+ console.log(secrets)
});
@@ -29963,14 +33280,14 @@ Example
- updateHookSecrets(params, data, cbopt) → {Promise|undefined}
+ updateMigrations(data, cbopt) → {Promise|undefined}
- Update an existing hook.
+ Update the tenant migrations.
@@ -30006,7 +33323,7 @@ upda
Source:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Hook parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Hook ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
dataParameters:
- Secrets key/value pairs
+ Updated migrations data.
@@ -30249,14 +33481,14 @@ Returns:
Example
- var params = { id: HOOK_ID };
-var data = { API_TOKEN: 'updated-secret'};
-management.updateHookSecrets(params, data, function (err, secrets) {
+ data = { flags: { migration: true } };
+management.updateMigrations(data, function (err, migrations) {
if (err) {
// Handle error.
}
- console.log(secrets)
+// Updated migrations flags
+ console.log(migrations.flags);
});
@@ -30311,7 +33543,7 @@ u
Source:
updateRole<
Source:
updateRule<
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 76a32b605..f8ce1198e 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.MigrationsManager.html b/docs/module-management.MigrationsManager.html
new file mode 100644
index 000000000..97c347c60
--- /dev/null
+++ b/docs/module-management.MigrationsManager.html
@@ -0,0 +1,894 @@
+
+
+
+
+
+ MigrationsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MigrationsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ MigrationsManager
+
+
+ Abstracts interaction with the migrations endpoint.
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new MigrationsManager(options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The client options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ baseUrl
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The URL of the API.
+
+
+
+
+
+
+
+
+ headers
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Headers to be included in all requests.
+
+
+
+
+
+
+
+
+ retry
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Retry Policy Config
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+
+(inner) auth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the migrations endpoint
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ getMigrations(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the tenant migrations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.migrations.getMigrations(function (err, migrations) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(migrations.flags);
+});
+
+
+
+
+
+
+
+
+
+
+ updateMigrations(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the tenant migrations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The tenant migrations to be updated
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ flags
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The tenant migrations flags to be updated
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.migrations.updateMigrations(data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index d450ac7fd..21d4124ea 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index fb5b1d27f..5a3fc2b55 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 961843c93..97ba3fa94 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index f6980c26f..4929adc05 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4293,7 +4293,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 838527adc..c27870d41 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 6dbd96b97..622494998 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 3555a998f..32b369ef9 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 2b6bee0fb..912072b15 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 7d1f5730b..82d4e1e47 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index 8543b95d7..87627110d 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 4f4e00d83..2c8b117f7 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index fb60127dd..6b0291d80 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -110,6 +110,9 @@ Classes
ManagementTokenProvider
+ MigrationsManager
+
+
PromptsManager
@@ -168,7 +171,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 12e5b188c..ee686ea37 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 8106671bc..d316de5ca 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -91,6 +91,9 @@ utils.js
*/
utils.wrapPropertyMethod = function(Parent, name, propertyMethod) {
var path = propertyMethod.split('.');
+ if (path.length > 2) {
+ throw new Error('wrapPropertyMethod() only supports one level of nesting for propertyMethod');
+ }
var property = path.shift();
var method = path.pop();
@@ -138,7 +141,7 @@ utils.js
diff --git a/package.json b/package.json
index c6cecbc29..8461fcac2 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.26.0",
+ "version": "2.27.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
Example
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html index 87e242ebd..60363e269 100644 --- a/docs/module-management.BrandingManager.html +++ b/docs/module-management.BrandingManager.html @@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html index 0b34dccea..4e2ab855e 100644 --- a/docs/module-management.ClientGrantsManager.html +++ b/docs/module-management.ClientGrantsManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html index 0b34dccea..4e2ab855e 100644 --- a/docs/module-management.ClientGrantsManager.html +++ b/docs/module-management.ClientGrantsManager.html @@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html index fde48120a..163a612ed 100644 --- a/docs/module-management.ClientsManager.html +++ b/docs/module-management.ClientsManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html index fde48120a..163a612ed 100644 --- a/docs/module-management.ClientsManager.html +++ b/docs/module-management.ClientsManager.html @@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html index bc6bdcb9b..95e8ee063 100644 --- a/docs/module-management.ConnectionsManager.html +++ b/docs/module-management.ConnectionsManager.html @@ -24,7 +24,7 @@createSource:
+Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html index bc6bdcb9b..95e8ee063 100644 --- a/docs/module-management.ConnectionsManager.html +++ b/docs/module-management.ConnectionsManager.html @@ -24,7 +24,7 @@
@@ -484,6 +484,81 @@
+
+
+
+Type:
+
+
@@ -541,7 +616,7 @@ (inner) userAuth0RestClient :external:RestClient
+ + + + +
+
+
+
+
+
+
+Provides an abstraction layer for consuming the +endpoint.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Type:
+-
+
-
+
+
external:RestClient+ + +
+
createSource:
deleteSource:
Example
Example
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
delete(params, cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Delete a connection user by email.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +|||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Connection parameters. + + + +
|
+ |||||||||
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+Example
+ +management.connections.deleteUserByEmail({ id: CONNECTION_ID, email:USER_EMAIL }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // User deleted.
+});
@@ -1028,7 +1398,7 @@ getSource:
getSource:
getAllSource:
updateSource:
Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 03ffd315c..0f056861a 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 ebd9db73e..852d95b86 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 41f18b371..695997f42 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 27ad509a8..19caed12c 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 fa71e19f3..a47960d4e 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -24,7 +24,7 @@
@@ -842,7 +842,7 @@ deleteGran
Source:
Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index f77df6f02..ec3e5a723 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -464,6 +464,154 @@ external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorsPhoneMessageTypesAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian phone factor message types.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorsPhoneSelectedProviderAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian phone factor selected provider.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
@@ -567,7 +715,7 @@
- Provides an abstraction layer for retrieving Guardian factors.
+ Provides an abstraction layer for retrieving Guardian factor templates.
@@ -612,6 +760,80 @@ external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianPoliciesAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian policies.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
@@ -761,7 +983,7 @@ Source:
Source:
Example
- getGuardianEnrollment(data, cbopt) → {Promise|undefined}
+ getFactorProvider(params, cbopt) → {Promise|undefined}
- Get a single Guardian enrollment.
+ Get Guardian factor provider configuration
@@ -1206,7 +1428,7 @@
Source:
Parameters:
- dataparams
@@ -1277,50 +1499,43 @@ Parameters:
- The user data object.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- The user id.
+ Callback function.
@@ -1329,7 +1544,2515 @@ Parameters:
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
+
+
+
+
+
+
+ getFactors(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a list of factors and statuses.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getFactors(function (err, factors) {
+ console.log(factors.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getFactorTemplates(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get Guardian enrollment and verification factor templates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor parameters.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getFactorTemplates({ name: 'sms' }, function (err, templates) {
+ console.log(templates);
+});
+
+
+
+
+
+
+
+
+
+
+ getGuardianEnrollment(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a single Guardian enrollment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The user data object.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ console.log(enrollment);
+});
+
+
+
+
+
+
+
+
+
+
+ getPhoneFactorMessageTypes(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the Guardian phone factor's message types
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getPhoneFactorMessageTypes(function (err, messageTypes) {
+ console.log(messageTypes);
+});
+
+
+
+
+
+
+
+
+
+
+ getPhoneFactorSelectedProvider(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the Guardian phone factor's selected provider
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getPhoneFactorSelectedProvider(function (err, selectedProvider) {
+ console.log(selectedProvider);
+});
+
+
+
+
+
+
+
+
+
+
+ getPolicies(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get enabled Guardian policies
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getPolicies(function (err, policies) {
+ console.log(policies);
+});
+
+
+
+
+
+
+
+
+
+
+ updateFactor(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian Factor
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated factor data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updateFactor({ name: 'sms' }, {
+ enabled: true
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updateFactorProvider(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian's factor provider
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor provider parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Factor provider data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updateFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ messaging_service_sid: 'XXXXXXXXXXXXXX',
+ auth_token: 'XXXXXXXXXXXXXX',
+ sid: 'XXXXXXXXXXXXXX'
+}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
+
+
+
+
+
+
+ updateFactorTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian enrollment and verification factor templates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated factor templates data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updateFactorProvider({ name: 'sms' }, {
+ enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+}, function (err, templates) {
+ console.log(templates);
+});
+
+
+
+
+
+
+
+
+
+
+ updatePhoneFactorMessageTypes(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the Guardian phone factor's message types
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ message_types
+
+
+Array.<String>
+
+
+
+
+
+
+
+
+
+
+ Message types (only "sms" and "voice" are supported).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updatePhoneFactorMessageTypes({}, {
+ message_types: ['sms', 'voice']
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updatePhoneFactorSelectedProvider(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the Guardian phone factor's selected provider
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Name of the selected provider
+
+
+
+
+
+
+
+
+
@@ -1415,8 +4138,260 @@ Returns:
Example
- management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
- console.log(enrollment);
+ management.guardian.updatePhoneFactorSelectedProvider({}, {
+ provider: 'twilio'
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updatePolicies(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update enabled Guardian policies
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Array.<String>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Policies to enable. Empty array disables all policies.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updatePolicies({}, [
+ 'all-applications'
+], function (err, policies) {
+ console.log(policies);
});
@@ -1440,7 +4415,7 @@ Example
diff --git a/docs/module-management.HooksManager.html b/docs/module-management.HooksManager.html
index 9facca9da..dcf47a8d6 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 b489005bd..debe93a8b 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -2676,7 +2676,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index ee8687280..084e7a64d 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 700e3ee3e..7767f2f9c 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -106,7 +106,7 @@ new M
Source:
blac
Source:
brandingSource:
clientGra
Source:
clientsSource:
connection
Source:
customDo
Source:
devi
Source:
emailPro
Source:
emailTe
Source:
grantsSource:
guardianSource:
hooksSource:
jobsSource:
logsSource:
Type:
+
+
+
+
+
+migrations :MigrationsManager
+
+
+
+
+
+ ManagementClient migrations manager.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
MigrationsManager
+
+
+
+
+
+
+
+
+
@@ -1811,7 +1885,7 @@ resour
Source:
rolesSource:
rulesSource:
rulesConf
Source:
statsSource:
tenantSource:
ticketsSource:
userBlocks<
Source:
usersSource:
addHookS
Source:
a
Source:
Source:
assi
Source:
blackli
Source:
Source:
createCli
Source:
crea
Source:
creat
Source:
cre
Source:
Source:
cr
Source:
Source:
Source:
createHook<
Source:
Source:
c
Source:
createRole<
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
+
+
+
+
+
+
+ getGuardianFactors(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a list of Guardian factors and statuses.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
cbReturns:
Example
- management.getHook({ id: HOOK_ID }, function (err, hook) {
- if (err) {
- // Handle error.
- }
-
- console.log(hook);
+ management.getGuardianFactors(function (err, factors) {
+ console.log(factors.length);
});
@@ -16825,14 +17024,14 @@ Example
- getHooks(paramsopt, cbopt) → {Promise|undefined}
+ getGuardianFactorTemplates(params, cbopt) → {Promise|undefined}
- Get all hooks.
+ Get Guardian enrollment and verification factor templates
@@ -16868,7 +17067,7 @@ getHooksSource:
Parameters:
- <optional>
-
@@ -16941,41 +17138,22 @@ Parameters:
- Hooks parameters.
+ Factor parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+
+
-
- per_pagecb
-Number
+function
@@ -16996,57 +17174,157 @@ Parameters:
- Number of results per page.
+ Callback function.
+
+
-
-
- page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
+ console.log(templates);
+});
+
+
+
+
+
+
-
- Page number, zero indexed.
-
-
-
+
+
+ getGuardianPhoneFactorMessageTypes(cbopt) → {Promise|undefined}
-
-
-
-
-
+
+
+
+ Get the Guardian phone factor's message types
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
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.getGuardianPhoneFactorMessageTypes(function (err, messageTypes) {
+ console.log(messageTypes);
});
@@ -17152,14 +17418,14 @@ Example
- getHookSecrets(params, cbopt) → {Promise|undefined}
+ getGuardianPhoneFactorSelectedProvider(cbopt) → {Promise|undefined}
- Get an Auth0 hook's secrets.
+ Get the Guardian phone factor's selected provider
@@ -17195,7 +17461,7 @@ getHook
Source:
Parameters:
- paramscb
-Object
+function
@@ -17256,6 +17522,8 @@ Parameters:
+ <optional>
+
@@ -17266,64 +17534,157 @@ Parameters:
- Hook parameters.
+ Callback function.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
- Name
-
- Type
+
+
+
+Returns:
+
+ -
+ Type:
+
+ -
+
Promise
+|
+
+undefined
+
+
+
+
- Description
-
-
-
+
-
-
- id
-
-
-String
+
+Example
-
-
+ management.getGuardianPhoneFactorSelectedProvider(function (err, selectedProvider) {
+ console.log(selectedProvider);
+});
-
+
+
+
+
-
- Hook ID.
-
-
-
+
+
+ getGuardianPolicies(cbopt) → {Promise|undefined}
-
-
-
-
-
+
+
+
+ Get enabled Guardian policies
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
cbReturns:
Example
- var params = { id: HOOK_ID }
-management.getHookSecrets(params, function (err, secrets) {
- if (err) {
- // Handle error.
- }
-
- console.log(secrets);
+ management.getGuardianPolicies(function (err, policies) {
+ console.log(policies);
});
@@ -17422,14 +17778,14 @@ Example
- getJob(params, cbopt) → {Promise|undefined}
+ getHook(params, cbopt) → {Promise|undefined}
- Get a job by its ID.
+ Get an Auth0 hook.
@@ -17465,7 +17821,7 @@ getJobSource:
Parameters:
- Job parameters.
+ Hook parameters.
@@ -17579,7 +17935,7 @@ Parameters:
- Job ID.
+ Hook ID.
@@ -17674,17 +18030,12 @@ Returns:
Example
- var params = {
- id: '{JOB_ID}'
-};
-
-management.getJob(params, function (err, job) {
+ management.getHook({ id: HOOK_ID }, function (err, hook) {
if (err) {
// Handle error.
}
- // Retrieved job.
- console.log(job);
+ console.log(hook);
});
@@ -17696,14 +18047,14 @@ Example
- getLog(params, cbopt) → {Promise|undefined}
+ getHooks(paramsopt, cbopt) → {Promise|undefined}
- Get an Auth0 log.
+ Get all hooks.
@@ -17739,7 +18090,7 @@ getLogSource:
Parameters:
+ <optional>
+
@@ -17810,7 +18163,7 @@ Parameters:
- Log parameters.
+ Hooks parameters.
@@ -17824,6 +18177,8 @@ Parameters:
Type
+ Attributes
+
@@ -17836,24 +18191,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- Event ID.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -17948,12 +18349,20 @@ Returns:
Example
- management.getLog({ id: EVENT_ID }, function (err, log) {
- 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(log);
+management.getHooks(params, function (err, hooks) {
+ console.log(hooks.length);
});
@@ -17965,14 +18374,14 @@ Example
- getLogs(paramsopt, cbopt) → {Promise|undefined}
+ getHookSecrets(params, cbopt) → {Promise|undefined}
- Get all logs.
+ Get an Auth0 hook's secrets.
@@ -18008,7 +18417,7 @@ getLogsSource:
Parameters:
- <optional>
-
@@ -18081,7 +18488,7 @@ Parameters:
- Logs params.
+ Hook parameters.
@@ -18095,8 +18502,6 @@ Parameters:
Type
- Attributes
-
@@ -18109,7 +18514,7 @@ Parameters:
- qid
@@ -18122,21 +18527,19 @@ Parameters:
-
-
- <optional>
-
-
+
+
+ Hook ID.
-
-
+
+
-
+
+
+
-
- Search Criteria using Query String Syntax
@@ -18145,13 +18548,13 @@ Parameters:
- pagecb
-Number
+function
@@ -18172,130 +18575,171 @@ Parameters:
- Page number. Zero based
+ Callback function.
+
+
-
-
- per_page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- The amount of entries per page
-
-
-
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
-
-
- sort
-
-
-String
+
+Example
-
-
+ var params = { id: HOOK_ID }
+management.getHookSecrets(params, function (err, secrets) {
+ if (err) {
+ // Handle error.
+ }
-
-
-
- <optional>
-
+ console.log(secrets);
+});
-
+
-
-
+
+
+
-
+
-
- The field to use for sorting.
-
-
-
+ getJob(params, cbopt) → {Promise|undefined}
-
-
- fields
-
-
-String
+
+ Get a job by its ID.
+
-
-
-
-
-
- <optional>
-
-
-
-
-
-
+
-
- A comma separated list of fields to include or exclude
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
- include_fieldsparams
-Boolean
+Object
@@ -18304,8 +18748,6 @@ Parameters:
- <optional>
-
@@ -18316,43 +18758,50 @@ Parameters:
- true if the fields specified are to be included in the result, false otherwise.
+ Job parameters.
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+ Description
+
+
+
+
- include_totalsid
-Boolean
+String
-
-
- <optional>
-
-
-
-
-
-
-
- true if a query summary must be included in the result, false otherwise. Default false
+ Job ID.
@@ -18447,20 +18896,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);
});
@@ -18472,14 +18918,14 @@ Example
- getPermissionsInRole(roleIdopt, cbopt) → {Promise|undefined}
+ getLog(params, cbopt) → {Promise|undefined}
- Get permissions for a given role
+ Get an Auth0 log.
@@ -18515,7 +18961,7 @@ g
Source:
Parameters:
- roleIdparams
-String
+Object
@@ -18576,8 +19022,6 @@ Parameters:
- <optional>
-
@@ -18588,7 +19032,58 @@ Parameters:
- Id of the role
+ Log parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Event ID.
+
+
+
+
+
+
+
+
@@ -18673,18 +19168,14 @@ Returns:
-Examples
-
- var params = { id :'ROLE_ID'};
+Example
-
- This method takes a roleId and
- returns all permissions within that role
+
management.getLog({ id: EVENT_ID }, function (err, log) {
+ if (err) {
+ // Handle error.
+ }
-
-
- management.getPermissionsInRole(params, function (err, permissions) {
- console.log(permissions);
+ console.log(log);
});
@@ -18696,14 +19187,14 @@ Examples
- getResourceServer(params, cbopt) → {Promise|undefined}
+ getLogs(paramsopt, cbopt) → {Promise|undefined}
- Get a Resource Server.
+ Get all logs.
@@ -18739,7 +19230,7 @@ getR
Source:
Parameters:
+ <optional>
+
@@ -18810,7 +19303,7 @@ Parameters:
- Resource Server parameters.
+ Logs params.
@@ -18824,6 +19317,8 @@ Parameters:
Type
+ Attributes
+
@@ -18836,7 +19331,7 @@ Parameters:
- idq
@@ -18849,11 +19344,237 @@ Parameters:
+
+
+ <optional>
+
+
+
+
+
+
+
- Resource Server ID.
+ 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.
+
+
+
+
+
+
+
+
+ fields
+
+
+String
+
+
+
+
+
+
+
+
+ <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
@@ -18948,12 +19669,205 @@ Returns:
Example
- management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+
+ 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
+};
+
+management.getLogs(params, function (err, logs) {
+ console.log(logs.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getMigrations(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get migrations flags
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getMigrations(function (err, migrations) {
if (err) {
// Handle error.
}
- console.log(resourceServer);
+// Migration flags
+ console.log(migrations.flags);
});
@@ -18965,14 +19879,2210 @@ Example
- getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+ getPermissionsInRole(roleIdopt, cbopt) → {Promise|undefined}
- Get all resource servers.
+ Get permissions for a given role
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ roleId
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Id of the role
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Examples
+
+ var params = { id :'ROLE_ID'};
+
+
+ This method takes a roleId and
+ returns all permissions within that role
+
+
+
+ management.getPermissionsInRole(params, function (err, permissions) {
+ console.log(permissions);
+});
+
+
+
+
+
+
+
+
+
+
+ getResourceServer(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a Resource Server.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Resource Server parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Resource Server ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(resourceServer);
+});
+
+
+
+
+
+
+
+
+
+
+ getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all resource servers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Resource Servers parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.getResourceServers(params, function (err, resourceServers) {
+ console.log(resourceServers.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getRole(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get an Auth0 role.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Role parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Role ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getRole({ id: ROLE_ID }, function (err, role) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(role);
+});
+
+
+
+
+
+
+
+
+
+
+ getRoles(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all roles.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Roles parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.getRoles(params, function (err, roles) {
+ console.log(roles.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getRule(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get an Auth0 rule.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rule parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getRule({ id: RULE_ID }, function (err, rule) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(rule);
+});
+
+
+
+
+
+
+
+
+
+
+ getRules(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all rules.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Rules parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.getRules(params, function (err, rules) {
+ console.log(rules.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getRulesConfigs(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get rules config.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getRulesConfigs(function (err, rulesConfigs) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Get Rules Configs.
+});
+
+
+
+
+
+
+
+
+
+
+ getTenantSettings(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the tenant settings..
@@ -19008,7 +22118,7 @@ get
Source:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Resource Servers 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.getSettings(function (err, settings) {
+ if (err) {
+ // Handle error.
+ }
-management.getResourceServers(params, function (err, resourceServers) {
- console.log(resourceServers.length);
+ console.log(settings);
});
@@ -19292,14 +22259,14 @@ Example
- getRole(params, cbopt) → {Promise|undefined}
+ getUser(data, cbopt) → {Promise|undefined}
- Get an Auth0 role.
+ Get a user by its id.
@@ -19335,7 +22302,7 @@ getRoleSource:
Parameters:
- paramsdata
@@ -19406,7 +22373,7 @@ Parameters:
- Role parameters.
+ The user data object.
@@ -19449,7 +22416,7 @@ Parameters:
- Role ID.
+ The user id.
@@ -19544,12 +22511,8 @@ Returns:
Example
- management.getRole({ id: ROLE_ID }, function (err, role) {
- if (err) {
- // Handle error.
- }
-
- console.log(role);
+ management.getUser({ id: USER_ID }, function (err, user) {
+ console.log(user);
});
@@ -19561,14 +22524,14 @@ Example
- getRoles(paramsopt, cbopt) → {Promise|undefined}
+ getUserBlocks(params, cbopt) → {Promise|undefined}
- Get all roles.
+ Get user blocks by its id.
@@ -19604,7 +22567,7 @@ getRolesSource:
Parameters:
- <optional>
-
@@ -19677,7 +22638,7 @@ Parameters:
- Roles parameters.
+ The user data object..
@@ -19691,8 +22652,6 @@ Parameters:
Type
- Attributes
-
@@ -19705,70 +22664,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ The user id.
@@ -19812,7 +22725,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -19863,20 +22776,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.getUserBlocks({ id: USER_ID }, function (err, blocks) {
+ if (err) {
+ // Handle error.
+ }
-management.getRoles(params, function (err, roles) {
- console.log(roles.length);
+ console.log(blocks);
});
@@ -19888,14 +22793,14 @@ Example
- getRule(params, cbopt) → {Promise|undefined}
+ getUserBlocksByIdentifier(params, cbopt) → {Promise|undefined}
- Get an Auth0 rule.
+ Get user blocks by its identifier.
@@ -19931,7 +22836,7 @@ getRuleSource:
Parameters:
- Rule parameters.
+ The user data object..
@@ -20028,7 +22933,7 @@ Parameters:
- ididentifier
@@ -20045,7 +22950,7 @@ Parameters:
- Rule ID.
+ The user identifier, any of: username, phone_number, email.
@@ -20089,7 +22994,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -20140,12 +23045,12 @@ Returns:
Example
- management.getRule({ id: RULE_ID }, function (err, rule) {
+ management.getUserBlocksByIdentifier({ identifier: USER_ID }, function (err, blocks) {
if (err) {
// Handle error.
}
- console.log(rule);
+ console.log(blocks);
});
@@ -20157,14 +23062,14 @@ Example
- getRules(paramsopt, cbopt) → {Promise|undefined}
+ getUserLogs(params, cbopt) → {Promise|undefined}
- Get all rules.
+ Get user's log events.
@@ -20200,7 +23105,7 @@ getRulesSource:
Parameters:
- <optional>
-
@@ -20273,7 +23176,7 @@ Parameters:
- Rules parameters.
+ Get logs data.
@@ -20287,8 +23190,6 @@ Parameters:
Type
- Attributes
-
@@ -20301,28 +23202,44 @@ Parameters:
- per_pageid
-Number
+String
-
-
- <optional>
-
+
+
+
+ User id.
+
+
+
+
+
+
+ per_page
+
-
+Number
+
+
+
+
+
@@ -20350,21 +23267,63 @@ Parameters:
-
+
+
+
+
+ Page number, zero indexed.
- <optional>
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
- Page number, zero indexed.
+ true if a query summary must be included in the result, false otherwise. Default false;
@@ -20459,20 +23418,14 @@ 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
-};
+ var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-management.getRules(params, function (err, rules) {
- console.log(rules.length);
+management.getUserLogs(params, function (err, logs) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logs);
});
@@ -20484,14 +23437,14 @@ Example
- getRulesConfigs(cbopt) → {Promise|undefined}
+ getUserPermissions(params, cbopt) → {Promise|undefined}
- Get rules config.
+ Get user's permissions
@@ -20527,7 +23480,7 @@ getRul
Source:
Parameters:
- cbparams
-function
+Object
@@ -20588,8 +23541,6 @@ Parameters:
- <optional>
-
@@ -20600,159 +23551,166 @@ Parameters:
- Callback function.
+ Get permissions data.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
+
+
+
+
-
-
- -
- Type:
-
- -
+
Name
-Promise
-|
-undefined
+ Type
+
-
-
+
+ Description
+
+
+
-
-
+
+
+ idExample
-
- management.getRulesConfigs(function (err, rulesConfigs) {
- if (err) {
- // Handle error.
- }
+
+
+
+String
- // Get Rules Configs.
-});
-
+
+
-
-
-
-
+
- getTenantSettings(cbopt) → {Promise|undefined}
+
+ User id.
+
+
+
+
+
+ per_pageGet the tenant settings..
-
+
+
+
+Number
+
+
+
+
-
+
+ Number of results per page.
+
+
+
-
+
+
+ page
+
+
+Number
-
-
+
+
-
+
-
+
-
+
+ Page number, zero indexed.
+
+
+
-
+
+
+ sort
+
+
+String
-
-
- Source:
-
-
+
-
+
-
-
+
+ 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;
+
+
+
- Parameters:
+
+
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+
+
+
-
@@ -20835,12 +23793,14 @@ Returns:
Example
- management.getSettings(function (err, settings) {
+ 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(settings);
+ console.log(logs);
});
@@ -20852,14 +23812,14 @@ Example
- getUser(data, cbopt) → {Promise|undefined}
+ getUserRoles(params, cbopt) → {Promise|undefined}
- Get a user by its id.
+ Get user's roles
@@ -20895,7 +23855,7 @@ getUserSource:
Parameters:
- dataparams
@@ -20966,7 +23926,7 @@ Parameters:
- The user data object.
+ Get roles data.
@@ -21009,7 +23969,111 @@ Parameters:
- The user id.
+ 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;
@@ -21104,8 +24168,14 @@ Returns:
Example
- management.getUser({ id: USER_ID }, function (err, user) {
- console.log(user);
+ 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);
});
@@ -21117,14 +24187,14 @@ Example
- getUserBlocks(params, cbopt) → {Promise|undefined}
+ getUsers(paramsopt, cbopt) → {Promise|undefined}
- Get user blocks by its id.
+ Get all users.
@@ -21160,7 +24230,7 @@ getUserB
Source:
Parameters:
+ <optional>
+
@@ -21231,7 +24303,7 @@ Parameters:
- The user data object..
+ Users params.
@@ -21245,6 +24317,8 @@ Parameters:
Type
+ Attributes
+
@@ -21257,7 +24331,43 @@ Parameters:
- idsearch_engine
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The version of the search engine to use.
+
+
+
+
+
+
+
+
+ q
@@ -21270,11 +24380,93 @@ Parameters:
+
+
+ <optional>
+
+
+
+
+
+
+
- The user id.
+ User Search string to filter which users are returned. Follows Lucene query string syntax as documented at https://auth0.com/docs/api/management/v2#!/Users/get_users.
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -21318,7 +24510,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -21369,12 +24561,22 @@ 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 = {
+ search_engine: 'v3',
+ q: 'name:*jane*',
+ per_page: 10,
+ page: 0
+};
- console.log(blocks);
+auth0.getUsers(params, function (err, users) {
+ console.log(users.length);
});
@@ -21386,14 +24588,14 @@ Example
- getUserBlocksByIdentifier(params, cbopt) → {Promise|undefined}
+ getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
- Get user blocks by its identifier.
+ Get users for a given email address
@@ -21429,7 +24631,7 @@ Source:
Parameters:
- paramsemail
-Object
+String
@@ -21490,68 +24692,19 @@ Parameters:
-
-
-
+ <optional>
-
-
-
-
-
- The user data object..
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- identifier
-
-String
-
-
-
-
-
+
- The user identifier, any of: username, phone_number, email.
-
-
-
-
-
-
-
-
+ Email Address of users to locate
@@ -21587,7 +24740,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -21638,12 +24791,13 @@ Returns:
Example
- management.getUserBlocksByIdentifier({ identifier: USER_ID }, function (err, blocks) {
- if (err) {
- // Handle error.
- }
-
- console.log(blocks);
+
+ This method takes an email address as the first argument,
+ and returns all users with that email address
+
+
+ auth0.getUsersByEmail(email, function (err, users) {
+ console.log(users);
});
@@ -21655,14 +24809,14 @@ Example
- getUserLogs(params, cbopt) → {Promise|undefined}
+ getUsersInRole(idopt, cbopt) → {Promise|undefined}
- Get user's log events.
+ Get users in a given role
@@ -21698,7 +24852,7 @@ getUserLog
Source:
Parameters:
- paramsid
-Object
+String
@@ -21759,6 +24913,8 @@ Parameters:
+ <optional>
+
@@ -21769,70 +24925,37 @@ Parameters:
- Get logs data.
+ Id of the role
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idparams.per_page
-String
+Number
-
-
-
-
- User id.
+
-
-
-
-
-
-
-
- per_page
-
+ <optional>
-Number
-
-
-
+
+
+
@@ -21847,7 +24970,7 @@ Parameters:
- pageparams.page
@@ -21860,71 +24983,21 @@ Parameters:
-
-
-
-
- Page number, zero indexed.
+
-
-
-
-
-
-
-
- sort
-
+ <optional>
-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;
-
-
-
-
-
-
-
-
+ Page number, zero indexed.
@@ -22009,16 +25082,20 @@ Returns:
-Example
-
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+Examples
-management.getUserLogs(params, function (err, logs) {
- if (err) {
- // Handle error.
- }
+ var params = {
+ id: 'ROLE_ID'
+ per_page: 50,
+ page: 0
+};
- console.log(logs);
+
+ This method takes a roleId and returns all users within that role
+
+
+ management.getUsersInRole(params, function (err, users) {
+ console.log(users);
});
@@ -22030,14 +25107,16 @@ Example
- getUserPermissions(params, cbopt) → {Promise|undefined}
+ importUsers(data, cbopt) → {Promise|undefined}
- Get user's permissions
+ Given a path to a file and a connection id, create a new job that imports the
+users contained in the file or JSON string and associate them with the given
+connection.
@@ -22073,7 +25152,7 @@ get
Source:
Parameters:
- paramsdata
@@ -22144,7 +25223,7 @@ Parameters:
- Get permissions data.
+ Users import data.
@@ -22158,6 +25237,8 @@ Parameters:
Type
+ Attributes
+
@@ -22170,7 +25251,7 @@ Parameters:
- idconnection_id
@@ -22183,11 +25264,19 @@ Parameters:
+
+
+
+
+
+
+
+
- User id.
+ connection_id of the connection to which users will be imported.
@@ -22196,24 +25285,34 @@ Parameters:
- per_pageusers
-Number
+String
+
+
+ <optional>
+
+
+
+
+
+
+
- Number of results per page.
+ Path to the users data file. Either users or users_json is mandatory.
@@ -22222,24 +25321,34 @@ Parameters:
- pageusers_json
-Number
+String
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ JSON data for the users.
@@ -22248,24 +25357,34 @@ Parameters:
- sortupsert
-String
+Boolean
+
+
+ <optional>
+
+
+
+
+
+
+
- The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+ Whether to update users if they already exist (true) or to ignore them (false).
@@ -22274,7 +25393,7 @@ Parameters:
- include_totalssend_completion_email
@@ -22287,11 +25406,21 @@ Parameters:
+
+
+ <optional>
+
+
+
+
+
+
+
- true if a query summary must be included in the result, false otherwise. Default false;
+ Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
@@ -22386,14 +25515,15 @@ Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+ var params = {
+ connection_id: '{CONNECTION_ID}',
+ users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}'
+};
-management.getUserPermissions(params, function (err, logs) {
+management.importUsers(params, function (err) {
if (err) {
// Handle error.
}
-
- console.log(logs);
});
@@ -22405,14 +25535,14 @@ Example
- getUserRoles(params, cbopt) → {Promise|undefined}
+ linkUsers(userId, params, cbopt) → {Promise|undefined}
- Get user's roles
+ Link the user with another account.
@@ -22448,7 +25578,7 @@ getUserRo
Source:
Parameters:
- paramsuserId
-Object
+String
@@ -22519,111 +25649,67 @@ Parameters:
- Get roles data.
+ ID of the primary user.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idparams
-String
+Object
-
-
-
-
- User id.
+
-
-
-
-
-
-
- per_page
-
-Number
-
-
-
-
+
+
- Number of results per page.
-
-
-
-
-
-
-
-
- page
-
+ Secondary user data.
-Number
+
+
+
+
+
+ Name
+
-
-
+ Type
-
+
-
+
-
- Page number, zero indexed.
-
-
-
+ Description
+
+
+
- sortuser_id
@@ -22640,7 +25726,7 @@ Parameters:
- The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+ ID of the user to be linked.
@@ -22649,13 +25735,13 @@ Parameters:
- include_totalsconnection_id
-Boolean
+String
@@ -22666,7 +25752,7 @@ Parameters:
- true if a query summary must be included in the result, false otherwise. Default false;
+ ID of the connection to be used.
@@ -22761,14 +25847,18 @@ Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+ var userId = 'USER_ID';
+var params = {
+ user_id: 'OTHER_USER_ID',
+ connection_id: 'CONNECTION_ID'
+};
-management.getUserRoles(params, function (err, logs) {
+management.linkUsers(userId, params, function (err, user) {
if (err) {
// Handle error.
}
- console.log(logs);
+ // Users linked.
});
@@ -22780,14 +25870,14 @@ Example
- getUsers(paramsopt, cbopt) → {Promise|undefined}
+ regenerateRecoveryCode(data, cbopt) → {Promise|undefined}
- Get all users.
+ Generate new Guardian recovery code.
@@ -22823,7 +25913,7 @@ getUsersSource:
Parameters:
- paramsdata
@@ -22884,8 +25974,6 @@ Parameters:
- <optional>
-
@@ -22896,7 +25984,7 @@ Parameters:
- Users params.
+ The user data object.
@@ -22910,8 +25998,6 @@ Parameters:
Type
- Attributes
-
@@ -22924,43 +26010,7 @@ Parameters:
- search_engine
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The version of the search engine to use.
-
-
-
-
-
-
-
-
- qid
@@ -22973,93 +26023,11 @@ Parameters:
-
-
- <optional>
-
-
-
-
-
-
-
- User Search string to filter which users are returned. Follows Lucene query string syntax as documented at https://auth0.com/docs/api/management/v2#!/Users/get_users.
-
-
-
-
-
-
-
-
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Page number, zero indexed.
+ The user id.
@@ -23154,22 +26122,8 @@ 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 = {
- search_engine: 'v3',
- q: 'name:*jane*',
- per_page: 10,
- page: 0
-};
-
-auth0.getUsers(params, function (err, users) {
- console.log(users.length);
+ management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
+ console.log(newRecoveryCode);
});
@@ -23181,14 +26135,14 @@ Example
- getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+ removeHookSecrets(params, data, cbopt) → {Promise|undefined}
- Get users for a given email address
+ Delete an existing hook.
@@ -23224,7 +26178,7 @@ getUse
Source:
Parameters:
- emailparams
-String
+Object
@@ -23285,7 +26239,90 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+
+ Hook parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Hook ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
@@ -23297,7 +26334,7 @@ Parameters:
- Email Address of users to locate
+ Secrets key/value pairs
@@ -23384,13 +26421,14 @@ Returns:
Example
-
- This method takes an email address as the first argument,
- and returns all users with that email address
-
-
- auth0.getUsersByEmail(email, function (err, users) {
- console.log(users);
+ var params = { id: HOOK_ID }
+var data = ['API_TOKEN', 'DB_PASSWORD']
+auth0.removeHookSecrets(params, data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Hook deleted.
});
@@ -23402,14 +26440,14 @@ Example
- getUsersInRole(idopt, cbopt) → {Promise|undefined}
+ removePermissionsFromRole(data, cbopt) → {Promise|undefined}
- Get users in a given role
+ Remove permissions from a role
@@ -23445,7 +26483,7 @@ getUser
Source:
Parameters:
- idparams.id
@@ -23506,8 +26544,6 @@ Parameters:
- <optional>
-
@@ -23518,7 +26554,7 @@ Parameters:
- Id of the role
+ ID of the Role.
@@ -23527,13 +26563,13 @@ Parameters:
- params.per_pagedata
-Number
+Object
@@ -23542,8 +26578,6 @@ Parameters:
- <optional>
-
@@ -23554,43 +26588,135 @@ Parameters:
- Number of results per page.
+ permissions data
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+ Description
+
+
+
+
- params.pagepermissions
-Number
+String
-
+
+
+
+
+ Array of permissions
- <optional>
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ permission_name
+
+String
+
+
+
+
+
+
+
+
+
+ Name of a permission
+
+
+
+
+
+
+ resource_server_identifier
+
-
+String
+
+
+
+
+
- Page number, zero indexed.
+ Identifier for a resource
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -23675,20 +26801,13 @@ Returns:
-Examples
+Example
- var params = {
- id: 'ROLE_ID'
- per_page: 50,
- page: 0
-};
+ var params = { id :'ROLE_ID'};
+var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
-
- This method takes a roleId and returns all users within that role
-
-
- management.getUsersInRole(params, function (err, users) {
- console.log(users);
+management.removePermissionsFromRole(params, data, function (err, permissions) {
+ console.log(permissions);
});
@@ -23700,16 +26819,14 @@ Examples
- importUsers(data, cbopt) → {Promise|undefined}
+ removePermissionsFromUser(params, data, cbopt) → {Promise|undefined}
- Given a path to a file and a connection id, create a new job that imports the
-users contained in the file or JSON string and associate them with the given
-connection.
+ Remove permissions from a user
@@ -23745,7 +26862,7 @@ importUser
Source:
Parameters:
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Users import data.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- connection_idparams
-String
+Object
@@ -23869,16 +26933,33 @@ Parameters:
- connection_id of the connection to which users will be imported.
+ params object
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+ Description
+
+
+
+
- usersid
@@ -23891,21 +26972,19 @@ Parameters:
-
-
- <optional>
-
-
+
+
+ user_id
-
-
+
+
-
+
+
+
-
- Path to the users data file. Either users or users_json is mandatory.
@@ -23914,7 +26993,7 @@ Parameters:
- users_jsondata
@@ -23929,8 +27008,6 @@ Parameters:
- <optional>
-
@@ -23941,79 +27018,50 @@ Parameters:
- JSON data for the users.
-
-
-
-
-
-
-
-
- upsert
-
+ data object containing list of permission IDs
-Boolean
-
-
-
-
+
-
-
-
- <optional>
-
+
+
+
+
+ Name
+
-
+ Type
-
-
-
+
-
+
-
- Whether to update users if they already exist (true) or to ignore them (false).
-
-
-
+ Description
+
+
+
- send_completion_emailpermissions
-Boolean
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
+ Array of permission IDs
@@ -24108,15 +27156,15 @@ Returns:
Example
- var params = {
- connection_id: '{CONNECTION_ID}',
- users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}'
-};
+ var parms = { id : 'USER_ID'};
+var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
-management.importUsers(params, function (err) {
+management.removePermissionsFromUser(params, data, function (err) {
if (err) {
// Handle error.
}
+
+ // User assigned permissions.
});
@@ -24128,14 +27176,14 @@ Example
- linkUsers(userId, params, cbopt) → {Promise|undefined}
+ removeRolesFromUser(params, data, cbopt) → {Promise|undefined}
- Link the user with another account.
+ Remove roles from a user
@@ -24171,7 +27219,7 @@ linkUsersSource:
Parameters:
- userIdparams
-String
+Object
@@ -24242,7 +27290,58 @@ Parameters:
- ID of the primary user.
+ params object
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ user_id
+
+
+
+
+
+
+
+
@@ -24251,13 +27350,13 @@ Parameters:
- paramsdata
-Object
+String
@@ -24276,7 +27375,7 @@ Parameters:
- Secondary user data.
+ data object containing list of role IDs
@@ -24302,33 +27401,7 @@ Parameters:
- user_id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- ID of the user to be linked.
-
-
-
-
-
-
-
-
- connection_idroles
@@ -24345,7 +27418,7 @@ Parameters:
- ID of the connection to be used.
+ Array of role IDs
@@ -24440,18 +27513,15 @@ Returns:
Example
- var userId = 'USER_ID';
-var params = {
- user_id: 'OTHER_USER_ID',
- connection_id: 'CONNECTION_ID'
-};
+ var parms = { id : 'USER_ID'};
+var data = { "roles" :["role1"]};
-management.linkUsers(userId, params, function (err, user) {
+management.removeRolesFromUser(params, data, function (err) {
if (err) {
// Handle error.
}
- // Users linked.
+ // User assigned roles.
});
@@ -24463,14 +27533,14 @@ Example
- regenerateRecoveryCode(data, cbopt) → {Promise|undefined}
+ sendEmailVerification(data, cbopt) → {Promise|undefined}
- Generate new Guardian recovery code.
+ Send a verification email to a user.
@@ -24506,7 +27576,7 @@ Source:
Parameters:
- The user data object.
+ User data object.
@@ -24603,7 +27673,7 @@ Parameters:
- iduser_id
@@ -24620,7 +27690,7 @@ Parameters:
- The user id.
+ ID of the user to be verified.
@@ -24715,8 +27785,14 @@ Returns:
Example
- management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
- console.log(newRecoveryCode);
+ var params = {
+ user_id: '{USER_ID}'
+};
+
+management.sendEmailVerification(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
});
@@ -24728,14 +27804,14 @@ Example
- removeHookSecrets(params, data, cbopt) → {Promise|undefined}
+ setRulesConfig(params, data, cbopt) → {Promise|undefined}
- Delete an existing hook.
+ Set a new rules config.
@@ -24771,7 +27847,7 @@ remo
Source:
Parameters:
- Hook parameters.
+ Rule Config parameters.
@@ -24868,7 +27944,7 @@ Parameters:
- idkey
@@ -24885,7 +27961,7 @@ Parameters:
- Hook ID.
+ Rule Config key.
@@ -24927,7 +28003,58 @@ Parameters:
- Secrets key/value pairs
+ Rule Config Data parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ value
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule Config Data value.
+
+
+
+
+
+
+
+
@@ -25014,14 +28141,15 @@ Returns:
Example
- var params = { id: HOOK_ID }
-var data = ['API_TOKEN', 'DB_PASSWORD']
-auth0.removeHookSecrets(params, data, function (err) {
+ var params = { key: RULE_CONFIG_KEY };
+var data = { value: RULES_CONFIG_VALUE };
+
+management.setRulesConfig(params, data, function (err, rulesConfig) {
if (err) {
// Handle error.
}
- // Hook deleted.
+ // Rules Config set.
});
@@ -25033,14 +28161,14 @@ Example
- removePermissionsFromRole(data, cbopt) → {Promise|undefined}
+ unblockUser(params, cbopt) → {Promise|undefined}
- Remove permissions from a role
+ Unblock an user by its id.
@@ -25076,7 +28204,7 @@ Source:
Parameters:
- params.idparams
-String
+Object
@@ -25147,7 +28275,58 @@ Parameters:
- ID of the Role.
+ The user data object..
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
@@ -25156,13 +28335,13 @@ Parameters:
- datacb
-Object
+function
@@ -25171,6 +28350,8 @@ Parameters:
+ <optional>
+
@@ -25181,9 +28362,138 @@ Parameters:
- permissions data
+ Callback function
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.unblockUser({ id: USER_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // User unblocked.
+});
+
+
+
+
+
+
+
+
+
+
+ unblockUser(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Unblock an user by its id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
@@ -25195,6 +28505,8 @@ Parameters:
Type
+ Attributes
+
@@ -25207,24 +28519,32 @@ Parameters:
- permissionsparams
-String
+Object
+
+
+
+
+
+
+
+
- Array of permissions
+ The user data object..
@@ -25250,33 +28570,7 @@ Parameters:
- permission_name
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Name of a permission
-
-
-
-
-
-
-
-
- resource_server_identifieridentifier
@@ -25293,15 +28587,7 @@ Parameters:
- Identifier for a resource
-
-
-
-
-
-
-
-
+ The user identifier, any of: username, phone_number, email.
@@ -25345,7 +28631,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -25396,11 +28682,12 @@ Returns:
Example
- var params = { id :'ROLE_ID'};
-var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
-management.removePermissionsFromRole(params, data, function (err, permissions) {
- console.log(permissions);
+ // User unblocked.
});
@@ -25412,14 +28699,14 @@ Example
- removePermissionsFromUser(params, data, cbopt) → {Promise|undefined}
+ unlinkUsers(params, cbopt) → {Promise|undefined}
- Remove permissions from a user
+ Unlink the given accounts.
@@ -25455,7 +28742,7 @@ Source:
Parameters:
- params object
+ Linked users data.
@@ -25569,15 +28856,7 @@ Parameters:
- user_id
-
-
-
-
-
-
-
-
+ Primary user ID.
@@ -25586,7 +28865,7 @@ Parameters:
- dataprovider
@@ -25599,45 +28878,20 @@ Parameters:
-
-
-
-
-
-
-
-
- data object containing list of permission IDs
+ Identity provider in use.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- permissionsuser_id
@@ -25654,7 +28908,7 @@ Parameters:
- Array of permission IDs
+ Secondary user ID.
@@ -25749,15 +29003,14 @@ Returns:
Example
- var parms = { id : 'USER_ID'};
-var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
+ var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
-management.removePermissionsFromUser(params, data, function (err) {
+management.unlinkUsers(params, function (err, user) {
if (err) {
// Handle error.
}
- // User assigned permissions.
+ // Users accounts unlinked.
});
@@ -25769,14 +29022,14 @@ Example
- removeRolesFromUser(params, data, cbopt) → {Promise|undefined}
+ updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
- Remove roles from a user
+ Update the app metadata for a user.
@@ -25812,7 +29065,7 @@ re
Source:
Parameters:
- params object
+ The user data object..
@@ -25926,7 +29179,7 @@ Parameters:
- user_id
+ The user id.
@@ -25943,13 +29196,13 @@ Parameters:
- datametadata
-String
+Object
@@ -25968,58 +29221,7 @@ Parameters:
- data object containing list of role IDs
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- roles
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Array of role IDs
-
-
-
-
-
-
-
-
+ New app metadata.
@@ -26055,7 +29257,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -26106,15 +29308,18 @@ Returns:
Example
- var parms = { id : 'USER_ID'};
-var data = { "roles" :["role1"]};
+ var params = { id: USER_ID };
+var metadata = {
+ foo: 'bar'
+};
-management.removeRolesFromUser(params, data, function (err) {
+management.updateAppMetadata(params, metadata, function (err, user) {
if (err) {
// Handle error.
}
- // User assigned roles.
+ // Updated user.
+ console.log(user);
});
@@ -26126,14 +29331,14 @@ Example
- sendEmailVerification(data, cbopt) → {Promise|undefined}
+ updateBrandingSettings(params, data, cbopt) → {Promise|undefined}
- Send a verification email to a user.
+ Update the branding settings.
@@ -26169,7 +29374,7 @@
Source:
Parameters:
- dataparams
@@ -26240,58 +29445,41 @@ Parameters:
- User data object.
+ Branding parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- user_iddata
-String
+Object
+
+
-
+
-
- ID of the user to be verified.
-
-
+
+
-
-
-
+
+
+ Updated branding data.
@@ -26378,14 +29566,13 @@ Returns:
Example
- var params = {
- user_id: '{USER_ID}'
-};
-
-management.sendEmailVerification(params, function (err) {
+ management.updateBrandingSettings(data, function (err, branding) {
if (err) {
// Handle error.
}
+
+// Updated branding
+ console.log(branding);
});
@@ -26397,14 +29584,14 @@ Example
- setRulesConfig(params, data, cbopt) → {Promise|undefined}
+ updateClient(params, data, cbopt) → {Promise|undefined}
- Set a new rules config.
+ Update an Auth0 client.
@@ -26440,7 +29627,7 @@ setRule
Source:
Parameters:
- Rule Config parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- key
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Rule Config key.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Rule Config Data parameters.
+ Client parameters.
@@ -26622,7 +29724,7 @@ Parameters:
- valueclient_id
@@ -26639,7 +29741,7 @@ Parameters:
- Rule Config Data value.
+ Application client ID.
@@ -26654,6 +29756,40 @@ Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated client data.
+
+
+
+
+
+
cbReturns:
Example
- var params = { key: RULE_CONFIG_KEY };
-var data = { value: RULES_CONFIG_VALUE };
+ var data = { name: 'newClientName' };
+var params = { client_id: CLIENT_ID };
-management.setRulesConfig(params, data, function (err, rulesConfig) {
+management.updateClient(params, data, function (err, client) {
if (err) {
// Handle error.
}
- // Rules Config set.
+ console.log(client.name); // 'newClientName'
});
@@ -26754,14 +29890,14 @@ Example
- unblockUser(params, cbopt) → {Promise|undefined}
+ updateClientGrant(params, data, cbopt) → {Promise|undefined}
- Unblock an user by its id.
+ Update an Auth0 client grant.
@@ -26797,7 +29933,7 @@ unblockUse
Source:
Parameters:
- The user data object..
+ Client parameters.
@@ -26911,7 +30047,7 @@ Parameters:
- The user id.
+ Client grant ID.
@@ -26926,6 +30062,40 @@ Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated client data.
+
+
+
+
+
+
cbParameters:
- Callback function
+ Callback function.
@@ -27006,12 +30176,19 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ var data = {
+ client_id: CLIENT_ID,
+ audience: AUDIENCE,
+ scope: []
+};
+var params = { id: CLIENT_GRANT_ID };
+
+management.clientGrants.update(params, data, function (err, grant) {
if (err) {
// Handle error.
}
- // User unblocked.
+ console.log(grant.id);
});
@@ -27023,14 +30200,14 @@ Example
- unblockUser(params, cbopt) → {Promise|undefined}
+ updateConnection(params, data, cbopt) → {Promise|undefined}
- Unblock an user by its id.
+ Update an existing connection.
@@ -27066,7 +30243,7 @@ unblockUse
Source:
Parameters:
- The user data object..
+ Connection parameters.
@@ -27163,7 +30340,7 @@ Parameters:
- identifierid
@@ -27180,7 +30357,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ Connection ID.
@@ -27195,6 +30372,40 @@ Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated connection data.
+
+
+
+
+
+
cbParameters:
- Callback function
+ Callback function.
@@ -27275,12 +30486,15 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ var data = { name: 'newConnectionName' };
+var params = { id: CONNECTION_ID };
+
+management.updateConnection(params, data, function (err, connection) {
if (err) {
// Handle error.
}
- // User unblocked.
+ console.log(connection.name); // 'newConnectionName'
});
@@ -27292,14 +30506,14 @@ Example
- unlinkUsers(params, cbopt) → {Promise|undefined}
+ updateEmailProvider(params, data, cbopt) → {Promise|undefined}
- Unlink the given accounts.
+ Update the email provider.
@@ -27335,7 +30549,7 @@ unlinkUser
Source:
Parameters:
- Linked users data.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Primary user ID.
+ Email provider parameters.
@@ -27458,58 +30629,32 @@ Parameters:
- providerdata
-String
+Object
-
-
-
-
- Identity provider in use.
+
-
-
-
-
-
-
-
- user_id
-
-String
-
-
-
-
+
+
- Secondary user ID.
-
-
-
-
-
-
-
-
+ Updated email provider data.
@@ -27596,14 +30741,13 @@ Returns:
Example
- var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
-
-management.unlinkUsers(params, function (err, user) {
+ management.updateEmailProvider(params, data, function (err, provider) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // Updated email provider.
+ console.log(provider);
});
@@ -27615,14 +30759,14 @@ Example
- updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
- Update the app metadata for a user.
+ Update an existing Email Template.
@@ -27658,7 +30802,7 @@ upda
Source:
Parameters:
- The user data object..
+ Email Template parameters.
@@ -27755,7 +30899,7 @@ Parameters:
- idname
@@ -27772,7 +30916,7 @@ Parameters:
- The user id.
+ Template Name
@@ -27789,7 +30933,7 @@ Parameters:
- metadatadata
@@ -27814,7 +30958,7 @@ Parameters:
- New app metadata.
+ Updated Email Template data.
@@ -27850,7 +30994,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -27901,18 +31045,15 @@ Returns:
Example
- var params = { id: USER_ID };
-var metadata = {
- foo: 'bar'
-};
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
-management.updateAppMetadata(params, metadata, function (err, user) {
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+ console.log(emailTemplate.from); // 'new@email.com'
});
@@ -27924,14 +31065,14 @@ Example
- updateBrandingSettings(params, data, cbopt) → {Promise|undefined}
+ updateFactorProvider(params, data, cbopt) → {Promise|undefined}
- Update the branding settings.
+ Update Guardian's factor provider
@@ -27967,7 +31108,7 @@ Source:
Parameters:
- Branding parameters.
+ Factor provider parameters.
@@ -28072,7 +31213,7 @@ Parameters:
- Updated branding data.
+ Updated Factor provider data.
@@ -28159,13 +31300,12 @@ Returns:
Example
- management.updateBrandingSettings(data, function (err, branding) {
- if (err) {
- // Handle error.
- }
-
-// Updated branding
- console.log(branding);
+ management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ messaging_service_sid: 'XXXXXXXXXXXXXX',
+ auth_token: 'XXXXXXXXXXXXXX',
+ sid: 'XXXXXXXXXXXXXX'
+}, function (err, provider) {
+ console.log(provider);
});
@@ -28177,14 +31317,14 @@ Example
- updateClient(params, data, cbopt) → {Promise|undefined}
+ updateGuardianFactor(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client.
+ Update Guardian Factor
@@ -28220,7 +31360,7 @@ updateCli
Source:
Parameters:
- Client parameters.
+ Factor parameters.
-
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated factor data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.updateGuardianFactor({ name: 'sms' }, {
+ enabled: true
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updateGuardianFactorTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian enrollment and verification factor templates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
@@ -28305,6 +31642,8 @@ Parameters:
Type
+ Attributes
+
@@ -28317,32 +31656,32 @@ Parameters:
- client_idparams
-String
+Object
+
+
-
+
-
- Application client ID.
-
-
+
+
-
-
-
+
+
+ Factor parameters.
@@ -28376,7 +31715,7 @@ Parameters:
- Updated client data.
+ Updated factor templates data.
@@ -28463,15 +31802,11 @@ Returns:
Example
- var data = { name: 'newClientName' };
-var params = { client_id: CLIENT_ID };
-
-management.updateClient(params, data, function (err, client) {
- if (err) {
- // Handle error.
- }
-
- console.log(client.name); // 'newClientName'
+ management.updateGuardianFactorTemplates({ name: 'sms' }, {
+ enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+}, function (err, templates) {
+ console.log(templates);
});
@@ -28483,14 +31818,14 @@ Example
- updateClientGrant(params, data, cbopt) → {Promise|undefined}
+ updateGuardianPhoneFactorMessageTypes(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client grant.
+ Update the Guardian phone factor's message types
@@ -28526,7 +31861,7 @@ upda
Source:
Parameters:
- Client parameters.
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
@@ -28623,13 +31992,13 @@ Parameters:
- idmessage_types
-String
+Array.<String>
@@ -28640,7 +32009,7 @@ Parameters:
- Client grant ID.
+ Message types (only "sms" and "voice" are supported).
@@ -28655,40 +32024,6 @@ Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Updated client data.
-
-
-
-
-
-
cbReturns:
Example
- var data = {
- client_id: CLIENT_ID,
- audience: AUDIENCE,
- scope: []
-};
-var params = { id: CLIENT_GRANT_ID };
-
-management.clientGrants.update(params, data, function (err, grant) {
- if (err) {
- // Handle error.
- }
-
- console.log(grant.id);
+ management.updateGuardianPhoneFactorMessageTypes({}, {
+ message_types: ['sms', 'voice']
+}, function (err, factor) {
+ console.log(factor);
});
@@ -28793,14 +32119,14 @@ Example
- updateConnection(params, data, cbopt) → {Promise|undefined}
+ updateGuardianPhoneFactorSelectedProvider(params, data, cbopt) → {Promise|undefined}
- Update an existing connection.
+ Update the Guardian phone factor's selected provider
@@ -28836,7 +32162,7 @@ updat
Source:
Parameters:
- Connection parameters.
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
@@ -28933,7 +32293,7 @@ Parameters:
- idprovider
@@ -28950,7 +32310,7 @@ Parameters:
- Connection ID.
+ Name of the selected provider
@@ -28965,40 +32325,6 @@ Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Updated connection data.
-
-
-
-
-
-
cbReturns:
Example
- var data = { name: 'newConnectionName' };
-var params = { id: CONNECTION_ID };
-
-management.updateConnection(params, data, function (err, connection) {
- if (err) {
- // Handle error.
- }
-
- console.log(connection.name); // 'newConnectionName'
+ management.updateGuardianPhoneFactorSelectedProvider({}, {
+ provider: 'twilio'
+}, function (err, factor) {
+ console.log(factor);
});
@@ -29099,14 +32420,14 @@ Example
- updateEmailProvider(params, data, cbopt) → {Promise|undefined}
+ updateGuardianPolicies(params, data, cbopt) → {Promise|undefined}
- Update the email provider.
+ Update enabled Guardian policies
@@ -29142,7 +32463,7 @@ up
Source:
Parameters:
- Email provider parameters.
+ Parameters.
@@ -29228,7 +32549,7 @@ Parameters:
-Object
+Array.<String>
@@ -29247,7 +32568,7 @@ Parameters:
- Updated email provider data.
+ Policies to enable. Empty array disables all policies.
@@ -29334,13 +32655,10 @@ Returns:
Example
- management.updateEmailProvider(params, data, function (err, provider) {
- if (err) {
- // Handle error.
- }
-
- // Updated email provider.
- console.log(provider);
+ management.updateGuardianPolicies({}, [
+ 'all-applications'
+], function (err, policies) {
+ console.log(policies);
});
@@ -29352,14 +32670,14 @@ Example
- updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+ updateHook(params, data, cbopt) → {Promise|undefined}
- Update an existing Email Template.
+ Update an existing hook.
@@ -29395,7 +32713,7 @@ u
Source:
Parameters:
- Email Template parameters.
+ Hook parameters.
@@ -29492,7 +32810,7 @@ Parameters:
- nameid
@@ -29509,7 +32827,7 @@ Parameters:
- Template Name
+ Hook ID.
@@ -29551,7 +32869,7 @@ Parameters:
- Updated Email Template data.
+ Updated hook data.
@@ -29638,15 +32956,14 @@ Returns:
Example
- var data = { from: 'new@email.com' };
-var params = { name: EMAIL_TEMPLATE_NAME };
-
-management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ var params = { id: HOOK_ID };
+var data = { name: 'my-hook'};
+management.updateHook(params, data, function (err, hook) {
if (err) {
// Handle error.
}
- console.log(emailTemplate.from); // 'new@email.com'
+ console.log(hook.name); // 'my-hook'.
});
@@ -29658,7 +32975,7 @@ Example
- updateHook(params, data, cbopt) → {Promise|undefined}
+ updateHookSecrets(params, data, cbopt) → {Promise|undefined}
@@ -29701,7 +33018,7 @@ updateHook<
Source:
Parameters:
- Updated hook data.
+ Secrets key/value pairs
@@ -29945,13 +33262,13 @@ Returns:
Example
var params = { id: HOOK_ID };
-var data = { name: 'my-hook'};
-management.updateHook(params, data, function (err, hook) {
+var data = { API_TOKEN: 'updated-secret'};
+management.updateHookSecrets(params, data, function (err, secrets) {
if (err) {
// Handle error.
}
- console.log(hook.name); // 'my-hook'.
+ console.log(secrets)
});
@@ -29963,14 +33280,14 @@ Example
- updateHookSecrets(params, data, cbopt) → {Promise|undefined}
+ updateMigrations(data, cbopt) → {Promise|undefined}
- Update an existing hook.
+ Update the tenant migrations.
@@ -30006,7 +33323,7 @@ upda
Source:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Hook parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Hook ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
dataParameters:
- Secrets key/value pairs
+ Updated migrations data.
@@ -30249,14 +33481,14 @@ Returns:
Example
- var params = { id: HOOK_ID };
-var data = { API_TOKEN: 'updated-secret'};
-management.updateHookSecrets(params, data, function (err, secrets) {
+ data = { flags: { migration: true } };
+management.updateMigrations(data, function (err, migrations) {
if (err) {
// Handle error.
}
- console.log(secrets)
+// Updated migrations flags
+ console.log(migrations.flags);
});
@@ -30311,7 +33543,7 @@ u
Source:
updateRole<
Source:
updateRule<
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 76a32b605..f8ce1198e 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.MigrationsManager.html b/docs/module-management.MigrationsManager.html
new file mode 100644
index 000000000..97c347c60
--- /dev/null
+++ b/docs/module-management.MigrationsManager.html
@@ -0,0 +1,894 @@
+
+
+
+
+
+ MigrationsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MigrationsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ MigrationsManager
+
+
+ Abstracts interaction with the migrations endpoint.
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new MigrationsManager(options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The client options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ baseUrl
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The URL of the API.
+
+
+
+
+
+
+
+
+ headers
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Headers to be included in all requests.
+
+
+
+
+
+
+
+
+ retry
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Retry Policy Config
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+
+(inner) auth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the migrations endpoint
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ getMigrations(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the tenant migrations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.migrations.getMigrations(function (err, migrations) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(migrations.flags);
+});
+
+
+
+
+
+
+
+
+
+
+ updateMigrations(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the tenant migrations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The tenant migrations to be updated
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ flags
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The tenant migrations flags to be updated
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.migrations.updateMigrations(data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index d450ac7fd..21d4124ea 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index fb5b1d27f..5a3fc2b55 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 961843c93..97ba3fa94 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index f6980c26f..4929adc05 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4293,7 +4293,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 838527adc..c27870d41 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 6dbd96b97..622494998 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 3555a998f..32b369ef9 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 2b6bee0fb..912072b15 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 7d1f5730b..82d4e1e47 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index 8543b95d7..87627110d 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 4f4e00d83..2c8b117f7 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index fb60127dd..6b0291d80 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -110,6 +110,9 @@ Classes
ManagementTokenProvider
+ MigrationsManager
+
+
PromptsManager
@@ -168,7 +171,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 12e5b188c..ee686ea37 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 8106671bc..d316de5ca 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -91,6 +91,9 @@ utils.js
*/
utils.wrapPropertyMethod = function(Parent, name, propertyMethod) {
var path = propertyMethod.split('.');
+ if (path.length > 2) {
+ throw new Error('wrapPropertyMethod() only supports one level of nesting for propertyMethod');
+ }
var property = path.shift();
var method = path.pop();
@@ -138,7 +141,7 @@ utils.js
diff --git a/package.json b/package.json
index c6cecbc29..8461fcac2 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.26.0",
+ "version": "2.27.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
updateSource:
Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 03ffd315c..0f056861a 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 ebd9db73e..852d95b86 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@ Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 41f18b371..695997f42 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 27ad509a8..19caed12c 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 fa71e19f3..a47960d4e 100644
--- a/docs/module-management.GrantsManager.html
+++ b/docs/module-management.GrantsManager.html
@@ -24,7 +24,7 @@
@@ -842,7 +842,7 @@ deleteGran
Source:
Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index f77df6f02..ec3e5a723 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -464,6 +464,154 @@ external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorsPhoneMessageTypesAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian phone factor message types.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorsPhoneSelectedProviderAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian phone factor selected provider.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
@@ -567,7 +715,7 @@
- Provides an abstraction layer for retrieving Guardian factors.
+ Provides an abstraction layer for retrieving Guardian factor templates.
@@ -612,6 +760,80 @@ external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianPoliciesAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian policies.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
@@ -761,7 +983,7 @@ Source:
Source:
Example
- getGuardianEnrollment(data, cbopt) → {Promise|undefined}
+ getFactorProvider(params, cbopt) → {Promise|undefined}
- Get a single Guardian enrollment.
+ Get Guardian factor provider configuration
@@ -1206,7 +1428,7 @@
Source:
Parameters:
- dataparams
@@ -1277,50 +1499,43 @@ Parameters:
- The user data object.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- The user id.
+ Callback function.
@@ -1329,7 +1544,2515 @@ Parameters:
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
+
+
+
+
+
+
+ getFactors(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a list of factors and statuses.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getFactors(function (err, factors) {
+ console.log(factors.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getFactorTemplates(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get Guardian enrollment and verification factor templates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor parameters.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getFactorTemplates({ name: 'sms' }, function (err, templates) {
+ console.log(templates);
+});
+
+
+
+
+
+
+
+
+
+
+ getGuardianEnrollment(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a single Guardian enrollment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The user data object.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ console.log(enrollment);
+});
+
+
+
+
+
+
+
+
+
+
+ getPhoneFactorMessageTypes(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the Guardian phone factor's message types
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getPhoneFactorMessageTypes(function (err, messageTypes) {
+ console.log(messageTypes);
+});
+
+
+
+
+
+
+
+
+
+
+ getPhoneFactorSelectedProvider(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the Guardian phone factor's selected provider
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getPhoneFactorSelectedProvider(function (err, selectedProvider) {
+ console.log(selectedProvider);
+});
+
+
+
+
+
+
+
+
+
+
+ getPolicies(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get enabled Guardian policies
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getPolicies(function (err, policies) {
+ console.log(policies);
+});
+
+
+
+
+
+
+
+
+
+
+ updateFactor(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian Factor
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated factor data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updateFactor({ name: 'sms' }, {
+ enabled: true
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updateFactorProvider(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian's factor provider
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor provider parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Factor provider data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updateFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ messaging_service_sid: 'XXXXXXXXXXXXXX',
+ auth_token: 'XXXXXXXXXXXXXX',
+ sid: 'XXXXXXXXXXXXXX'
+}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
+
+
+
+
+
+
+ updateFactorTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian enrollment and verification factor templates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated factor templates data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updateFactorProvider({ name: 'sms' }, {
+ enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+}, function (err, templates) {
+ console.log(templates);
+});
+
+
+
+
+
+
+
+
+
+
+ updatePhoneFactorMessageTypes(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the Guardian phone factor's message types
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ message_types
+
+
+Array.<String>
+
+
+
+
+
+
+
+
+
+
+ Message types (only "sms" and "voice" are supported).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updatePhoneFactorMessageTypes({}, {
+ message_types: ['sms', 'voice']
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updatePhoneFactorSelectedProvider(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the Guardian phone factor's selected provider
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Name of the selected provider
+
+
+
+
+
+
+
+
+
@@ -1415,8 +4138,260 @@ Returns:
Example
- management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
- console.log(enrollment);
+ management.guardian.updatePhoneFactorSelectedProvider({}, {
+ provider: 'twilio'
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updatePolicies(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update enabled Guardian policies
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Array.<String>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Policies to enable. Empty array disables all policies.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updatePolicies({}, [
+ 'all-applications'
+], function (err, policies) {
+ console.log(policies);
});
@@ -1440,7 +4415,7 @@ Example
diff --git a/docs/module-management.HooksManager.html b/docs/module-management.HooksManager.html
index 9facca9da..dcf47a8d6 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 b489005bd..debe93a8b 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -2676,7 +2676,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index ee8687280..084e7a64d 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 700e3ee3e..7767f2f9c 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -106,7 +106,7 @@ new M
Source:
blac
Source:
brandingSource:
clientGra
Source:
clientsSource:
connection
Source:
customDo
Source:
devi
Source:
emailPro
Source:
emailTe
Source:
grantsSource:
guardianSource:
hooksSource:
jobsSource:
logsSource:
Type:
+
+
+
+
+
+migrations :MigrationsManager
+
+
+
+
+
+ ManagementClient migrations manager.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
MigrationsManager
+
+
+
+
+
+
+
+
+
@@ -1811,7 +1885,7 @@ resour
Source:
rolesSource:
rulesSource:
rulesConf
Source:
statsSource:
tenantSource:
ticketsSource:
userBlocks<
Source:
usersSource:
addHookS
Source:
a
Source:
Source:
assi
Source:
blackli
Source:
Source:
createCli
Source:
crea
Source:
creat
Source:
cre
Source:
Source:
cr
Source:
Source:
Source:
createHook<
Source:
Source:
c
Source:
createRole<
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
+
+
+
+
+
+
+ getGuardianFactors(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a list of Guardian factors and statuses.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
cbReturns:
Example
- management.getHook({ id: HOOK_ID }, function (err, hook) {
- if (err) {
- // Handle error.
- }
-
- console.log(hook);
+ management.getGuardianFactors(function (err, factors) {
+ console.log(factors.length);
});
@@ -16825,14 +17024,14 @@ Example
- getHooks(paramsopt, cbopt) → {Promise|undefined}
+ getGuardianFactorTemplates(params, cbopt) → {Promise|undefined}
- Get all hooks.
+ Get Guardian enrollment and verification factor templates
@@ -16868,7 +17067,7 @@ getHooksSource:
Parameters:
- <optional>
-
@@ -16941,41 +17138,22 @@ Parameters:
- Hooks parameters.
+ Factor parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+
+
-
- per_pagecb
-Number
+function
@@ -16996,57 +17174,157 @@ Parameters:
- Number of results per page.
+ Callback function.
+
+
-
-
- page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
+ console.log(templates);
+});
+
+
+
+
+
+
-
- Page number, zero indexed.
-
-
-
+
+
+ getGuardianPhoneFactorMessageTypes(cbopt) → {Promise|undefined}
-
-
-
-
-
+
+
+
+ Get the Guardian phone factor's message types
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
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.getGuardianPhoneFactorMessageTypes(function (err, messageTypes) {
+ console.log(messageTypes);
});
@@ -17152,14 +17418,14 @@ Example
- getHookSecrets(params, cbopt) → {Promise|undefined}
+ getGuardianPhoneFactorSelectedProvider(cbopt) → {Promise|undefined}
- Get an Auth0 hook's secrets.
+ Get the Guardian phone factor's selected provider
@@ -17195,7 +17461,7 @@ getHook
Source:
Parameters:
- paramscb
-Object
+function
@@ -17256,6 +17522,8 @@ Parameters:
+ <optional>
+
@@ -17266,64 +17534,157 @@ Parameters:
- Hook parameters.
+ Callback function.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
- Name
-
- Type
+
+
+
+Returns:
+
+ -
+ Type:
+
+ -
+
Promise
+|
+
+undefined
+
+
+
+
- Description
-
-
-
+
-
-
- id
-
-
-String
+
+Example
-
-
+ management.getGuardianPhoneFactorSelectedProvider(function (err, selectedProvider) {
+ console.log(selectedProvider);
+});
-
+
+
+
+
-
- Hook ID.
-
-
-
+
+
+ getGuardianPolicies(cbopt) → {Promise|undefined}
-
-
-
-
-
+
+
+
+ Get enabled Guardian policies
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
cbReturns:
Example
- var params = { id: HOOK_ID }
-management.getHookSecrets(params, function (err, secrets) {
- if (err) {
- // Handle error.
- }
-
- console.log(secrets);
+ management.getGuardianPolicies(function (err, policies) {
+ console.log(policies);
});
@@ -17422,14 +17778,14 @@ Example
- getJob(params, cbopt) → {Promise|undefined}
+ getHook(params, cbopt) → {Promise|undefined}
- Get a job by its ID.
+ Get an Auth0 hook.
@@ -17465,7 +17821,7 @@ getJobSource:
Parameters:
- Job parameters.
+ Hook parameters.
@@ -17579,7 +17935,7 @@ Parameters:
- Job ID.
+ Hook ID.
@@ -17674,17 +18030,12 @@ Returns:
Example
- var params = {
- id: '{JOB_ID}'
-};
-
-management.getJob(params, function (err, job) {
+ management.getHook({ id: HOOK_ID }, function (err, hook) {
if (err) {
// Handle error.
}
- // Retrieved job.
- console.log(job);
+ console.log(hook);
});
@@ -17696,14 +18047,14 @@ Example
- getLog(params, cbopt) → {Promise|undefined}
+ getHooks(paramsopt, cbopt) → {Promise|undefined}
- Get an Auth0 log.
+ Get all hooks.
@@ -17739,7 +18090,7 @@ getLogSource:
Parameters:
+ <optional>
+
@@ -17810,7 +18163,7 @@ Parameters:
- Log parameters.
+ Hooks parameters.
@@ -17824,6 +18177,8 @@ Parameters:
Type
+ Attributes
+
@@ -17836,24 +18191,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- Event ID.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -17948,12 +18349,20 @@ Returns:
Example
- management.getLog({ id: EVENT_ID }, function (err, log) {
- 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(log);
+management.getHooks(params, function (err, hooks) {
+ console.log(hooks.length);
});
@@ -17965,14 +18374,14 @@ Example
- getLogs(paramsopt, cbopt) → {Promise|undefined}
+ getHookSecrets(params, cbopt) → {Promise|undefined}
- Get all logs.
+ Get an Auth0 hook's secrets.
@@ -18008,7 +18417,7 @@ getLogsSource:
Parameters:
- <optional>
-
@@ -18081,7 +18488,7 @@ Parameters:
- Logs params.
+ Hook parameters.
@@ -18095,8 +18502,6 @@ Parameters:
Type
- Attributes
-
@@ -18109,7 +18514,7 @@ Parameters:
- qid
@@ -18122,21 +18527,19 @@ Parameters:
-
-
- <optional>
-
-
+
+
+ Hook ID.
-
-
+
+
-
+
+
+
-
- Search Criteria using Query String Syntax
@@ -18145,13 +18548,13 @@ Parameters:
- pagecb
-Number
+function
@@ -18172,130 +18575,171 @@ Parameters:
- Page number. Zero based
+ Callback function.
+
+
-
-
- per_page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- The amount of entries per page
-
-
-
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
-
-
- sort
-
-
-String
+
+Example
-
-
+ var params = { id: HOOK_ID }
+management.getHookSecrets(params, function (err, secrets) {
+ if (err) {
+ // Handle error.
+ }
-
-
-
- <optional>
-
+ console.log(secrets);
+});
-
+
-
-
+
+
+
-
+
-
- The field to use for sorting.
-
-
-
+ getJob(params, cbopt) → {Promise|undefined}
-
-
- fields
-
-
-String
+
+ Get a job by its ID.
+
-
-
-
-
-
- <optional>
-
-
-
-
-
-
+
-
- A comma separated list of fields to include or exclude
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
- include_fieldsparams
-Boolean
+Object
@@ -18304,8 +18748,6 @@ Parameters:
- <optional>
-
@@ -18316,43 +18758,50 @@ Parameters:
- true if the fields specified are to be included in the result, false otherwise.
+ Job parameters.
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+ Description
+
+
+
+
- include_totalsid
-Boolean
+String
-
-
- <optional>
-
-
-
-
-
-
-
- true if a query summary must be included in the result, false otherwise. Default false
+ Job ID.
@@ -18447,20 +18896,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);
});
@@ -18472,14 +18918,14 @@ Example
- getPermissionsInRole(roleIdopt, cbopt) → {Promise|undefined}
+ getLog(params, cbopt) → {Promise|undefined}
- Get permissions for a given role
+ Get an Auth0 log.
@@ -18515,7 +18961,7 @@ g
Source:
Parameters:
- roleIdparams
-String
+Object
@@ -18576,8 +19022,6 @@ Parameters:
- <optional>
-
@@ -18588,7 +19032,58 @@ Parameters:
- Id of the role
+ Log parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Event ID.
+
+
+
+
+
+
+
+
@@ -18673,18 +19168,14 @@ Returns:
-Examples
-
- var params = { id :'ROLE_ID'};
+Example
-
- This method takes a roleId and
- returns all permissions within that role
+
management.getLog({ id: EVENT_ID }, function (err, log) {
+ if (err) {
+ // Handle error.
+ }
-
-
- management.getPermissionsInRole(params, function (err, permissions) {
- console.log(permissions);
+ console.log(log);
});
@@ -18696,14 +19187,14 @@ Examples
- getResourceServer(params, cbopt) → {Promise|undefined}
+ getLogs(paramsopt, cbopt) → {Promise|undefined}
- Get a Resource Server.
+ Get all logs.
@@ -18739,7 +19230,7 @@ getR
Source:
Parameters:
+ <optional>
+
@@ -18810,7 +19303,7 @@ Parameters:
- Resource Server parameters.
+ Logs params.
@@ -18824,6 +19317,8 @@ Parameters:
Type
+ Attributes
+
@@ -18836,7 +19331,7 @@ Parameters:
- idq
@@ -18849,11 +19344,237 @@ Parameters:
+
+
+ <optional>
+
+
+
+
+
+
+
- Resource Server ID.
+ 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.
+
+
+
+
+
+
+
+
+ fields
+
+
+String
+
+
+
+
+
+
+
+
+ <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
@@ -18948,12 +19669,205 @@ Returns:
Example
- management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+
+ 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
+};
+
+management.getLogs(params, function (err, logs) {
+ console.log(logs.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getMigrations(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get migrations flags
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getMigrations(function (err, migrations) {
if (err) {
// Handle error.
}
- console.log(resourceServer);
+// Migration flags
+ console.log(migrations.flags);
});
@@ -18965,14 +19879,2210 @@ Example
- getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+ getPermissionsInRole(roleIdopt, cbopt) → {Promise|undefined}
- Get all resource servers.
+ Get permissions for a given role
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ roleId
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Id of the role
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Examples
+
+ var params = { id :'ROLE_ID'};
+
+
+ This method takes a roleId and
+ returns all permissions within that role
+
+
+
+ management.getPermissionsInRole(params, function (err, permissions) {
+ console.log(permissions);
+});
+
+
+
+
+
+
+
+
+
+
+ getResourceServer(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a Resource Server.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Resource Server parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Resource Server ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(resourceServer);
+});
+
+
+
+
+
+
+
+
+
+
+ getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all resource servers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Resource Servers parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.getResourceServers(params, function (err, resourceServers) {
+ console.log(resourceServers.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getRole(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get an Auth0 role.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Role parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Role ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getRole({ id: ROLE_ID }, function (err, role) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(role);
+});
+
+
+
+
+
+
+
+
+
+
+ getRoles(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all roles.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Roles parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.getRoles(params, function (err, roles) {
+ console.log(roles.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getRule(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get an Auth0 rule.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rule parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getRule({ id: RULE_ID }, function (err, rule) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(rule);
+});
+
+
+
+
+
+
+
+
+
+
+ getRules(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all rules.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Rules parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.getRules(params, function (err, rules) {
+ console.log(rules.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getRulesConfigs(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get rules config.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getRulesConfigs(function (err, rulesConfigs) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Get Rules Configs.
+});
+
+
+
+
+
+
+
+
+
+
+ getTenantSettings(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the tenant settings..
@@ -19008,7 +22118,7 @@ get
Source:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Resource Servers 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.getSettings(function (err, settings) {
+ if (err) {
+ // Handle error.
+ }
-management.getResourceServers(params, function (err, resourceServers) {
- console.log(resourceServers.length);
+ console.log(settings);
});
@@ -19292,14 +22259,14 @@ Example
- getRole(params, cbopt) → {Promise|undefined}
+ getUser(data, cbopt) → {Promise|undefined}
- Get an Auth0 role.
+ Get a user by its id.
@@ -19335,7 +22302,7 @@ getRoleSource:
Parameters:
- paramsdata
@@ -19406,7 +22373,7 @@ Parameters:
- Role parameters.
+ The user data object.
@@ -19449,7 +22416,7 @@ Parameters:
- Role ID.
+ The user id.
@@ -19544,12 +22511,8 @@ Returns:
Example
- management.getRole({ id: ROLE_ID }, function (err, role) {
- if (err) {
- // Handle error.
- }
-
- console.log(role);
+ management.getUser({ id: USER_ID }, function (err, user) {
+ console.log(user);
});
@@ -19561,14 +22524,14 @@ Example
- getRoles(paramsopt, cbopt) → {Promise|undefined}
+ getUserBlocks(params, cbopt) → {Promise|undefined}
- Get all roles.
+ Get user blocks by its id.
@@ -19604,7 +22567,7 @@ getRolesSource:
Parameters:
- <optional>
-
@@ -19677,7 +22638,7 @@ Parameters:
- Roles parameters.
+ The user data object..
@@ -19691,8 +22652,6 @@ Parameters:
Type
- Attributes
-
@@ -19705,70 +22664,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ The user id.
@@ -19812,7 +22725,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -19863,20 +22776,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.getUserBlocks({ id: USER_ID }, function (err, blocks) {
+ if (err) {
+ // Handle error.
+ }
-management.getRoles(params, function (err, roles) {
- console.log(roles.length);
+ console.log(blocks);
});
@@ -19888,14 +22793,14 @@ Example
- getRule(params, cbopt) → {Promise|undefined}
+ getUserBlocksByIdentifier(params, cbopt) → {Promise|undefined}
- Get an Auth0 rule.
+ Get user blocks by its identifier.
@@ -19931,7 +22836,7 @@ getRuleSource:
Parameters:
- Rule parameters.
+ The user data object..
@@ -20028,7 +22933,7 @@ Parameters:
- ididentifier
@@ -20045,7 +22950,7 @@ Parameters:
- Rule ID.
+ The user identifier, any of: username, phone_number, email.
@@ -20089,7 +22994,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -20140,12 +23045,12 @@ Returns:
Example
- management.getRule({ id: RULE_ID }, function (err, rule) {
+ management.getUserBlocksByIdentifier({ identifier: USER_ID }, function (err, blocks) {
if (err) {
// Handle error.
}
- console.log(rule);
+ console.log(blocks);
});
@@ -20157,14 +23062,14 @@ Example
- getRules(paramsopt, cbopt) → {Promise|undefined}
+ getUserLogs(params, cbopt) → {Promise|undefined}
- Get all rules.
+ Get user's log events.
@@ -20200,7 +23105,7 @@ getRulesSource:
Parameters:
- <optional>
-
@@ -20273,7 +23176,7 @@ Parameters:
- Rules parameters.
+ Get logs data.
@@ -20287,8 +23190,6 @@ Parameters:
Type
- Attributes
-
@@ -20301,28 +23202,44 @@ Parameters:
- per_pageid
-Number
+String
-
-
- <optional>
-
+
+
+
+ User id.
+
+
+
+
+
+
+ per_page
+
-
+Number
+
+
+
+
+
@@ -20350,21 +23267,63 @@ Parameters:
-
+
+
+
+
+ Page number, zero indexed.
- <optional>
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
- Page number, zero indexed.
+ true if a query summary must be included in the result, false otherwise. Default false;
@@ -20459,20 +23418,14 @@ 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
-};
+ var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-management.getRules(params, function (err, rules) {
- console.log(rules.length);
+management.getUserLogs(params, function (err, logs) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logs);
});
@@ -20484,14 +23437,14 @@ Example
- getRulesConfigs(cbopt) → {Promise|undefined}
+ getUserPermissions(params, cbopt) → {Promise|undefined}
- Get rules config.
+ Get user's permissions
@@ -20527,7 +23480,7 @@ getRul
Source:
Parameters:
- cbparams
-function
+Object
@@ -20588,8 +23541,6 @@ Parameters:
- <optional>
-
@@ -20600,159 +23551,166 @@ Parameters:
- Callback function.
+ Get permissions data.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
+
+
+
+
-
-
- -
- Type:
-
- -
+
Name
-Promise
-|
-undefined
+ Type
+
-
-
+
+ Description
+
+
+
-
-
+
+
+ idExample
-
- management.getRulesConfigs(function (err, rulesConfigs) {
- if (err) {
- // Handle error.
- }
+
+
+
+String
- // Get Rules Configs.
-});
-
+
+
-
-
-
-
+
- getTenantSettings(cbopt) → {Promise|undefined}
+
+ User id.
+
+
+
+
+
+ per_pageGet the tenant settings..
-
+
+
+
+Number
+
+
+
+
-
+
+ Number of results per page.
+
+
+
-
+
+
+ page
+
+
+Number
-
-
+
+
-
+
-
+
-
+
+ Page number, zero indexed.
+
+
+
-
+
+
+ sort
+
+
+String
-
-
- Source:
-
-
+
-
+
-
-
+
+ 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;
+
+
+
- Parameters:
+
+
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+
+
+
-
@@ -20835,12 +23793,14 @@ Returns:
Example
- management.getSettings(function (err, settings) {
+ 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(settings);
+ console.log(logs);
});
@@ -20852,14 +23812,14 @@ Example
- getUser(data, cbopt) → {Promise|undefined}
+ getUserRoles(params, cbopt) → {Promise|undefined}
- Get a user by its id.
+ Get user's roles
@@ -20895,7 +23855,7 @@ getUserSource:
Parameters:
- dataparams
@@ -20966,7 +23926,7 @@ Parameters:
- The user data object.
+ Get roles data.
@@ -21009,7 +23969,111 @@ Parameters:
- The user id.
+ 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;
@@ -21104,8 +24168,14 @@ Returns:
Example
- management.getUser({ id: USER_ID }, function (err, user) {
- console.log(user);
+ 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);
});
@@ -21117,14 +24187,14 @@ Example
- getUserBlocks(params, cbopt) → {Promise|undefined}
+ getUsers(paramsopt, cbopt) → {Promise|undefined}
- Get user blocks by its id.
+ Get all users.
@@ -21160,7 +24230,7 @@ getUserB
Source:
Parameters:
+ <optional>
+
@@ -21231,7 +24303,7 @@ Parameters:
- The user data object..
+ Users params.
@@ -21245,6 +24317,8 @@ Parameters:
Type
+ Attributes
+
@@ -21257,7 +24331,43 @@ Parameters:
- idsearch_engine
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The version of the search engine to use.
+
+
+
+
+
+
+
+
+ q
@@ -21270,11 +24380,93 @@ Parameters:
+
+
+ <optional>
+
+
+
+
+
+
+
- The user id.
+ User Search string to filter which users are returned. Follows Lucene query string syntax as documented at https://auth0.com/docs/api/management/v2#!/Users/get_users.
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -21318,7 +24510,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -21369,12 +24561,22 @@ 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 = {
+ search_engine: 'v3',
+ q: 'name:*jane*',
+ per_page: 10,
+ page: 0
+};
- console.log(blocks);
+auth0.getUsers(params, function (err, users) {
+ console.log(users.length);
});
@@ -21386,14 +24588,14 @@ Example
- getUserBlocksByIdentifier(params, cbopt) → {Promise|undefined}
+ getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
- Get user blocks by its identifier.
+ Get users for a given email address
@@ -21429,7 +24631,7 @@ Source:
Parameters:
- paramsemail
-Object
+String
@@ -21490,68 +24692,19 @@ Parameters:
-
-
-
+ <optional>
-
-
-
-
-
- The user data object..
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- identifier
-
-String
-
-
-
-
-
+
- The user identifier, any of: username, phone_number, email.
-
-
-
-
-
-
-
-
+ Email Address of users to locate
@@ -21587,7 +24740,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -21638,12 +24791,13 @@ Returns:
Example
- management.getUserBlocksByIdentifier({ identifier: USER_ID }, function (err, blocks) {
- if (err) {
- // Handle error.
- }
-
- console.log(blocks);
+
+ This method takes an email address as the first argument,
+ and returns all users with that email address
+
+
+ auth0.getUsersByEmail(email, function (err, users) {
+ console.log(users);
});
@@ -21655,14 +24809,14 @@ Example
- getUserLogs(params, cbopt) → {Promise|undefined}
+ getUsersInRole(idopt, cbopt) → {Promise|undefined}
- Get user's log events.
+ Get users in a given role
@@ -21698,7 +24852,7 @@ getUserLog
Source:
Parameters:
- paramsid
-Object
+String
@@ -21759,6 +24913,8 @@ Parameters:
+ <optional>
+
@@ -21769,70 +24925,37 @@ Parameters:
- Get logs data.
+ Id of the role
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idparams.per_page
-String
+Number
-
-
-
-
- User id.
+
-
-
-
-
-
-
-
- per_page
-
+ <optional>
-Number
-
-
-
+
+
+
@@ -21847,7 +24970,7 @@ Parameters:
- pageparams.page
@@ -21860,71 +24983,21 @@ Parameters:
-
-
-
-
- Page number, zero indexed.
+
-
-
-
-
-
-
-
- sort
-
+ <optional>
-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;
-
-
-
-
-
-
-
-
+ Page number, zero indexed.
@@ -22009,16 +25082,20 @@ Returns:
-Example
-
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+Examples
-management.getUserLogs(params, function (err, logs) {
- if (err) {
- // Handle error.
- }
+ var params = {
+ id: 'ROLE_ID'
+ per_page: 50,
+ page: 0
+};
- console.log(logs);
+
+ This method takes a roleId and returns all users within that role
+
+
+ management.getUsersInRole(params, function (err, users) {
+ console.log(users);
});
@@ -22030,14 +25107,16 @@ Example
- getUserPermissions(params, cbopt) → {Promise|undefined}
+ importUsers(data, cbopt) → {Promise|undefined}
- Get user's permissions
+ Given a path to a file and a connection id, create a new job that imports the
+users contained in the file or JSON string and associate them with the given
+connection.
@@ -22073,7 +25152,7 @@ get
Source:
Parameters:
- paramsdata
@@ -22144,7 +25223,7 @@ Parameters:
- Get permissions data.
+ Users import data.
@@ -22158,6 +25237,8 @@ Parameters:
Type
+ Attributes
+
@@ -22170,7 +25251,7 @@ Parameters:
- idconnection_id
@@ -22183,11 +25264,19 @@ Parameters:
+
+
+
+
+
+
+
+
- User id.
+ connection_id of the connection to which users will be imported.
@@ -22196,24 +25285,34 @@ Parameters:
- per_pageusers
-Number
+String
+
+
+ <optional>
+
+
+
+
+
+
+
- Number of results per page.
+ Path to the users data file. Either users or users_json is mandatory.
@@ -22222,24 +25321,34 @@ Parameters:
- pageusers_json
-Number
+String
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ JSON data for the users.
@@ -22248,24 +25357,34 @@ Parameters:
- sortupsert
-String
+Boolean
+
+
+ <optional>
+
+
+
+
+
+
+
- The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+ Whether to update users if they already exist (true) or to ignore them (false).
@@ -22274,7 +25393,7 @@ Parameters:
- include_totalssend_completion_email
@@ -22287,11 +25406,21 @@ Parameters:
+
+
+ <optional>
+
+
+
+
+
+
+
- true if a query summary must be included in the result, false otherwise. Default false;
+ Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
@@ -22386,14 +25515,15 @@ Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+ var params = {
+ connection_id: '{CONNECTION_ID}',
+ users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}'
+};
-management.getUserPermissions(params, function (err, logs) {
+management.importUsers(params, function (err) {
if (err) {
// Handle error.
}
-
- console.log(logs);
});
@@ -22405,14 +25535,14 @@ Example
- getUserRoles(params, cbopt) → {Promise|undefined}
+ linkUsers(userId, params, cbopt) → {Promise|undefined}
- Get user's roles
+ Link the user with another account.
@@ -22448,7 +25578,7 @@ getUserRo
Source:
Parameters:
- paramsuserId
-Object
+String
@@ -22519,111 +25649,67 @@ Parameters:
- Get roles data.
+ ID of the primary user.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idparams
-String
+Object
-
-
-
-
- User id.
+
-
-
-
-
-
-
- per_page
-
-Number
-
-
-
-
+
+
- Number of results per page.
-
-
-
-
-
-
-
-
- page
-
+ Secondary user data.
-Number
+
+
+
+
+
+ Name
+
-
-
+ Type
-
+
-
+
-
- Page number, zero indexed.
-
-
-
+ Description
+
+
+
- sortuser_id
@@ -22640,7 +25726,7 @@ Parameters:
- The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+ ID of the user to be linked.
@@ -22649,13 +25735,13 @@ Parameters:
- include_totalsconnection_id
-Boolean
+String
@@ -22666,7 +25752,7 @@ Parameters:
- true if a query summary must be included in the result, false otherwise. Default false;
+ ID of the connection to be used.
@@ -22761,14 +25847,18 @@ Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+ var userId = 'USER_ID';
+var params = {
+ user_id: 'OTHER_USER_ID',
+ connection_id: 'CONNECTION_ID'
+};
-management.getUserRoles(params, function (err, logs) {
+management.linkUsers(userId, params, function (err, user) {
if (err) {
// Handle error.
}
- console.log(logs);
+ // Users linked.
});
@@ -22780,14 +25870,14 @@ Example
- getUsers(paramsopt, cbopt) → {Promise|undefined}
+ regenerateRecoveryCode(data, cbopt) → {Promise|undefined}
- Get all users.
+ Generate new Guardian recovery code.
@@ -22823,7 +25913,7 @@ getUsersSource:
Parameters:
- paramsdata
@@ -22884,8 +25974,6 @@ Parameters:
- <optional>
-
@@ -22896,7 +25984,7 @@ Parameters:
- Users params.
+ The user data object.
@@ -22910,8 +25998,6 @@ Parameters:
Type
- Attributes
-
@@ -22924,43 +26010,7 @@ Parameters:
- search_engine
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The version of the search engine to use.
-
-
-
-
-
-
-
-
- qid
@@ -22973,93 +26023,11 @@ Parameters:
-
-
- <optional>
-
-
-
-
-
-
-
- User Search string to filter which users are returned. Follows Lucene query string syntax as documented at https://auth0.com/docs/api/management/v2#!/Users/get_users.
-
-
-
-
-
-
-
-
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Page number, zero indexed.
+ The user id.
@@ -23154,22 +26122,8 @@ 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 = {
- search_engine: 'v3',
- q: 'name:*jane*',
- per_page: 10,
- page: 0
-};
-
-auth0.getUsers(params, function (err, users) {
- console.log(users.length);
+ management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
+ console.log(newRecoveryCode);
});
@@ -23181,14 +26135,14 @@ Example
- getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+ removeHookSecrets(params, data, cbopt) → {Promise|undefined}
- Get users for a given email address
+ Delete an existing hook.
@@ -23224,7 +26178,7 @@ getUse
Source:
Parameters:
- emailparams
-String
+Object
@@ -23285,7 +26239,90 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+
+ Hook parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Hook ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
@@ -23297,7 +26334,7 @@ Parameters:
- Email Address of users to locate
+ Secrets key/value pairs
@@ -23384,13 +26421,14 @@ Returns:
Example
-
- This method takes an email address as the first argument,
- and returns all users with that email address
-
-
- auth0.getUsersByEmail(email, function (err, users) {
- console.log(users);
+ var params = { id: HOOK_ID }
+var data = ['API_TOKEN', 'DB_PASSWORD']
+auth0.removeHookSecrets(params, data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Hook deleted.
});
@@ -23402,14 +26440,14 @@ Example
- getUsersInRole(idopt, cbopt) → {Promise|undefined}
+ removePermissionsFromRole(data, cbopt) → {Promise|undefined}
- Get users in a given role
+ Remove permissions from a role
@@ -23445,7 +26483,7 @@ getUser
Source:
Parameters:
- idparams.id
@@ -23506,8 +26544,6 @@ Parameters:
- <optional>
-
@@ -23518,7 +26554,7 @@ Parameters:
- Id of the role
+ ID of the Role.
@@ -23527,13 +26563,13 @@ Parameters:
- params.per_pagedata
-Number
+Object
@@ -23542,8 +26578,6 @@ Parameters:
- <optional>
-
@@ -23554,43 +26588,135 @@ Parameters:
- Number of results per page.
+ permissions data
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+ Description
+
+
+
+
- params.pagepermissions
-Number
+String
-
+
+
+
+
+ Array of permissions
- <optional>
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ permission_name
+
+String
+
+
+
+
+
+
+
+
+
+ Name of a permission
+
+
+
+
+
+
+ resource_server_identifier
+
-
+String
+
+
+
+
+
- Page number, zero indexed.
+ Identifier for a resource
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -23675,20 +26801,13 @@ Returns:
-Examples
+Example
- var params = {
- id: 'ROLE_ID'
- per_page: 50,
- page: 0
-};
+ var params = { id :'ROLE_ID'};
+var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
-
- This method takes a roleId and returns all users within that role
-
-
- management.getUsersInRole(params, function (err, users) {
- console.log(users);
+management.removePermissionsFromRole(params, data, function (err, permissions) {
+ console.log(permissions);
});
@@ -23700,16 +26819,14 @@ Examples
- importUsers(data, cbopt) → {Promise|undefined}
+ removePermissionsFromUser(params, data, cbopt) → {Promise|undefined}
- Given a path to a file and a connection id, create a new job that imports the
-users contained in the file or JSON string and associate them with the given
-connection.
+ Remove permissions from a user
@@ -23745,7 +26862,7 @@ importUser
Source:
Parameters:
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Users import data.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- connection_idparams
-String
+Object
@@ -23869,16 +26933,33 @@ Parameters:
- connection_id of the connection to which users will be imported.
+ params object
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+ Description
+
+
+
+
- usersid
@@ -23891,21 +26972,19 @@ Parameters:
-
-
- <optional>
-
-
+
+
+ user_id
-
-
+
+
-
+
+
+
-
- Path to the users data file. Either users or users_json is mandatory.
@@ -23914,7 +26993,7 @@ Parameters:
- users_jsondata
@@ -23929,8 +27008,6 @@ Parameters:
- <optional>
-
@@ -23941,79 +27018,50 @@ Parameters:
- JSON data for the users.
-
-
-
-
-
-
-
-
- upsert
-
+ data object containing list of permission IDs
-Boolean
-
-
-
-
+
-
-
-
- <optional>
-
+
+
+
+
+ Name
+
-
+ Type
-
-
-
+
-
+
-
- Whether to update users if they already exist (true) or to ignore them (false).
-
-
-
+ Description
+
+
+
- send_completion_emailpermissions
-Boolean
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
+ Array of permission IDs
@@ -24108,15 +27156,15 @@ Returns:
Example
- var params = {
- connection_id: '{CONNECTION_ID}',
- users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}'
-};
+ var parms = { id : 'USER_ID'};
+var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
-management.importUsers(params, function (err) {
+management.removePermissionsFromUser(params, data, function (err) {
if (err) {
// Handle error.
}
+
+ // User assigned permissions.
});
@@ -24128,14 +27176,14 @@ Example
- linkUsers(userId, params, cbopt) → {Promise|undefined}
+ removeRolesFromUser(params, data, cbopt) → {Promise|undefined}
- Link the user with another account.
+ Remove roles from a user
@@ -24171,7 +27219,7 @@ linkUsersSource:
Parameters:
- userIdparams
-String
+Object
@@ -24242,7 +27290,58 @@ Parameters:
- ID of the primary user.
+ params object
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ user_id
+
+
+
+
+
+
+
+
@@ -24251,13 +27350,13 @@ Parameters:
- paramsdata
-Object
+String
@@ -24276,7 +27375,7 @@ Parameters:
- Secondary user data.
+ data object containing list of role IDs
@@ -24302,33 +27401,7 @@ Parameters:
- user_id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- ID of the user to be linked.
-
-
-
-
-
-
-
-
- connection_idroles
@@ -24345,7 +27418,7 @@ Parameters:
- ID of the connection to be used.
+ Array of role IDs
@@ -24440,18 +27513,15 @@ Returns:
Example
- var userId = 'USER_ID';
-var params = {
- user_id: 'OTHER_USER_ID',
- connection_id: 'CONNECTION_ID'
-};
+ var parms = { id : 'USER_ID'};
+var data = { "roles" :["role1"]};
-management.linkUsers(userId, params, function (err, user) {
+management.removeRolesFromUser(params, data, function (err) {
if (err) {
// Handle error.
}
- // Users linked.
+ // User assigned roles.
});
@@ -24463,14 +27533,14 @@ Example
- regenerateRecoveryCode(data, cbopt) → {Promise|undefined}
+ sendEmailVerification(data, cbopt) → {Promise|undefined}
- Generate new Guardian recovery code.
+ Send a verification email to a user.
@@ -24506,7 +27576,7 @@ Source:
Parameters:
- The user data object.
+ User data object.
@@ -24603,7 +27673,7 @@ Parameters:
- iduser_id
@@ -24620,7 +27690,7 @@ Parameters:
- The user id.
+ ID of the user to be verified.
@@ -24715,8 +27785,14 @@ Returns:
Example
- management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
- console.log(newRecoveryCode);
+ var params = {
+ user_id: '{USER_ID}'
+};
+
+management.sendEmailVerification(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
});
@@ -24728,14 +27804,14 @@ Example
- removeHookSecrets(params, data, cbopt) → {Promise|undefined}
+ setRulesConfig(params, data, cbopt) → {Promise|undefined}
- Delete an existing hook.
+ Set a new rules config.
@@ -24771,7 +27847,7 @@ remo
Source:
Parameters:
- Hook parameters.
+ Rule Config parameters.
@@ -24868,7 +27944,7 @@ Parameters:
- idkey
@@ -24885,7 +27961,7 @@ Parameters:
- Hook ID.
+ Rule Config key.
@@ -24927,7 +28003,58 @@ Parameters:
- Secrets key/value pairs
+ Rule Config Data parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ value
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule Config Data value.
+
+
+
+
+
+
+
+
@@ -25014,14 +28141,15 @@ Returns:
Example
- var params = { id: HOOK_ID }
-var data = ['API_TOKEN', 'DB_PASSWORD']
-auth0.removeHookSecrets(params, data, function (err) {
+ var params = { key: RULE_CONFIG_KEY };
+var data = { value: RULES_CONFIG_VALUE };
+
+management.setRulesConfig(params, data, function (err, rulesConfig) {
if (err) {
// Handle error.
}
- // Hook deleted.
+ // Rules Config set.
});
@@ -25033,14 +28161,14 @@ Example
- removePermissionsFromRole(data, cbopt) → {Promise|undefined}
+ unblockUser(params, cbopt) → {Promise|undefined}
- Remove permissions from a role
+ Unblock an user by its id.
@@ -25076,7 +28204,7 @@ Source:
Parameters:
- params.idparams
-String
+Object
@@ -25147,7 +28275,58 @@ Parameters:
- ID of the Role.
+ The user data object..
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
@@ -25156,13 +28335,13 @@ Parameters:
- datacb
-Object
+function
@@ -25171,6 +28350,8 @@ Parameters:
+ <optional>
+
@@ -25181,9 +28362,138 @@ Parameters:
- permissions data
+ Callback function
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.unblockUser({ id: USER_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // User unblocked.
+});
+
+
+
+
+
+
+
+
+
+
+ unblockUser(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Unblock an user by its id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
@@ -25195,6 +28505,8 @@ Parameters:
Type
+ Attributes
+
@@ -25207,24 +28519,32 @@ Parameters:
- permissionsparams
-String
+Object
+
+
+
+
+
+
+
+
- Array of permissions
+ The user data object..
@@ -25250,33 +28570,7 @@ Parameters:
- permission_name
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Name of a permission
-
-
-
-
-
-
-
-
- resource_server_identifieridentifier
@@ -25293,15 +28587,7 @@ Parameters:
- Identifier for a resource
-
-
-
-
-
-
-
-
+ The user identifier, any of: username, phone_number, email.
@@ -25345,7 +28631,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -25396,11 +28682,12 @@ Returns:
Example
- var params = { id :'ROLE_ID'};
-var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
-management.removePermissionsFromRole(params, data, function (err, permissions) {
- console.log(permissions);
+ // User unblocked.
});
@@ -25412,14 +28699,14 @@ Example
- removePermissionsFromUser(params, data, cbopt) → {Promise|undefined}
+ unlinkUsers(params, cbopt) → {Promise|undefined}
- Remove permissions from a user
+ Unlink the given accounts.
@@ -25455,7 +28742,7 @@ Source:
Parameters:
- params object
+ Linked users data.
@@ -25569,15 +28856,7 @@ Parameters:
- user_id
-
-
-
-
-
-
-
-
+ Primary user ID.
@@ -25586,7 +28865,7 @@ Parameters:
- dataprovider
@@ -25599,45 +28878,20 @@ Parameters:
-
-
-
-
-
-
-
-
- data object containing list of permission IDs
+ Identity provider in use.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- permissionsuser_id
@@ -25654,7 +28908,7 @@ Parameters:
- Array of permission IDs
+ Secondary user ID.
@@ -25749,15 +29003,14 @@ Returns:
Example
- var parms = { id : 'USER_ID'};
-var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
+ var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
-management.removePermissionsFromUser(params, data, function (err) {
+management.unlinkUsers(params, function (err, user) {
if (err) {
// Handle error.
}
- // User assigned permissions.
+ // Users accounts unlinked.
});
@@ -25769,14 +29022,14 @@ Example
- removeRolesFromUser(params, data, cbopt) → {Promise|undefined}
+ updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
- Remove roles from a user
+ Update the app metadata for a user.
@@ -25812,7 +29065,7 @@ re
Source:
Parameters:
- params object
+ The user data object..
@@ -25926,7 +29179,7 @@ Parameters:
- user_id
+ The user id.
@@ -25943,13 +29196,13 @@ Parameters:
- datametadata
-String
+Object
@@ -25968,58 +29221,7 @@ Parameters:
- data object containing list of role IDs
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- roles
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Array of role IDs
-
-
-
-
-
-
-
-
+ New app metadata.
@@ -26055,7 +29257,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -26106,15 +29308,18 @@ Returns:
Example
- var parms = { id : 'USER_ID'};
-var data = { "roles" :["role1"]};
+ var params = { id: USER_ID };
+var metadata = {
+ foo: 'bar'
+};
-management.removeRolesFromUser(params, data, function (err) {
+management.updateAppMetadata(params, metadata, function (err, user) {
if (err) {
// Handle error.
}
- // User assigned roles.
+ // Updated user.
+ console.log(user);
});
@@ -26126,14 +29331,14 @@ Example
- sendEmailVerification(data, cbopt) → {Promise|undefined}
+ updateBrandingSettings(params, data, cbopt) → {Promise|undefined}
- Send a verification email to a user.
+ Update the branding settings.
@@ -26169,7 +29374,7 @@
Source:
Parameters:
- dataparams
@@ -26240,58 +29445,41 @@ Parameters:
- User data object.
+ Branding parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- user_iddata
-String
+Object
+
+
-
+
-
- ID of the user to be verified.
-
-
+
+
-
-
-
+
+
+ Updated branding data.
@@ -26378,14 +29566,13 @@ Returns:
Example
- var params = {
- user_id: '{USER_ID}'
-};
-
-management.sendEmailVerification(params, function (err) {
+ management.updateBrandingSettings(data, function (err, branding) {
if (err) {
// Handle error.
}
+
+// Updated branding
+ console.log(branding);
});
@@ -26397,14 +29584,14 @@ Example
- setRulesConfig(params, data, cbopt) → {Promise|undefined}
+ updateClient(params, data, cbopt) → {Promise|undefined}
- Set a new rules config.
+ Update an Auth0 client.
@@ -26440,7 +29627,7 @@ setRule
Source:
Parameters:
- Rule Config parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- key
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Rule Config key.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Rule Config Data parameters.
+ Client parameters.
@@ -26622,7 +29724,7 @@ Parameters:
- valueclient_id
@@ -26639,7 +29741,7 @@ Parameters:
- Rule Config Data value.
+ Application client ID.
@@ -26654,6 +29756,40 @@ Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated client data.
+
+
+
+
+
+
cbReturns:
Example
- var params = { key: RULE_CONFIG_KEY };
-var data = { value: RULES_CONFIG_VALUE };
+ var data = { name: 'newClientName' };
+var params = { client_id: CLIENT_ID };
-management.setRulesConfig(params, data, function (err, rulesConfig) {
+management.updateClient(params, data, function (err, client) {
if (err) {
// Handle error.
}
- // Rules Config set.
+ console.log(client.name); // 'newClientName'
});
@@ -26754,14 +29890,14 @@ Example
- unblockUser(params, cbopt) → {Promise|undefined}
+ updateClientGrant(params, data, cbopt) → {Promise|undefined}
- Unblock an user by its id.
+ Update an Auth0 client grant.
@@ -26797,7 +29933,7 @@ unblockUse
Source:
Parameters:
- The user data object..
+ Client parameters.
@@ -26911,7 +30047,7 @@ Parameters:
- The user id.
+ Client grant ID.
@@ -26926,6 +30062,40 @@ Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated client data.
+
+
+
+
+
+
cbParameters:
- Callback function
+ Callback function.
@@ -27006,12 +30176,19 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ var data = {
+ client_id: CLIENT_ID,
+ audience: AUDIENCE,
+ scope: []
+};
+var params = { id: CLIENT_GRANT_ID };
+
+management.clientGrants.update(params, data, function (err, grant) {
if (err) {
// Handle error.
}
- // User unblocked.
+ console.log(grant.id);
});
@@ -27023,14 +30200,14 @@ Example
- unblockUser(params, cbopt) → {Promise|undefined}
+ updateConnection(params, data, cbopt) → {Promise|undefined}
- Unblock an user by its id.
+ Update an existing connection.
@@ -27066,7 +30243,7 @@ unblockUse
Source:
Parameters:
- The user data object..
+ Connection parameters.
@@ -27163,7 +30340,7 @@ Parameters:
- identifierid
@@ -27180,7 +30357,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ Connection ID.
@@ -27195,6 +30372,40 @@ Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated connection data.
+
+
+
+
+
+
cbParameters:
- Callback function
+ Callback function.
@@ -27275,12 +30486,15 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ var data = { name: 'newConnectionName' };
+var params = { id: CONNECTION_ID };
+
+management.updateConnection(params, data, function (err, connection) {
if (err) {
// Handle error.
}
- // User unblocked.
+ console.log(connection.name); // 'newConnectionName'
});
@@ -27292,14 +30506,14 @@ Example
- unlinkUsers(params, cbopt) → {Promise|undefined}
+ updateEmailProvider(params, data, cbopt) → {Promise|undefined}
- Unlink the given accounts.
+ Update the email provider.
@@ -27335,7 +30549,7 @@ unlinkUser
Source:
Parameters:
- Linked users data.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Primary user ID.
+ Email provider parameters.
@@ -27458,58 +30629,32 @@ Parameters:
- providerdata
-String
+Object
-
-
-
-
- Identity provider in use.
+
-
-
-
-
-
-
-
- user_id
-
-String
-
-
-
-
+
+
- Secondary user ID.
-
-
-
-
-
-
-
-
+ Updated email provider data.
@@ -27596,14 +30741,13 @@ Returns:
Example
- var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
-
-management.unlinkUsers(params, function (err, user) {
+ management.updateEmailProvider(params, data, function (err, provider) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // Updated email provider.
+ console.log(provider);
});
@@ -27615,14 +30759,14 @@ Example
- updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
- Update the app metadata for a user.
+ Update an existing Email Template.
@@ -27658,7 +30802,7 @@ upda
Source:
Parameters:
- The user data object..
+ Email Template parameters.
@@ -27755,7 +30899,7 @@ Parameters:
- idname
@@ -27772,7 +30916,7 @@ Parameters:
- The user id.
+ Template Name
@@ -27789,7 +30933,7 @@ Parameters:
- metadatadata
@@ -27814,7 +30958,7 @@ Parameters:
- New app metadata.
+ Updated Email Template data.
@@ -27850,7 +30994,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -27901,18 +31045,15 @@ Returns:
Example
- var params = { id: USER_ID };
-var metadata = {
- foo: 'bar'
-};
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
-management.updateAppMetadata(params, metadata, function (err, user) {
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+ console.log(emailTemplate.from); // 'new@email.com'
});
@@ -27924,14 +31065,14 @@ Example
- updateBrandingSettings(params, data, cbopt) → {Promise|undefined}
+ updateFactorProvider(params, data, cbopt) → {Promise|undefined}
- Update the branding settings.
+ Update Guardian's factor provider
@@ -27967,7 +31108,7 @@ Source:
Parameters:
- Branding parameters.
+ Factor provider parameters.
@@ -28072,7 +31213,7 @@ Parameters:
- Updated branding data.
+ Updated Factor provider data.
@@ -28159,13 +31300,12 @@ Returns:
Example
- management.updateBrandingSettings(data, function (err, branding) {
- if (err) {
- // Handle error.
- }
-
-// Updated branding
- console.log(branding);
+ management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ messaging_service_sid: 'XXXXXXXXXXXXXX',
+ auth_token: 'XXXXXXXXXXXXXX',
+ sid: 'XXXXXXXXXXXXXX'
+}, function (err, provider) {
+ console.log(provider);
});
@@ -28177,14 +31317,14 @@ Example
- updateClient(params, data, cbopt) → {Promise|undefined}
+ updateGuardianFactor(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client.
+ Update Guardian Factor
@@ -28220,7 +31360,7 @@ updateCli
Source:
Parameters:
- Client parameters.
+ Factor parameters.
-
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated factor data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.updateGuardianFactor({ name: 'sms' }, {
+ enabled: true
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updateGuardianFactorTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian enrollment and verification factor templates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
@@ -28305,6 +31642,8 @@ Parameters:
Type
+ Attributes
+
@@ -28317,32 +31656,32 @@ Parameters:
- client_idparams
-String
+Object
+
+
-
+
-
- Application client ID.
-
-
+
+
-
-
-
+
+
+ Factor parameters.
@@ -28376,7 +31715,7 @@ Parameters:
- Updated client data.
+ Updated factor templates data.
@@ -28463,15 +31802,11 @@ Returns:
Example
- var data = { name: 'newClientName' };
-var params = { client_id: CLIENT_ID };
-
-management.updateClient(params, data, function (err, client) {
- if (err) {
- // Handle error.
- }
-
- console.log(client.name); // 'newClientName'
+ management.updateGuardianFactorTemplates({ name: 'sms' }, {
+ enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+}, function (err, templates) {
+ console.log(templates);
});
@@ -28483,14 +31818,14 @@ Example
- updateClientGrant(params, data, cbopt) → {Promise|undefined}
+ updateGuardianPhoneFactorMessageTypes(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client grant.
+ Update the Guardian phone factor's message types
@@ -28526,7 +31861,7 @@ upda
Source:
Parameters:
- Client parameters.
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
@@ -28623,13 +31992,13 @@ Parameters:
- idmessage_types
-String
+Array.<String>
@@ -28640,7 +32009,7 @@ Parameters:
- Client grant ID.
+ Message types (only "sms" and "voice" are supported).
@@ -28655,40 +32024,6 @@ Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Updated client data.
-
-
-
-
-
-
cbReturns:
Example
- var data = {
- client_id: CLIENT_ID,
- audience: AUDIENCE,
- scope: []
-};
-var params = { id: CLIENT_GRANT_ID };
-
-management.clientGrants.update(params, data, function (err, grant) {
- if (err) {
- // Handle error.
- }
-
- console.log(grant.id);
+ management.updateGuardianPhoneFactorMessageTypes({}, {
+ message_types: ['sms', 'voice']
+}, function (err, factor) {
+ console.log(factor);
});
@@ -28793,14 +32119,14 @@ Example
- updateConnection(params, data, cbopt) → {Promise|undefined}
+ updateGuardianPhoneFactorSelectedProvider(params, data, cbopt) → {Promise|undefined}
- Update an existing connection.
+ Update the Guardian phone factor's selected provider
@@ -28836,7 +32162,7 @@ updat
Source:
Parameters:
- Connection parameters.
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
@@ -28933,7 +32293,7 @@ Parameters:
- idprovider
@@ -28950,7 +32310,7 @@ Parameters:
- Connection ID.
+ Name of the selected provider
@@ -28965,40 +32325,6 @@ Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Updated connection data.
-
-
-
-
-
-
cbReturns:
Example
- var data = { name: 'newConnectionName' };
-var params = { id: CONNECTION_ID };
-
-management.updateConnection(params, data, function (err, connection) {
- if (err) {
- // Handle error.
- }
-
- console.log(connection.name); // 'newConnectionName'
+ management.updateGuardianPhoneFactorSelectedProvider({}, {
+ provider: 'twilio'
+}, function (err, factor) {
+ console.log(factor);
});
@@ -29099,14 +32420,14 @@ Example
- updateEmailProvider(params, data, cbopt) → {Promise|undefined}
+ updateGuardianPolicies(params, data, cbopt) → {Promise|undefined}
- Update the email provider.
+ Update enabled Guardian policies
@@ -29142,7 +32463,7 @@ up
Source:
Parameters:
- Email provider parameters.
+ Parameters.
@@ -29228,7 +32549,7 @@ Parameters:
-Object
+Array.<String>
@@ -29247,7 +32568,7 @@ Parameters:
- Updated email provider data.
+ Policies to enable. Empty array disables all policies.
@@ -29334,13 +32655,10 @@ Returns:
Example
- management.updateEmailProvider(params, data, function (err, provider) {
- if (err) {
- // Handle error.
- }
-
- // Updated email provider.
- console.log(provider);
+ management.updateGuardianPolicies({}, [
+ 'all-applications'
+], function (err, policies) {
+ console.log(policies);
});
@@ -29352,14 +32670,14 @@ Example
- updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+ updateHook(params, data, cbopt) → {Promise|undefined}
- Update an existing Email Template.
+ Update an existing hook.
@@ -29395,7 +32713,7 @@ u
Source:
Parameters:
- Email Template parameters.
+ Hook parameters.
@@ -29492,7 +32810,7 @@ Parameters:
- nameid
@@ -29509,7 +32827,7 @@ Parameters:
- Template Name
+ Hook ID.
@@ -29551,7 +32869,7 @@ Parameters:
- Updated Email Template data.
+ Updated hook data.
@@ -29638,15 +32956,14 @@ Returns:
Example
- var data = { from: 'new@email.com' };
-var params = { name: EMAIL_TEMPLATE_NAME };
-
-management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ var params = { id: HOOK_ID };
+var data = { name: 'my-hook'};
+management.updateHook(params, data, function (err, hook) {
if (err) {
// Handle error.
}
- console.log(emailTemplate.from); // 'new@email.com'
+ console.log(hook.name); // 'my-hook'.
});
@@ -29658,7 +32975,7 @@ Example
- updateHook(params, data, cbopt) → {Promise|undefined}
+ updateHookSecrets(params, data, cbopt) → {Promise|undefined}
@@ -29701,7 +33018,7 @@ updateHook<
Source:
Parameters:
- Updated hook data.
+ Secrets key/value pairs
@@ -29945,13 +33262,13 @@ Returns:
Example
var params = { id: HOOK_ID };
-var data = { name: 'my-hook'};
-management.updateHook(params, data, function (err, hook) {
+var data = { API_TOKEN: 'updated-secret'};
+management.updateHookSecrets(params, data, function (err, secrets) {
if (err) {
// Handle error.
}
- console.log(hook.name); // 'my-hook'.
+ console.log(secrets)
});
@@ -29963,14 +33280,14 @@ Example
- updateHookSecrets(params, data, cbopt) → {Promise|undefined}
+ updateMigrations(data, cbopt) → {Promise|undefined}
- Update an existing hook.
+ Update the tenant migrations.
@@ -30006,7 +33323,7 @@ upda
Source:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Hook parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Hook ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
dataParameters:
- Secrets key/value pairs
+ Updated migrations data.
@@ -30249,14 +33481,14 @@ Returns:
Example
- var params = { id: HOOK_ID };
-var data = { API_TOKEN: 'updated-secret'};
-management.updateHookSecrets(params, data, function (err, secrets) {
+ data = { flags: { migration: true } };
+management.updateMigrations(data, function (err, migrations) {
if (err) {
// Handle error.
}
- console.log(secrets)
+// Updated migrations flags
+ console.log(migrations.flags);
});
@@ -30311,7 +33543,7 @@ u
Source:
updateRole<
Source:
updateRule<
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 76a32b605..f8ce1198e 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.MigrationsManager.html b/docs/module-management.MigrationsManager.html
new file mode 100644
index 000000000..97c347c60
--- /dev/null
+++ b/docs/module-management.MigrationsManager.html
@@ -0,0 +1,894 @@
+
+
+
+
+
+ MigrationsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MigrationsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ MigrationsManager
+
+
+ Abstracts interaction with the migrations endpoint.
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new MigrationsManager(options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The client options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ baseUrl
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The URL of the API.
+
+
+
+
+
+
+
+
+ headers
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Headers to be included in all requests.
+
+
+
+
+
+
+
+
+ retry
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Retry Policy Config
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+
+(inner) auth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the migrations endpoint
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ getMigrations(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the tenant migrations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.migrations.getMigrations(function (err, migrations) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(migrations.flags);
+});
+
+
+
+
+
+
+
+
+
+
+ updateMigrations(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the tenant migrations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The tenant migrations to be updated
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ flags
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The tenant migrations flags to be updated
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.migrations.updateMigrations(data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index d450ac7fd..21d4124ea 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index fb5b1d27f..5a3fc2b55 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 961843c93..97ba3fa94 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index f6980c26f..4929adc05 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4293,7 +4293,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 838527adc..c27870d41 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 6dbd96b97..622494998 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 3555a998f..32b369ef9 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 2b6bee0fb..912072b15 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 7d1f5730b..82d4e1e47 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index 8543b95d7..87627110d 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 4f4e00d83..2c8b117f7 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index fb60127dd..6b0291d80 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -110,6 +110,9 @@ Classes
ManagementTokenProvider
+ MigrationsManager
+
+
PromptsManager
@@ -168,7 +171,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 12e5b188c..ee686ea37 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 8106671bc..d316de5ca 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -91,6 +91,9 @@ utils.js
*/
utils.wrapPropertyMethod = function(Parent, name, propertyMethod) {
var path = propertyMethod.split('.');
+ if (path.length > 2) {
+ throw new Error('wrapPropertyMethod() only supports one level of nesting for propertyMethod');
+ }
var property = path.shift();
var method = path.pop();
@@ -138,7 +141,7 @@ utils.js
diff --git a/package.json b/package.json
index c6cecbc29..8461fcac2 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.26.0",
+ "version": "2.27.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html index ebd9db73e..852d95b86 100644 --- a/docs/module-management.DeviceCredentialsManager.html +++ b/docs/module-management.DeviceCredentialsManager.html @@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html index 41f18b371..695997f42 100644 --- a/docs/module-management.EmailProviderManager.html +++ b/docs/module-management.EmailProviderManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html index 41f18b371..695997f42 100644 --- a/docs/module-management.EmailProviderManager.html +++ b/docs/module-management.EmailProviderManager.html @@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html index 27ad509a8..19caed12c 100644 --- a/docs/module-management.EmailTemplatesManager.html +++ b/docs/module-management.EmailTemplatesManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html index 27ad509a8..19caed12c 100644 --- a/docs/module-management.EmailTemplatesManager.html +++ b/docs/module-management.EmailTemplatesManager.html @@ -24,7 +24,7 @@
@@ -1304,7 +1304,7 @@
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html index fa71e19f3..a47960d4e 100644 --- a/docs/module-management.GrantsManager.html +++ b/docs/module-management.GrantsManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html index fa71e19f3..a47960d4e 100644 --- a/docs/module-management.GrantsManager.html +++ b/docs/module-management.GrantsManager.html @@ -24,7 +24,7 @@
@@ -842,7 +842,7 @@ deleteGran
+
+
+
+deleteGran
Source:
Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index f77df6f02..ec3e5a723 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -464,6 +464,154 @@ external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorsPhoneMessageTypesAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian phone factor message types.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorsPhoneSelectedProviderAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian phone factor selected provider.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
@@ -567,7 +715,7 @@
- Provides an abstraction layer for retrieving Guardian factors.
+ Provides an abstraction layer for retrieving Guardian factor templates.
@@ -612,6 +760,80 @@ external:RestClient
+
+
+
+
+
+
+
+
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
(inner) guardianFactorsPhoneMessageTypesAuth0RestClient :external:RestClient
+ + + + +
+
+
+
+
+
+
+Provides an abstraction layer for retrieving Guardian phone factor message types.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Type:
+-
+
-
+
+
external:RestClient+ + +
+
(inner) guardianFactorsPhoneSelectedProviderAuth0RestClient :external:RestClient
+ + + + +
+
+
+
+
+
+
+Provides an abstraction layer for retrieving Guardian phone factor selected provider.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + +
- Provides an abstraction layer for retrieving Guardian factors.
+ Provides an abstraction layer for retrieving Guardian factor templates.
external:RestClient
+
+
+
+
+
+
+
+
+
+
+Source:
(inner) guardianPoliciesAuth0RestClient :external:RestClient
+ + + + +
+
+
+
+
+
+
+Provides an abstraction layer for retrieving Guardian policies.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + +
Source:
Source:
Example
- getGuardianEnrollment(data, cbopt) → {Promise|undefined}
+ getFactorProvider(params, cbopt) → {Promise|undefined}
- Get a single Guardian enrollment.
+ Get Guardian factor provider configuration
@@ -1206,7 +1428,7 @@
Source:
Parameters:
- dataparams
@@ -1277,50 +1499,43 @@ Parameters:
- The user data object.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- The user id.
+ Callback function.
@@ -1329,7 +1544,2515 @@ Parameters:
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
+
+
+
+
+
+
+ getFactors(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a list of factors and statuses.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getFactors(function (err, factors) {
+ console.log(factors.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getFactorTemplates(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get Guardian enrollment and verification factor templates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor parameters.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getFactorTemplates({ name: 'sms' }, function (err, templates) {
+ console.log(templates);
+});
+
+
+
+
+
+
+
+
+
+
+ getGuardianEnrollment(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a single Guardian enrollment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The user data object.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ console.log(enrollment);
+});
+
+
+
+
+
+
+
+
+
+
+ getPhoneFactorMessageTypes(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the Guardian phone factor's message types
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getPhoneFactorMessageTypes(function (err, messageTypes) {
+ console.log(messageTypes);
+});
+
+
+
+
+
+
+
+
+
+
+ getPhoneFactorSelectedProvider(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the Guardian phone factor's selected provider
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getPhoneFactorSelectedProvider(function (err, selectedProvider) {
+ console.log(selectedProvider);
+});
+
+
+
+
+
+
+
+
+
+
+ getPolicies(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get enabled Guardian policies
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getPolicies(function (err, policies) {
+ console.log(policies);
+});
+
+
+
+
+
+
+
+
+
+
+ updateFactor(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian Factor
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated factor data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updateFactor({ name: 'sms' }, {
+ enabled: true
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updateFactorProvider(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian's factor provider
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor provider parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Factor provider data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updateFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ messaging_service_sid: 'XXXXXXXXXXXXXX',
+ auth_token: 'XXXXXXXXXXXXXX',
+ sid: 'XXXXXXXXXXXXXX'
+}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
+
+
+
+
+
+
+ updateFactorTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian enrollment and verification factor templates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated factor templates data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updateFactorProvider({ name: 'sms' }, {
+ enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+}, function (err, templates) {
+ console.log(templates);
+});
+
+
+
+
+
+
+
+
+
+
+ updatePhoneFactorMessageTypes(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the Guardian phone factor's message types
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ message_types
+
+
+Array.<String>
+
+
+
+
+
+
+
+
+
+
+ Message types (only "sms" and "voice" are supported).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updatePhoneFactorMessageTypes({}, {
+ message_types: ['sms', 'voice']
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updatePhoneFactorSelectedProvider(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the Guardian phone factor's selected provider
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Name of the selected provider
+
+
+
+
+
+
+
+
+
@@ -1415,8 +4138,260 @@ Returns:
Example
- management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
- console.log(enrollment);
+ management.guardian.updatePhoneFactorSelectedProvider({}, {
+ provider: 'twilio'
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updatePolicies(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update enabled Guardian policies
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Array.<String>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Policies to enable. Empty array disables all policies.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updatePolicies({}, [
+ 'all-applications'
+], function (err, policies) {
+ console.log(policies);
});
@@ -1440,7 +4415,7 @@ Example
diff --git a/docs/module-management.HooksManager.html b/docs/module-management.HooksManager.html
index 9facca9da..dcf47a8d6 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 b489005bd..debe93a8b 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -2676,7 +2676,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index ee8687280..084e7a64d 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 700e3ee3e..7767f2f9c 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -106,7 +106,7 @@ new M
Source:
blac
Source:
brandingSource:
clientGra
Source:
clientsSource:
connection
Source:
customDo
Source:
devi
Source:
emailPro
Source:
emailTe
Source:
grantsSource:
guardianSource:
hooksSource:
jobsSource:
logsSource:
Type:
+
+
+
+
+
+migrations :MigrationsManager
+
+
+
+
+
+ ManagementClient migrations manager.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
MigrationsManager
+
+
+
+
+
+
+
+
+
@@ -1811,7 +1885,7 @@ resour
Source:
rolesSource:
rulesSource:
rulesConf
Source:
statsSource:
tenantSource:
ticketsSource:
userBlocks<
Source:
usersSource:
addHookS
Source:
a
Source:
Source:
assi
Source:
blackli
Source:
Source:
createCli
Source:
crea
Source:
creat
Source:
cre
Source:
Source:
cr
Source:
Source:
Source:
createHook<
Source:
Source:
c
Source:
createRole<
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
+
+
+
+
+
+
+ getGuardianFactors(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a list of Guardian factors and statuses.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
cbReturns:
Example
- management.getHook({ id: HOOK_ID }, function (err, hook) {
- if (err) {
- // Handle error.
- }
-
- console.log(hook);
+ management.getGuardianFactors(function (err, factors) {
+ console.log(factors.length);
});
@@ -16825,14 +17024,14 @@ Example
- getHooks(paramsopt, cbopt) → {Promise|undefined}
+ getGuardianFactorTemplates(params, cbopt) → {Promise|undefined}
- Get all hooks.
+ Get Guardian enrollment and verification factor templates
@@ -16868,7 +17067,7 @@ getHooksSource:
Parameters:
- <optional>
-
@@ -16941,41 +17138,22 @@ Parameters:
- Hooks parameters.
+ Factor parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+
+
-
- per_pagecb
-Number
+function
@@ -16996,57 +17174,157 @@ Parameters:
- Number of results per page.
+ Callback function.
+
+
-
-
- page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
+ console.log(templates);
+});
+
+
+
+
+
+
-
- Page number, zero indexed.
-
-
-
+
+
+ getGuardianPhoneFactorMessageTypes(cbopt) → {Promise|undefined}
-
-
-
-
-
+
+
+
+ Get the Guardian phone factor's message types
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
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.getGuardianPhoneFactorMessageTypes(function (err, messageTypes) {
+ console.log(messageTypes);
});
@@ -17152,14 +17418,14 @@ Example
- getHookSecrets(params, cbopt) → {Promise|undefined}
+ getGuardianPhoneFactorSelectedProvider(cbopt) → {Promise|undefined}
- Get an Auth0 hook's secrets.
+ Get the Guardian phone factor's selected provider
@@ -17195,7 +17461,7 @@ getHook
Source:
Parameters:
- paramscb
-Object
+function
@@ -17256,6 +17522,8 @@ Parameters:
+ <optional>
+
@@ -17266,64 +17534,157 @@ Parameters:
- Hook parameters.
+ Callback function.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
- Name
-
- Type
+
+
+
+Returns:
+
+ -
+ Type:
+
+ -
+
Promise
+|
+
+undefined
+
+
+
+
- Description
-
-
-
+
-
-
- id
-
-
-String
+
+Example
-
-
+ management.getGuardianPhoneFactorSelectedProvider(function (err, selectedProvider) {
+ console.log(selectedProvider);
+});
-
+
+
+
+
-
- Hook ID.
-
-
-
+
+
+ getGuardianPolicies(cbopt) → {Promise|undefined}
-
-
-
-
-
+
+
+
+ Get enabled Guardian policies
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
cbReturns:
Example
- var params = { id: HOOK_ID }
-management.getHookSecrets(params, function (err, secrets) {
- if (err) {
- // Handle error.
- }
-
- console.log(secrets);
+ management.getGuardianPolicies(function (err, policies) {
+ console.log(policies);
});
@@ -17422,14 +17778,14 @@ Example
- getJob(params, cbopt) → {Promise|undefined}
+ getHook(params, cbopt) → {Promise|undefined}
- Get a job by its ID.
+ Get an Auth0 hook.
@@ -17465,7 +17821,7 @@ getJobSource:
Parameters:
- Job parameters.
+ Hook parameters.
@@ -17579,7 +17935,7 @@ Parameters:
- Job ID.
+ Hook ID.
@@ -17674,17 +18030,12 @@ Returns:
Example
- var params = {
- id: '{JOB_ID}'
-};
-
-management.getJob(params, function (err, job) {
+ management.getHook({ id: HOOK_ID }, function (err, hook) {
if (err) {
// Handle error.
}
- // Retrieved job.
- console.log(job);
+ console.log(hook);
});
@@ -17696,14 +18047,14 @@ Example
- getLog(params, cbopt) → {Promise|undefined}
+ getHooks(paramsopt, cbopt) → {Promise|undefined}
- Get an Auth0 log.
+ Get all hooks.
@@ -17739,7 +18090,7 @@ getLogSource:
Parameters:
+ <optional>
+
@@ -17810,7 +18163,7 @@ Parameters:
- Log parameters.
+ Hooks parameters.
@@ -17824,6 +18177,8 @@ Parameters:
Type
+ Attributes
+
@@ -17836,24 +18191,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- Event ID.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -17948,12 +18349,20 @@ Returns:
Example
- management.getLog({ id: EVENT_ID }, function (err, log) {
- 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(log);
+management.getHooks(params, function (err, hooks) {
+ console.log(hooks.length);
});
@@ -17965,14 +18374,14 @@ Example
- getLogs(paramsopt, cbopt) → {Promise|undefined}
+ getHookSecrets(params, cbopt) → {Promise|undefined}
- Get all logs.
+ Get an Auth0 hook's secrets.
@@ -18008,7 +18417,7 @@ getLogsSource:
Parameters:
- <optional>
-
@@ -18081,7 +18488,7 @@ Parameters:
- Logs params.
+ Hook parameters.
@@ -18095,8 +18502,6 @@ Parameters:
Type
- Attributes
-
@@ -18109,7 +18514,7 @@ Parameters:
- qid
@@ -18122,21 +18527,19 @@ Parameters:
-
-
- <optional>
-
-
+
+
+ Hook ID.
-
-
+
+
-
+
+
+
-
- Search Criteria using Query String Syntax
@@ -18145,13 +18548,13 @@ Parameters:
- pagecb
-Number
+function
@@ -18172,130 +18575,171 @@ Parameters:
- Page number. Zero based
+ Callback function.
+
+
-
-
- per_page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- The amount of entries per page
-
-
-
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
-
-
- sort
-
-
-String
+
+Example
-
-
+ var params = { id: HOOK_ID }
+management.getHookSecrets(params, function (err, secrets) {
+ if (err) {
+ // Handle error.
+ }
-
-
-
- <optional>
-
+ console.log(secrets);
+});
-
+
-
-
+
+
+
-
+
-
- The field to use for sorting.
-
-
-
+ getJob(params, cbopt) → {Promise|undefined}
-
-
- fields
-
-
-String
+
+ Get a job by its ID.
+
-
-
-
-
-
- <optional>
-
-
-
-
-
-
+
-
- A comma separated list of fields to include or exclude
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
- include_fieldsparams
-Boolean
+Object
@@ -18304,8 +18748,6 @@ Parameters:
- <optional>
-
@@ -18316,43 +18758,50 @@ Parameters:
- true if the fields specified are to be included in the result, false otherwise.
+ Job parameters.
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+ Description
+
+
+
+
- include_totalsid
-Boolean
+String
-
-
- <optional>
-
-
-
-
-
-
-
- true if a query summary must be included in the result, false otherwise. Default false
+ Job ID.
@@ -18447,20 +18896,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);
});
@@ -18472,14 +18918,14 @@ Example
- getPermissionsInRole(roleIdopt, cbopt) → {Promise|undefined}
+ getLog(params, cbopt) → {Promise|undefined}
- Get permissions for a given role
+ Get an Auth0 log.
@@ -18515,7 +18961,7 @@ g
Source:
Parameters:
- roleIdparams
-String
+Object
@@ -18576,8 +19022,6 @@ Parameters:
- <optional>
-
@@ -18588,7 +19032,58 @@ Parameters:
- Id of the role
+ Log parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Event ID.
+
+
+
+
+
+
+
+
@@ -18673,18 +19168,14 @@ Returns:
-Examples
-
- var params = { id :'ROLE_ID'};
+Example
-
- This method takes a roleId and
- returns all permissions within that role
+
management.getLog({ id: EVENT_ID }, function (err, log) {
+ if (err) {
+ // Handle error.
+ }
-
-
- management.getPermissionsInRole(params, function (err, permissions) {
- console.log(permissions);
+ console.log(log);
});
@@ -18696,14 +19187,14 @@ Examples
- getResourceServer(params, cbopt) → {Promise|undefined}
+ getLogs(paramsopt, cbopt) → {Promise|undefined}
- Get a Resource Server.
+ Get all logs.
@@ -18739,7 +19230,7 @@ getR
Source:
Parameters:
+ <optional>
+
@@ -18810,7 +19303,7 @@ Parameters:
- Resource Server parameters.
+ Logs params.
@@ -18824,6 +19317,8 @@ Parameters:
Type
+ Attributes
+
@@ -18836,7 +19331,7 @@ Parameters:
- idq
@@ -18849,11 +19344,237 @@ Parameters:
+
+
+ <optional>
+
+
+
+
+
+
+
- Resource Server ID.
+ 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.
+
+
+
+
+
+
+
+
+ fields
+
+
+String
+
+
+
+
+
+
+
+
+ <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
@@ -18948,12 +19669,205 @@ Returns:
Example
- management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+
+ 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
+};
+
+management.getLogs(params, function (err, logs) {
+ console.log(logs.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getMigrations(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get migrations flags
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getMigrations(function (err, migrations) {
if (err) {
// Handle error.
}
- console.log(resourceServer);
+// Migration flags
+ console.log(migrations.flags);
});
@@ -18965,14 +19879,2210 @@ Example
- getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+ getPermissionsInRole(roleIdopt, cbopt) → {Promise|undefined}
- Get all resource servers.
+ Get permissions for a given role
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ roleId
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Id of the role
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Examples
+
+ var params = { id :'ROLE_ID'};
+
+
+ This method takes a roleId and
+ returns all permissions within that role
+
+
+
+ management.getPermissionsInRole(params, function (err, permissions) {
+ console.log(permissions);
+});
+
+
+
+
+
+
+
+
+
+
+ getResourceServer(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a Resource Server.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Resource Server parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Resource Server ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(resourceServer);
+});
+
+
+
+
+
+
+
+
+
+
+ getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all resource servers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Resource Servers parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.getResourceServers(params, function (err, resourceServers) {
+ console.log(resourceServers.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getRole(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get an Auth0 role.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Role parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Role ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getRole({ id: ROLE_ID }, function (err, role) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(role);
+});
+
+
+
+
+
+
+
+
+
+
+ getRoles(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all roles.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Roles parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.getRoles(params, function (err, roles) {
+ console.log(roles.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getRule(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get an Auth0 rule.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rule parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getRule({ id: RULE_ID }, function (err, rule) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(rule);
+});
+
+
+
+
+
+
+
+
+
+
+ getRules(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all rules.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Rules parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.getRules(params, function (err, rules) {
+ console.log(rules.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getRulesConfigs(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get rules config.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getRulesConfigs(function (err, rulesConfigs) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Get Rules Configs.
+});
+
+
+
+
+
+
+
+
+
+
+ getTenantSettings(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the tenant settings..
@@ -19008,7 +22118,7 @@ get
Source:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Resource Servers 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.getSettings(function (err, settings) {
+ if (err) {
+ // Handle error.
+ }
-management.getResourceServers(params, function (err, resourceServers) {
- console.log(resourceServers.length);
+ console.log(settings);
});
@@ -19292,14 +22259,14 @@ Example
- getRole(params, cbopt) → {Promise|undefined}
+ getUser(data, cbopt) → {Promise|undefined}
- Get an Auth0 role.
+ Get a user by its id.
@@ -19335,7 +22302,7 @@ getRoleSource:
Parameters:
- paramsdata
@@ -19406,7 +22373,7 @@ Parameters:
- Role parameters.
+ The user data object.
@@ -19449,7 +22416,7 @@ Parameters:
- Role ID.
+ The user id.
@@ -19544,12 +22511,8 @@ Returns:
Example
- management.getRole({ id: ROLE_ID }, function (err, role) {
- if (err) {
- // Handle error.
- }
-
- console.log(role);
+ management.getUser({ id: USER_ID }, function (err, user) {
+ console.log(user);
});
@@ -19561,14 +22524,14 @@ Example
- getRoles(paramsopt, cbopt) → {Promise|undefined}
+ getUserBlocks(params, cbopt) → {Promise|undefined}
- Get all roles.
+ Get user blocks by its id.
@@ -19604,7 +22567,7 @@ getRolesSource:
Parameters:
- <optional>
-
@@ -19677,7 +22638,7 @@ Parameters:
- Roles parameters.
+ The user data object..
@@ -19691,8 +22652,6 @@ Parameters:
Type
- Attributes
-
@@ -19705,70 +22664,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ The user id.
@@ -19812,7 +22725,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -19863,20 +22776,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.getUserBlocks({ id: USER_ID }, function (err, blocks) {
+ if (err) {
+ // Handle error.
+ }
-management.getRoles(params, function (err, roles) {
- console.log(roles.length);
+ console.log(blocks);
});
@@ -19888,14 +22793,14 @@ Example
- getRule(params, cbopt) → {Promise|undefined}
+ getUserBlocksByIdentifier(params, cbopt) → {Promise|undefined}
- Get an Auth0 rule.
+ Get user blocks by its identifier.
@@ -19931,7 +22836,7 @@ getRuleSource:
Parameters:
- Rule parameters.
+ The user data object..
@@ -20028,7 +22933,7 @@ Parameters:
- ididentifier
@@ -20045,7 +22950,7 @@ Parameters:
- Rule ID.
+ The user identifier, any of: username, phone_number, email.
@@ -20089,7 +22994,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -20140,12 +23045,12 @@ Returns:
Example
- management.getRule({ id: RULE_ID }, function (err, rule) {
+ management.getUserBlocksByIdentifier({ identifier: USER_ID }, function (err, blocks) {
if (err) {
// Handle error.
}
- console.log(rule);
+ console.log(blocks);
});
@@ -20157,14 +23062,14 @@ Example
- getRules(paramsopt, cbopt) → {Promise|undefined}
+ getUserLogs(params, cbopt) → {Promise|undefined}
- Get all rules.
+ Get user's log events.
@@ -20200,7 +23105,7 @@ getRulesSource:
Parameters:
- <optional>
-
@@ -20273,7 +23176,7 @@ Parameters:
- Rules parameters.
+ Get logs data.
@@ -20287,8 +23190,6 @@ Parameters:
Type
- Attributes
-
@@ -20301,28 +23202,44 @@ Parameters:
- per_pageid
-Number
+String
-
-
- <optional>
-
+
+
+
+ User id.
+
+
+
+
+
+
+ per_page
+
-
+Number
+
+
+
+
+
@@ -20350,21 +23267,63 @@ Parameters:
-
+
+
+
+
+ Page number, zero indexed.
- <optional>
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
- Page number, zero indexed.
+ true if a query summary must be included in the result, false otherwise. Default false;
@@ -20459,20 +23418,14 @@ 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
-};
+ var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-management.getRules(params, function (err, rules) {
- console.log(rules.length);
+management.getUserLogs(params, function (err, logs) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logs);
});
@@ -20484,14 +23437,14 @@ Example
- getRulesConfigs(cbopt) → {Promise|undefined}
+ getUserPermissions(params, cbopt) → {Promise|undefined}
- Get rules config.
+ Get user's permissions
@@ -20527,7 +23480,7 @@ getRul
Source:
Parameters:
- cbparams
-function
+Object
@@ -20588,8 +23541,6 @@ Parameters:
- <optional>
-
@@ -20600,159 +23551,166 @@ Parameters:
- Callback function.
+ Get permissions data.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
+
+
+
+
-
-
- -
- Type:
-
- -
+
Name
-Promise
-|
-undefined
+ Type
+
-
-
+
+ Description
+
+
+
-
-
+
+
+ idExample
-
- management.getRulesConfigs(function (err, rulesConfigs) {
- if (err) {
- // Handle error.
- }
+
+
+
+String
- // Get Rules Configs.
-});
-
+
+
-
-
-
-
+
- getTenantSettings(cbopt) → {Promise|undefined}
+
+ User id.
+
+
+
+
+
+ per_pageGet the tenant settings..
-
+
+
+
+Number
+
+
+
+
-
+
+ Number of results per page.
+
+
+
-
+
+
+ page
+
+
+Number
-
-
+
+
-
+
-
+
-
+
+ Page number, zero indexed.
+
+
+
-
+
+
+ sort
+
+
+String
-
-
- Source:
-
-
+
-
+
-
-
+
+ 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;
+
+
+
- Parameters:
+
+
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+
+
+
-
@@ -20835,12 +23793,14 @@ Returns:
Example
- management.getSettings(function (err, settings) {
+ 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(settings);
+ console.log(logs);
});
@@ -20852,14 +23812,14 @@ Example
- getUser(data, cbopt) → {Promise|undefined}
+ getUserRoles(params, cbopt) → {Promise|undefined}
- Get a user by its id.
+ Get user's roles
@@ -20895,7 +23855,7 @@ getUserSource:
Parameters:
- dataparams
@@ -20966,7 +23926,7 @@ Parameters:
- The user data object.
+ Get roles data.
@@ -21009,7 +23969,111 @@ Parameters:
- The user id.
+ 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;
@@ -21104,8 +24168,14 @@ Returns:
Example
- management.getUser({ id: USER_ID }, function (err, user) {
- console.log(user);
+ 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);
});
@@ -21117,14 +24187,14 @@ Example
- getUserBlocks(params, cbopt) → {Promise|undefined}
+ getUsers(paramsopt, cbopt) → {Promise|undefined}
- Get user blocks by its id.
+ Get all users.
@@ -21160,7 +24230,7 @@ getUserB
Source:
Parameters:
+ <optional>
+
@@ -21231,7 +24303,7 @@ Parameters:
- The user data object..
+ Users params.
@@ -21245,6 +24317,8 @@ Parameters:
Type
+ Attributes
+
@@ -21257,7 +24331,43 @@ Parameters:
- idsearch_engine
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The version of the search engine to use.
+
+
+
+
+
+
+
+
+ q
@@ -21270,11 +24380,93 @@ Parameters:
+
+
+ <optional>
+
+
+
+
+
+
+
- The user id.
+ User Search string to filter which users are returned. Follows Lucene query string syntax as documented at https://auth0.com/docs/api/management/v2#!/Users/get_users.
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -21318,7 +24510,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -21369,12 +24561,22 @@ 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 = {
+ search_engine: 'v3',
+ q: 'name:*jane*',
+ per_page: 10,
+ page: 0
+};
- console.log(blocks);
+auth0.getUsers(params, function (err, users) {
+ console.log(users.length);
});
@@ -21386,14 +24588,14 @@ Example
- getUserBlocksByIdentifier(params, cbopt) → {Promise|undefined}
+ getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
- Get user blocks by its identifier.
+ Get users for a given email address
@@ -21429,7 +24631,7 @@ Source:
Parameters:
- paramsemail
-Object
+String
@@ -21490,68 +24692,19 @@ Parameters:
-
-
-
+ <optional>
-
-
-
-
-
- The user data object..
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- identifier
-
-String
-
-
-
-
-
+
- The user identifier, any of: username, phone_number, email.
-
-
-
-
-
-
-
-
+ Email Address of users to locate
@@ -21587,7 +24740,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -21638,12 +24791,13 @@ Returns:
Example
- management.getUserBlocksByIdentifier({ identifier: USER_ID }, function (err, blocks) {
- if (err) {
- // Handle error.
- }
-
- console.log(blocks);
+
+ This method takes an email address as the first argument,
+ and returns all users with that email address
+
+
+ auth0.getUsersByEmail(email, function (err, users) {
+ console.log(users);
});
@@ -21655,14 +24809,14 @@ Example
- getUserLogs(params, cbopt) → {Promise|undefined}
+ getUsersInRole(idopt, cbopt) → {Promise|undefined}
- Get user's log events.
+ Get users in a given role
@@ -21698,7 +24852,7 @@ getUserLog
Source:
Parameters:
- paramsid
-Object
+String
@@ -21759,6 +24913,8 @@ Parameters:
+ <optional>
+
@@ -21769,70 +24925,37 @@ Parameters:
- Get logs data.
+ Id of the role
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idparams.per_page
-String
+Number
-
-
-
-
- User id.
+
-
-
-
-
-
-
-
- per_page
-
+ <optional>
-Number
-
-
-
+
+
+
@@ -21847,7 +24970,7 @@ Parameters:
- pageparams.page
@@ -21860,71 +24983,21 @@ Parameters:
-
-
-
-
- Page number, zero indexed.
+
-
-
-
-
-
-
-
- sort
-
+ <optional>
-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;
-
-
-
-
-
-
-
-
+ Page number, zero indexed.
@@ -22009,16 +25082,20 @@ Returns:
-Example
-
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+Examples
-management.getUserLogs(params, function (err, logs) {
- if (err) {
- // Handle error.
- }
+ var params = {
+ id: 'ROLE_ID'
+ per_page: 50,
+ page: 0
+};
- console.log(logs);
+
+ This method takes a roleId and returns all users within that role
+
+
+ management.getUsersInRole(params, function (err, users) {
+ console.log(users);
});
@@ -22030,14 +25107,16 @@ Example
- getUserPermissions(params, cbopt) → {Promise|undefined}
+ importUsers(data, cbopt) → {Promise|undefined}
- Get user's permissions
+ Given a path to a file and a connection id, create a new job that imports the
+users contained in the file or JSON string and associate them with the given
+connection.
@@ -22073,7 +25152,7 @@ get
Source:
Parameters:
- paramsdata
@@ -22144,7 +25223,7 @@ Parameters:
- Get permissions data.
+ Users import data.
@@ -22158,6 +25237,8 @@ Parameters:
Type
+ Attributes
+
@@ -22170,7 +25251,7 @@ Parameters:
- idconnection_id
@@ -22183,11 +25264,19 @@ Parameters:
+
+
+
+
+
+
+
+
- User id.
+ connection_id of the connection to which users will be imported.
@@ -22196,24 +25285,34 @@ Parameters:
- per_pageusers
-Number
+String
+
+
+ <optional>
+
+
+
+
+
+
+
- Number of results per page.
+ Path to the users data file. Either users or users_json is mandatory.
@@ -22222,24 +25321,34 @@ Parameters:
- pageusers_json
-Number
+String
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ JSON data for the users.
@@ -22248,24 +25357,34 @@ Parameters:
- sortupsert
-String
+Boolean
+
+
+ <optional>
+
+
+
+
+
+
+
- The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+ Whether to update users if they already exist (true) or to ignore them (false).
@@ -22274,7 +25393,7 @@ Parameters:
- include_totalssend_completion_email
@@ -22287,11 +25406,21 @@ Parameters:
+
+
+ <optional>
+
+
+
+
+
+
+
- true if a query summary must be included in the result, false otherwise. Default false;
+ Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
@@ -22386,14 +25515,15 @@ Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+ var params = {
+ connection_id: '{CONNECTION_ID}',
+ users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}'
+};
-management.getUserPermissions(params, function (err, logs) {
+management.importUsers(params, function (err) {
if (err) {
// Handle error.
}
-
- console.log(logs);
});
@@ -22405,14 +25535,14 @@ Example
- getUserRoles(params, cbopt) → {Promise|undefined}
+ linkUsers(userId, params, cbopt) → {Promise|undefined}
- Get user's roles
+ Link the user with another account.
@@ -22448,7 +25578,7 @@ getUserRo
Source:
Parameters:
- paramsuserId
-Object
+String
@@ -22519,111 +25649,67 @@ Parameters:
- Get roles data.
+ ID of the primary user.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idparams
-String
+Object
-
-
-
-
- User id.
+
-
-
-
-
-
-
- per_page
-
-Number
-
-
-
-
+
+
- Number of results per page.
-
-
-
-
-
-
-
-
- page
-
+ Secondary user data.
-Number
+
+
+
+
+
+ Name
+
-
-
+ Type
-
+
-
+
-
- Page number, zero indexed.
-
-
-
+ Description
+
+
+
- sortuser_id
@@ -22640,7 +25726,7 @@ Parameters:
- The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+ ID of the user to be linked.
@@ -22649,13 +25735,13 @@ Parameters:
- include_totalsconnection_id
-Boolean
+String
@@ -22666,7 +25752,7 @@ Parameters:
- true if a query summary must be included in the result, false otherwise. Default false;
+ ID of the connection to be used.
@@ -22761,14 +25847,18 @@ Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+ var userId = 'USER_ID';
+var params = {
+ user_id: 'OTHER_USER_ID',
+ connection_id: 'CONNECTION_ID'
+};
-management.getUserRoles(params, function (err, logs) {
+management.linkUsers(userId, params, function (err, user) {
if (err) {
// Handle error.
}
- console.log(logs);
+ // Users linked.
});
@@ -22780,14 +25870,14 @@ Example
- getUsers(paramsopt, cbopt) → {Promise|undefined}
+ regenerateRecoveryCode(data, cbopt) → {Promise|undefined}
- Get all users.
+ Generate new Guardian recovery code.
@@ -22823,7 +25913,7 @@ getUsersSource:
Parameters:
- paramsdata
@@ -22884,8 +25974,6 @@ Parameters:
- <optional>
-
@@ -22896,7 +25984,7 @@ Parameters:
- Users params.
+ The user data object.
@@ -22910,8 +25998,6 @@ Parameters:
Type
- Attributes
-
@@ -22924,43 +26010,7 @@ Parameters:
- search_engine
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The version of the search engine to use.
-
-
-
-
-
-
-
-
- qid
@@ -22973,93 +26023,11 @@ Parameters:
-
-
- <optional>
-
-
-
-
-
-
-
- User Search string to filter which users are returned. Follows Lucene query string syntax as documented at https://auth0.com/docs/api/management/v2#!/Users/get_users.
-
-
-
-
-
-
-
-
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Page number, zero indexed.
+ The user id.
@@ -23154,22 +26122,8 @@ 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 = {
- search_engine: 'v3',
- q: 'name:*jane*',
- per_page: 10,
- page: 0
-};
-
-auth0.getUsers(params, function (err, users) {
- console.log(users.length);
+ management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
+ console.log(newRecoveryCode);
});
@@ -23181,14 +26135,14 @@ Example
- getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+ removeHookSecrets(params, data, cbopt) → {Promise|undefined}
- Get users for a given email address
+ Delete an existing hook.
@@ -23224,7 +26178,7 @@ getUse
Source:
Parameters:
- emailparams
-String
+Object
@@ -23285,7 +26239,90 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+
+ Hook parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Hook ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
@@ -23297,7 +26334,7 @@ Parameters:
- Email Address of users to locate
+ Secrets key/value pairs
@@ -23384,13 +26421,14 @@ Returns:
Example
-
- This method takes an email address as the first argument,
- and returns all users with that email address
-
-
- auth0.getUsersByEmail(email, function (err, users) {
- console.log(users);
+ var params = { id: HOOK_ID }
+var data = ['API_TOKEN', 'DB_PASSWORD']
+auth0.removeHookSecrets(params, data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Hook deleted.
});
@@ -23402,14 +26440,14 @@ Example
- getUsersInRole(idopt, cbopt) → {Promise|undefined}
+ removePermissionsFromRole(data, cbopt) → {Promise|undefined}
- Get users in a given role
+ Remove permissions from a role
@@ -23445,7 +26483,7 @@ getUser
Source:
Parameters:
- idparams.id
@@ -23506,8 +26544,6 @@ Parameters:
- <optional>
-
@@ -23518,7 +26554,7 @@ Parameters:
- Id of the role
+ ID of the Role.
@@ -23527,13 +26563,13 @@ Parameters:
- params.per_pagedata
-Number
+Object
@@ -23542,8 +26578,6 @@ Parameters:
- <optional>
-
@@ -23554,43 +26588,135 @@ Parameters:
- Number of results per page.
+ permissions data
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+ Description
+
+
+
+
- params.pagepermissions
-Number
+String
-
+
+
+
+
+ Array of permissions
- <optional>
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ permission_name
+
+String
+
+
+
+
+
+
+
+
+
+ Name of a permission
+
+
+
+
+
+
+ resource_server_identifier
+
-
+String
+
+
+
+
+
- Page number, zero indexed.
+ Identifier for a resource
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -23675,20 +26801,13 @@ Returns:
-Examples
+Example
- var params = {
- id: 'ROLE_ID'
- per_page: 50,
- page: 0
-};
+ var params = { id :'ROLE_ID'};
+var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
-
- This method takes a roleId and returns all users within that role
-
-
- management.getUsersInRole(params, function (err, users) {
- console.log(users);
+management.removePermissionsFromRole(params, data, function (err, permissions) {
+ console.log(permissions);
});
@@ -23700,16 +26819,14 @@ Examples
- importUsers(data, cbopt) → {Promise|undefined}
+ removePermissionsFromUser(params, data, cbopt) → {Promise|undefined}
- Given a path to a file and a connection id, create a new job that imports the
-users contained in the file or JSON string and associate them with the given
-connection.
+ Remove permissions from a user
@@ -23745,7 +26862,7 @@ importUser
Source:
Parameters:
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Users import data.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- connection_idparams
-String
+Object
@@ -23869,16 +26933,33 @@ Parameters:
- connection_id of the connection to which users will be imported.
+ params object
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+ Description
+
+
+
+
- usersid
@@ -23891,21 +26972,19 @@ Parameters:
-
-
- <optional>
-
-
+
+
+ user_id
-
-
+
+
-
+
+
+
-
- Path to the users data file. Either users or users_json is mandatory.
@@ -23914,7 +26993,7 @@ Parameters:
- users_jsondata
@@ -23929,8 +27008,6 @@ Parameters:
- <optional>
-
@@ -23941,79 +27018,50 @@ Parameters:
- JSON data for the users.
-
-
-
-
-
-
-
-
- upsert
-
+ data object containing list of permission IDs
-Boolean
-
-
-
-
+
-
-
-
- <optional>
-
+
+
+
+
+ Name
+
-
+ Type
-
-
-
+
-
+
-
- Whether to update users if they already exist (true) or to ignore them (false).
-
-
-
+ Description
+
+
+
- send_completion_emailpermissions
-Boolean
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
+ Array of permission IDs
@@ -24108,15 +27156,15 @@ Returns:
Example
- var params = {
- connection_id: '{CONNECTION_ID}',
- users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}'
-};
+ var parms = { id : 'USER_ID'};
+var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
-management.importUsers(params, function (err) {
+management.removePermissionsFromUser(params, data, function (err) {
if (err) {
// Handle error.
}
+
+ // User assigned permissions.
});
@@ -24128,14 +27176,14 @@ Example
- linkUsers(userId, params, cbopt) → {Promise|undefined}
+ removeRolesFromUser(params, data, cbopt) → {Promise|undefined}
- Link the user with another account.
+ Remove roles from a user
@@ -24171,7 +27219,7 @@ linkUsersSource:
Parameters:
- userIdparams
-String
+Object
@@ -24242,7 +27290,58 @@ Parameters:
- ID of the primary user.
+ params object
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ user_id
+
+
+
+
+
+
+
+
@@ -24251,13 +27350,13 @@ Parameters:
- paramsdata
-Object
+String
@@ -24276,7 +27375,7 @@ Parameters:
- Secondary user data.
+ data object containing list of role IDs
@@ -24302,33 +27401,7 @@ Parameters:
- user_id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- ID of the user to be linked.
-
-
-
-
-
-
-
-
- connection_idroles
@@ -24345,7 +27418,7 @@ Parameters:
- ID of the connection to be used.
+ Array of role IDs
@@ -24440,18 +27513,15 @@ Returns:
Example
- var userId = 'USER_ID';
-var params = {
- user_id: 'OTHER_USER_ID',
- connection_id: 'CONNECTION_ID'
-};
+ var parms = { id : 'USER_ID'};
+var data = { "roles" :["role1"]};
-management.linkUsers(userId, params, function (err, user) {
+management.removeRolesFromUser(params, data, function (err) {
if (err) {
// Handle error.
}
- // Users linked.
+ // User assigned roles.
});
@@ -24463,14 +27533,14 @@ Example
- regenerateRecoveryCode(data, cbopt) → {Promise|undefined}
+ sendEmailVerification(data, cbopt) → {Promise|undefined}
- Generate new Guardian recovery code.
+ Send a verification email to a user.
@@ -24506,7 +27576,7 @@ Source:
Parameters:
- The user data object.
+ User data object.
@@ -24603,7 +27673,7 @@ Parameters:
- iduser_id
@@ -24620,7 +27690,7 @@ Parameters:
- The user id.
+ ID of the user to be verified.
@@ -24715,8 +27785,14 @@ Returns:
Example
- management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
- console.log(newRecoveryCode);
+ var params = {
+ user_id: '{USER_ID}'
+};
+
+management.sendEmailVerification(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
});
@@ -24728,14 +27804,14 @@ Example
- removeHookSecrets(params, data, cbopt) → {Promise|undefined}
+ setRulesConfig(params, data, cbopt) → {Promise|undefined}
- Delete an existing hook.
+ Set a new rules config.
@@ -24771,7 +27847,7 @@ remo
Source:
Parameters:
- Hook parameters.
+ Rule Config parameters.
@@ -24868,7 +27944,7 @@ Parameters:
- idkey
@@ -24885,7 +27961,7 @@ Parameters:
- Hook ID.
+ Rule Config key.
@@ -24927,7 +28003,58 @@ Parameters:
- Secrets key/value pairs
+ Rule Config Data parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ value
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule Config Data value.
+
+
+
+
+
+
+
+
@@ -25014,14 +28141,15 @@ Returns:
Example
- var params = { id: HOOK_ID }
-var data = ['API_TOKEN', 'DB_PASSWORD']
-auth0.removeHookSecrets(params, data, function (err) {
+ var params = { key: RULE_CONFIG_KEY };
+var data = { value: RULES_CONFIG_VALUE };
+
+management.setRulesConfig(params, data, function (err, rulesConfig) {
if (err) {
// Handle error.
}
- // Hook deleted.
+ // Rules Config set.
});
@@ -25033,14 +28161,14 @@ Example
- removePermissionsFromRole(data, cbopt) → {Promise|undefined}
+ unblockUser(params, cbopt) → {Promise|undefined}
- Remove permissions from a role
+ Unblock an user by its id.
@@ -25076,7 +28204,7 @@ Source:
Parameters:
- params.idparams
-String
+Object
@@ -25147,7 +28275,58 @@ Parameters:
- ID of the Role.
+ The user data object..
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
@@ -25156,13 +28335,13 @@ Parameters:
- datacb
-Object
+function
@@ -25171,6 +28350,8 @@ Parameters:
+ <optional>
+
@@ -25181,9 +28362,138 @@ Parameters:
- permissions data
+ Callback function
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.unblockUser({ id: USER_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // User unblocked.
+});
+
+
+
+
+
+
+
+
+
+
+ unblockUser(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Unblock an user by its id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
@@ -25195,6 +28505,8 @@ Parameters:
Type
+ Attributes
+
@@ -25207,24 +28519,32 @@ Parameters:
- permissionsparams
-String
+Object
+
+
+
+
+
+
+
+
- Array of permissions
+ The user data object..
@@ -25250,33 +28570,7 @@ Parameters:
- permission_name
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Name of a permission
-
-
-
-
-
-
-
-
- resource_server_identifieridentifier
@@ -25293,15 +28587,7 @@ Parameters:
- Identifier for a resource
-
-
-
-
-
-
-
-
+ The user identifier, any of: username, phone_number, email.
@@ -25345,7 +28631,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -25396,11 +28682,12 @@ Returns:
Example
- var params = { id :'ROLE_ID'};
-var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
-management.removePermissionsFromRole(params, data, function (err, permissions) {
- console.log(permissions);
+ // User unblocked.
});
@@ -25412,14 +28699,14 @@ Example
- removePermissionsFromUser(params, data, cbopt) → {Promise|undefined}
+ unlinkUsers(params, cbopt) → {Promise|undefined}
- Remove permissions from a user
+ Unlink the given accounts.
@@ -25455,7 +28742,7 @@ Source:
Parameters:
- params object
+ Linked users data.
@@ -25569,15 +28856,7 @@ Parameters:
- user_id
-
-
-
-
-
-
-
-
+ Primary user ID.
@@ -25586,7 +28865,7 @@ Parameters:
- dataprovider
@@ -25599,45 +28878,20 @@ Parameters:
-
-
-
-
-
-
-
-
- data object containing list of permission IDs
+ Identity provider in use.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- permissionsuser_id
@@ -25654,7 +28908,7 @@ Parameters:
- Array of permission IDs
+ Secondary user ID.
@@ -25749,15 +29003,14 @@ Returns:
Example
- var parms = { id : 'USER_ID'};
-var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
+ var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
-management.removePermissionsFromUser(params, data, function (err) {
+management.unlinkUsers(params, function (err, user) {
if (err) {
// Handle error.
}
- // User assigned permissions.
+ // Users accounts unlinked.
});
@@ -25769,14 +29022,14 @@ Example
- removeRolesFromUser(params, data, cbopt) → {Promise|undefined}
+ updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
- Remove roles from a user
+ Update the app metadata for a user.
@@ -25812,7 +29065,7 @@ re
Source:
Parameters:
- params object
+ The user data object..
@@ -25926,7 +29179,7 @@ Parameters:
- user_id
+ The user id.
@@ -25943,13 +29196,13 @@ Parameters:
- datametadata
-String
+Object
@@ -25968,58 +29221,7 @@ Parameters:
- data object containing list of role IDs
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- roles
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Array of role IDs
-
-
-
-
-
-
-
-
+ New app metadata.
@@ -26055,7 +29257,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -26106,15 +29308,18 @@ Returns:
Example
- var parms = { id : 'USER_ID'};
-var data = { "roles" :["role1"]};
+ var params = { id: USER_ID };
+var metadata = {
+ foo: 'bar'
+};
-management.removeRolesFromUser(params, data, function (err) {
+management.updateAppMetadata(params, metadata, function (err, user) {
if (err) {
// Handle error.
}
- // User assigned roles.
+ // Updated user.
+ console.log(user);
});
@@ -26126,14 +29331,14 @@ Example
- sendEmailVerification(data, cbopt) → {Promise|undefined}
+ updateBrandingSettings(params, data, cbopt) → {Promise|undefined}
- Send a verification email to a user.
+ Update the branding settings.
@@ -26169,7 +29374,7 @@
Source:
Parameters:
- dataparams
@@ -26240,58 +29445,41 @@ Parameters:
- User data object.
+ Branding parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- user_iddata
-String
+Object
+
+
-
+
-
- ID of the user to be verified.
-
-
+
+
-
-
-
+
+
+ Updated branding data.
@@ -26378,14 +29566,13 @@ Returns:
Example
- var params = {
- user_id: '{USER_ID}'
-};
-
-management.sendEmailVerification(params, function (err) {
+ management.updateBrandingSettings(data, function (err, branding) {
if (err) {
// Handle error.
}
+
+// Updated branding
+ console.log(branding);
});
@@ -26397,14 +29584,14 @@ Example
- setRulesConfig(params, data, cbopt) → {Promise|undefined}
+ updateClient(params, data, cbopt) → {Promise|undefined}
- Set a new rules config.
+ Update an Auth0 client.
@@ -26440,7 +29627,7 @@ setRule
Source:
Parameters:
- Rule Config parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- key
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Rule Config key.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Rule Config Data parameters.
+ Client parameters.
@@ -26622,7 +29724,7 @@ Parameters:
- valueclient_id
@@ -26639,7 +29741,7 @@ Parameters:
- Rule Config Data value.
+ Application client ID.
@@ -26654,6 +29756,40 @@ Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated client data.
+
+
+
+
+
+
cbReturns:
Example
- var params = { key: RULE_CONFIG_KEY };
-var data = { value: RULES_CONFIG_VALUE };
+ var data = { name: 'newClientName' };
+var params = { client_id: CLIENT_ID };
-management.setRulesConfig(params, data, function (err, rulesConfig) {
+management.updateClient(params, data, function (err, client) {
if (err) {
// Handle error.
}
- // Rules Config set.
+ console.log(client.name); // 'newClientName'
});
@@ -26754,14 +29890,14 @@ Example
- unblockUser(params, cbopt) → {Promise|undefined}
+ updateClientGrant(params, data, cbopt) → {Promise|undefined}
- Unblock an user by its id.
+ Update an Auth0 client grant.
@@ -26797,7 +29933,7 @@ unblockUse
Source:
Parameters:
- The user data object..
+ Client parameters.
@@ -26911,7 +30047,7 @@ Parameters:
- The user id.
+ Client grant ID.
@@ -26926,6 +30062,40 @@ Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated client data.
+
+
+
+
+
+
cbParameters:
- Callback function
+ Callback function.
@@ -27006,12 +30176,19 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ var data = {
+ client_id: CLIENT_ID,
+ audience: AUDIENCE,
+ scope: []
+};
+var params = { id: CLIENT_GRANT_ID };
+
+management.clientGrants.update(params, data, function (err, grant) {
if (err) {
// Handle error.
}
- // User unblocked.
+ console.log(grant.id);
});
@@ -27023,14 +30200,14 @@ Example
- unblockUser(params, cbopt) → {Promise|undefined}
+ updateConnection(params, data, cbopt) → {Promise|undefined}
- Unblock an user by its id.
+ Update an existing connection.
@@ -27066,7 +30243,7 @@ unblockUse
Source:
Parameters:
- The user data object..
+ Connection parameters.
@@ -27163,7 +30340,7 @@ Parameters:
- identifierid
@@ -27180,7 +30357,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ Connection ID.
@@ -27195,6 +30372,40 @@ Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated connection data.
+
+
+
+
+
+
cbParameters:
- Callback function
+ Callback function.
@@ -27275,12 +30486,15 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ var data = { name: 'newConnectionName' };
+var params = { id: CONNECTION_ID };
+
+management.updateConnection(params, data, function (err, connection) {
if (err) {
// Handle error.
}
- // User unblocked.
+ console.log(connection.name); // 'newConnectionName'
});
@@ -27292,14 +30506,14 @@ Example
- unlinkUsers(params, cbopt) → {Promise|undefined}
+ updateEmailProvider(params, data, cbopt) → {Promise|undefined}
- Unlink the given accounts.
+ Update the email provider.
@@ -27335,7 +30549,7 @@ unlinkUser
Source:
Parameters:
- Linked users data.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Primary user ID.
+ Email provider parameters.
@@ -27458,58 +30629,32 @@ Parameters:
- providerdata
-String
+Object
-
-
-
-
- Identity provider in use.
+
-
-
-
-
-
-
-
- user_id
-
-String
-
-
-
-
+
+
- Secondary user ID.
-
-
-
-
-
-
-
-
+ Updated email provider data.
@@ -27596,14 +30741,13 @@ Returns:
Example
- var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
-
-management.unlinkUsers(params, function (err, user) {
+ management.updateEmailProvider(params, data, function (err, provider) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // Updated email provider.
+ console.log(provider);
});
@@ -27615,14 +30759,14 @@ Example
- updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
- Update the app metadata for a user.
+ Update an existing Email Template.
@@ -27658,7 +30802,7 @@ upda
Source:
Parameters:
- The user data object..
+ Email Template parameters.
@@ -27755,7 +30899,7 @@ Parameters:
- idname
@@ -27772,7 +30916,7 @@ Parameters:
- The user id.
+ Template Name
@@ -27789,7 +30933,7 @@ Parameters:
- metadatadata
@@ -27814,7 +30958,7 @@ Parameters:
- New app metadata.
+ Updated Email Template data.
@@ -27850,7 +30994,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -27901,18 +31045,15 @@ Returns:
Example
- var params = { id: USER_ID };
-var metadata = {
- foo: 'bar'
-};
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
-management.updateAppMetadata(params, metadata, function (err, user) {
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+ console.log(emailTemplate.from); // 'new@email.com'
});
@@ -27924,14 +31065,14 @@ Example
- updateBrandingSettings(params, data, cbopt) → {Promise|undefined}
+ updateFactorProvider(params, data, cbopt) → {Promise|undefined}
- Update the branding settings.
+ Update Guardian's factor provider
@@ -27967,7 +31108,7 @@ Source:
Parameters:
- Branding parameters.
+ Factor provider parameters.
@@ -28072,7 +31213,7 @@ Parameters:
- Updated branding data.
+ Updated Factor provider data.
@@ -28159,13 +31300,12 @@ Returns:
Example
- management.updateBrandingSettings(data, function (err, branding) {
- if (err) {
- // Handle error.
- }
-
-// Updated branding
- console.log(branding);
+ management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ messaging_service_sid: 'XXXXXXXXXXXXXX',
+ auth_token: 'XXXXXXXXXXXXXX',
+ sid: 'XXXXXXXXXXXXXX'
+}, function (err, provider) {
+ console.log(provider);
});
@@ -28177,14 +31317,14 @@ Example
- updateClient(params, data, cbopt) → {Promise|undefined}
+ updateGuardianFactor(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client.
+ Update Guardian Factor
@@ -28220,7 +31360,7 @@ updateCli
Source:
Parameters:
- Client parameters.
+ Factor parameters.
-
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated factor data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.updateGuardianFactor({ name: 'sms' }, {
+ enabled: true
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updateGuardianFactorTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian enrollment and verification factor templates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
@@ -28305,6 +31642,8 @@ Parameters:
Type
+ Attributes
+
@@ -28317,32 +31656,32 @@ Parameters:
- client_idparams
-String
+Object
+
+
-
+
-
- Application client ID.
-
-
+
+
-
-
-
+
+
+ Factor parameters.
@@ -28376,7 +31715,7 @@ Parameters:
- Updated client data.
+ Updated factor templates data.
@@ -28463,15 +31802,11 @@ Returns:
Example
- var data = { name: 'newClientName' };
-var params = { client_id: CLIENT_ID };
-
-management.updateClient(params, data, function (err, client) {
- if (err) {
- // Handle error.
- }
-
- console.log(client.name); // 'newClientName'
+ management.updateGuardianFactorTemplates({ name: 'sms' }, {
+ enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+}, function (err, templates) {
+ console.log(templates);
});
@@ -28483,14 +31818,14 @@ Example
- updateClientGrant(params, data, cbopt) → {Promise|undefined}
+ updateGuardianPhoneFactorMessageTypes(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client grant.
+ Update the Guardian phone factor's message types
@@ -28526,7 +31861,7 @@ upda
Source:
Parameters:
- Client parameters.
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
@@ -28623,13 +31992,13 @@ Parameters:
- idmessage_types
-String
+Array.<String>
@@ -28640,7 +32009,7 @@ Parameters:
- Client grant ID.
+ Message types (only "sms" and "voice" are supported).
@@ -28655,40 +32024,6 @@ Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Updated client data.
-
-
-
-
-
-
cbReturns:
Example
- var data = {
- client_id: CLIENT_ID,
- audience: AUDIENCE,
- scope: []
-};
-var params = { id: CLIENT_GRANT_ID };
-
-management.clientGrants.update(params, data, function (err, grant) {
- if (err) {
- // Handle error.
- }
-
- console.log(grant.id);
+ management.updateGuardianPhoneFactorMessageTypes({}, {
+ message_types: ['sms', 'voice']
+}, function (err, factor) {
+ console.log(factor);
});
@@ -28793,14 +32119,14 @@ Example
- updateConnection(params, data, cbopt) → {Promise|undefined}
+ updateGuardianPhoneFactorSelectedProvider(params, data, cbopt) → {Promise|undefined}
- Update an existing connection.
+ Update the Guardian phone factor's selected provider
@@ -28836,7 +32162,7 @@ updat
Source:
Parameters:
- Connection parameters.
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
@@ -28933,7 +32293,7 @@ Parameters:
- idprovider
@@ -28950,7 +32310,7 @@ Parameters:
- Connection ID.
+ Name of the selected provider
@@ -28965,40 +32325,6 @@ Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Updated connection data.
-
-
-
-
-
-
cbReturns:
Example
- var data = { name: 'newConnectionName' };
-var params = { id: CONNECTION_ID };
-
-management.updateConnection(params, data, function (err, connection) {
- if (err) {
- // Handle error.
- }
-
- console.log(connection.name); // 'newConnectionName'
+ management.updateGuardianPhoneFactorSelectedProvider({}, {
+ provider: 'twilio'
+}, function (err, factor) {
+ console.log(factor);
});
@@ -29099,14 +32420,14 @@ Example
- updateEmailProvider(params, data, cbopt) → {Promise|undefined}
+ updateGuardianPolicies(params, data, cbopt) → {Promise|undefined}
- Update the email provider.
+ Update enabled Guardian policies
@@ -29142,7 +32463,7 @@ up
Source:
Parameters:
- Email provider parameters.
+ Parameters.
@@ -29228,7 +32549,7 @@ Parameters:
-Object
+Array.<String>
@@ -29247,7 +32568,7 @@ Parameters:
- Updated email provider data.
+ Policies to enable. Empty array disables all policies.
@@ -29334,13 +32655,10 @@ Returns:
Example
- management.updateEmailProvider(params, data, function (err, provider) {
- if (err) {
- // Handle error.
- }
-
- // Updated email provider.
- console.log(provider);
+ management.updateGuardianPolicies({}, [
+ 'all-applications'
+], function (err, policies) {
+ console.log(policies);
});
@@ -29352,14 +32670,14 @@ Example
- updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+ updateHook(params, data, cbopt) → {Promise|undefined}
- Update an existing Email Template.
+ Update an existing hook.
@@ -29395,7 +32713,7 @@ u
Source:
Parameters:
- Email Template parameters.
+ Hook parameters.
@@ -29492,7 +32810,7 @@ Parameters:
- nameid
@@ -29509,7 +32827,7 @@ Parameters:
- Template Name
+ Hook ID.
@@ -29551,7 +32869,7 @@ Parameters:
- Updated Email Template data.
+ Updated hook data.
@@ -29638,15 +32956,14 @@ Returns:
Example
- var data = { from: 'new@email.com' };
-var params = { name: EMAIL_TEMPLATE_NAME };
-
-management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ var params = { id: HOOK_ID };
+var data = { name: 'my-hook'};
+management.updateHook(params, data, function (err, hook) {
if (err) {
// Handle error.
}
- console.log(emailTemplate.from); // 'new@email.com'
+ console.log(hook.name); // 'my-hook'.
});
@@ -29658,7 +32975,7 @@ Example
- updateHook(params, data, cbopt) → {Promise|undefined}
+ updateHookSecrets(params, data, cbopt) → {Promise|undefined}
@@ -29701,7 +33018,7 @@ updateHook<
Source:
Parameters:
- Updated hook data.
+ Secrets key/value pairs
@@ -29945,13 +33262,13 @@ Returns:
Example
var params = { id: HOOK_ID };
-var data = { name: 'my-hook'};
-management.updateHook(params, data, function (err, hook) {
+var data = { API_TOKEN: 'updated-secret'};
+management.updateHookSecrets(params, data, function (err, secrets) {
if (err) {
// Handle error.
}
- console.log(hook.name); // 'my-hook'.
+ console.log(secrets)
});
@@ -29963,14 +33280,14 @@ Example
- updateHookSecrets(params, data, cbopt) → {Promise|undefined}
+ updateMigrations(data, cbopt) → {Promise|undefined}
- Update an existing hook.
+ Update the tenant migrations.
@@ -30006,7 +33323,7 @@ upda
Source:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Hook parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Hook ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
dataParameters:
- Secrets key/value pairs
+ Updated migrations data.
@@ -30249,14 +33481,14 @@ Returns:
Example
- var params = { id: HOOK_ID };
-var data = { API_TOKEN: 'updated-secret'};
-management.updateHookSecrets(params, data, function (err, secrets) {
+ data = { flags: { migration: true } };
+management.updateMigrations(data, function (err, migrations) {
if (err) {
// Handle error.
}
- console.log(secrets)
+// Updated migrations flags
+ console.log(migrations.flags);
});
@@ -30311,7 +33543,7 @@ u
Source:
updateRole<
Source:
updateRule<
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 76a32b605..f8ce1198e 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.MigrationsManager.html b/docs/module-management.MigrationsManager.html
new file mode 100644
index 000000000..97c347c60
--- /dev/null
+++ b/docs/module-management.MigrationsManager.html
@@ -0,0 +1,894 @@
+
+
+
+
+
+ MigrationsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MigrationsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ MigrationsManager
+
+
+ Abstracts interaction with the migrations endpoint.
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new MigrationsManager(options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The client options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ baseUrl
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The URL of the API.
+
+
+
+
+
+
+
+
+ headers
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Headers to be included in all requests.
+
+
+
+
+
+
+
+
+ retry
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Retry Policy Config
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+
+(inner) auth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the migrations endpoint
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ getMigrations(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the tenant migrations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.migrations.getMigrations(function (err, migrations) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(migrations.flags);
+});
+
+
+
+
+
+
+
+
+
+
+ updateMigrations(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the tenant migrations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The tenant migrations to be updated
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ flags
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The tenant migrations flags to be updated
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.migrations.updateMigrations(data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index d450ac7fd..21d4124ea 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index fb5b1d27f..5a3fc2b55 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 961843c93..97ba3fa94 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index f6980c26f..4929adc05 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4293,7 +4293,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 838527adc..c27870d41 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 6dbd96b97..622494998 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 3555a998f..32b369ef9 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 2b6bee0fb..912072b15 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 7d1f5730b..82d4e1e47 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index 8543b95d7..87627110d 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 4f4e00d83..2c8b117f7 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index fb60127dd..6b0291d80 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -110,6 +110,9 @@ Classes
ManagementTokenProvider
+ MigrationsManager
+
+
PromptsManager
@@ -168,7 +171,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 12e5b188c..ee686ea37 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 8106671bc..d316de5ca 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -91,6 +91,9 @@ utils.js
*/
utils.wrapPropertyMethod = function(Parent, name, propertyMethod) {
var path = propertyMethod.split('.');
+ if (path.length > 2) {
+ throw new Error('wrapPropertyMethod() only supports one level of nesting for propertyMethod');
+ }
var property = path.shift();
var method = path.pop();
@@ -138,7 +141,7 @@ utils.js
diff --git a/package.json b/package.json
index c6cecbc29..8461fcac2 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.26.0",
+ "version": "2.27.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
Example
-getGuardianEnrollment(data, cbopt) → {Promise|undefined}
+getFactorProvider(params, cbopt) → {Promise|undefined}
-
@@ -1206,7 +1428,7 @@ Get a single Guardian enrollment.
+Get Guardian factor provider configuration
Source:
Parameters:
- dataparams
@@ -1277,50 +1499,43 @@ Parameters:
- The user data object.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- The user id.
+ Callback function.
@@ -1329,7 +1544,2515 @@ Parameters:
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
+
+
+
+
+
+
+ getFactors(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a list of factors and statuses.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getFactors(function (err, factors) {
+ console.log(factors.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getFactorTemplates(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get Guardian enrollment and verification factor templates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor parameters.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getFactorTemplates({ name: 'sms' }, function (err, templates) {
+ console.log(templates);
+});
+
+
+
+
+
+
+
+
+
+
+ getGuardianEnrollment(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a single Guardian enrollment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The user data object.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ console.log(enrollment);
+});
+
+
+
+
+
+
+
+
+
+
+ getPhoneFactorMessageTypes(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the Guardian phone factor's message types
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getPhoneFactorMessageTypes(function (err, messageTypes) {
+ console.log(messageTypes);
+});
+
+
+
+
+
+
+
+
+
+
+ getPhoneFactorSelectedProvider(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the Guardian phone factor's selected provider
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getPhoneFactorSelectedProvider(function (err, selectedProvider) {
+ console.log(selectedProvider);
+});
+
+
+
+
+
+
+
+
+
+
+ getPolicies(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get enabled Guardian policies
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.getPolicies(function (err, policies) {
+ console.log(policies);
+});
+
+
+
+
+
+
+
+
+
+
+ updateFactor(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian Factor
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated factor data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updateFactor({ name: 'sms' }, {
+ enabled: true
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updateFactorProvider(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian's factor provider
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor provider parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated Factor provider data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updateFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ messaging_service_sid: 'XXXXXXXXXXXXXX',
+ auth_token: 'XXXXXXXXXXXXXX',
+ sid: 'XXXXXXXXXXXXXX'
+}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
+
+
+
+
+
+
+ updateFactorTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian enrollment and verification factor templates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Factor parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated factor templates data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updateFactorProvider({ name: 'sms' }, {
+ enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+}, function (err, templates) {
+ console.log(templates);
+});
+
+
+
+
+
+
+
+
+
+
+ updatePhoneFactorMessageTypes(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the Guardian phone factor's message types
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ message_types
+
+
+Array.<String>
+
+
+
+
+
+
+
+
+
+
+ Message types (only "sms" and "voice" are supported).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updatePhoneFactorMessageTypes({}, {
+ message_types: ['sms', 'voice']
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updatePhoneFactorSelectedProvider(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the Guardian phone factor's selected provider
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Name of the selected provider
+
+
+
+
+
+
+
+
+
@@ -1415,8 +4138,260 @@ Returns:
Example
- management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
- console.log(enrollment);
+ management.guardian.updatePhoneFactorSelectedProvider({}, {
+ provider: 'twilio'
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updatePolicies(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update enabled Guardian policies
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Array.<String>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Policies to enable. Empty array disables all policies.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.guardian.updatePolicies({}, [
+ 'all-applications'
+], function (err, policies) {
+ console.log(policies);
});
@@ -1440,7 +4415,7 @@ Example
diff --git a/docs/module-management.HooksManager.html b/docs/module-management.HooksManager.html
index 9facca9da..dcf47a8d6 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 b489005bd..debe93a8b 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -2676,7 +2676,7 @@ Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index ee8687280..084e7a64d 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 700e3ee3e..7767f2f9c 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -106,7 +106,7 @@ new M
Source:
blac
Source:
brandingSource:
clientGra
Source:
clientsSource:
connection
Source:
customDo
Source:
devi
Source:
emailPro
Source:
emailTe
Source:
grantsSource:
guardianSource:
hooksSource:
jobsSource:
logsSource:
Type:
+
+
+
+
+
+migrations :MigrationsManager
+
+
+
+
+
+ ManagementClient migrations manager.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
MigrationsManager
+
+
+
+
+
+
+
+
+
@@ -1811,7 +1885,7 @@ resour
Source:
rolesSource:
rulesSource:
rulesConf
Source:
statsSource:
tenantSource:
ticketsSource:
userBlocks<
Source:
usersSource:
addHookS
Source:
a
Source:
Source:
assi
Source:
blackli
Source:
Source:
createCli
Source:
crea
Source:
creat
Source:
cre
Source:
Source:
cr
Source:
Source:
Source:
createHook<
Source:
Source:
c
Source:
createRole<
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
+
+
+
+
+
+
+ getGuardianFactors(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a list of Guardian factors and statuses.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
cbReturns:
Example
- management.getHook({ id: HOOK_ID }, function (err, hook) {
- if (err) {
- // Handle error.
- }
-
- console.log(hook);
+ management.getGuardianFactors(function (err, factors) {
+ console.log(factors.length);
});
@@ -16825,14 +17024,14 @@ Example
- getHooks(paramsopt, cbopt) → {Promise|undefined}
+ getGuardianFactorTemplates(params, cbopt) → {Promise|undefined}
- Get all hooks.
+ Get Guardian enrollment and verification factor templates
@@ -16868,7 +17067,7 @@ getHooksSource:
Parameters:
- <optional>
-
@@ -16941,41 +17138,22 @@ Parameters:
- Hooks parameters.
+ Factor parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+
+
-
- per_pagecb
-Number
+function
@@ -16996,57 +17174,157 @@ Parameters:
- Number of results per page.
+ Callback function.
+
+
-
-
- page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
+ console.log(templates);
+});
+
+
+
+
+
+
-
- Page number, zero indexed.
-
-
-
+
+
+ getGuardianPhoneFactorMessageTypes(cbopt) → {Promise|undefined}
-
-
-
-
-
+
+
+
+ Get the Guardian phone factor's message types
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
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.getGuardianPhoneFactorMessageTypes(function (err, messageTypes) {
+ console.log(messageTypes);
});
@@ -17152,14 +17418,14 @@ Example
- getHookSecrets(params, cbopt) → {Promise|undefined}
+ getGuardianPhoneFactorSelectedProvider(cbopt) → {Promise|undefined}
- Get an Auth0 hook's secrets.
+ Get the Guardian phone factor's selected provider
@@ -17195,7 +17461,7 @@ getHook
Source:
Parameters:
- paramscb
-Object
+function
@@ -17256,6 +17522,8 @@ Parameters:
+ <optional>
+
@@ -17266,64 +17534,157 @@ Parameters:
- Hook parameters.
+ Callback function.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
- Name
-
- Type
+
+
+
+Returns:
+
+ -
+ Type:
+
+ -
+
Promise
+|
+
+undefined
+
+
+
+
- Description
-
-
-
+
-
-
- id
-
-
-String
+
+Example
-
-
+ management.getGuardianPhoneFactorSelectedProvider(function (err, selectedProvider) {
+ console.log(selectedProvider);
+});
-
+
+
+
+
-
- Hook ID.
-
-
-
+
+
+ getGuardianPolicies(cbopt) → {Promise|undefined}
-
-
-
-
-
+
+
+
+ Get enabled Guardian policies
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
cbReturns:
Example
- var params = { id: HOOK_ID }
-management.getHookSecrets(params, function (err, secrets) {
- if (err) {
- // Handle error.
- }
-
- console.log(secrets);
+ management.getGuardianPolicies(function (err, policies) {
+ console.log(policies);
});
@@ -17422,14 +17778,14 @@ Example
- getJob(params, cbopt) → {Promise|undefined}
+ getHook(params, cbopt) → {Promise|undefined}
- Get a job by its ID.
+ Get an Auth0 hook.
@@ -17465,7 +17821,7 @@ getJobSource:
Parameters:
- Job parameters.
+ Hook parameters.
@@ -17579,7 +17935,7 @@ Parameters:
- Job ID.
+ Hook ID.
@@ -17674,17 +18030,12 @@ Returns:
Example
- var params = {
- id: '{JOB_ID}'
-};
-
-management.getJob(params, function (err, job) {
+ management.getHook({ id: HOOK_ID }, function (err, hook) {
if (err) {
// Handle error.
}
- // Retrieved job.
- console.log(job);
+ console.log(hook);
});
@@ -17696,14 +18047,14 @@ Example
- getLog(params, cbopt) → {Promise|undefined}
+ getHooks(paramsopt, cbopt) → {Promise|undefined}
- Get an Auth0 log.
+ Get all hooks.
@@ -17739,7 +18090,7 @@ getLogSource:
Parameters:
+ <optional>
+
@@ -17810,7 +18163,7 @@ Parameters:
- Log parameters.
+ Hooks parameters.
@@ -17824,6 +18177,8 @@ Parameters:
Type
+ Attributes
+
@@ -17836,24 +18191,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- Event ID.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -17948,12 +18349,20 @@ Returns:
Example
- management.getLog({ id: EVENT_ID }, function (err, log) {
- 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(log);
+management.getHooks(params, function (err, hooks) {
+ console.log(hooks.length);
});
@@ -17965,14 +18374,14 @@ Example
- getLogs(paramsopt, cbopt) → {Promise|undefined}
+ getHookSecrets(params, cbopt) → {Promise|undefined}
- Get all logs.
+ Get an Auth0 hook's secrets.
@@ -18008,7 +18417,7 @@ getLogsSource:
Parameters:
- <optional>
-
@@ -18081,7 +18488,7 @@ Parameters:
- Logs params.
+ Hook parameters.
@@ -18095,8 +18502,6 @@ Parameters:
Type
- Attributes
-
@@ -18109,7 +18514,7 @@ Parameters:
- qid
@@ -18122,21 +18527,19 @@ Parameters:
-
-
- <optional>
-
-
+
+
+ Hook ID.
-
-
+
+
-
+
+
+
-
- Search Criteria using Query String Syntax
@@ -18145,13 +18548,13 @@ Parameters:
- pagecb
-Number
+function
@@ -18172,130 +18575,171 @@ Parameters:
- Page number. Zero based
+ Callback function.
+
+
-
-
- per_page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- The amount of entries per page
-
-
-
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
-
-
- sort
-
-
-String
+
+Example
-
-
+ var params = { id: HOOK_ID }
+management.getHookSecrets(params, function (err, secrets) {
+ if (err) {
+ // Handle error.
+ }
-
-
-
- <optional>
-
+ console.log(secrets);
+});
-
+
-
-
+
+
+
-
+
-
- The field to use for sorting.
-
-
-
+ getJob(params, cbopt) → {Promise|undefined}
-
-
- fields
-
-
-String
+
+ Get a job by its ID.
+
-
-
-
-
-
- <optional>
-
-
-
-
-
-
+
-
- A comma separated list of fields to include or exclude
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
- include_fieldsparams
-Boolean
+Object
@@ -18304,8 +18748,6 @@ Parameters:
- <optional>
-
@@ -18316,43 +18758,50 @@ Parameters:
- true if the fields specified are to be included in the result, false otherwise.
+ Job parameters.
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+ Description
+
+
+
+
- include_totalsid
-Boolean
+String
-
-
- <optional>
-
-
-
-
-
-
-
- true if a query summary must be included in the result, false otherwise. Default false
+ Job ID.
@@ -18447,20 +18896,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);
});
@@ -18472,14 +18918,14 @@ Example
- getPermissionsInRole(roleIdopt, cbopt) → {Promise|undefined}
+ getLog(params, cbopt) → {Promise|undefined}
- Get permissions for a given role
+ Get an Auth0 log.
@@ -18515,7 +18961,7 @@ g
Source:
Parameters:
- roleIdparams
-String
+Object
@@ -18576,8 +19022,6 @@ Parameters:
- <optional>
-
@@ -18588,7 +19032,58 @@ Parameters:
- Id of the role
+ Log parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Event ID.
+
+
+
+
+
+
+
+
@@ -18673,18 +19168,14 @@ Returns:
-Examples
-
- var params = { id :'ROLE_ID'};
+Example
-
- This method takes a roleId and
- returns all permissions within that role
+
management.getLog({ id: EVENT_ID }, function (err, log) {
+ if (err) {
+ // Handle error.
+ }
-
-
- management.getPermissionsInRole(params, function (err, permissions) {
- console.log(permissions);
+ console.log(log);
});
@@ -18696,14 +19187,14 @@ Examples
- getResourceServer(params, cbopt) → {Promise|undefined}
+ getLogs(paramsopt, cbopt) → {Promise|undefined}
- Get a Resource Server.
+ Get all logs.
@@ -18739,7 +19230,7 @@ getR
Source:
Parameters:
+ <optional>
+
@@ -18810,7 +19303,7 @@ Parameters:
- Resource Server parameters.
+ Logs params.
@@ -18824,6 +19317,8 @@ Parameters:
Type
+ Attributes
+
@@ -18836,7 +19331,7 @@ Parameters:
- idq
@@ -18849,11 +19344,237 @@ Parameters:
+
+
+ <optional>
+
+
+
+
+
+
+
- Resource Server ID.
+ 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.
+
+
+
+
+
+
+
+
+ fields
+
+
+String
+
+
+
+
+
+
+
+
+ <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
@@ -18948,12 +19669,205 @@ Returns:
Example
- management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+
+ 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
+};
+
+management.getLogs(params, function (err, logs) {
+ console.log(logs.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getMigrations(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get migrations flags
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getMigrations(function (err, migrations) {
if (err) {
// Handle error.
}
- console.log(resourceServer);
+// Migration flags
+ console.log(migrations.flags);
});
@@ -18965,14 +19879,2210 @@ Example
- getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+ getPermissionsInRole(roleIdopt, cbopt) → {Promise|undefined}
- Get all resource servers.
+ Get permissions for a given role
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ roleId
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Id of the role
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Examples
+
+ var params = { id :'ROLE_ID'};
+
+
+ This method takes a roleId and
+ returns all permissions within that role
+
+
+
+ management.getPermissionsInRole(params, function (err, permissions) {
+ console.log(permissions);
+});
+
+
+
+
+
+
+
+
+
+
+ getResourceServer(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a Resource Server.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Resource Server parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Resource Server ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(resourceServer);
+});
+
+
+
+
+
+
+
+
+
+
+ getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all resource servers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Resource Servers parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.getResourceServers(params, function (err, resourceServers) {
+ console.log(resourceServers.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getRole(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get an Auth0 role.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Role parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Role ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getRole({ id: ROLE_ID }, function (err, role) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(role);
+});
+
+
+
+
+
+
+
+
+
+
+ getRoles(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all roles.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Roles parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.getRoles(params, function (err, roles) {
+ console.log(roles.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getRule(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get an Auth0 rule.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rule parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getRule({ id: RULE_ID }, function (err, rule) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(rule);
+});
+
+
+
+
+
+
+
+
+
+
+ getRules(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all rules.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Rules parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+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.getRules(params, function (err, rules) {
+ console.log(rules.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getRulesConfigs(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get rules config.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getRulesConfigs(function (err, rulesConfigs) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Get Rules Configs.
+});
+
+
+
+
+
+
+
+
+
+
+ getTenantSettings(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the tenant settings..
@@ -19008,7 +22118,7 @@ get
Source:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Resource Servers 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.getSettings(function (err, settings) {
+ if (err) {
+ // Handle error.
+ }
-management.getResourceServers(params, function (err, resourceServers) {
- console.log(resourceServers.length);
+ console.log(settings);
});
@@ -19292,14 +22259,14 @@ Example
- getRole(params, cbopt) → {Promise|undefined}
+ getUser(data, cbopt) → {Promise|undefined}
- Get an Auth0 role.
+ Get a user by its id.
@@ -19335,7 +22302,7 @@ getRoleSource:
Parameters:
- paramsdata
@@ -19406,7 +22373,7 @@ Parameters:
- Role parameters.
+ The user data object.
@@ -19449,7 +22416,7 @@ Parameters:
- Role ID.
+ The user id.
@@ -19544,12 +22511,8 @@ Returns:
Example
- management.getRole({ id: ROLE_ID }, function (err, role) {
- if (err) {
- // Handle error.
- }
-
- console.log(role);
+ management.getUser({ id: USER_ID }, function (err, user) {
+ console.log(user);
});
@@ -19561,14 +22524,14 @@ Example
- getRoles(paramsopt, cbopt) → {Promise|undefined}
+ getUserBlocks(params, cbopt) → {Promise|undefined}
- Get all roles.
+ Get user blocks by its id.
@@ -19604,7 +22567,7 @@ getRolesSource:
Parameters:
- <optional>
-
@@ -19677,7 +22638,7 @@ Parameters:
- Roles parameters.
+ The user data object..
@@ -19691,8 +22652,6 @@ Parameters:
Type
- Attributes
-
@@ -19705,70 +22664,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ The user id.
@@ -19812,7 +22725,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -19863,20 +22776,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.getUserBlocks({ id: USER_ID }, function (err, blocks) {
+ if (err) {
+ // Handle error.
+ }
-management.getRoles(params, function (err, roles) {
- console.log(roles.length);
+ console.log(blocks);
});
@@ -19888,14 +22793,14 @@ Example
- getRule(params, cbopt) → {Promise|undefined}
+ getUserBlocksByIdentifier(params, cbopt) → {Promise|undefined}
- Get an Auth0 rule.
+ Get user blocks by its identifier.
@@ -19931,7 +22836,7 @@ getRuleSource:
Parameters:
- Rule parameters.
+ The user data object..
@@ -20028,7 +22933,7 @@ Parameters:
- ididentifier
@@ -20045,7 +22950,7 @@ Parameters:
- Rule ID.
+ The user identifier, any of: username, phone_number, email.
@@ -20089,7 +22994,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -20140,12 +23045,12 @@ Returns:
Example
- management.getRule({ id: RULE_ID }, function (err, rule) {
+ management.getUserBlocksByIdentifier({ identifier: USER_ID }, function (err, blocks) {
if (err) {
// Handle error.
}
- console.log(rule);
+ console.log(blocks);
});
@@ -20157,14 +23062,14 @@ Example
- getRules(paramsopt, cbopt) → {Promise|undefined}
+ getUserLogs(params, cbopt) → {Promise|undefined}
- Get all rules.
+ Get user's log events.
@@ -20200,7 +23105,7 @@ getRulesSource:
Parameters:
- <optional>
-
@@ -20273,7 +23176,7 @@ Parameters:
- Rules parameters.
+ Get logs data.
@@ -20287,8 +23190,6 @@ Parameters:
Type
- Attributes
-
@@ -20301,28 +23202,44 @@ Parameters:
- per_pageid
-Number
+String
-
-
- <optional>
-
+
+
+
+ User id.
+
+
+
+
+
+
+ per_page
+
-
+Number
+
+
+
+
+
@@ -20350,21 +23267,63 @@ Parameters:
-
+
+
+
+
+ Page number, zero indexed.
- <optional>
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
- Page number, zero indexed.
+ true if a query summary must be included in the result, false otherwise. Default false;
@@ -20459,20 +23418,14 @@ 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
-};
+ var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-management.getRules(params, function (err, rules) {
- console.log(rules.length);
+management.getUserLogs(params, function (err, logs) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logs);
});
@@ -20484,14 +23437,14 @@ Example
- getRulesConfigs(cbopt) → {Promise|undefined}
+ getUserPermissions(params, cbopt) → {Promise|undefined}
- Get rules config.
+ Get user's permissions
@@ -20527,7 +23480,7 @@ getRul
Source:
Parameters:
- cbparams
-function
+Object
@@ -20588,8 +23541,6 @@ Parameters:
- <optional>
-
@@ -20600,159 +23551,166 @@ Parameters:
- Callback function.
+ Get permissions data.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
+
+
+
+
-
-
- -
- Type:
-
- -
+
Name
-Promise
-|
-undefined
+ Type
+
-
-
+
+ Description
+
+
+
-
-
+
+
+ idExample
-
- management.getRulesConfigs(function (err, rulesConfigs) {
- if (err) {
- // Handle error.
- }
+
+
+
+String
- // Get Rules Configs.
-});
-
+
+
-
-
-
-
+
- getTenantSettings(cbopt) → {Promise|undefined}
+
+ User id.
+
+
+
+
+
+ per_pageGet the tenant settings..
-
+
+
+
+Number
+
+
+
+
-
+
+ Number of results per page.
+
+
+
-
+
+
+ page
+
+
+Number
-
-
+
+
-
+
-
+
-
+
+ Page number, zero indexed.
+
+
+
-
+
+
+ sort
+
+
+String
-
-
- Source:
-
-
+
-
+
-
-
+
+ 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;
+
+
+
- Parameters:
+
+
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+
+
+
-
@@ -20835,12 +23793,14 @@ Returns:
Example
- management.getSettings(function (err, settings) {
+ 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(settings);
+ console.log(logs);
});
@@ -20852,14 +23812,14 @@ Example
- getUser(data, cbopt) → {Promise|undefined}
+ getUserRoles(params, cbopt) → {Promise|undefined}
- Get a user by its id.
+ Get user's roles
@@ -20895,7 +23855,7 @@ getUserSource:
Parameters:
- dataparams
@@ -20966,7 +23926,7 @@ Parameters:
- The user data object.
+ Get roles data.
@@ -21009,7 +23969,111 @@ Parameters:
- The user id.
+ 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;
@@ -21104,8 +24168,14 @@ Returns:
Example
- management.getUser({ id: USER_ID }, function (err, user) {
- console.log(user);
+ 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);
});
@@ -21117,14 +24187,14 @@ Example
- getUserBlocks(params, cbopt) → {Promise|undefined}
+ getUsers(paramsopt, cbopt) → {Promise|undefined}
- Get user blocks by its id.
+ Get all users.
@@ -21160,7 +24230,7 @@ getUserB
Source:
Parameters:
+ <optional>
+
@@ -21231,7 +24303,7 @@ Parameters:
- The user data object..
+ Users params.
@@ -21245,6 +24317,8 @@ Parameters:
Type
+ Attributes
+
@@ -21257,7 +24331,43 @@ Parameters:
- idsearch_engine
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The version of the search engine to use.
+
+
+
+
+
+
+
+
+ q
@@ -21270,11 +24380,93 @@ Parameters:
+
+
+ <optional>
+
+
+
+
+
+
+
- The user id.
+ User Search string to filter which users are returned. Follows Lucene query string syntax as documented at https://auth0.com/docs/api/management/v2#!/Users/get_users.
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -21318,7 +24510,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -21369,12 +24561,22 @@ 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 = {
+ search_engine: 'v3',
+ q: 'name:*jane*',
+ per_page: 10,
+ page: 0
+};
- console.log(blocks);
+auth0.getUsers(params, function (err, users) {
+ console.log(users.length);
});
@@ -21386,14 +24588,14 @@ Example
- getUserBlocksByIdentifier(params, cbopt) → {Promise|undefined}
+ getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
- Get user blocks by its identifier.
+ Get users for a given email address
@@ -21429,7 +24631,7 @@ Source:
Parameters:
- paramsemail
-Object
+String
@@ -21490,68 +24692,19 @@ Parameters:
-
-
-
+ <optional>
-
-
-
-
-
- The user data object..
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- identifier
-
-String
-
-
-
-
-
+
- The user identifier, any of: username, phone_number, email.
-
-
-
-
-
-
-
-
+ Email Address of users to locate
@@ -21587,7 +24740,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -21638,12 +24791,13 @@ Returns:
Example
- management.getUserBlocksByIdentifier({ identifier: USER_ID }, function (err, blocks) {
- if (err) {
- // Handle error.
- }
-
- console.log(blocks);
+
+ This method takes an email address as the first argument,
+ and returns all users with that email address
+
+
+ auth0.getUsersByEmail(email, function (err, users) {
+ console.log(users);
});
@@ -21655,14 +24809,14 @@ Example
- getUserLogs(params, cbopt) → {Promise|undefined}
+ getUsersInRole(idopt, cbopt) → {Promise|undefined}
- Get user's log events.
+ Get users in a given role
@@ -21698,7 +24852,7 @@ getUserLog
Source:
Parameters:
- paramsid
-Object
+String
@@ -21759,6 +24913,8 @@ Parameters:
+ <optional>
+
@@ -21769,70 +24925,37 @@ Parameters:
- Get logs data.
+ Id of the role
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idparams.per_page
-String
+Number
-
-
-
-
- User id.
+
-
-
-
-
-
-
-
- per_page
-
+ <optional>
-Number
-
-
-
+
+
+
@@ -21847,7 +24970,7 @@ Parameters:
- pageparams.page
@@ -21860,71 +24983,21 @@ Parameters:
-
-
-
-
- Page number, zero indexed.
+
-
-
-
-
-
-
-
- sort
-
+ <optional>
-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;
-
-
-
-
-
-
-
-
+ Page number, zero indexed.
@@ -22009,16 +25082,20 @@ Returns:
-Example
-
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+Examples
-management.getUserLogs(params, function (err, logs) {
- if (err) {
- // Handle error.
- }
+ var params = {
+ id: 'ROLE_ID'
+ per_page: 50,
+ page: 0
+};
- console.log(logs);
+
+ This method takes a roleId and returns all users within that role
+
+
+ management.getUsersInRole(params, function (err, users) {
+ console.log(users);
});
@@ -22030,14 +25107,16 @@ Example
- getUserPermissions(params, cbopt) → {Promise|undefined}
+ importUsers(data, cbopt) → {Promise|undefined}
- Get user's permissions
+ Given a path to a file and a connection id, create a new job that imports the
+users contained in the file or JSON string and associate them with the given
+connection.
@@ -22073,7 +25152,7 @@ get
Source:
Parameters:
- paramsdata
@@ -22144,7 +25223,7 @@ Parameters:
- Get permissions data.
+ Users import data.
@@ -22158,6 +25237,8 @@ Parameters:
Type
+ Attributes
+
@@ -22170,7 +25251,7 @@ Parameters:
- idconnection_id
@@ -22183,11 +25264,19 @@ Parameters:
+
+
+
+
+
+
+
+
- User id.
+ connection_id of the connection to which users will be imported.
@@ -22196,24 +25285,34 @@ Parameters:
- per_pageusers
-Number
+String
+
+
+ <optional>
+
+
+
+
+
+
+
- Number of results per page.
+ Path to the users data file. Either users or users_json is mandatory.
@@ -22222,24 +25321,34 @@ Parameters:
- pageusers_json
-Number
+String
+
+
+ <optional>
+
+
+
+
+
+
+
- Page number, zero indexed.
+ JSON data for the users.
@@ -22248,24 +25357,34 @@ Parameters:
- sortupsert
-String
+Boolean
+
+
+ <optional>
+
+
+
+
+
+
+
- The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+ Whether to update users if they already exist (true) or to ignore them (false).
@@ -22274,7 +25393,7 @@ Parameters:
- include_totalssend_completion_email
@@ -22287,11 +25406,21 @@ Parameters:
+
+
+ <optional>
+
+
+
+
+
+
+
- true if a query summary must be included in the result, false otherwise. Default false;
+ Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
@@ -22386,14 +25515,15 @@ Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+ var params = {
+ connection_id: '{CONNECTION_ID}',
+ users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}'
+};
-management.getUserPermissions(params, function (err, logs) {
+management.importUsers(params, function (err) {
if (err) {
// Handle error.
}
-
- console.log(logs);
});
@@ -22405,14 +25535,14 @@ Example
- getUserRoles(params, cbopt) → {Promise|undefined}
+ linkUsers(userId, params, cbopt) → {Promise|undefined}
- Get user's roles
+ Link the user with another account.
@@ -22448,7 +25578,7 @@ getUserRo
Source:
Parameters:
- paramsuserId
-Object
+String
@@ -22519,111 +25649,67 @@ Parameters:
- Get roles data.
+ ID of the primary user.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idparams
-String
+Object
-
-
-
-
- User id.
+
-
-
-
-
-
-
- per_page
-
-Number
-
-
-
-
+
+
- Number of results per page.
-
-
-
-
-
-
-
-
- page
-
+ Secondary user data.
-Number
+
+
+
+
+
+ Name
+
-
-
+ Type
-
+
-
+
-
- Page number, zero indexed.
-
-
-
+ Description
+
+
+
- sortuser_id
@@ -22640,7 +25726,7 @@ Parameters:
- The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+ ID of the user to be linked.
@@ -22649,13 +25735,13 @@ Parameters:
- include_totalsconnection_id
-Boolean
+String
@@ -22666,7 +25752,7 @@ Parameters:
- true if a query summary must be included in the result, false otherwise. Default false;
+ ID of the connection to be used.
@@ -22761,14 +25847,18 @@ Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+ var userId = 'USER_ID';
+var params = {
+ user_id: 'OTHER_USER_ID',
+ connection_id: 'CONNECTION_ID'
+};
-management.getUserRoles(params, function (err, logs) {
+management.linkUsers(userId, params, function (err, user) {
if (err) {
// Handle error.
}
- console.log(logs);
+ // Users linked.
});
@@ -22780,14 +25870,14 @@ Example
- getUsers(paramsopt, cbopt) → {Promise|undefined}
+ regenerateRecoveryCode(data, cbopt) → {Promise|undefined}
- Get all users.
+ Generate new Guardian recovery code.
@@ -22823,7 +25913,7 @@ getUsersSource:
Parameters:
- paramsdata
@@ -22884,8 +25974,6 @@ Parameters:
- <optional>
-
@@ -22896,7 +25984,7 @@ Parameters:
- Users params.
+ The user data object.
@@ -22910,8 +25998,6 @@ Parameters:
Type
- Attributes
-
@@ -22924,43 +26010,7 @@ Parameters:
- search_engine
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The version of the search engine to use.
-
-
-
-
-
-
-
-
- qid
@@ -22973,93 +26023,11 @@ Parameters:
-
-
- <optional>
-
-
-
-
-
-
-
- User Search string to filter which users are returned. Follows Lucene query string syntax as documented at https://auth0.com/docs/api/management/v2#!/Users/get_users.
-
-
-
-
-
-
-
-
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Page number, zero indexed.
+ The user id.
@@ -23154,22 +26122,8 @@ 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 = {
- search_engine: 'v3',
- q: 'name:*jane*',
- per_page: 10,
- page: 0
-};
-
-auth0.getUsers(params, function (err, users) {
- console.log(users.length);
+ management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
+ console.log(newRecoveryCode);
});
@@ -23181,14 +26135,14 @@ Example
- getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+ removeHookSecrets(params, data, cbopt) → {Promise|undefined}
- Get users for a given email address
+ Delete an existing hook.
@@ -23224,7 +26178,7 @@ getUse
Source:
Parameters:
- emailparams
-String
+Object
@@ -23285,7 +26239,90 @@ Parameters:
- <optional>
+
+
+
+
+
+
+
+
+
+
+ Hook parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Hook ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
@@ -23297,7 +26334,7 @@ Parameters:
- Email Address of users to locate
+ Secrets key/value pairs
@@ -23384,13 +26421,14 @@ Returns:
Example
-
- This method takes an email address as the first argument,
- and returns all users with that email address
-
-
- auth0.getUsersByEmail(email, function (err, users) {
- console.log(users);
+ var params = { id: HOOK_ID }
+var data = ['API_TOKEN', 'DB_PASSWORD']
+auth0.removeHookSecrets(params, data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Hook deleted.
});
@@ -23402,14 +26440,14 @@ Example
- getUsersInRole(idopt, cbopt) → {Promise|undefined}
+ removePermissionsFromRole(data, cbopt) → {Promise|undefined}
- Get users in a given role
+ Remove permissions from a role
@@ -23445,7 +26483,7 @@ getUser
Source:
Parameters:
- idparams.id
@@ -23506,8 +26544,6 @@ Parameters:
- <optional>
-
@@ -23518,7 +26554,7 @@ Parameters:
- Id of the role
+ ID of the Role.
@@ -23527,13 +26563,13 @@ Parameters:
- params.per_pagedata
-Number
+Object
@@ -23542,8 +26578,6 @@ Parameters:
- <optional>
-
@@ -23554,43 +26588,135 @@ Parameters:
- Number of results per page.
+ permissions data
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+ Description
+
+
+
+
- params.pagepermissions
-Number
+String
-
+
+
+
+
+ Array of permissions
- <optional>
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ permission_name
+
+String
+
+
+
+
+
+
+
+
+
+ Name of a permission
+
+
+
+
+
+
+ resource_server_identifier
+
-
+String
+
+
+
+
+
- Page number, zero indexed.
+ Identifier for a resource
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -23675,20 +26801,13 @@ Returns:
-Examples
+Example
- var params = {
- id: 'ROLE_ID'
- per_page: 50,
- page: 0
-};
+ var params = { id :'ROLE_ID'};
+var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
-
- This method takes a roleId and returns all users within that role
-
-
- management.getUsersInRole(params, function (err, users) {
- console.log(users);
+management.removePermissionsFromRole(params, data, function (err, permissions) {
+ console.log(permissions);
});
@@ -23700,16 +26819,14 @@ Examples
- importUsers(data, cbopt) → {Promise|undefined}
+ removePermissionsFromUser(params, data, cbopt) → {Promise|undefined}
- Given a path to a file and a connection id, create a new job that imports the
-users contained in the file or JSON string and associate them with the given
-connection.
+ Remove permissions from a user
@@ -23745,7 +26862,7 @@ importUser
Source:
Parameters:
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Users import data.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- connection_idparams
-String
+Object
@@ -23869,16 +26933,33 @@ Parameters:
- connection_id of the connection to which users will be imported.
+ params object
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+ Description
+
+
+
+
- usersid
@@ -23891,21 +26972,19 @@ Parameters:
-
-
- <optional>
-
-
+
+
+ user_id
-
-
+
+
-
+
+
+
-
- Path to the users data file. Either users or users_json is mandatory.
@@ -23914,7 +26993,7 @@ Parameters:
- users_jsondata
@@ -23929,8 +27008,6 @@ Parameters:
- <optional>
-
@@ -23941,79 +27018,50 @@ Parameters:
- JSON data for the users.
-
-
-
-
-
-
-
-
- upsert
-
+ data object containing list of permission IDs
-Boolean
-
-
-
-
+
-
-
-
- <optional>
-
+
+
+
+
+ Name
+
-
+ Type
-
-
-
+
-
+
-
- Whether to update users if they already exist (true) or to ignore them (false).
-
-
-
+ Description
+
+
+
- send_completion_emailpermissions
-Boolean
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Whether to send a completion email to all tenant owners when the job is finished (true) or not (false).
+ Array of permission IDs
@@ -24108,15 +27156,15 @@ Returns:
Example
- var params = {
- connection_id: '{CONNECTION_ID}',
- users: '{PATH_TO_USERS_FILE}' // or users_json: '{USERS_JSON_STRING}'
-};
+ var parms = { id : 'USER_ID'};
+var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
-management.importUsers(params, function (err) {
+management.removePermissionsFromUser(params, data, function (err) {
if (err) {
// Handle error.
}
+
+ // User assigned permissions.
});
@@ -24128,14 +27176,14 @@ Example
- linkUsers(userId, params, cbopt) → {Promise|undefined}
+ removeRolesFromUser(params, data, cbopt) → {Promise|undefined}
- Link the user with another account.
+ Remove roles from a user
@@ -24171,7 +27219,7 @@ linkUsersSource:
Parameters:
- userIdparams
-String
+Object
@@ -24242,7 +27290,58 @@ Parameters:
- ID of the primary user.
+ params object
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ user_id
+
+
+
+
+
+
+
+
@@ -24251,13 +27350,13 @@ Parameters:
- paramsdata
-Object
+String
@@ -24276,7 +27375,7 @@ Parameters:
- Secondary user data.
+ data object containing list of role IDs
@@ -24302,33 +27401,7 @@ Parameters:
- user_id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- ID of the user to be linked.
-
-
-
-
-
-
-
-
- connection_idroles
@@ -24345,7 +27418,7 @@ Parameters:
- ID of the connection to be used.
+ Array of role IDs
@@ -24440,18 +27513,15 @@ Returns:
Example
- var userId = 'USER_ID';
-var params = {
- user_id: 'OTHER_USER_ID',
- connection_id: 'CONNECTION_ID'
-};
+ var parms = { id : 'USER_ID'};
+var data = { "roles" :["role1"]};
-management.linkUsers(userId, params, function (err, user) {
+management.removeRolesFromUser(params, data, function (err) {
if (err) {
// Handle error.
}
- // Users linked.
+ // User assigned roles.
});
@@ -24463,14 +27533,14 @@ Example
- regenerateRecoveryCode(data, cbopt) → {Promise|undefined}
+ sendEmailVerification(data, cbopt) → {Promise|undefined}
- Generate new Guardian recovery code.
+ Send a verification email to a user.
@@ -24506,7 +27576,7 @@ Source:
Parameters:
- The user data object.
+ User data object.
@@ -24603,7 +27673,7 @@ Parameters:
- iduser_id
@@ -24620,7 +27690,7 @@ Parameters:
- The user id.
+ ID of the user to be verified.
@@ -24715,8 +27785,14 @@ Returns:
Example
- management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
- console.log(newRecoveryCode);
+ var params = {
+ user_id: '{USER_ID}'
+};
+
+management.sendEmailVerification(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
});
@@ -24728,14 +27804,14 @@ Example
- removeHookSecrets(params, data, cbopt) → {Promise|undefined}
+ setRulesConfig(params, data, cbopt) → {Promise|undefined}
- Delete an existing hook.
+ Set a new rules config.
@@ -24771,7 +27847,7 @@ remo
Source:
Parameters:
- Hook parameters.
+ Rule Config parameters.
@@ -24868,7 +27944,7 @@ Parameters:
- idkey
@@ -24885,7 +27961,7 @@ Parameters:
- Hook ID.
+ Rule Config key.
@@ -24927,7 +28003,58 @@ Parameters:
- Secrets key/value pairs
+ Rule Config Data parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ value
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule Config Data value.
+
+
+
+
+
+
+
+
@@ -25014,14 +28141,15 @@ Returns:
Example
- var params = { id: HOOK_ID }
-var data = ['API_TOKEN', 'DB_PASSWORD']
-auth0.removeHookSecrets(params, data, function (err) {
+ var params = { key: RULE_CONFIG_KEY };
+var data = { value: RULES_CONFIG_VALUE };
+
+management.setRulesConfig(params, data, function (err, rulesConfig) {
if (err) {
// Handle error.
}
- // Hook deleted.
+ // Rules Config set.
});
@@ -25033,14 +28161,14 @@ Example
- removePermissionsFromRole(data, cbopt) → {Promise|undefined}
+ unblockUser(params, cbopt) → {Promise|undefined}
- Remove permissions from a role
+ Unblock an user by its id.
@@ -25076,7 +28204,7 @@ Source:
Parameters:
- params.idparams
-String
+Object
@@ -25147,7 +28275,58 @@ Parameters:
- ID of the Role.
+ The user data object..
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
@@ -25156,13 +28335,13 @@ Parameters:
- datacb
-Object
+function
@@ -25171,6 +28350,8 @@ Parameters:
+ <optional>
+
@@ -25181,9 +28362,138 @@ Parameters:
- permissions data
+ Callback function
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.unblockUser({ id: USER_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // User unblocked.
+});
+
+
+
+
+
+
+
+
+
+
+ unblockUser(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Unblock an user by its id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
@@ -25195,6 +28505,8 @@ Parameters:
Type
+ Attributes
+
@@ -25207,24 +28519,32 @@ Parameters:
- permissionsparams
-String
+Object
+
+
+
+
+
+
+
+
- Array of permissions
+ The user data object..
@@ -25250,33 +28570,7 @@ Parameters:
- permission_name
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Name of a permission
-
-
-
-
-
-
-
-
- resource_server_identifieridentifier
@@ -25293,15 +28587,7 @@ Parameters:
- Identifier for a resource
-
-
-
-
-
-
-
-
+ The user identifier, any of: username, phone_number, email.
@@ -25345,7 +28631,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -25396,11 +28682,12 @@ Returns:
Example
- var params = { id :'ROLE_ID'};
-var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
+ management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
-management.removePermissionsFromRole(params, data, function (err, permissions) {
- console.log(permissions);
+ // User unblocked.
});
@@ -25412,14 +28699,14 @@ Example
- removePermissionsFromUser(params, data, cbopt) → {Promise|undefined}
+ unlinkUsers(params, cbopt) → {Promise|undefined}
- Remove permissions from a user
+ Unlink the given accounts.
@@ -25455,7 +28742,7 @@ Source:
Parameters:
- params object
+ Linked users data.
@@ -25569,15 +28856,7 @@ Parameters:
- user_id
-
-
-
-
-
-
-
-
+ Primary user ID.
@@ -25586,7 +28865,7 @@ Parameters:
- dataprovider
@@ -25599,45 +28878,20 @@ Parameters:
-
-
-
-
-
-
-
-
- data object containing list of permission IDs
+ Identity provider in use.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- permissionsuser_id
@@ -25654,7 +28908,7 @@ Parameters:
- Array of permission IDs
+ Secondary user ID.
@@ -25749,15 +29003,14 @@ Returns:
Example
- var parms = { id : 'USER_ID'};
-var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
+ var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
-management.removePermissionsFromUser(params, data, function (err) {
+management.unlinkUsers(params, function (err, user) {
if (err) {
// Handle error.
}
- // User assigned permissions.
+ // Users accounts unlinked.
});
@@ -25769,14 +29022,14 @@ Example
- removeRolesFromUser(params, data, cbopt) → {Promise|undefined}
+ updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
- Remove roles from a user
+ Update the app metadata for a user.
@@ -25812,7 +29065,7 @@ re
Source:
Parameters:
- params object
+ The user data object..
@@ -25926,7 +29179,7 @@ Parameters:
- user_id
+ The user id.
@@ -25943,13 +29196,13 @@ Parameters:
- datametadata
-String
+Object
@@ -25968,58 +29221,7 @@ Parameters:
- data object containing list of role IDs
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- roles
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Array of role IDs
-
-
-
-
-
-
-
-
+ New app metadata.
@@ -26055,7 +29257,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -26106,15 +29308,18 @@ Returns:
Example
- var parms = { id : 'USER_ID'};
-var data = { "roles" :["role1"]};
+ var params = { id: USER_ID };
+var metadata = {
+ foo: 'bar'
+};
-management.removeRolesFromUser(params, data, function (err) {
+management.updateAppMetadata(params, metadata, function (err, user) {
if (err) {
// Handle error.
}
- // User assigned roles.
+ // Updated user.
+ console.log(user);
});
@@ -26126,14 +29331,14 @@ Example
- sendEmailVerification(data, cbopt) → {Promise|undefined}
+ updateBrandingSettings(params, data, cbopt) → {Promise|undefined}
- Send a verification email to a user.
+ Update the branding settings.
@@ -26169,7 +29374,7 @@
Source:
Parameters:
- dataparams
@@ -26240,58 +29445,41 @@ Parameters:
- User data object.
+ Branding parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- user_iddata
-String
+Object
+
+
-
+
-
- ID of the user to be verified.
-
-
+
+
-
-
-
+
+
+ Updated branding data.
@@ -26378,14 +29566,13 @@ Returns:
Example
- var params = {
- user_id: '{USER_ID}'
-};
-
-management.sendEmailVerification(params, function (err) {
+ management.updateBrandingSettings(data, function (err, branding) {
if (err) {
// Handle error.
}
+
+// Updated branding
+ console.log(branding);
});
@@ -26397,14 +29584,14 @@ Example
- setRulesConfig(params, data, cbopt) → {Promise|undefined}
+ updateClient(params, data, cbopt) → {Promise|undefined}
- Set a new rules config.
+ Update an Auth0 client.
@@ -26440,7 +29627,7 @@ setRule
Source:
Parameters:
- Rule Config parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- key
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Rule Config key.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Rule Config Data parameters.
+ Client parameters.
@@ -26622,7 +29724,7 @@ Parameters:
- valueclient_id
@@ -26639,7 +29741,7 @@ Parameters:
- Rule Config Data value.
+ Application client ID.
@@ -26654,6 +29756,40 @@ Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated client data.
+
+
+
+
+
+
cbReturns:
Example
- var params = { key: RULE_CONFIG_KEY };
-var data = { value: RULES_CONFIG_VALUE };
+ var data = { name: 'newClientName' };
+var params = { client_id: CLIENT_ID };
-management.setRulesConfig(params, data, function (err, rulesConfig) {
+management.updateClient(params, data, function (err, client) {
if (err) {
// Handle error.
}
- // Rules Config set.
+ console.log(client.name); // 'newClientName'
});
@@ -26754,14 +29890,14 @@ Example
- unblockUser(params, cbopt) → {Promise|undefined}
+ updateClientGrant(params, data, cbopt) → {Promise|undefined}
- Unblock an user by its id.
+ Update an Auth0 client grant.
@@ -26797,7 +29933,7 @@ unblockUse
Source:
Parameters:
- The user data object..
+ Client parameters.
@@ -26911,7 +30047,7 @@ Parameters:
- The user id.
+ Client grant ID.
@@ -26926,6 +30062,40 @@ Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated client data.
+
+
+
+
+
+
cbParameters:
- Callback function
+ Callback function.
@@ -27006,12 +30176,19 @@ Returns:
Example
- management.unblockUser({ id: USER_ID }, function (err) {
+ var data = {
+ client_id: CLIENT_ID,
+ audience: AUDIENCE,
+ scope: []
+};
+var params = { id: CLIENT_GRANT_ID };
+
+management.clientGrants.update(params, data, function (err, grant) {
if (err) {
// Handle error.
}
- // User unblocked.
+ console.log(grant.id);
});
@@ -27023,14 +30200,14 @@ Example
- unblockUser(params, cbopt) → {Promise|undefined}
+ updateConnection(params, data, cbopt) → {Promise|undefined}
- Unblock an user by its id.
+ Update an existing connection.
@@ -27066,7 +30243,7 @@ unblockUse
Source:
Parameters:
- The user data object..
+ Connection parameters.
@@ -27163,7 +30340,7 @@ Parameters:
- identifierid
@@ -27180,7 +30357,7 @@ Parameters:
- The user identifier, any of: username, phone_number, email.
+ Connection ID.
@@ -27195,6 +30372,40 @@ Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated connection data.
+
+
+
+
+
+
cbParameters:
- Callback function
+ Callback function.
@@ -27275,12 +30486,15 @@ Returns:
Example
- management.unblockUserByIdentifier({ identifier: USER_ID }, function (err) {
+ var data = { name: 'newConnectionName' };
+var params = { id: CONNECTION_ID };
+
+management.updateConnection(params, data, function (err, connection) {
if (err) {
// Handle error.
}
- // User unblocked.
+ console.log(connection.name); // 'newConnectionName'
});
@@ -27292,14 +30506,14 @@ Example
- unlinkUsers(params, cbopt) → {Promise|undefined}
+ updateEmailProvider(params, data, cbopt) → {Promise|undefined}
- Unlink the given accounts.
+ Update the email provider.
@@ -27335,7 +30549,7 @@ unlinkUser
Source:
Parameters:
- Linked users data.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Primary user ID.
+ Email provider parameters.
@@ -27458,58 +30629,32 @@ Parameters:
- providerdata
-String
+Object
-
-
-
-
- Identity provider in use.
+
-
-
-
-
-
-
-
- user_id
-
-String
-
-
-
-
+
+
- Secondary user ID.
-
-
-
-
-
-
-
-
+ Updated email provider data.
@@ -27596,14 +30741,13 @@ Returns:
Example
- var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
-
-management.unlinkUsers(params, function (err, user) {
+ management.updateEmailProvider(params, data, function (err, provider) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // Updated email provider.
+ console.log(provider);
});
@@ -27615,14 +30759,14 @@ Example
- updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
+ updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
- Update the app metadata for a user.
+ Update an existing Email Template.
@@ -27658,7 +30802,7 @@ upda
Source:
Parameters:
- The user data object..
+ Email Template parameters.
@@ -27755,7 +30899,7 @@ Parameters:
- idname
@@ -27772,7 +30916,7 @@ Parameters:
- The user id.
+ Template Name
@@ -27789,7 +30933,7 @@ Parameters:
- metadatadata
@@ -27814,7 +30958,7 @@ Parameters:
- New app metadata.
+ Updated Email Template data.
@@ -27850,7 +30994,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -27901,18 +31045,15 @@ Returns:
Example
- var params = { id: USER_ID };
-var metadata = {
- foo: 'bar'
-};
+ var data = { from: 'new@email.com' };
+var params = { name: EMAIL_TEMPLATE_NAME };
-management.updateAppMetadata(params, metadata, function (err, user) {
+management.updateEmailTemplates(params, data, function (err, emailTemplate) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+ console.log(emailTemplate.from); // 'new@email.com'
});
@@ -27924,14 +31065,14 @@ Example
- updateBrandingSettings(params, data, cbopt) → {Promise|undefined}
+ updateFactorProvider(params, data, cbopt) → {Promise|undefined}
- Update the branding settings.
+ Update Guardian's factor provider
@@ -27967,7 +31108,7 @@ Source:
Parameters:
- Branding parameters.
+ Factor provider parameters.
@@ -28072,7 +31213,7 @@ Parameters:
- Updated branding data.
+ Updated Factor provider data.
@@ -28159,13 +31300,12 @@ Returns:
Example
- management.updateBrandingSettings(data, function (err, branding) {
- if (err) {
- // Handle error.
- }
-
-// Updated branding
- console.log(branding);
+ management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ messaging_service_sid: 'XXXXXXXXXXXXXX',
+ auth_token: 'XXXXXXXXXXXXXX',
+ sid: 'XXXXXXXXXXXXXX'
+}, function (err, provider) {
+ console.log(provider);
});
@@ -28177,14 +31317,14 @@ Example
- updateClient(params, data, cbopt) → {Promise|undefined}
+ updateGuardianFactor(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client.
+ Update Guardian Factor
@@ -28220,7 +31360,7 @@ updateCli
Source:
Parameters:
- Client parameters.
+ Factor parameters.
-
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated factor data.
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.updateGuardianFactor({ name: 'sms' }, {
+ enabled: true
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+ updateGuardianFactorTemplates(params, data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update Guardian enrollment and verification factor templates
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
@@ -28305,6 +31642,8 @@ Parameters:
Type
+ Attributes
+
@@ -28317,32 +31656,32 @@ Parameters:
- client_idparams
-String
+Object
+
+
-
+
-
- Application client ID.
-
-
+
+
-
-
-
+
+
+ Factor parameters.
@@ -28376,7 +31715,7 @@ Parameters:
- Updated client data.
+ Updated factor templates data.
@@ -28463,15 +31802,11 @@ Returns:
Example
- var data = { name: 'newClientName' };
-var params = { client_id: CLIENT_ID };
-
-management.updateClient(params, data, function (err, client) {
- if (err) {
- // Handle error.
- }
-
- console.log(client.name); // 'newClientName'
+ management.updateGuardianFactorTemplates({ name: 'sms' }, {
+ enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+}, function (err, templates) {
+ console.log(templates);
});
@@ -28483,14 +31818,14 @@ Example
- updateClientGrant(params, data, cbopt) → {Promise|undefined}
+ updateGuardianPhoneFactorMessageTypes(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client grant.
+ Update the Guardian phone factor's message types
@@ -28526,7 +31861,7 @@ upda
Source:
Parameters:
- Client parameters.
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
@@ -28623,13 +31992,13 @@ Parameters:
- idmessage_types
-String
+Array.<String>
@@ -28640,7 +32009,7 @@ Parameters:
- Client grant ID.
+ Message types (only "sms" and "voice" are supported).
@@ -28655,40 +32024,6 @@ Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Updated client data.
-
-
-
-
-
-
cbReturns:
Example
- var data = {
- client_id: CLIENT_ID,
- audience: AUDIENCE,
- scope: []
-};
-var params = { id: CLIENT_GRANT_ID };
-
-management.clientGrants.update(params, data, function (err, grant) {
- if (err) {
- // Handle error.
- }
-
- console.log(grant.id);
+ management.updateGuardianPhoneFactorMessageTypes({}, {
+ message_types: ['sms', 'voice']
+}, function (err, factor) {
+ console.log(factor);
});
@@ -28793,14 +32119,14 @@ Example
- updateConnection(params, data, cbopt) → {Promise|undefined}
+ updateGuardianPhoneFactorSelectedProvider(params, data, cbopt) → {Promise|undefined}
- Update an existing connection.
+ Update the Guardian phone factor's selected provider
@@ -28836,7 +32162,7 @@ updat
Source:
Parameters:
- Connection parameters.
+ Parameters.
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Updated selected provider data.
@@ -28933,7 +32293,7 @@ Parameters:
- idprovider
@@ -28950,7 +32310,7 @@ Parameters:
- Connection ID.
+ Name of the selected provider
@@ -28965,40 +32325,6 @@ Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Updated connection data.
-
-
-
-
-
-
cbReturns:
Example
- var data = { name: 'newConnectionName' };
-var params = { id: CONNECTION_ID };
-
-management.updateConnection(params, data, function (err, connection) {
- if (err) {
- // Handle error.
- }
-
- console.log(connection.name); // 'newConnectionName'
+ management.updateGuardianPhoneFactorSelectedProvider({}, {
+ provider: 'twilio'
+}, function (err, factor) {
+ console.log(factor);
});
@@ -29099,14 +32420,14 @@ Example
- updateEmailProvider(params, data, cbopt) → {Promise|undefined}
+ updateGuardianPolicies(params, data, cbopt) → {Promise|undefined}
- Update the email provider.
+ Update enabled Guardian policies
@@ -29142,7 +32463,7 @@ up
Source:
Parameters:
- Email provider parameters.
+ Parameters.
@@ -29228,7 +32549,7 @@ Parameters:
-Object
+Array.<String>
@@ -29247,7 +32568,7 @@ Parameters:
- Updated email provider data.
+ Policies to enable. Empty array disables all policies.
@@ -29334,13 +32655,10 @@ Returns:
Example
- management.updateEmailProvider(params, data, function (err, provider) {
- if (err) {
- // Handle error.
- }
-
- // Updated email provider.
- console.log(provider);
+ management.updateGuardianPolicies({}, [
+ 'all-applications'
+], function (err, policies) {
+ console.log(policies);
});
@@ -29352,14 +32670,14 @@ Example
- updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+ updateHook(params, data, cbopt) → {Promise|undefined}
- Update an existing Email Template.
+ Update an existing hook.
@@ -29395,7 +32713,7 @@ u
Source:
Parameters:
- Email Template parameters.
+ Hook parameters.
@@ -29492,7 +32810,7 @@ Parameters:
- nameid
@@ -29509,7 +32827,7 @@ Parameters:
- Template Name
+ Hook ID.
@@ -29551,7 +32869,7 @@ Parameters:
- Updated Email Template data.
+ Updated hook data.
@@ -29638,15 +32956,14 @@ Returns:
Example
- var data = { from: 'new@email.com' };
-var params = { name: EMAIL_TEMPLATE_NAME };
-
-management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ var params = { id: HOOK_ID };
+var data = { name: 'my-hook'};
+management.updateHook(params, data, function (err, hook) {
if (err) {
// Handle error.
}
- console.log(emailTemplate.from); // 'new@email.com'
+ console.log(hook.name); // 'my-hook'.
});
@@ -29658,7 +32975,7 @@ Example
- updateHook(params, data, cbopt) → {Promise|undefined}
+ updateHookSecrets(params, data, cbopt) → {Promise|undefined}
@@ -29701,7 +33018,7 @@ updateHook<
Source:
Parameters:
- Updated hook data.
+ Secrets key/value pairs
@@ -29945,13 +33262,13 @@ Returns:
Example
var params = { id: HOOK_ID };
-var data = { name: 'my-hook'};
-management.updateHook(params, data, function (err, hook) {
+var data = { API_TOKEN: 'updated-secret'};
+management.updateHookSecrets(params, data, function (err, secrets) {
if (err) {
// Handle error.
}
- console.log(hook.name); // 'my-hook'.
+ console.log(secrets)
});
@@ -29963,14 +33280,14 @@ Example
- updateHookSecrets(params, data, cbopt) → {Promise|undefined}
+ updateMigrations(data, cbopt) → {Promise|undefined}
- Update an existing hook.
+ Update the tenant migrations.
@@ -30006,7 +33323,7 @@ upda
Source:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Hook parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Hook ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
dataParameters:
- Secrets key/value pairs
+ Updated migrations data.
@@ -30249,14 +33481,14 @@ Returns:
Example
- var params = { id: HOOK_ID };
-var data = { API_TOKEN: 'updated-secret'};
-management.updateHookSecrets(params, data, function (err, secrets) {
+ data = { flags: { migration: true } };
+management.updateMigrations(data, function (err, migrations) {
if (err) {
// Handle error.
}
- console.log(secrets)
+// Updated migrations flags
+ console.log(migrations.flags);
});
@@ -30311,7 +33543,7 @@ u
Source:
updateRole<
Source:
updateRule<
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 76a32b605..f8ce1198e 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.MigrationsManager.html b/docs/module-management.MigrationsManager.html
new file mode 100644
index 000000000..97c347c60
--- /dev/null
+++ b/docs/module-management.MigrationsManager.html
@@ -0,0 +1,894 @@
+
+
+
+
+
+ MigrationsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MigrationsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ MigrationsManager
+
+
+ Abstracts interaction with the migrations endpoint.
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new MigrationsManager(options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The client options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ baseUrl
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The URL of the API.
+
+
+
+
+
+
+
+
+ headers
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Headers to be included in all requests.
+
+
+
+
+
+
+
+
+ retry
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Retry Policy Config
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+
+(inner) auth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the migrations endpoint
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ getMigrations(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the tenant migrations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.migrations.getMigrations(function (err, migrations) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(migrations.flags);
+});
+
+
+
+
+
+
+
+
+
+
+ updateMigrations(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the tenant migrations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The tenant migrations to be updated
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ flags
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The tenant migrations flags to be updated
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.migrations.updateMigrations(data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index d450ac7fd..21d4124ea 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index fb5b1d27f..5a3fc2b55 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 961843c93..97ba3fa94 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index f6980c26f..4929adc05 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4293,7 +4293,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 838527adc..c27870d41 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 6dbd96b97..622494998 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 3555a998f..32b369ef9 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 2b6bee0fb..912072b15 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 7d1f5730b..82d4e1e47 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index 8543b95d7..87627110d 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 4f4e00d83..2c8b117f7 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index fb60127dd..6b0291d80 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -110,6 +110,9 @@ Classes
ManagementTokenProvider
+ MigrationsManager
+
+
PromptsManager
@@ -168,7 +171,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 12e5b188c..ee686ea37 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 8106671bc..d316de5ca 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -91,6 +91,9 @@ utils.js
*/
utils.wrapPropertyMethod = function(Parent, name, propertyMethod) {
var path = propertyMethod.split('.');
+ if (path.length > 2) {
+ throw new Error('wrapPropertyMethod() only supports one level of nesting for propertyMethod');
+ }
var property = path.shift();
var method = path.pop();
@@ -138,7 +141,7 @@ utils.js
diff --git a/package.json b/package.json
index c6cecbc29..8461fcac2 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.26.0",
+ "version": "2.27.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
dataparamsParameters:
The user data object.
+Factor provider parameters.
- - -| Name | - - -Type | - - - - - -Description | -||
|---|---|---|---|---|
id |
+ cb |
-String
+function
|
+
+
+ <optional> + + + + + + |
+
- The user id. +Callback function. |
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+
+
+
+Example
+ +management.guardian.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+getFactors(cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Get a list of factors and statuses.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +
|---|---|---|---|
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+Example
+ +management.guardian.getFactors(function (err, factors) {
+ console.log(factors.length);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+getFactorTemplates(params, cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Get Guardian enrollment and verification factor templates
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +
|---|---|---|---|
params |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Factor parameters. + + |
+
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+Example
+ +management.guardian.getFactorTemplates({ name: 'sms' }, function (err, templates) {
+ console.log(templates);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+getGuardianEnrollment(data, cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Get a single Guardian enrollment.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +||||||
|---|---|---|---|---|---|---|---|---|---|
data |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ The user data object. + + + +
|
+ ||||||
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+Example
+ +management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ console.log(enrollment);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+getPhoneFactorMessageTypes(cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Get the Guardian phone factor's message types
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +
|---|---|---|---|
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+Example
+ +management.guardian.getPhoneFactorMessageTypes(function (err, messageTypes) {
+ console.log(messageTypes);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+getPhoneFactorSelectedProvider(cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Get the Guardian phone factor's selected provider
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +
|---|---|---|---|
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+Example
+ +management.guardian.getPhoneFactorSelectedProvider(function (err, selectedProvider) {
+ console.log(selectedProvider);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+getPolicies(cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Get enabled Guardian policies
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +
|---|---|---|---|
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+Example
+ +management.guardian.getPolicies(function (err, policies) {
+ console.log(policies);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+updateFactor(params, data, cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Update Guardian Factor
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +
|---|---|---|---|
params |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Factor parameters. + + |
+
data |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Updated factor data. + + |
+
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+Example
+ +management.guardian.updateFactor({ name: 'sms' }, {
+ enabled: true
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+updateFactorProvider(params, data, cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Update Guardian's factor provider
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +
|---|---|---|---|
params |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Factor provider parameters. + + |
+
data |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Updated Factor provider data. + + |
+
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+Example
+ +management.guardian.updateFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ messaging_service_sid: 'XXXXXXXXXXXXXX',
+ auth_token: 'XXXXXXXXXXXXXX',
+ sid: 'XXXXXXXXXXXXXX'
+}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+updateFactorTemplates(params, data, cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Update Guardian enrollment and verification factor templates
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +
|---|---|---|---|
params |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Factor parameters. + + |
+
data |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Updated factor templates data. + + |
+
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+Example
+ +management.guardian.updateFactorProvider({ name: 'sms' }, {
+ enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+}, function (err, templates) {
+ console.log(templates);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+updatePhoneFactorMessageTypes(params, data, cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Update the Guardian phone factor's message types
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +||||||
|---|---|---|---|---|---|---|---|---|---|
params |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Parameters. + + |
+ ||||||
data |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Updated selected provider data. + + + +
|
+ ||||||
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+Example
+ +management.guardian.updatePhoneFactorMessageTypes({}, {
+ message_types: ['sms', 'voice']
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
- <optional>
- - - -
-
-
-
-
-
+
+
+
+
+
+
-
-
-
-
-
+
+
-
-
-
-
-
-
-
-
- <optional>
- - - -
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
updatePhoneFactorSelectedProvider(params, data, cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Update the Guardian phone factor's selected provider
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +|||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Parameters. + + |
+ |||||||||||
data |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Updated selected provider data. + + + +
|
| Name | + + +Type | + + +Attributes | + + + + +Description | +
|---|---|---|---|
params |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Parameters. + + |
+
data |
+
+
+
+
+
+Array.<String>
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Policies to enable. Empty array disables all policies. + + |
+
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
@@ -1440,7 +4415,7 @@ Example
+ +management.guardian.updatePolicies({}, [
+ 'all-applications'
+], function (err, policies) {
+ console.log(policies);
});Example
diff --git a/docs/module-management.HooksManager.html b/docs/module-management.HooksManager.html index 9facca9da..dcf47a8d6 100644 --- a/docs/module-management.HooksManager.html +++ b/docs/module-management.HooksManager.html @@ -24,7 +24,7 @@
@@ -3099,7 +3099,7 @@
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html index b489005bd..debe93a8b 100644 --- a/docs/module-management.JobsManager.html +++ b/docs/module-management.JobsManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html index b489005bd..debe93a8b 100644 --- a/docs/module-management.JobsManager.html +++ b/docs/module-management.JobsManager.html @@ -24,7 +24,7 @@
@@ -2676,7 +2676,7 @@
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html index ee8687280..084e7a64d 100644 --- a/docs/module-management.LogsManager.html +++ b/docs/module-management.LogsManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html index ee8687280..084e7a64d 100644 --- a/docs/module-management.LogsManager.html +++ b/docs/module-management.LogsManager.html @@ -24,7 +24,7 @@
@@ -1286,7 +1286,7 @@
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html index 700e3ee3e..7767f2f9c 100644 --- a/docs/module-management.ManagementClient.html +++ b/docs/module-management.ManagementClient.html @@ -24,7 +24,7 @@resour
+
+
+Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html index 700e3ee3e..7767f2f9c 100644 --- a/docs/module-management.ManagementClient.html +++ b/docs/module-management.ManagementClient.html @@ -24,7 +24,7 @@
@@ -106,7 +106,7 @@ new M
+
+
+
+new M
Source:
blac
Source:
brandingSource:
clientGra
Source:
clientsSource:
connection
Source:
customDo
Source:
devi
Source:
emailPro
Source:
emailTe
Source:
grantsSource:
guardianSource:
hooksSource:
jobsSource:
logsSource:
Type:
+
brandingSource:
clientGra
Source:
clientsSource:
connection
Source:
customDo
Source:
devi
Source:
emailPro
Source:
emailTe
Source:
grantsSource:
guardianSource:
hooksSource:
jobsSource:
logsSource:
Type:
+
clientsSource:
connection
Source:
customDo
Source:
devi
Source:
emailPro
Source:
emailTe
Source:
grantsSource:
guardianSource:
hooksSource:
jobsSource:
logsSource:
Type:
+
customDo
Source:
devi
Source:
emailPro
Source:
emailTe
Source:
grantsSource:
guardianSource:
hooksSource:
jobsSource:
logsSource:
Type:
+
emailPro
Source:
emailTe
Source:
grantsSource:
guardianSource:
hooksSource:
jobsSource:
logsSource:
Type:
+
grantsSource:
guardianSource:
hooksSource:
jobsSource:
logsSource:
Type:
+
hooksSource:
jobsSource:
logsSource:
Type:
+
logsSource:
Type:
+
+
@@ -1811,7 +1885,7 @@ migrations :MigrationsManager
+ + + + +
+
+
+
+
+
+
+ManagementClient migrations manager.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Type:
+-
+
-
+
+
MigrationsManager+ + +
+
resour
Source:
rolesSource:
rulesSource:
rulesConf
Source:
statsSource:
tenantSource:
ticketsSource:
userBlocks<
Source:
usersSource:
addHookS
Source:
a
Source:
Source:
assi
Source:
blackli
Source:
Source:
createCli
Source:
crea
Source:
creat
Source:
cre
Source:
Source:
cr
Source:
Source:
Source:
createHook<
Source:
Source:
c
Source:
createRole<
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
rulesSource:
rulesConf
Source:
statsSource:
tenantSource:
ticketsSource:
userBlocks<
Source:
usersSource:
addHookS
Source:
a
Source:
Source:
assi
Source:
blackli
Source:
Source:
createCli
Source:
crea
Source:
creat
Source:
cre
Source:
Source:
cr
Source:
Source:
Source:
createHook<
Source:
Source:
c
Source:
createRole<
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
statsSource:
tenantSource:
ticketsSource:
userBlocks<
Source:
usersSource:
addHookS
Source:
a
Source:
Source:
assi
Source:
blackli
Source:
Source:
createCli
Source:
crea
Source:
creat
Source:
cre
Source:
Source:
cr
Source:
Source:
Source:
createHook<
Source:
Source:
c
Source:
createRole<
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
ticketsSource:
userBlocks<
Source:
usersSource:
addHookS
Source:
a
Source:
Source:
assi
Source:
blackli
Source:
Source:
createCli
Source:
crea
Source:
creat
Source:
cre
Source:
Source:
cr
Source:
Source:
Source:
createHook<
Source:
Source:
c
Source:
createRole<
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
usersSource:
addHookS
Source:
a
Source:
Source:
assi
Source:
blackli
Source:
Source:
createCli
Source:
crea
Source:
creat
Source:
cre
Source:
Source:
cr
Source:
Source:
Source:
createHook<
Source:
Source:
c
Source:
createRole<
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
a
Source:
Source:
assi
Source:
blackli
Source:
Source:
createCli
Source:
crea
Source:
creat
Source:
cre
Source:
Source:
cr
Source:
Source:
Source:
createHook<
Source:
Source:
c
Source:
createRole<
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
assi
Source:
blackli
Source:
Source:
createCli
Source:
crea
Source:
creat
Source:
cre
Source:
Source:
cr
Source:
Source:
Source:
createHook<
Source:
Source:
c
Source:
createRole<
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
Source:
createCli
Source:
crea
Source:
creat
Source:
cre
Source:
Source:
cr
Source:
Source:
Source:
createHook<
Source:
Source:
c
Source:
createRole<
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
crea
Source:
creat
Source:
cre
Source:
Source:
cr
Source:
Source:
Source:
createHook<
Source:
Source:
c
Source:
createRole<
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
cre
Source:
Source:
cr
Source:
Source:
Source:
createHook<
Source:
Source:
c
Source:
createRole<
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
cr
Source:
Source:
Source:
createHook<
Source:
Source:
c
Source:
createRole<
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
Source:
createHook<
Source:
Source:
c
Source:
createRole<
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
Source:
c
Source:
createRole<
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
createRole<
Source:
createRule<
Source:
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
createUser<
Source:
deleteA
Source:
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
deleteCli
Source:
dele
Source:
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
delet
Source:
del
Source:
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
Source:
de
Source:
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
Source:
deleteHook<
Source:
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
d
Source:
deleteRole<
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
deleteUser<
Source:
Source:
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
Source:
exportUser
Source:
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
getAcce
Source:
ge
Source:
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
g
Source:
ge
Source:
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
getClientSource:
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
getCli
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
getConne
Source:
getConn
Source:
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
getCus
Source:
getCu
Source:
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
getDaily
Source:
g
Source:
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
getEm
Source:
getEm
Source:
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
getGrantsSource:
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
Source:
Source:
Example
- getHook(params, cbopt) → {Promise|undefined}
+ getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
- Get an Auth0 hook.
+ Get Guardian factor provider configuration
@@ -16599,7 +16673,7 @@ getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
Example
-getHook(params, cbopt) → {Promise|undefined}
+getGuardianFactorProvider(params, cbopt) → {Promise|undefined}
-
@@ -16599,7 +16673,7 @@ Get an Auth0 hook.
+Get Guardian factor provider configuration
getHookSource:
Parameters:
- Hook parameters.
+ Factor provider parameters.
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- idcb
-String
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Hook ID.
+ Callback function.
@@ -16722,12 +16789,148 @@ Parameters:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
Hook parameters.
+Factor provider parameters.
- - -| Name | - - -Type | - - - - - -Description | -||
|---|---|---|---|---|
id |
+ cb |
-String
+function
|
+
+
+ <optional> + + + + + + |
+
- Hook ID. +Callback function. |
Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
Example
+ +management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ console.log(provider);
+});
+
+
+
+
+
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
+
+
+
+
+
-
-
@@ -18145,13 +18548,13 @@
-
-
-
+
getGuardianFactors(cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Get a list of Guardian factors and statuses.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +|||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
cb |
@@ -16808,12 +17011,8 @@
- <optional> - @@ -16941,41 +17138,22 @@ Parameters: |
- Hooks parameters. +Factor parameters. - - -
| ||||||||||||
page |
-
-
-
-
-Number
-
- |
-
-
-
- <optional> - - - - |
-
+
+
+
+
+
+
+
- Page number, zero indexed. - - |
-
+
+
+
+
+
+
+Get the Guardian phone factor's message types
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +||
|---|---|---|---|---|---|
cb |
@@ -17127,20 +17405,8 @@ |||||
params |
+ cb |
-Object
+function
@@ -17256,6 +17522,8 @@ Parameters: |
+ <optional> + @@ -17266,64 +17534,157 @@ Parameters: |
- Hook parameters. +Callback function. - + |
+
| Name | - -Type | + + +Description | -
|---|---|---|
id |
-
-
-
-
-String
+
+ Example- - |
+
- Hook ID. - - |
-
+
+
+
+
+
+
+Get enabled Guardian policies
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +|
|---|---|---|---|---|
cb |
@@ -17404,13 +17765,8 @@
- Job parameters. +Hook parameters. @@ -17579,7 +17935,7 @@Parameters: |
- Job ID. +Hook ID. |
+ <optional> + @@ -17810,7 +18163,7 @@ Parameters: |
- Log parameters. +Hooks parameters. @@ -17824,6 +18177,8 @@Parameters: | Type | +Attributes | + @@ -17836,24 +18191,70 @@
id |
+ per_page |
-String
+Number
|
+
+
+ <optional> + + + + + + |
+
- Event ID. +Number of results per page. + + |
+
page |
+
+
+
+
+
+Number
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Page number, zero indexed. |
- <optional> - @@ -18081,7 +18488,7 @@ Parameters: |
- Logs params. +Hook parameters. @@ -18095,8 +18502,6 @@Parameters: | Type | -Attributes | - @@ -18109,7 +18514,7 @@
q |
+ id |
@@ -18122,21 +18527,19 @@ Parameters: |
-
-
- <optional> - - + + |
+ Hook ID. - |
-
+
+
Search Criteria using Query String Syntax
Parameters:
pagecbNumber
+function
@@ -18172,130 +18575,171 @@ Parameters:
Page number. Zero based
+Callback function.
per_pageNumber
-
- - - - -
The amount of entries per page
- -
+
- Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
sortString
+
+
Example
- -var params = { id: HOOK_ID }
+management.getHookSecrets(params, function (err, secrets) {
+ if (err) {
+ // Handle error.
+ }
-
-
-
- <optional>
-
+ console.log(secrets);
+});
-
+
-
-
+
+
+
-
+
-
- The field to use for sorting.
-
-
- getJob(params, cbopt) → {Promise|undefined}
-fieldsString
+
+
-
- Get a job by its ID.
+- - - -
-
-
A comma separated list of fields to include or exclude
- -Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
include_fields |
+ params |
-Boolean
+Object
@@ -18304,8 +18748,6 @@ Parameters: |
- <optional> - @@ -18316,43 +18758,50 @@ Parameters: |
- true if the fields specified are to be included in the result, false otherwise. +Job parameters. - |
-
| Name | + + +Type | + + + + +Description | +|||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
include_totals |
+ id |
-Boolean
+String
|
-
-
- <optional> - - - - - - |
-
- true if a query summary must be included in the result, false otherwise. Default false +Job ID. |
|||||||||||||||
roleId |
+ params |
-String
+Object
@@ -18576,8 +19022,6 @@ Parameters: |
- <optional> - @@ -18588,7 +19032,58 @@ Parameters: |
- Id of the role +Log parameters. + + + +
|
+ <optional> + @@ -18810,7 +19303,7 @@ Parameters: |
- Resource Server parameters. +Logs params. @@ -18824,6 +19317,8 @@Parameters: | Type | +Attributes | + @@ -18836,7 +19331,7 @@|||||||||||
id |
+ q |
@@ -18849,11 +19344,237 @@ Parameters: |
+
+
+ <optional> + + + + + + |
+
- Resource Server ID. +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. + + |
+ ||||||||||||||||
fields |
+
+
+
+
+
+String
+
+
+
+ |
+
+
+
+
+ <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 |
| Name | + + +Type | + + +Attributes | + + + + +Description | +
|---|---|---|---|
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
@@ -18965,14 +19879,2210 @@ Example
+ +management.getMigrations(function (err, migrations) {
if (err) {
// Handle error.
}
- console.log(resourceServer);
+// Migration flags
+ console.log(migrations.flags);
});Example
-getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+getPermissionsInRole(roleIdopt, cbopt) → {Promise|undefined}
-
+
+
+
+
+
+Get all resource servers.
+Get permissions for a given role
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +
|---|---|---|---|
roleId |
+
+
+
+
+
+String
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Id of the role + + |
+
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+Examples
+ +var params = { id :'ROLE_ID'};+ This method takes a roleId and + returns all permissions within that role + +
+ +management.getPermissionsInRole(params, function (err, permissions) {
+ console.log(permissions);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+getResourceServer(params, cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Get a Resource Server.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +||||||
|---|---|---|---|---|---|---|---|---|---|
params |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Resource Server parameters. + + + +
|
+ ||||||
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+Example
+ +management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(resourceServer);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Get all resource servers.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Resource Servers parameters. + + + +
|
+ ||||||||||||
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+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.getResourceServers(params, function (err, resourceServers) {
+ console.log(resourceServers.length);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+getRole(params, cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Get an Auth0 role.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +||||||
|---|---|---|---|---|---|---|---|---|---|
params |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Role parameters. + + + +
|
+ ||||||
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+Example
+ +management.getRole({ id: ROLE_ID }, function (err, role) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(role);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+getRoles(paramsopt, cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Get all roles.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Roles parameters. + + + +
|
+ ||||||||||||
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+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.getRoles(params, function (err, roles) {
+ console.log(roles.length);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+getRule(params, cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Get an Auth0 rule.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +||||||
|---|---|---|---|---|---|---|---|---|---|
params |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Rule parameters. + + + +
|
+ ||||||
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+Example
+ +management.getRule({ id: RULE_ID }, function (err, rule) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(rule);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+getRules(paramsopt, cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Get all rules.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Rules parameters. + + + +
|
+ ||||||||||||
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+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.getRules(params, function (err, rules) {
+ console.log(rules.length);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+getRulesConfigs(cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Get rules config.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +
|---|---|---|---|
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+Example
+ +management.getRulesConfigs(function (err, rulesConfigs) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Get Rules Configs.
+});
+
+
+
+ get
getTenantSettings(cbopt) → {Promise|undefined}
+ + + + + +
+
@@ -19008,7 +22118,7 @@ Get the tenant settings..
get
Source:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Resource Servers 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.getSettings(function (err, settings) {
+ if (err) {
+ // Handle error.
+ }
-management.getResourceServers(params, function (err, resourceServers) {
- console.log(resourceServers.length);
+ console.log(settings);
});
@@ -19292,14 +22259,14 @@ Example
- getRole(params, cbopt) → {Promise|undefined}
+ getUser(data, cbopt) → {Promise|undefined}
- Get an Auth0 role.
+ Get a user by its id.
@@ -19335,7 +22302,7 @@ getRoleSource:
Parameters:
- paramsdata
@@ -19406,7 +22373,7 @@ Parameters:
- Role parameters.
+ The user data object.
@@ -19449,7 +22416,7 @@ Parameters:
- Role ID.
+ The user id.
@@ -19544,12 +22511,8 @@ Returns:
Example
- management.getRole({ id: ROLE_ID }, function (err, role) {
- if (err) {
- // Handle error.
- }
-
- console.log(role);
+ management.getUser({ id: USER_ID }, function (err, user) {
+ console.log(user);
});
@@ -19561,14 +22524,14 @@ Example
- getRoles(paramsopt, cbopt) → {Promise|undefined}
+ getUserBlocks(params, cbopt) → {Promise|undefined}
- Get all roles.
+ Get user blocks by its id.
@@ -19604,7 +22567,7 @@ getRolesSource:
Parameters:
- <optional>
-
@@ -19677,7 +22638,7 @@ Parameters:
- Roles parameters.
+ The user data object..
@@ -19691,8 +22652,6 @@ Parameters:
Type
- Attributes
-
@@ -19705,70 +22664,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ The user id.
@@ -19812,7 +22725,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -19863,20 +22776,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.getUserBlocks({ id: USER_ID }, function (err, blocks) {
+ if (err) {
+ // Handle error.
+ }
-management.getRoles(params, function (err, roles) {
- console.log(roles.length);
+ console.log(blocks);
});
@@ -19888,14 +22793,14 @@ Example
- getRule(params, cbopt) → {Promise|undefined}
+ getUserBlocksByIdentifier(params, cbopt) → {Promise|undefined}
- Get an Auth0 rule.
+ Get user blocks by its identifier.
@@ -19931,7 +22836,7 @@ getRuleSource:
Parameters:
- Rule parameters.
+ The user data object..
@@ -20028,7 +22933,7 @@ Parameters:
- ididentifier
@@ -20045,7 +22950,7 @@ Parameters:
- Rule ID.
+ The user identifier, any of: username, phone_number, email.
@@ -20089,7 +22994,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -20140,12 +23045,12 @@ Returns:
Example
- management.getRule({ id: RULE_ID }, function (err, rule) {
+ management.getUserBlocksByIdentifier({ identifier: USER_ID }, function (err, blocks) {
if (err) {
// Handle error.
}
- console.log(rule);
+ console.log(blocks);
});
@@ -20157,14 +23062,14 @@ Example
- getRules(paramsopt, cbopt) → {Promise|undefined}
+ getUserLogs(params, cbopt) → {Promise|undefined}
- Get all rules.
+ Get user's log events.
@@ -20200,7 +23105,7 @@ getRulesSource:
Parameters:
- <optional>
-
@@ -20273,7 +23176,7 @@ Parameters:
- Rules parameters.
+ Get logs data.
@@ -20287,8 +23190,6 @@ Parameters:
Type
- Attributes
-
@@ -20301,28 +23202,44 @@ Parameters:
- per_pageid
-Number
+String
-
-
- <optional>
-
+
+
+
+ User id.
+
+
+
+
+
+
+ per_page
+
-
+Number
+
+
+
+
+
@@ -20350,21 +23267,63 @@ Parameters:
-
+
+
+
+
+ Page number, zero indexed.
- <optional>
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
- Page number, zero indexed.
+ true if a query summary must be included in the result, false otherwise. Default false;
@@ -20459,20 +23418,14 @@ 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
-};
+ var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-management.getRules(params, function (err, rules) {
- console.log(rules.length);
+management.getUserLogs(params, function (err, logs) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logs);
});
@@ -20484,14 +23437,14 @@ Example
- getRulesConfigs(cbopt) → {Promise|undefined}
+ getUserPermissions(params, cbopt) → {Promise|undefined}
- Get rules config.
+ Get user's permissions
@@ -20527,7 +23480,7 @@ getRul
Source:
Parameters:
- cbparams
-function
+Object
@@ -20588,8 +23541,6 @@ Parameters:
- <optional>
-
@@ -20600,159 +23551,166 @@ Parameters:
- Callback function.
+ Get permissions data.
-
-
-
-
-
-
paramsObject
-
-
-
- - - - - - -
Resource Servers 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.getSettings(function (err, settings) {
+ if (err) {
+ // Handle error.
+ }
-management.getResourceServers(params, function (err, resourceServers) {
- console.log(resourceServers.length);
+ console.log(settings);
});
Example
-getRole(params, cbopt) → {Promise|undefined}
+getUser(data, cbopt) → {Promise|undefined}
-
@@ -19335,7 +22302,7 @@ Get an Auth0 role.
+Get a user by its id.
getRoleSource:
Parameters:
- paramsdata
@@ -19406,7 +22373,7 @@ Parameters:
- Role parameters.
+ The user data object.
@@ -19449,7 +22416,7 @@ Parameters:
- Role ID.
+ The user id.
@@ -19544,12 +22511,8 @@ Returns:
Example
- management.getRole({ id: ROLE_ID }, function (err, role) {
- if (err) {
- // Handle error.
- }
-
- console.log(role);
+ management.getUser({ id: USER_ID }, function (err, user) {
+ console.log(user);
});
@@ -19561,14 +22524,14 @@ Example
- getRoles(paramsopt, cbopt) → {Promise|undefined}
+ getUserBlocks(params, cbopt) → {Promise|undefined}
- Get all roles.
+ Get user blocks by its id.
@@ -19604,7 +22567,7 @@ getRolesSource:
Parameters:
- <optional>
-
@@ -19677,7 +22638,7 @@ Parameters:
- Roles parameters.
+ The user data object..
@@ -19691,8 +22652,6 @@ Parameters:
Type
- Attributes
-
@@ -19705,70 +22664,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ The user id.
@@ -19812,7 +22725,7 @@ Parameters:
- Callback function.
+ Callback function
paramsdataParameters:
Role parameters.
+The user data object.
@@ -19449,7 +22416,7 @@Parameters:
Role ID.
+The user id.
Example
-management.getRole({ id: ROLE_ID }, function (err, role) {
- if (err) {
- // Handle error.
- }
-
- console.log(role);
+ management.getUser({ id: USER_ID }, function (err, user) {
+ console.log(user);
});
Get all roles.
+Get user blocks by its id.
Parameters:
- @@ -19677,7 +22638,7 @@
Parameters:
Roles parameters.
+The user data object..
@@ -19691,8 +22652,6 @@Parameters:
Parameters:
per_pageNumber
-
-
-
- - - - - - -
Number of results per page.
- -pageidNumber
+String
- - - - - -
Page number, zero indexed.
+The user id.
Parameters:
Callback function.
+Callback function
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.getUserBlocks({ id: USER_ID }, function (err, blocks) {
+ if (err) {
+ // Handle error.
+ }
-management.getRoles(params, function (err, roles) {
- console.log(roles.length);
+ console.log(blocks);
});
Get an Auth0 rule.
+Get user blocks by its identifier.
Parameters:
Rule parameters.
+The user data object..
@@ -20028,7 +22933,7 @@Parameters:
ididentifierParameters:
Rule ID.
+The user identifier, any of: username, phone_number, email.
Parameters:
Callback function.
+Callback function
Returns:
Example
-management.getRule({ id: RULE_ID }, function (err, rule) {
+ management.getUserBlocksByIdentifier({ identifier: USER_ID }, function (err, blocks) {
if (err) {
// Handle error.
}
- console.log(rule);
+ console.log(blocks);
});
Example
-getRules(paramsopt, cbopt) → {Promise|undefined}
+getUserLogs(params, cbopt) → {Promise|undefined}
-
@@ -20200,7 +23105,7 @@ Get all rules.
+Get user's log events.
getRulesSource:
Parameters:
- <optional>
-
@@ -20273,7 +23176,7 @@ Parameters:
- Rules parameters.
+ Get logs data.
@@ -20287,8 +23190,6 @@ Parameters:
Type
- Attributes
-
@@ -20301,28 +23202,44 @@ Parameters:
- per_pageid
-Number
+String
-
-
- <optional>
-
+
+
+
+ User id.
+
+
+
+
+
+
+ per_page
+
-
+Number
+
+
+
+
+
@@ -20350,21 +23267,63 @@ Parameters:
-
+
+
+
+
+ Page number, zero indexed.
- <optional>
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
- Page number, zero indexed.
+ true if a query summary must be included in the result, false otherwise. Default false;
@@ -20459,20 +23418,14 @@ 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
-};
+ var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-management.getRules(params, function (err, rules) {
- console.log(rules.length);
+management.getUserLogs(params, function (err, logs) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logs);
});
@@ -20484,14 +23437,14 @@ Example
- getRulesConfigs(cbopt) → {Promise|undefined}
+ getUserPermissions(params, cbopt) → {Promise|undefined}
- Get rules config.
+ Get user's permissions
@@ -20527,7 +23480,7 @@ getRul
Source:
Parameters:
- cbparams
-function
+Object
@@ -20588,8 +23541,6 @@ Parameters:
- <optional>
-
@@ -20600,159 +23551,166 @@ Parameters:
- Callback function.
+ Get permissions data.
-
-
-
-
-
- @@ -20273,7 +23176,7 @@
Parameters:
Rules parameters.
+Get logs data.
@@ -20287,8 +23190,6 @@Parameters:
per_pageidNumber
+String
- + + +
User id.
+per_pageNumber
+
+
+
+
+
@@ -20350,21 +23267,63 @@ Parameters:
-Page number, zero indexed.
- <optional>+
sortString
+
+
+
+ The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+include_totalsBoolean
+
+
+
+
+
Page number, zero indexed.
+true if a query summary must be included in the result, false otherwise. Default false;
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
-};
+ var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-management.getRules(params, function (err, rules) {
- console.log(rules.length);
+management.getUserLogs(params, function (err, logs) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logs);
});
Get rules config.
+Get user's permissions
Parameters:
cbparamsfunction
+Object
@@ -20588,8 +23541,6 @@ Parameters:
- @@ -20600,159 +23551,166 @@
Parameters:
Callback function.
+Get permissions data.
-
-
+
+
-
-
-
Returns:
+ +| Name | -Type | + -Description | +
|---|---|---|
id |
+
-
+
+
+String
- // Get Rules Configs.
-});
-
+
+ |
-
+ 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; + + |
+
| Name | - - -Type | - - -Attributes | - - - - -Description | -|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
+ params |
@@ -20966,7 +23926,7 @@ Parameters: |
- The user data object. +Get roles data. @@ -21009,7 +23969,111 @@Parameters: |
- The user id. +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; |
+ <optional> + @@ -21231,7 +24303,7 @@ Parameters: |
- The user data object.. +Users params. @@ -21245,6 +24317,8 @@Parameters: | Type | +Attributes | + @@ -21257,7 +24331,43 @@||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id |
+ search_engine |
+
+
+
+
+
+Number
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ The version of the search engine to use. + + |
+ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q |
@@ -21270,11 +24380,93 @@ Parameters: |
+
+
+ <optional> + + + + + + |
+
- The user id. +User Search string to filter which users are returned. Follows Lucene query string syntax as documented at https://auth0.com/docs/api/management/v2#!/Users/get_users. + + |
+ |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
per_page |
+
+
+
+
+
+Number
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Number of results per page. + + |
+ |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
page |
+
+
+
+
+
+Number
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Page number, zero indexed. |
- Callback function +Callback function. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
params |
+ email |
-Object
+String
@@ -21490,68 +24692,19 @@ Parameters: |
-
-
-
+ <optional> - |
-
-
-
-
- The user data object.. - - -
Email Address of users to locate |
- Callback function +Callback function. |
@@ -21638,12 +24791,13 @@ |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
params |
+ id |
-Object
+String
@@ -21759,6 +24913,8 @@ Parameters: |
+ <optional> + @@ -21769,70 +24925,37 @@ Parameters: |
- Get logs data. +Id of the role - - -
Page number, zero indexed. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
params |
+ data |
@@ -22144,7 +25223,7 @@ Parameters: |
- Get permissions data. +Users import data. @@ -22158,6 +25237,8 @@Parameters: | Type | +Attributes | + @@ -22170,7 +25251,7 @@|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id |
+ connection_id |
@@ -22183,11 +25264,19 @@ Parameters: |
+ + + + + + + | +
- User id. +connection_id of the connection to which users will be imported. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
per_page |
+ users |
-Number
+String
|
+
+
+ <optional> + + + + + + |
+
- Number of results per page. +Path to the users data file. Either users or users_json is mandatory. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
page |
+ users_json |
-Number
+String
|
+
+
+ <optional> + + + + + + |
+
- Page number, zero indexed. +JSON data for the users. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sort |
+ upsert |
-String
+Boolean
|
+
+
+ <optional> + + + + + + |
+
- The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1. +Whether to update users if they already exist (true) or to ignore them (false). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
include_totals |
+ send_completion_email |
@@ -22287,11 +25406,21 @@ Parameters: |
+
+
+ <optional> + + + + + + |
+
- true if a query summary must be included in the result, false otherwise. Default false; +Whether to send a completion email to all tenant owners when the job is finished (true) or not (false). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
params |
+ userId |
-Object
+String
@@ -22519,111 +25649,67 @@ Parameters: |
- Get roles data. +ID of the primary user. - - -
|
Primary user ID.
dataproviderParameters:
data object containing list of permission IDs
+Identity provider in use.
- - -| Name | - - -Type | - - - - - -Description | -||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
permissions |
+ user_id |
@@ -25654,7 +28908,7 @@ Parameters: |
- Array of permission IDs +Secondary user ID. |
- params object +The user data object.. @@ -25926,7 +29179,7 @@Parameters: |
- user_id +The user id. |
@@ -25943,13 +29196,13 @@ |||||||
data |
+ metadata |
-String
+Object
@@ -25968,58 +29221,7 @@ Parameters: |
- data object containing list of role IDs - - - -
New app metadata. |
- Callback function. +Callback function |
@@ -26106,15 +29308,18 @@ ||||||||
data |
+ params |
@@ -26240,58 +29445,41 @@ Parameters: |
- User data object. +Branding parameters. - - -
|
+ Updated branding data. |
- Rule Config parameters. - - - -
|
-
-
-
-
- |||||||
data |
-
-
-
-
-
-Object
-
-
-
- |
-
-
- - - - - - - | - - - - -
- Rule Config Data parameters. +Client parameters. @@ -26622,7 +29724,7 @@Parameters: | |||||||||
value |
+ client_id |
@@ -26639,7 +29741,7 @@ Parameters: |
- Rule Config Data value. +Application client ID. |
|||||||||
data |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Updated client data. + + |
+ |||||||||
cb |
@@ -26734,15 +29870,15 @@
- The user data object.. +Client parameters. @@ -26911,7 +30047,7 @@Parameters: |
- The user id. +Client grant ID. |
||||||||||
data |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Updated client data. + + |
+ |||||||||
cb |
@@ -26955,7 +30125,7 @@
- Callback function +Callback function. |
- The user data object.. +Connection parameters. @@ -27163,7 +30340,7 @@Parameters: | ||||||||||
identifier |
+ id |
@@ -27180,7 +30357,7 @@ Parameters: |
- The user identifier, any of: username, phone_number, email. +Connection ID. |
|||||||||
data |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Updated connection data. + + |
+ |||||||||
cb |
@@ -27224,7 +30435,7 @@
- Callback function +Callback function. |
- Linked users data. - - - -
Updated email provider data. |
@@ -27596,14 +30741,13 @@
- The user data object.. +Email Template parameters. @@ -27755,7 +30899,7 @@Parameters: | |||||||||
id |
+ name |
@@ -27772,7 +30916,7 @@ Parameters: |
- The user id. +Template Name |
|||||||||
metadata |
+ data |
@@ -27814,7 +30958,7 @@ Parameters: |
- New app metadata. +Updated Email Template data. |
- Callback function +Callback function. |
@@ -27901,18 +31045,15 @@
- Branding parameters. +Factor provider parameters. |
@@ -28072,7 +31213,7 @@
- Updated branding data. +Updated Factor provider data. |
@@ -28159,13 +31300,12 @@
- Client parameters. +Factor parameters. - + |
+
+
+
+
+ |||||
data |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Updated factor data. + + |
+ |||||||||
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+
+
+
+Example
+ +management.updateGuardianFactor({ name: 'sms' }, {
+ enabled: true
+}, function (err, factor) {
+ console.log(factor);
+});
+
+
+
+
@@ -28305,6 +31642,8 @@
+
+
+
updateGuardianFactorTemplates(params, data, cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Update Guardian enrollment and verification factor templates
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+| Type | +Attributes | + @@ -28317,32 +31656,32 @@|||
|---|---|---|---|---|
client_id |
+ params |
-String
+Object
|
+ + - + - |
- Application client ID. - |
-
Factor parameters.
Updated client data.
+Updated factor templates data.
Example
-var data = { name: 'newClientName' };
-var params = { client_id: CLIENT_ID };
-
-management.updateClient(params, data, function (err, client) {
- if (err) {
- // Handle error.
- }
-
- console.log(client.name); // 'newClientName'
+ management.updateGuardianFactorTemplates({ name: 'sms' }, {
+ enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+}, function (err, templates) {
+ console.log(templates);
});
Update an Auth0 client grant.
+Update the Guardian phone factor's message types
Parameters:
Client parameters.
+Parameters.
+ +dataObject
+
+
+
+ Updated selected provider data.
@@ -28623,13 +31992,13 @@Parameters:
idmessage_typesString
+Array.<String>
@@ -28640,7 +32009,7 @@ Parameters:
Client grant ID.
+Message types (only "sms" and "voice" are supported).
Parameters:
-dataObject
-
-
-
- Updated client data.
- -cbReturns:
Example
-var data = {
- client_id: CLIENT_ID,
- audience: AUDIENCE,
- scope: []
-};
-var params = { id: CLIENT_GRANT_ID };
-
-management.clientGrants.update(params, data, function (err, grant) {
- if (err) {
- // Handle error.
- }
-
- console.log(grant.id);
+ management.updateGuardianPhoneFactorMessageTypes({}, {
+ message_types: ['sms', 'voice']
+}, function (err, factor) {
+ console.log(factor);
});
Example
-updateConnection(params, data, cbopt) → {Promise|undefined}
+updateGuardianPhoneFactorSelectedProvider(params, data, cbopt) → {Promise|undefined}
-
@@ -28836,7 +32162,7 @@ Update an existing connection.
+Update the Guardian phone factor's selected provider
updat
Source:
Parameters:
- Connection parameters.
+ Parameters.
+
+
+
Connection parameters.
+Parameters.
+ +dataObject
+
+
+
+ Updated selected provider data.
@@ -28933,7 +32293,7 @@Parameters:
idproviderParameters:
Connection ID.
+Name of the selected provider
Parameters:
-dataObject
-
-
-
- Updated connection data.
- -cbReturns:
Example
-var data = { name: 'newConnectionName' };
-var params = { id: CONNECTION_ID };
-
-management.updateConnection(params, data, function (err, connection) {
- if (err) {
- // Handle error.
- }
-
- console.log(connection.name); // 'newConnectionName'
+ management.updateGuardianPhoneFactorSelectedProvider({}, {
+ provider: 'twilio'
+}, function (err, factor) {
+ console.log(factor);
});
Example
-updateEmailProvider(params, data, cbopt) → {Promise|undefined}
+updateGuardianPolicies(params, data, cbopt) → {Promise|undefined}
-
@@ -29142,7 +32463,7 @@ Update the email provider.
+Update enabled Guardian policies
up
Source:
Parameters:
- Email provider parameters.
+ Parameters.
Email provider parameters.
+Parameters.
Parameters:
Object
+Array.<String>
@@ -29247,7 +32568,7 @@ Parameters:
Updated email provider data.
+Policies to enable. Empty array disables all policies.
Returns:
Example
-management.updateEmailProvider(params, data, function (err, provider) {
- if (err) {
- // Handle error.
- }
-
- // Updated email provider.
- console.log(provider);
+ management.updateGuardianPolicies({}, [
+ 'all-applications'
+], function (err, policies) {
+ console.log(policies);
});
Example
-updateEmailTemplates(params, data, cbopt) → {Promise|undefined}
+updateHook(params, data, cbopt) → {Promise|undefined}
-
@@ -29395,7 +32713,7 @@ Update an existing Email Template.
+Update an existing hook.
u
Source:
Parameters:
- Email Template parameters.
+ Hook parameters.
@@ -29492,7 +32810,7 @@ Parameters:
- nameid
@@ -29509,7 +32827,7 @@ Parameters:
- Template Name
+ Hook ID.
@@ -29551,7 +32869,7 @@ Parameters:
- Updated Email Template data.
+ Updated hook data.
@@ -29638,15 +32956,14 @@ Returns:
Example
- var data = { from: 'new@email.com' };
-var params = { name: EMAIL_TEMPLATE_NAME };
-
-management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ var params = { id: HOOK_ID };
+var data = { name: 'my-hook'};
+management.updateHook(params, data, function (err, hook) {
if (err) {
// Handle error.
}
- console.log(emailTemplate.from); // 'new@email.com'
+ console.log(hook.name); // 'my-hook'.
});
@@ -29658,7 +32975,7 @@ Example
- updateHook(params, data, cbopt) → {Promise|undefined}
+ updateHookSecrets(params, data, cbopt) → {Promise|undefined}
@@ -29701,7 +33018,7 @@ updateHook<
Source:
Parameters:
- Updated hook data.
+ Secrets key/value pairs
@@ -29945,13 +33262,13 @@ Returns:
Example
var params = { id: HOOK_ID };
-var data = { name: 'my-hook'};
-management.updateHook(params, data, function (err, hook) {
+var data = { API_TOKEN: 'updated-secret'};
+management.updateHookSecrets(params, data, function (err, secrets) {
if (err) {
// Handle error.
}
- console.log(hook.name); // 'my-hook'.
+ console.log(secrets)
});
@@ -29963,14 +33280,14 @@ Example
- updateHookSecrets(params, data, cbopt) → {Promise|undefined}
+ updateMigrations(data, cbopt) → {Promise|undefined}
- Update an existing hook.
+ Update the tenant migrations.
@@ -30006,7 +33323,7 @@ upda
Source:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Hook parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Hook ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
dataParameters:
- Secrets key/value pairs
+ Updated migrations data.
@@ -30249,14 +33481,14 @@ Returns:
Example
- var params = { id: HOOK_ID };
-var data = { API_TOKEN: 'updated-secret'};
-management.updateHookSecrets(params, data, function (err, secrets) {
+ data = { flags: { migration: true } };
+management.updateMigrations(data, function (err, migrations) {
if (err) {
// Handle error.
}
- console.log(secrets)
+// Updated migrations flags
+ console.log(migrations.flags);
});
@@ -30311,7 +33543,7 @@ u
Source:
updateRole<
Source:
updateRule<
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 76a32b605..f8ce1198e 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.MigrationsManager.html b/docs/module-management.MigrationsManager.html
new file mode 100644
index 000000000..97c347c60
--- /dev/null
+++ b/docs/module-management.MigrationsManager.html
@@ -0,0 +1,894 @@
+
+
+
+
+
+ MigrationsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MigrationsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ MigrationsManager
+
+
+ Abstracts interaction with the migrations endpoint.
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new MigrationsManager(options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The client options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ baseUrl
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The URL of the API.
+
+
+
+
+
+
+
+
+ headers
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Headers to be included in all requests.
+
+
+
+
+
+
+
+
+ retry
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Retry Policy Config
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+
+(inner) auth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the migrations endpoint
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ getMigrations(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the tenant migrations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.migrations.getMigrations(function (err, migrations) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(migrations.flags);
+});
+
+
+
+
+
+
+
+
+
+
+ updateMigrations(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the tenant migrations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The tenant migrations to be updated
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ flags
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The tenant migrations flags to be updated
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.migrations.updateMigrations(data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index d450ac7fd..21d4124ea 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index fb5b1d27f..5a3fc2b55 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 961843c93..97ba3fa94 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index f6980c26f..4929adc05 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4293,7 +4293,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 838527adc..c27870d41 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 6dbd96b97..622494998 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 3555a998f..32b369ef9 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 2b6bee0fb..912072b15 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 7d1f5730b..82d4e1e47 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index 8543b95d7..87627110d 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 4f4e00d83..2c8b117f7 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index fb60127dd..6b0291d80 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -110,6 +110,9 @@ Classes
ManagementTokenProvider
+ MigrationsManager
+
+
PromptsManager
@@ -168,7 +171,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 12e5b188c..ee686ea37 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 8106671bc..d316de5ca 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -91,6 +91,9 @@ utils.js
*/
utils.wrapPropertyMethod = function(Parent, name, propertyMethod) {
var path = propertyMethod.split('.');
+ if (path.length > 2) {
+ throw new Error('wrapPropertyMethod() only supports one level of nesting for propertyMethod');
+ }
var property = path.shift();
var method = path.pop();
@@ -138,7 +141,7 @@ utils.js
diff --git a/package.json b/package.json
index c6cecbc29..8461fcac2 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.26.0",
+ "version": "2.27.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
Email Template parameters.
+Hook parameters.
@@ -29492,7 +32810,7 @@Parameters:
nameidParameters:
Template Name
+Hook ID.
Updated Email Template data.
+Updated hook data.
Example
-var data = { from: 'new@email.com' };
-var params = { name: EMAIL_TEMPLATE_NAME };
-
-management.updateEmailTemplates(params, data, function (err, emailTemplate) {
+ var params = { id: HOOK_ID };
+var data = { name: 'my-hook'};
+management.updateHook(params, data, function (err, hook) {
if (err) {
// Handle error.
}
- console.log(emailTemplate.from); // 'new@email.com'
+ console.log(hook.name); // 'my-hook'.
});
Parameters:
Updated hook data.
+Secrets key/value pairs
Returns:
Example
var params = { id: HOOK_ID };
-var data = { name: 'my-hook'};
-management.updateHook(params, data, function (err, hook) {
+var data = { API_TOKEN: 'updated-secret'};
+management.updateHookSecrets(params, data, function (err, secrets) {
if (err) {
// Handle error.
}
- console.log(hook.name); // 'my-hook'.
+ console.log(secrets)
});Example
-updateHookSecrets(params, data, cbopt) → {Promise|undefined}
+updateMigrations(data, cbopt) → {Promise|undefined}
-
@@ -30006,7 +33323,7 @@ Update an existing hook.
+Update the tenant migrations.
upda
Source:
Parameters:
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Hook parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Hook ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
dataParameters:
- Secrets key/value pairs
+ Updated migrations data.
@@ -30249,14 +33481,14 @@ Returns:
Example
- var params = { id: HOOK_ID };
-var data = { API_TOKEN: 'updated-secret'};
-management.updateHookSecrets(params, data, function (err, secrets) {
+ data = { flags: { migration: true } };
+management.updateMigrations(data, function (err, migrations) {
if (err) {
// Handle error.
}
- console.log(secrets)
+// Updated migrations flags
+ console.log(migrations.flags);
});
@@ -30311,7 +33543,7 @@ u
Source:
updateRole<
Source:
updateRule<
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 76a32b605..f8ce1198e 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.MigrationsManager.html b/docs/module-management.MigrationsManager.html
new file mode 100644
index 000000000..97c347c60
--- /dev/null
+++ b/docs/module-management.MigrationsManager.html
@@ -0,0 +1,894 @@
+
+
+
+
+
+ MigrationsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MigrationsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ MigrationsManager
+
+
+ Abstracts interaction with the migrations endpoint.
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new MigrationsManager(options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The client options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ baseUrl
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The URL of the API.
+
+
+
+
+
+
+
+
+ headers
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Headers to be included in all requests.
+
+
+
+
+
+
+
+
+ retry
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Retry Policy Config
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+
+(inner) auth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the migrations endpoint
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ getMigrations(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the tenant migrations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.migrations.getMigrations(function (err, migrations) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(migrations.flags);
+});
+
+
+
+
+
+
+
+
+
+
+ updateMigrations(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the tenant migrations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The tenant migrations to be updated
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ flags
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The tenant migrations flags to be updated
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.migrations.updateMigrations(data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index d450ac7fd..21d4124ea 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index fb5b1d27f..5a3fc2b55 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 961843c93..97ba3fa94 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index f6980c26f..4929adc05 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4293,7 +4293,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 838527adc..c27870d41 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 6dbd96b97..622494998 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 3555a998f..32b369ef9 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 2b6bee0fb..912072b15 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 7d1f5730b..82d4e1e47 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index 8543b95d7..87627110d 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 4f4e00d83..2c8b117f7 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index fb60127dd..6b0291d80 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -110,6 +110,9 @@ Classes
ManagementTokenProvider
+ MigrationsManager
+
+
PromptsManager
@@ -168,7 +171,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 12e5b188c..ee686ea37 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 8106671bc..d316de5ca 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -91,6 +91,9 @@ utils.js
*/
utils.wrapPropertyMethod = function(Parent, name, propertyMethod) {
var path = propertyMethod.split('.');
+ if (path.length > 2) {
+ throw new Error('wrapPropertyMethod() only supports one level of nesting for propertyMethod');
+ }
var property = path.shift();
var method = path.pop();
@@ -138,7 +141,7 @@ utils.js
diff --git a/package.json b/package.json
index c6cecbc29..8461fcac2 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.26.0",
+ "version": "2.27.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
paramsObject
-
-
-
- Hook parameters.
- - - -| Name | - - -Type | - - - - - -Description | -
|---|---|---|
id |
-
-
-
-
-
-String
-
-
-
- |
-
-
-
-
-
-
- Hook ID. - - |
-
dataParameters:
Secrets key/value pairs
+Updated migrations data.
Example
-var params = { id: HOOK_ID };
-var data = { API_TOKEN: 'updated-secret'};
-management.updateHookSecrets(params, data, function (err, secrets) {
+ data = { flags: { migration: true } };
+management.updateMigrations(data, function (err, migrations) {
if (err) {
// Handle error.
}
- console.log(secrets)
+// Updated migrations flags
+ console.log(migrations.flags);
});
updateRole<
Source:
updateRule<
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 76a32b605..f8ce1198e 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.MigrationsManager.html b/docs/module-management.MigrationsManager.html
new file mode 100644
index 000000000..97c347c60
--- /dev/null
+++ b/docs/module-management.MigrationsManager.html
@@ -0,0 +1,894 @@
+
+
+
+
+
+ MigrationsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MigrationsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ MigrationsManager
+
+
+ Abstracts interaction with the migrations endpoint.
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new MigrationsManager(options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The client options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ baseUrl
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The URL of the API.
+
+
+
+
+
+
+
+
+ headers
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Headers to be included in all requests.
+
+
+
+
+
+
+
+
+ retry
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Retry Policy Config
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+
+(inner) auth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the migrations endpoint
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ getMigrations(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the tenant migrations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.migrations.getMigrations(function (err, migrations) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(migrations.flags);
+});
+
+
+
+
+
+
+
+
+
+
+ updateMigrations(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the tenant migrations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The tenant migrations to be updated
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ flags
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The tenant migrations flags to be updated
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.migrations.updateMigrations(data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index d450ac7fd..21d4124ea 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index fb5b1d27f..5a3fc2b55 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 961843c93..97ba3fa94 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index f6980c26f..4929adc05 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4293,7 +4293,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 838527adc..c27870d41 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 6dbd96b97..622494998 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 3555a998f..32b369ef9 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 2b6bee0fb..912072b15 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 7d1f5730b..82d4e1e47 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index 8543b95d7..87627110d 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 4f4e00d83..2c8b117f7 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index fb60127dd..6b0291d80 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -110,6 +110,9 @@ Classes
ManagementTokenProvider
+ MigrationsManager
+
+
PromptsManager
@@ -168,7 +171,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 12e5b188c..ee686ea37 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 8106671bc..d316de5ca 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -91,6 +91,9 @@ utils.js
*/
utils.wrapPropertyMethod = function(Parent, name, propertyMethod) {
var path = propertyMethod.split('.');
+ if (path.length > 2) {
+ throw new Error('wrapPropertyMethod() only supports one level of nesting for propertyMethod');
+ }
var property = path.shift();
var method = path.pop();
@@ -138,7 +141,7 @@ utils.js
diff --git a/package.json b/package.json
index c6cecbc29..8461fcac2 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.26.0",
+ "version": "2.27.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
u
Source:
updateUser<
Source:
upd
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 76a32b605..f8ce1198e 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.MigrationsManager.html b/docs/module-management.MigrationsManager.html
new file mode 100644
index 000000000..97c347c60
--- /dev/null
+++ b/docs/module-management.MigrationsManager.html
@@ -0,0 +1,894 @@
+
+
+
+
+
+ MigrationsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MigrationsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ MigrationsManager
+
+
+ Abstracts interaction with the migrations endpoint.
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new MigrationsManager(options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The client options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ baseUrl
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The URL of the API.
+
+
+
+
+
+
+
+
+ headers
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Headers to be included in all requests.
+
+
+
+
+
+
+
+
+ retry
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Retry Policy Config
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+
+(inner) auth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the migrations endpoint
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ getMigrations(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the tenant migrations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.migrations.getMigrations(function (err, migrations) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(migrations.flags);
+});
+
+
+
+
+
+
+
+
+
+
+ updateMigrations(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the tenant migrations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The tenant migrations to be updated
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ flags
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The tenant migrations flags to be updated
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.migrations.updateMigrations(data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index d450ac7fd..21d4124ea 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index fb5b1d27f..5a3fc2b55 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 961843c93..97ba3fa94 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index f6980c26f..4929adc05 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4293,7 +4293,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 838527adc..c27870d41 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 6dbd96b97..622494998 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 3555a998f..32b369ef9 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 2b6bee0fb..912072b15 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 7d1f5730b..82d4e1e47 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index 8543b95d7..87627110d 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 4f4e00d83..2c8b117f7 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index fb60127dd..6b0291d80 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -110,6 +110,9 @@ Classes
ManagementTokenProvider
+ MigrationsManager
+
+
PromptsManager
@@ -168,7 +171,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 12e5b188c..ee686ea37 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 8106671bc..d316de5ca 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -91,6 +91,9 @@ utils.js
*/
utils.wrapPropertyMethod = function(Parent, name, propertyMethod) {
var path = propertyMethod.split('.');
+ if (path.length > 2) {
+ throw new Error('wrapPropertyMethod() only supports one level of nesting for propertyMethod');
+ }
var property = path.shift();
var method = path.pop();
@@ -138,7 +141,7 @@ utils.js
diff --git a/package.json b/package.json
index c6cecbc29..8461fcac2 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.26.0",
+ "version": "2.27.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
upd
Source:
ver
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 76a32b605..f8ce1198e 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@ Returns:
diff --git a/docs/module-management.MigrationsManager.html b/docs/module-management.MigrationsManager.html
new file mode 100644
index 000000000..97c347c60
--- /dev/null
+++ b/docs/module-management.MigrationsManager.html
@@ -0,0 +1,894 @@
+
+
+
+
+
+ MigrationsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MigrationsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ MigrationsManager
+
+
+ Abstracts interaction with the migrations endpoint.
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new MigrationsManager(options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The client options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ baseUrl
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The URL of the API.
+
+
+
+
+
+
+
+
+ headers
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Headers to be included in all requests.
+
+
+
+
+
+
+
+
+ retry
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Retry Policy Config
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+
+(inner) auth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the migrations endpoint
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ getMigrations(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get the tenant migrations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.migrations.getMigrations(function (err, migrations) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(migrations.flags);
+});
+
+
+
+
+
+
+
+
+
+
+ updateMigrations(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Update the tenant migrations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The tenant migrations to be updated
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ flags
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The tenant migrations flags to be updated
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.migrations.updateMigrations(data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html
index d450ac7fd..21d4124ea 100644
--- a/docs/module-management.PromptsManager.html
+++ b/docs/module-management.PromptsManager.html
@@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@ Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index fb5b1d27f..5a3fc2b55 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 961843c93..97ba3fa94 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@ Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
index f6980c26f..4929adc05 100644
--- a/docs/module-management.RolesManager.html
+++ b/docs/module-management.RolesManager.html
@@ -24,7 +24,7 @@
@@ -4293,7 +4293,7 @@ Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 838527adc..c27870d41 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 6dbd96b97..622494998 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 3555a998f..32b369ef9 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 2b6bee0fb..912072b15 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 7d1f5730b..82d4e1e47 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@ Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index 8543b95d7..87627110d 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 4f4e00d83..2c8b117f7 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index fb60127dd..6b0291d80 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -110,6 +110,9 @@ Classes
ManagementTokenProvider
+ MigrationsManager
+
+
PromptsManager
@@ -168,7 +171,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 12e5b188c..ee686ea37 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 8106671bc..d316de5ca 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -91,6 +91,9 @@ utils.js
*/
utils.wrapPropertyMethod = function(Parent, name, propertyMethod) {
var path = propertyMethod.split('.');
+ if (path.length > 2) {
+ throw new Error('wrapPropertyMethod() only supports one level of nesting for propertyMethod');
+ }
var property = path.shift();
var method = path.pop();
@@ -138,7 +141,7 @@ utils.js
diff --git a/package.json b/package.json
index c6cecbc29..8461fcac2 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.26.0",
+ "version": "2.27.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html index 76a32b605..f8ce1198e 100644 --- a/docs/module-management.ManagementTokenProvider.html +++ b/docs/module-management.ManagementTokenProvider.html @@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@
diff --git a/docs/module-management.MigrationsManager.html b/docs/module-management.MigrationsManager.html new file mode 100644 index 000000000..97c347c60 --- /dev/null +++ b/docs/module-management.MigrationsManager.html @@ -0,0 +1,894 @@ + + + + + +MigrationsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + + + + + + \ No newline at end of file diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html index d450ac7fd..21d4124ea 100644 --- a/docs/module-management.PromptsManager.html +++ b/docs/module-management.PromptsManager.html @@ -24,7 +24,7 @@
Returns:
diff --git a/docs/module-management.MigrationsManager.html b/docs/module-management.MigrationsManager.html new file mode 100644 index 000000000..97c347c60 --- /dev/null +++ b/docs/module-management.MigrationsManager.html @@ -0,0 +1,894 @@ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+MigrationsManager
+ + + + + + + ++ management. + + MigrationsManager +
+ +Abstracts interaction with the migrations endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+ + +new MigrationsManager(options)
+ + + + + + + + + +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+
+
+
+
+ The client options. + + + +
|
+
Members
+ + + +
+
+
+
+
+
+
+ (inner) auth0RestClient :external:RestClient
+ + + + +
+
+
+
+
+
+
+Provides an abstraction layer for consuming the migrations endpoint
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Type:
+-
+
-
+
+
external:RestClient+ + +
+
Methods
+ + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+getMigrations(cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Get the tenant migrations.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +
|---|---|---|---|
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+Example
+ +management.migrations.getMigrations(function (err, migrations) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(migrations.flags);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+updateMigrations(data, cbopt) → {Promise|undefined}
+ + + + + +
+
+
+
+
+
+
+Update the tenant migrations.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +||||||
|---|---|---|---|---|---|---|---|---|---|
data |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ The tenant migrations to be updated + + + +
|
+ ||||||
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
+
+
+
+
+Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise+| + +undefined+ + +
+
+
+
+Example
+ +management.migrations.updateMigrations(data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+});+ + + + + + + \ No newline at end of file diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html index d450ac7fd..21d4124ea 100644 --- a/docs/module-management.PromptsManager.html +++ b/docs/module-management.PromptsManager.html @@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html index fb5b1d27f..5a3fc2b55 100644 --- a/docs/module-management.ResourceServersManager.html +++ b/docs/module-management.ResourceServersManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html index fb5b1d27f..5a3fc2b55 100644 --- a/docs/module-management.ResourceServersManager.html +++ b/docs/module-management.ResourceServersManager.html @@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html index 961843c93..97ba3fa94 100644 --- a/docs/module-management.RetryRestClient.html +++ b/docs/module-management.RetryRestClient.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html index 961843c93..97ba3fa94 100644 --- a/docs/module-management.RetryRestClient.html +++ b/docs/module-management.RetryRestClient.html @@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html index f6980c26f..4929adc05 100644 --- a/docs/module-management.RolesManager.html +++ b/docs/module-management.RolesManager.html @@ -24,7 +24,7 @@
Parameters:
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html index f6980c26f..4929adc05 100644 --- a/docs/module-management.RolesManager.html +++ b/docs/module-management.RolesManager.html @@ -24,7 +24,7 @@
@@ -4293,7 +4293,7 @@
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html index 838527adc..c27870d41 100644 --- a/docs/module-management.RulesConfigsManager.html +++ b/docs/module-management.RulesConfigsManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html index 838527adc..c27870d41 100644 --- a/docs/module-management.RulesConfigsManager.html +++ b/docs/module-management.RulesConfigsManager.html @@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html index 6dbd96b97..622494998 100644 --- a/docs/module-management.RulesManager.html +++ b/docs/module-management.RulesManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html index 6dbd96b97..622494998 100644 --- a/docs/module-management.RulesManager.html +++ b/docs/module-management.RulesManager.html @@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html index 3555a998f..32b369ef9 100644 --- a/docs/module-management.StatsManager.html +++ b/docs/module-management.StatsManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html index 3555a998f..32b369ef9 100644 --- a/docs/module-management.StatsManager.html +++ b/docs/module-management.StatsManager.html @@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html index 2b6bee0fb..912072b15 100644 --- a/docs/module-management.TenantManager.html +++ b/docs/module-management.TenantManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html index 2b6bee0fb..912072b15 100644 --- a/docs/module-management.TenantManager.html +++ b/docs/module-management.TenantManager.html @@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html index 7d1f5730b..82d4e1e47 100644 --- a/docs/module-management.TicketsManager.html +++ b/docs/module-management.TicketsManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html index 7d1f5730b..82d4e1e47 100644 --- a/docs/module-management.TicketsManager.html +++ b/docs/module-management.TicketsManager.html @@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html index 8543b95d7..87627110d 100644 --- a/docs/module-management.UserBlocksManager.html +++ b/docs/module-management.UserBlocksManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html index 8543b95d7..87627110d 100644 --- a/docs/module-management.UserBlocksManager.html +++ b/docs/module-management.UserBlocksManager.html @@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html index 4f4e00d83..2c8b117f7 100644 --- a/docs/module-management.UsersManager.html +++ b/docs/module-management.UsersManager.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html index 4f4e00d83..2c8b117f7 100644 --- a/docs/module-management.UsersManager.html +++ b/docs/module-management.UsersManager.html @@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@
diff --git a/docs/module-management.html b/docs/module-management.html index fb60127dd..6b0291d80 100644 --- a/docs/module-management.html +++ b/docs/module-management.html @@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.html b/docs/module-management.html index fb60127dd..6b0291d80 100644 --- a/docs/module-management.html +++ b/docs/module-management.html @@ -24,7 +24,7 @@
@@ -110,6 +110,9 @@ ManagementTokenProvider
+ MigrationsManager
+
+
PromptsManager
@@ -168,7 +171,7 @@
diff --git a/docs/module-utils.html b/docs/module-utils.html index 12e5b188c..ee686ea37 100644 --- a/docs/module-utils.html +++ b/docs/module-utils.html @@ -24,7 +24,7 @@
Classes
Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html index 12e5b188c..ee686ea37 100644 --- a/docs/module-utils.html +++ b/docs/module-utils.html @@ -24,7 +24,7 @@
@@ -363,7 +363,7 @@ (static)
(static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index 8106671bc..d316de5ca 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -91,6 +91,9 @@ utils.js
*/
utils.wrapPropertyMethod = function(Parent, name, propertyMethod) {
var path = propertyMethod.split('.');
+ if (path.length > 2) {
+ throw new Error('wrapPropertyMethod() only supports one level of nesting for propertyMethod');
+ }
var property = path.shift();
var method = path.pop();
@@ -138,7 +141,7 @@ utils.js
diff --git a/package.json b/package.json
index c6cecbc29..8461fcac2 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.26.0",
+ "version": "2.27.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": [
utils.js
*/ utils.wrapPropertyMethod = function(Parent, name, propertyMethod) { var path = propertyMethod.split('.'); + if (path.length > 2) { + throw new Error('wrapPropertyMethod() only supports one level of nesting for propertyMethod'); + } var property = path.shift(); var method = path.pop(); @@ -138,7 +141,7 @@utils.js
diff --git a/package.json b/package.json index c6cecbc29..8461fcac2 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "auth0", - "version": "2.26.0", + "version": "2.27.0", "description": "SDK for Auth0 API v2", "main": "src/index.js", "files": [