RetryRestClient.js
diff --git a/docs/auth_DatabaseAuthenticator.js.html b/docs/auth_DatabaseAuthenticator.js.html index 9cfabf416..81b0a5a0a 100644 --- a/docs/auth_DatabaseAuthenticator.js.html +++ b/docs/auth_DatabaseAuthenticator.js.html @@ -24,7 +24,7 @@
auth/DatabaseAuthenticator.js
* @param {Object} data User credentials object. * @param {String} data.email User email address. * @param {String} data.password User password. - * @param {Stinrg} data.connection Identity provider in use. + * @param {String} data.connection Identity provider in use. * @param {Function} [cb] Method callback. * * @return {Promise|undefined} @@ -345,7 +345,7 @@auth/DatabaseAuthenticator.js
diff --git a/docs/auth_OAUthWithIDTokenValidation.js.html b/docs/auth_OAUthWithIDTokenValidation.js.html index c8d5b0180..ec4acfc0a 100644 --- a/docs/auth_OAUthWithIDTokenValidation.js.html +++ b/docs/auth_OAUthWithIDTokenValidation.js.html @@ -24,7 +24,7 @@
auth/OAUthWithIDTokenValidation.js
var ArgumentError = require('rest-facade').ArgumentError; +var HS256_IGNORE_VALIDATION_MESSAGE = + 'Validation of `id_token` requires a `clientSecret` when using the HS256 algorithm. To ensure tokens are validated, please switch the signing algorithm to RS256 or provide a `clientSecret` in the constructor.'; + /** * @class * Abstracts the `oauth.create` method with additional id_token validation @@ -99,6 +102,9 @@auth/OAUthWithIDTokenValidation.js
if (r.id_token) { function getKey(header, callback) { if (header.alg === 'HS256') { + if (!_this.clientSecret) { + return callback({ message: HS256_IGNORE_VALIDATION_MESSAGE }); + } return callback(null, Buffer.from(_this.clientSecret, 'base64')); } _this._jwksClient.getSigningKey(header.kid, function(err, key) { @@ -118,11 +124,15 @@auth/OAUthWithIDTokenValidation.js
audience: this.clientId, issuer: 'https://' + this.domain + '/' }, - function(err, payload) { - if (err) { - return rej(err); + function(err) { + if (!err) { + return res(r); + } + if (err.message && err.message.includes(HS256_IGNORE_VALIDATION_MESSAGE)) { + console.warn(HS256_IGNORE_VALIDATION_MESSAGE); + return res(r); } - return res(r); + return rej(err); } ); }); @@ -148,7 +158,7 @@auth/OAUthWithIDTokenValidation.js
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html index 31055ed63..727dcef3b 100644 --- a/docs/auth_OAuthAuthenticator.js.html +++ b/docs/auth_OAuthAuthenticator.js.html @@ -24,7 +24,7 @@
auth/OAuthAuthenticator.js
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html index 49e45b1be..88599915d 100644 --- a/docs/auth_PasswordlessAuthenticator.js.html +++ b/docs/auth_PasswordlessAuthenticator.js.html @@ -24,7 +24,7 @@
auth/PasswordlessAuthenticator.js
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html index dab714d38..2cc6f4c80 100644 --- a/docs/auth_TokensManager.js.html +++ b/docs/auth_TokensManager.js.html @@ -24,7 +24,7 @@
auth/TokensManager.js
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html index 49fa17592..65d309b9d 100644 --- a/docs/auth_UsersManager.js.html +++ b/docs/auth_UsersManager.js.html @@ -24,7 +24,7 @@
auth/UsersManager.js
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html index 09545aa68..15aacbf37 100644 --- a/docs/auth_index.js.html +++ b/docs/auth_index.js.html @@ -24,7 +24,7 @@
auth/index.js
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html index 65462a15f..4975cbc43 100644 --- a/docs/external-RestClient.html +++ b/docs/external-RestClient.html @@ -24,7 +24,7 @@
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
diff --git a/docs/index.html b/docs/index.html
index 284900d46..35675c193 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -151,7 +151,7 @@ License
This project is licensed under the MIT license. See the
diff --git a/docs/index.js.html b/docs/index.js.html
index 1c8d473a0..9e941863c 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 48fdcb021..57186a500 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_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index 02d124357..090f03820 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 ee848a5a2..c8a415528 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 15c95b0b1..70edd7e7a 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index 09e419d59..8940d287b 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 f5dc2e012..9f64551f5 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 38f961049..276f60672 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -132,7 +132,10 @@ management/EmailProviderManager.js
* });
*
* @param {Function} [cb] Callback function.
- *
+ * @param {Object} [params] Clients parameters.
+ * @param {Number} [params.fields] A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
+ * @param {Number} [params.include_fields] true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(EmailProviderManager, 'get', 'resource.getAll');
@@ -195,7 +198,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index b926f4b92..1d5725300 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_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index fd969d25b..3afa11710 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 0b1a0388d..409665611 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -98,6 +98,19 @@ management/JobsManager.js
options.tokenProvider
);
this.jobs = new RetryRestClient(auth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for consuming the
+ * {@link https://auth0.com/docs/api/v2#!/Jobs/post_users_exports Create job to export users endpoint}
+ *
+ * @type {external:RestClient}
+ */
+ const usersExportsRestClient = new Auth0RestClient(
+ options.baseUrl + '/jobs/users-exports',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.usersExports = new RetryRestClient(usersExportsRestClient, options.retry);
};
/**
@@ -155,7 +168,7 @@ management/JobsManager.js
* send_completion_email: false //optional
* };
*
- * management.jobs.get(params, function (err) {
+ * management.jobs.importUsers(params, function (err) {
* if (err) {
* // Handle error.
* }
@@ -235,6 +248,63 @@ management/JobsManager.js
return promise;
};
+/**
+ * Export all users to a file using a long running job.
+ *
+ * @method exportUsers
+ * @memberOf module:management.JobsManager.prototype
+ *
+ * @example
+ * var data = {
+ * connection_id: 'con_0000000000000001',
+ * format: 'csv',
+ * limit: 5,
+ * fields: [
+ * {
+ * "name": "user_id"
+ * },
+ * {
+ * "name": "name"
+ * },
+ * {
+ * "name": "email"
+ * },
+ * {
+ * "name": "identities[0].connection",
+ * "export_as": "provider"
+ * },
+ * {
+ * "name": "user_metadata.some_field"
+ * }
+ * ]
+ * }
+ *
+ * management.jobs.exportUsers(data, function (err, results) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Retrieved job.
+ * console.log(results);
+ * });
+ *
+ * @param {Object} data Users export data.
+ * @param {String} [data.connection_id] The connection id of the connection from which users will be exported
+ * @param {String} [data.format] The format of the file. Valid values are: "json" and "csv".
+ * @param {Number} [data.limit] Limit the number of records.
+ * @param {Object[]} [data.fields] A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+JobsManager.prototype.exportUsers = function(data, cb) {
+ if (cb && cb instanceof Function) {
+ return this.usersExports.create(data, cb);
+ }
+
+ return this.usersExports.create(data);
+};
+
/**
* Send a verification email to a user.
*
@@ -284,7 +354,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 6c9f5b9ea..02b71be8d 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 2b5b18db8..61a6fa94b 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -189,7 +189,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index 3cfaa5da4..fafbb3aca 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_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index 18de21ac5..439658b62 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
@@ -179,7 +179,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 8f51c048f..93eae695b 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 aff6e68c8..6ef638d33 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 2a14fe60a..25f65f66b 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -161,7 +161,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index ce0b83bb6..03451ef26 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_UsersManager.js.html b/docs/management_UsersManager.js.html
index 76adaeaa4..e09e07ad9 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -677,7 +677,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index 9e4daa584..a94ca9567 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -599,8 +599,8 @@ management/index.js
/**
* Get all Auth0 Client Grants.
*
- * @method getAll
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method getClientGrants
+ * @memberOf module:management.ManagementClient.prototype
*
* @example <caption>
* This method takes an optional object as first argument that may be used to
@@ -630,8 +630,8 @@ management/index.js
/**
* Create an Auth0 client grant.
*
- * @method create
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method createClientGrant
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.clientGrants.create(data, function (err) {
@@ -652,8 +652,8 @@ management/index.js
/**
* Update an Auth0 client grant.
*
- * @method update
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method updateClientGrant
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* var data = {
@@ -683,8 +683,8 @@ management/index.js
/**
* Delete an Auth0 client grant.
*
- * @method delete
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method deleteClientGrant
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.clientGrants.delete({ id: GRANT_ID }, function (err) {
@@ -1430,7 +1430,10 @@ management/index.js
* });
*
* @param {Function} [cb] Callback function.
- *
+ * @param {Object} [params] Clients parameters.
+ * @param {Number} [params.fields] A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
+ * @param {Number} [params.include_fields] true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(ManagementClient, 'getEmailProvider', 'emailProvider.get');
@@ -1649,6 +1652,57 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'importUsers', 'jobs.importUsers');
+/**
+ * Export all users to a file using a long running job.
+ *
+ * @method exportUsers
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var data = {
+ * connection_id: 'con_0000000000000001',
+ * format: 'csv',
+ * limit: 5,
+ * fields: [
+ * {
+ * "name": "user_id"
+ * },
+ * {
+ * "name": "name"
+ * },
+ * {
+ * "name": "email"
+ * },
+ * {
+ * "name": "identities[0].connection",
+ * "export_as": "provider"
+ * },
+ * {
+ * "name": "user_metadata.some_field"
+ * }
+ * ]
+ * }
+ *
+ * management.exportUsers(data, function (err, results) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Retrieved job.
+ * console.log(results);
+ * });
+ *
+ * @param {Object} data Users export data.
+ * @param {String} [data.connection_id] The connection id of the connection from which users will be exported
+ * @param {String} [data.format] The format of the file. Valid values are: "json" and "csv".
+ * @param {Number} [data.limit] Limit the number of records.
+ * @param {Object[]} [data.fields] A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'exportUsers', 'jobs.exportUsers');
+
/**
* Send a verification email to a user.
*
@@ -1982,8 +2036,8 @@ management/index.js
/**
* Create an Auth0 Custom Domain.
*
- * @method create
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method createCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.createCustomDomain(data, function (err) {
@@ -2004,8 +2058,8 @@ management/index.js
/**
* Get all Auth0 CustomDomains.
*
- * @method getAll
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method getCustomDomains
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.getCustomDomains(function (err, customDomains) {
@@ -2019,8 +2073,8 @@ management/index.js
/**
* Get a Custom Domain.
*
- * @method get
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method getCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
@@ -2042,8 +2096,8 @@ management/index.js
/**
* Verify a Custom Domain.
*
- * @method verify
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method verifyCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
@@ -2065,8 +2119,8 @@ management/index.js
/**
* Delete a Custom Domain.
*
- * @method delete
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method deleteCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
@@ -2089,7 +2143,7 @@ management/index.js
* Create a Guardian enrollment ticket.
*
* @method createGuardianEnrollmentTicket
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.createGuardianEnrollmentTicket(function (err, ticket) {
@@ -2110,7 +2164,7 @@ management/index.js
* Get a list of Guardian factors and statuses.
*
* @method getGuardianFactors
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.getGuardianFactors(function (err, factors) {
* console.log(factors.length);
@@ -2126,7 +2180,7 @@ management/index.js
* Get Guardian factor provider configuration
*
* @method getGuardianFactorProvider
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
* console.log(provider);
@@ -2147,7 +2201,7 @@ management/index.js
* Update Guardian's factor provider
*
* @method updateFactorProvider
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
* messaging_service_sid: 'XXXXXXXXXXXXXX',
@@ -2173,7 +2227,7 @@ management/index.js
* Get Guardian enrollment and verification factor templates
*
* @method getGuardianFactorTemplates
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
* console.log(templates);
@@ -2194,7 +2248,7 @@ management/index.js
* Update Guardian enrollment and verification factor templates
*
* @method updateGuardianFactorTemplates
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.updateGuardianFactorTemplates({ name: 'sms' }, {
* enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
@@ -2219,7 +2273,7 @@ management/index.js
* Update Guardian Factor
*
* @method updateGuardianFactor
- * @memberOf module.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.updateGuardianFactor({ name: 'sms' }, {
* enabled: true
@@ -2248,7 +2302,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index fb612176b..3759ff8a2 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -3894,7 +3894,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index b7b29e7b2..64f95eedb 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1590,7 +1590,7 @@ Parameters:
-Stinrg
+String
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index 8697b3777..f161a65ee 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -101,7 +101,7 @@ Source:
Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 1a653544b..9aec2c527 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1796,7 +1796,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index e81cdc6c4..e20079a2c 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index 97a1daf27..c01be4808 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 1b625dd20..f35ae1e47 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 249e89209..cc295c8ec 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-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 0451d5674..094d54110 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.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index dee679a9a..a14a07f8c 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -717,1097 +717,14 @@ Example
- create(data, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Create an Auth0 client grant.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The client data object.
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.clientGrants.create(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Client grant created.
-});
-
-
-
-
-
-
-
-
-
-
- delete(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Delete an Auth0 client grant.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Client parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Client grant ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.clientGrants.delete({ id: GRANT_ID }, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Grant deleted.
-});
-
-
-
-
-
-
-
-
-
-
- delete(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Delete an Auth0 client grant.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Client parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Client grant ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.clientGrants.delete({ id: GRANT_ID }, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Grant deleted.
-});
-
-
-
-
-
-
-
-
-
-
- getAll(paramsopt, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get all Auth0 Client Grants.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Client Grants 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.getClientGrants(params, function (err, grants) {
- console.log(grants.length);
-});
-
-
-
-
-
-
-
-
-
-
- getAll(paramsopt, cbopt) → {Promise|undefined}
+ delete(params, cbopt) → {Promise|undefined}
- Get all Auth0 Client Grants.
+ Delete an Auth0 client grant.
@@ -1843,7 +760,7 @@ getAllSource:
Parameters:
- <optional>
-
@@ -1916,7 +831,7 @@ Parameters:
- Client Grants parameters.
+ Client parameters.
@@ -1930,8 +845,6 @@ Parameters:
Type
- Attributes
-
@@ -1944,70 +857,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ Client grant ID.
@@ -2102,21 +969,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.clientGrants.delete({ id: GRANT_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
-management.clientGrants.getAll(params, function (err, grants) {
- console.log(grants.length);
+ // Grant deleted.
});
@@ -2128,14 +986,14 @@ Example
- update(params, data, cbopt) → {Promise|undefined}
+ getAll(paramsopt, cbopt) → {Promise|undefined}
- Update an Auth0 client grant.
+ Get all Auth0 Client Grants.
@@ -2171,7 +1029,7 @@ updateSource:
Parameters:
+ <optional>
+
@@ -2242,7 +1102,7 @@ Parameters:
- Client parameters.
+ Client Grants parameters.
@@ -2256,6 +1116,8 @@ Parameters:
Type
+ Attributes
+
@@ -2268,32 +1130,34 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
-
+
-
- Client grant ID.
-
-
+
+
-
-
-
+
+
+ Number of results per page.
@@ -2302,13 +1166,13 @@ Parameters:
- datapage
-Object
+Number
@@ -2317,6 +1181,8 @@ Parameters:
+ <optional>
+
@@ -2327,7 +1193,15 @@ Parameters:
- Updated client data.
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
@@ -2414,19 +1288,21 @@ Returns:
Example
- var data = {
- client_id: CLIENT_ID,
- audience: AUDIENCE,
- scope: []
+
+ 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: CLIENT_GRANT_ID };
-management.clientGrants.update(params, data, function (err, grant) {
- if (err) {
- // Handle error.
- }
- console.log(grant.id);
+management.clientGrants.getAll(params, function (err, grants) {
+ console.log(grants.length);
});
@@ -2760,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 02612947b..0b77f92d1 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 7ebfbcc77..c6a8da76d 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 6c4def656..c61671616 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -792,224 +792,6 @@ Example
-
-
-
-
- create(data, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Create an Auth0 Custom Domain.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The custom domain data object.
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.createCustomDomain(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // CustomDomain created.
-});
-
-
-
-
-
-
@@ -1057,7 +839,7 @@ deleteSource:
Returns:
Example
- management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ management.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -1283,14 +1065,14 @@ Example
- delete(params, cbopt) → {Promise|undefined}
+ get(params, cbopt) → {Promise|undefined}
- Delete a Custom Domain.
+ Get a Custom Domain.
@@ -1326,7 +1108,7 @@ deleteSource:
Returns:
Example
- management.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ management.customDomains.get({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
if (err) {
// Handle error.
}
- // CustomDomain deleted.
+ console.log(customDomain);
});
@@ -1552,14 +1334,14 @@ Example
- get(params, cbopt) → {Promise|undefined}
+ getAll() → {Promise|undefined}
- Get a Custom Domain.
+ Get all Auth0 CustomDomains.
@@ -1595,7 +1377,7 @@ getSource:
get
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Custom Domain parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Custom Domain ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
- if (err) {
- // Handle error.
- }
-
- console.log(customDomain);
-});
-
-
-
-
-
-
-
-
-
-
- get(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get a Custom Domain.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Custom Domain parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Custom Domain ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.customDomains.get({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
- if (err) {
- // Handle error.
- }
-
- console.log(customDomain);
-});
-
-
-
-
-
-
-
-
-
-
- getAll() → {Promise|undefined}
-
-
-
-
-
-
- Get all Auth0 CustomDomains.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.getCustomDomains(function (err, customDomains) {
- console.log(customDomains.length);
-});
-
-
-
-
-
-
-
-
-
-
- getAll() → {Promise|undefined}
-
-
-
-
-
-
- Get all Auth0 CustomDomains.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.customDomains.getAll(function (err, customDomains) {
- console.log(customDomains.length);
-});
-
-
-
-
-
-
-
-
-
-
- verify(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Verify a Custom Domain.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Custom Domain parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Custom Domain ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
@@ -2574,12 +1437,8 @@ Returns:
Example
- management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
- if (err) {
- // Handle error.
- }
-
- console.log(customDomain);
+ management.customDomains.getAll(function (err, customDomains) {
+ console.log(customDomains.length);
});
@@ -2872,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index 01d6666b7..c87bb56fc 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 52441ed0a..530ab5dcb 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -759,7 +759,7 @@ deleteSource:
Example
- get(cbopt) → {Promise|undefined}
+ get(cbopt, paramsopt) → {Promise|undefined}
@@ -1022,6 +1022,141 @@ Parameters:
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Clients parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ fields
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
+
+
+
+
+
+
+
+
+ include_fields
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1123,7 +1258,7 @@ updateSource:
Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index 2495916b4..ecaea5ef5 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.GuardianManager.html b/docs/module-management.GuardianManager.html
index eff768fda..59e6fb9d8 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -894,186 +894,6 @@ Example
-
-
-
-
- createGuardianEnrollmentTicket(cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Create a Guardian enrollment ticket.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.createGuardianEnrollmentTicket(function (err, ticket) {
- console.log(ticket);
-});
-
-
-
-
-
-
@@ -1620,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index a17cf8ff0..a8d359bf4 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -391,6 +391,81 @@ (inner)
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner, constant) usersExportsRestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the
+Create job to export users endpoint
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
@@ -419,6 +494,420 @@ Methods
+
+
+
+
+ exportUsers(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Export all users to a file using a long running job.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Users export data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ connection_id
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The connection id of the connection from which users will be exported
+
+
+
+
+
+
+
+
+ format
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The format of the file. Valid values are: "json" and "csv".
+
+
+
+
+
+
+
+
+ limit
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Limit the number of records.
+
+
+
+
+
+
+
+
+ fields
+
+
+Array.<Object>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = {
+ connection_id: 'con_0000000000000001',
+ format: 'csv',
+ limit: 5,
+ fields: [
+ {
+ "name": "user_id"
+ },
+ {
+ "name": "name"
+ },
+ {
+ "name": "email"
+ },
+ {
+ "name": "identities[0].connection",
+ "export_as": "provider"
+ },
+ {
+ "name": "user_metadata.some_field"
+ }
+ ]
+}
+
+management.jobs.exportUsers(data, function (err, results) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Retrieved job.
+ console.log(results);
+});
+
+
+
+
+
+
@@ -466,7 +955,7 @@ getSource:
importUser
Source:
Example
send_completion_email: false //optional
};
-management.jobs.get(params, function (err) {
+management.jobs.importUsers(params, function (err) {
if (err) {
// Handle error.
}
@@ -1120,7 +1609,7 @@ verifyEmai
Source:
Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index a476b9d52..c022c6e50 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 bc804d928..843cb3828 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -2376,7 +2376,7 @@ Source:
Example
- createConnection(data, cbopt) → {Promise|undefined}
+ createClientGrant(data, cbopt) → {Promise|undefined}
- Create a new connection.
+ Create an Auth0 client grant.
@@ -2812,7 +2812,7 @@ creat
Source:
Parameters:
- Connection data object.
+ The client data object.
@@ -2970,12 +2970,12 @@ Returns:
Example
- management.createConnection(data, function (err) {
+ management.clientGrants.create(data, function (err) {
if (err) {
// Handle error.
}
- // Conection created.
+ // Client grant created.
});
@@ -2987,14 +2987,14 @@ Example
- createDevicePublicKey(data, cbopt) → {Promise|undefined}
+ createConnection(data, cbopt) → {Promise|undefined}
- Create an Auth0 credential.
+ Create a new connection.
@@ -3030,7 +3030,7 @@
Source:
Parameters:
- The device credential data object.
+ Connection data object.
@@ -3193,7 +3193,7 @@ Example
// Handle error.
}
- // Credential created.
+ // Conection created.
});
@@ -3205,14 +3205,14 @@ Example
- createEmailVerificationTicket(cbopt) → {Promise}
+ createCustomDomain(data, cbopt) → {Promise|undefined}
- Create an email verification ticket.
+ Create an Auth0 Custom Domain.
@@ -3248,7 +3248,7 @@ Source:
Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The custom domain data object.
+
+
+
+
+
+
cbReturns:
Promise
+|
+
+undefined
@@ -3369,15 +3406,12 @@ Returns:
Example
- var data = {
- user_id: '{USER_ID}',
- result_url: '{REDIRECT_URL}' // Optional redirect after the ticket is used.
-};
-
-auth0.createEmailVerificationTicket(data, function (err) {
+ management.createCustomDomain(data, function (err) {
if (err) {
// Handle error.
}
+
+ // CustomDomain created.
});
@@ -3389,14 +3423,14 @@ Example
- createPasswordChangeTicket(cbopt) → {Promise}
+ createDevicePublicKey(data, cbopt) → {Promise|undefined}
- Create a new password change ticket.
+ Create an Auth0 credential.
@@ -3432,7 +3466,7 @@ Source:
Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The device credential data object.
+
+
+
+
+
+
cbReturns:
Promise
+|
+
+undefined
@@ -3553,17 +3624,12 @@ Returns:
Example
- var params = {
- result_url: '{REDIRECT_URL}', // Redirect after using the ticket.
- user_id: '{USER_ID}', // Optional.
- email: '{USER_EMAIL}', // Optional.
- new_password: '{PASSWORD}'
-};
-
-auth0.createPasswordChangeTicket(params, function (err) {
+ management.createConnection(data, function (err) {
if (err) {
// Handle error.
}
+
+ // Credential created.
});
@@ -3575,14 +3641,14 @@ Example
- createResourceServer(data, cbopt) → {Promise|undefined}
+ createEmailVerificationTicket(cbopt) → {Promise}
- Create a new resource server.
+ Create an email verification ticket.
@@ -3618,7 +3684,7 @@ c
Source:
Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Resource Server data object.
-
-
-
-
-
-
cbReturns:
Promise
-|
-
-undefined
@@ -3776,12 +3805,15 @@ Returns:
Example
- management.createResourceServer(data, function (err) {
+ var data = {
+ user_id: '{USER_ID}',
+ result_url: '{REDIRECT_URL}' // Optional redirect after the ticket is used.
+};
+
+auth0.createEmailVerificationTicket(data, function (err) {
if (err) {
// Handle error.
}
-
- // Resource Server created.
});
@@ -3793,14 +3825,14 @@ Example
- createRule(data, cbopt) → {Promise|undefined}
+ createGuardianEnrollmentTicket(cbopt) → {Promise|undefined}
- Create a new rule.
+ Create a Guardian enrollment ticket.
@@ -3836,7 +3868,7 @@ createRule<
Source:
Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Rule data object.
-
-
-
-
-
-
cbReturns:
Example
- management.createRule(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Rule created.
+ management.createGuardianEnrollmentTicket(function (err, ticket) {
+ console.log(ticket);
});
@@ -4011,14 +4005,14 @@ Example
- createUser(data, cbopt) → {Promise|undefined}
+ createPasswordChangeTicket(cbopt) → {Promise}
- Create a new user.
+ Create a new password change ticket.
@@ -4054,7 +4048,7 @@ createUser<
Source:
Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- User data.
-
-
-
-
-
-
cbReturns:
Promise
-|
-
-undefined
@@ -4212,12 +4169,17 @@ Returns:
Example
- management.createUser(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // User created.
+ var params = {
+ result_url: '{REDIRECT_URL}', // Redirect after using the ticket.
+ user_id: '{USER_ID}', // Optional.
+ email: '{USER_EMAIL}', // Optional.
+ new_password: '{PASSWORD}'
+};
+
+auth0.createPasswordChangeTicket(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
});
@@ -4229,14 +4191,14 @@ Example
- deleteAllUsers(cbopt) → {Promise|undefined}
+ createResourceServer(data, cbopt) → {Promise|undefined}
- Delete all users.
+ Create a new resource server.
@@ -4260,8 +4222,6 @@ deleteA
- Deprecated: - This method will be removed in the next major release.
deleteA
Source:
Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Resource Server data object.
+
+
+
+
+
+
cbParameters:
- Callback function
+ Callback function.
@@ -4398,12 +4392,12 @@ Returns:
Example
- management.deleteAllUsers(function (err) {
+ management.createResourceServer(data, function (err) {
if (err) {
// Handle error.
}
- // Users deleted
+ // Resource Server created.
});
@@ -4415,14 +4409,14 @@ Example
- deleteClient(params, cbopt) → {Promise|undefined}
+ createRule(data, cbopt) → {Promise|undefined}
- Delete an Auth0 client.
+ Create a new rule.
@@ -4458,7 +4452,7 @@ deleteCli
Source:
Parameters:
- paramsdata
@@ -4529,58 +4523,7 @@ Parameters:
- Client parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- client_id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Application client ID.
-
-
-
-
-
-
-
-
+ Rule data object.
@@ -4667,12 +4610,12 @@ Returns:
Example
- management.deleteClient({ client_id: CLIENT_ID }, function (err) {
+ management.createRule(data, function (err) {
if (err) {
// Handle error.
}
- // Client deleted.
+ // Rule created.
});
@@ -4684,14 +4627,14 @@ Example
- deleteConnection(params, cbopt) → {Promise|undefined}
+ createUser(data, cbopt) → {Promise|undefined}
- Delete an existing connection.
+ Create a new user.
@@ -4727,7 +4670,7 @@ delet
Source:
Parameters:
- paramsdata
@@ -4798,58 +4741,7 @@ Parameters:
- Connection parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Connection ID.
-
-
-
-
-
-
-
-
+ User data.
@@ -4936,12 +4828,12 @@ Returns:
Example
- management.deleteConnection({ id: CONNECTION_ID }, function (err) {
+ management.createUser(data, function (err) {
if (err) {
// Handle error.
}
- // Conection deleted.
+ // User created.
});
@@ -4953,14 +4845,14 @@ Example
- deleteDeviceCredential(params, cbopt) → {Promise|undefined}
+ deleteAllUsers(cbopt) → {Promise|undefined}
- Delete an Auth0 device credential.
+ Delete all users.
@@ -4984,6 +4876,8 @@ Deprecated:- This method will be removed in the next major release.
Source:
Parameters:
- paramscb
-Object
+function
@@ -5057,6 +4951,8 @@ Parameters:
+ <optional>
+
@@ -5067,119 +4963,32 @@ Parameters:
- Credential parameters.
+ Callback function
-
-
-
-
-
-
- Name
-
+
+
- Type
+
+
+
-
-
- Description
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
- Device credential ID.
-
-
-
-
-
-
-
-
-
-
+
+Returns:
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
+
-
@@ -5205,14 +5014,12 @@
Returns:
Example
- var params = { id: CREDENTIAL_ID };
-
-management.deleteDeviceCredential(params, function (err) {
+ management.deleteAllUsers(function (err) {
if (err) {
// Handle error.
}
- // Credential deleted.
+ // Users deleted
});
@@ -5224,14 +5031,14 @@ Example
- deleteEmailProvider(cbopt) → {Promise|undefined}
+ deleteClient(params, cbopt) → {Promise|undefined}
- Delete email provider.
+ Delete an Auth0 client.
@@ -5267,7 +5074,7 @@ de
- Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Client parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Application client ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.deleteEmailProvider(function (err) {
+ management.deleteClient({ client_id: CLIENT_ID }, function (err) {
if (err) {
// Handle error.
}
- // Email provider deleted.
+ // Client deleted.
});
@@ -5408,14 +5300,14 @@ Example
- deleteGuardianEnrollment(data, cbopt) → {Promise|undefined}
+ deleteClientGrant(params, cbopt) → {Promise|undefined}
- Delete a user's Guardian enrollment.
+ Delete an Auth0 client grant.
@@ -5451,7 +5343,7 @@ Source:
Parameters:
- dataparams
@@ -5522,7 +5414,7 @@ Parameters:
- The Guardian enrollment data object.
+ Client parameters.
@@ -5565,7 +5457,7 @@ Parameters:
- The Guardian enrollment id.
+ Client grant ID.
@@ -5660,12 +5552,12 @@ Returns:
Example
- management.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err) {
+ management.clientGrants.delete({ id: GRANT_ID }, function (err) {
if (err) {
// Handle error.
}
- // Email provider deleted.
+ // Grant deleted.
});
@@ -5677,14 +5569,14 @@ Example
- deleteResourceServer(params, cbopt) → {Promise|undefined}
+ deleteConnection(params, cbopt) → {Promise|undefined}
- Delete an existing resource server.
+ Delete an existing connection.
@@ -5720,7 +5612,7 @@ d
- Source:
Parameters:
- Resource Server parameters.
+ Connection parameters.
@@ -5834,7 +5726,7 @@ Parameters:
- Resource Server ID.
+ Connection ID.
@@ -5929,12 +5821,12 @@ Returns:
Example
- management.deleteResourceServer({ id: RESOURCE_SERVER_ID }, function (err) {
+ management.deleteConnection({ id: CONNECTION_ID }, function (err) {
if (err) {
// Handle error.
}
- // Resource Server deleted.
+ // Conection deleted.
});
@@ -5946,14 +5838,14 @@ Example
- deleteRule(params, cbopt) → {Promise|undefined}
+ deleteCustomDomain(params, cbopt) → {Promise|undefined}
- Delete an existing rule.
+ Delete a Custom Domain.
@@ -5989,7 +5881,7 @@ deleteRule<
- Source:
Parameters:
- Rule parameters.
+ Custom Domain parameters.
@@ -6103,7 +5995,7 @@ Parameters:
- Rule ID.
+ Custom Domain ID.
@@ -6198,12 +6090,12 @@ Returns:
Example
- auth0.deleteRule({ id: RULE_ID }, function (err) {
+ management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
if (err) {
// Handle error.
}
- // Rule deleted.
+ // CustomDomain deleted.
});
@@ -6215,14 +6107,14 @@ Example
- deleteRulesConfig(params, cbopt) → {Promise|undefined}
+ deleteDeviceCredential(params, cbopt) → {Promise|undefined}
- Delete rules config.
+ Delete an Auth0 device credential.
@@ -6258,7 +6150,7 @@ dele
- Source:
Parameters:
- Rule Configs parameters.
+ Credential parameters.
@@ -6355,7 +6247,7 @@ Parameters:
- keyid
@@ -6372,7 +6264,7 @@ Parameters:
- Rule Configs key.
+ Device credential ID.
@@ -6467,12 +6359,14 @@ Returns:
Example
- management.deleteRulesConfig({ key: RULE_CONFIG_KEY }, function (err) {
+ var params = { id: CREDENTIAL_ID };
+
+management.deleteDeviceCredential(params, function (err) {
if (err) {
// Handle error.
}
- // Rules Config deleted.
+ // Credential deleted.
});
@@ -6484,14 +6378,14 @@ Example
- deleteUser(params, cbopt) → {Promise|undefined}
+ deleteEmailProvider(cbopt) → {Promise|undefined}
- Delete a user by its id.
+ Delete email provider.
@@ -6527,7 +6421,7 @@ deleteUser<
- Source:
Parameters:
- paramscb
-Object
+function
@@ -6588,6 +6482,8 @@ Parameters:
+ <optional>
+
@@ -6598,101 +6494,14 @@ Parameters:
- The user data object..
+ Callback function.
-
-
-
-
-
-
- Name
-
+
+
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- The user id.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function
-
-
-
-
-
-
-
+
+
+
@@ -6736,12 +6545,12 @@ Returns:
Example
- management.deleteUser({ id: USER_ID }, function (err) {
+ management.deleteEmailProvider(function (err) {
if (err) {
// Handle error.
}
- // User deleted.
+ // Email provider deleted.
});
@@ -6753,14 +6562,14 @@ Example
- deleteUserMultifactor(params, cbopt) → {Promise|undefined}
+ deleteGuardianEnrollment(data, cbopt) → {Promise|undefined}
- Delete a multifactor provider for a user.
+ Delete a user's Guardian enrollment.
@@ -6796,7 +6605,7 @@
Source:
Parameters:
- paramsdata
@@ -6867,7 +6676,7 @@ Parameters:
- Data object.
+ The Guardian enrollment data object.
@@ -6910,33 +6719,7 @@ Parameters:
- The user id.
-
-
-
-
-
-
-
-
- provider
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Multifactor provider.
+ The Guardian enrollment id.
@@ -6980,7 +6763,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -7031,14 +6814,12 @@ Returns:
Example
- var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-
-management.deleteUserMultifactor(params, function (err, user) {
+ management.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // Email provider deleted.
});
@@ -7050,14 +6831,14 @@ Example
- deleteUserMultifcator(params, cbopt) → {Promise|undefined}
+ deleteResourceServer(params, cbopt) → {Promise|undefined}
- Delete a multifactor provider for a user.
+ Delete an existing resource server.
@@ -7081,10 +6862,6 @@
- Deprecated: - The function name has a typo.
-We're shipping this so it doesn't break compatibility.
-Use
deleteUserMultifactor instead.
Source:
Parameters:
- Data object.
+ Resource Server parameters.
@@ -7211,33 +6988,7 @@ Parameters:
- The user id.
-
-
-
-
-
-
-
-
- provider
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Multifactor provider.
+ Resource Server ID.
@@ -7281,7 +7032,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -7332,14 +7083,12 @@ Returns:
Example
- var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-
-management.deleteUserMultifcator(params, function (err, user) {
+ management.deleteResourceServer({ id: RESOURCE_SERVER_ID }, function (err) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // Resource Server deleted.
});
@@ -7351,14 +7100,14 @@ Example
- getActiveUsersCount(cbopt) → {Promise|undefined}
+ deleteRule(params, cbopt) → {Promise|undefined}
- Get a the active users count.
+ Delete an existing rule.
@@ -7394,7 +7143,7 @@ ge
Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rule parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.getActiveUsersCount(function (err, usersCount) {
+ auth0.deleteRule({ id: RULE_ID }, function (err) {
if (err) {
// Handle error.
}
- console.log(usersCount);
+ // Rule deleted.
});
@@ -7535,14 +7369,14 @@ Example
- getBlacklistedTokens(cbopt) → {Promise|undefined}
+ deleteRulesConfig(params, cbopt) → {Promise|undefined}
- Get all blacklisted tokens.
+ Delete rules config.
@@ -7578,7 +7412,7 @@ g
Source:
Parameters:
- cbparams
-function
+Object
@@ -7639,8 +7473,6 @@ Parameters:
- <optional>
-
@@ -7651,7 +7483,94 @@ Parameters:
- Callback function.
+ Rule Configs parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule Configs key.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
@@ -7702,8 +7621,12 @@ Returns:
Example
- management.getBlacklistedTokens(function (err, tokens) {
- console.log(tokens.length);
+ management.deleteRulesConfig({ key: RULE_CONFIG_KEY }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Rules Config deleted.
});
@@ -7715,14 +7638,14 @@ Example
- getClient(params, cbopt) → {Promise|undefined}
+ deleteUser(params, cbopt) → {Promise|undefined}
- Get an Auth0 client.
+ Delete a user by its id.
@@ -7758,7 +7681,7 @@ getClientSource:
Parameters:
- Client parameters.
+ The user data object..
@@ -7855,7 +7778,7 @@ Parameters:
- client_idid
@@ -7872,7 +7795,7 @@ Parameters:
- Application client ID.
+ The user id.
@@ -7916,7 +7839,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -7967,12 +7890,12 @@ Returns:
Example
- management.getClient({ client_id: CLIENT_ID }, function (err, client) {
+ management.deleteUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
- console.log(client);
+ // User deleted.
});
@@ -7984,122 +7907,14 @@ Example
- getClientInfo() → {Object}
-
-
-
-
-
-
- Return an object with information about the current client,
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Object
-
-
-
-
-
-
-
- Object containing client information.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- getClients(paramsopt, cbopt) → {Promise|undefined}
+ deleteUserMultifactor(params, cbopt) → {Promise|undefined}
- Get all Auth0 clients.
+ Delete a multifactor provider for a user.
@@ -8135,7 +7950,7 @@ getClients<
Source:
Parameters:
- <optional>
-
@@ -8208,7 +8021,7 @@ Parameters:
- Clients parameters.
+ Data object.
@@ -8222,8 +8035,6 @@ Parameters:
Type
- Attributes
-
@@ -8236,34 +8047,24 @@ Parameters:
- per_pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Number of results per page.
+ The user id.
@@ -8272,34 +8073,24 @@ Parameters:
- pageprovider
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ Multifactor provider.
@@ -8343,7 +8134,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -8394,20 +8185,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, provider: MULTIFACTOR_PROVIDER };
-management.getClients(params, function (err, clients) {
- console.log(clients.length);
+management.deleteUserMultifactor(params, function (err, user) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Users accounts unlinked.
});
@@ -8419,14 +8204,14 @@ Example
- getConnection(params, cbopt) → {Promise|undefined}
+ deleteUserMultifcator(params, cbopt) → {Promise|undefined}
- Get an Auth0 connection.
+ Delete a multifactor provider for a user.
@@ -8450,6 +8235,10 @@ getConne
+ Deprecated: - The function name has a typo.
+We're shipping this so it doesn't break compatibility.
+Use
deleteUserMultifactor instead.
getConne
Source:
Parameters:
- Connection parameters.
+ Data object.
@@ -8576,7 +8365,33 @@ Parameters:
- Connection ID.
+ The user id.
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Multifactor provider.
@@ -8620,7 +8435,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -8671,12 +8486,14 @@ Returns:
Example
- management.getConnection({ id: CONNECTION_ID }, function (err, connection) {
+ var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
+
+management.deleteUserMultifcator(params, function (err, user) {
if (err) {
// Handle error.
}
- console.log(connection);
+ // Users accounts unlinked.
});
@@ -8688,14 +8505,14 @@ Example
- getConnections(paramsopt, cbopt) → {Promise|undefined}
+ exportUsers(data, cbopt) → {Promise|undefined}
- Get all connections.
+ Export all users to a file using a long running job.
@@ -8731,7 +8548,7 @@ getConn
Source:
Parameters:
- paramsdata
@@ -8792,8 +8609,6 @@ Parameters:
- <optional>
-
@@ -8804,7 +8619,7 @@ Parameters:
- Connections params.
+ Users export data.
@@ -8832,13 +8647,13 @@ Parameters:
- per_pageconnection_id
-Number
+String
@@ -8859,7 +8674,7 @@ Parameters:
- Number of results per page.
+ The connection id of the connection from which users will be exported
@@ -8868,7 +8683,43 @@ Parameters:
- pageformat
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The format of the file. Valid values are: "json" and "csv".
+
+
+
+
+
+
+
+
+ limit
@@ -8895,7 +8746,43 @@ Parameters:
- Page number, zero indexed.
+ Limit the number of records.
+
+
+
+
+
+
+
+
+ fields
+
+
+Array.<Object>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
@@ -8990,20 +8877,37 @@ 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 data = {
+ connection_id: 'con_0000000000000001',
+ format: 'csv',
+ limit: 5,
+ fields: [
+ {
+ "name": "user_id"
+ },
+ {
+ "name": "name"
+ },
+ {
+ "name": "email"
+ },
+ {
+ "name": "identities[0].connection",
+ "export_as": "provider"
+ },
+ {
+ "name": "user_metadata.some_field"
+ }
+ ]
+}
+
+management.exportUsers(data, function (err, results) {
+ if (err) {
+ // Handle error.
+ }
-management.getConnections(params, function (err, connections) {
- console.log(connections.length);
+ // Retrieved job.
+ console.log(results);
});
@@ -9015,14 +8919,14 @@ Example
- getDailyStats(params, cbopt) → {Promise|undefined}
+ getActiveUsersCount(cbopt) → {Promise|undefined}
- Get the daily stats.
+ Get a the active users count.
@@ -9058,7 +8962,7 @@ getDaily
Source:
Parameters:
- paramscb
-Object
+function
@@ -9119,6 +9023,8 @@ Parameters:
+ <optional>
+
@@ -9129,156 +9035,43 @@ Parameters:
- Stats parameters.
+ Callback function.
-
-
-
-
-
-
- Name
-
+
+
- Type
+
+
+
-
-
- Description
-
-
-
-
-
-
- from
-
-
-String
-
-
-
-
-
- The first day in YYYYMMDD format.
-
-
-
-
-
-
- to
-
-
-String
+
+Returns:
+
-
-
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
-
-
-
-
-
- The last day in YYYYMMDD format.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
+undefined
@@ -9293,17 +9086,12 @@ Returns:
Example
- var params = {
- from: '{YYYYMMDD}', // First day included in the stats.
- to: '{YYYYMMDD}' // Last day included in the stats.
-};
-
-management.getDaily(params, function (err, stats) {
+ management.getActiveUsersCount(function (err, usersCount) {
if (err) {
// Handle error.
}
- console.log(stats);
+ console.log(usersCount);
});
@@ -9315,14 +9103,14 @@ Example
- getDeviceCredentials(cbopt) → {Promise|undefined}
+ getBlacklistedTokens(cbopt) → {Promise|undefined}
- Get all Auth0 credentials.
+ Get all blacklisted tokens.
@@ -9358,7 +9146,7 @@ g
- Source:
Returns:
Example
- management.getDeviceCredentials(function (err, credentials) {
- console.log(credentials.length);
+ management.getBlacklistedTokens(function (err, tokens) {
+ console.log(tokens.length);
});
@@ -9495,14 +9283,14 @@ Example
- getEmailProvider(cbopt) → {Promise|undefined}
+ getClient(params, cbopt) → {Promise|undefined}
- Get the email provider.
+ Get an Auth0 client.
@@ -9538,7 +9326,7 @@ getEm
- Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Client parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Application client ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.getEmailProvider(function (err, provider) {
- console.log(provider.length);
+ management.getClient({ client_id: CLIENT_ID }, function (err, client) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(client);
});
@@ -9675,14 +9552,14 @@ Example
- getGuardianEnrollment(data, cbopt) → {Promise|undefined}
+ getClientGrants(paramsopt, cbopt) → {Promise|undefined}
- Get a single Guardian enrollment.
+ Get all Auth0 Client Grants.
@@ -9718,7 +9595,7 @@
- Source:
Parameters:
- dataparams
@@ -9779,6 +9656,8 @@ Parameters:
+ <optional>
+
@@ -9789,7 +9668,7 @@ Parameters:
- The Guardian enrollment data object.
+ Client Grants parameters.
@@ -9803,6 +9682,8 @@ Parameters:
Type
+ Attributes
+
@@ -9815,32 +9696,34 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
-
+
-
- The Guardian enrollment id.
-
-
+
+
-
-
-
+
+
+ Number of results per page.
@@ -9849,13 +9732,13 @@ Parameters:
- cbpage
-function
+Number
@@ -9876,7 +9759,7 @@ Parameters:
- Callback function.
+ Page number, zero indexed.
@@ -9885,6 +9768,53 @@ Parameters:
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
@@ -9895,9 +9825,6 @@ Parameters:
-
-
-
Returns:
@@ -9927,8 +9854,20 @@ Returns:
Example
- management.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
- console.log(enrollment);
+
+ 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.getClientGrants(params, function (err, grants) {
+ console.log(grants.length);
});
@@ -9940,14 +9879,14 @@ Example
- getGuardianEnrollments(data, cbopt) → {Promise|undefined}
+ getClientInfo() → {Object}
- Get a list of a user's Guardian enrollments.
+ Return an object with information about the current client,
@@ -9983,7 +9922,115 @@ Source:
Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Object
+
+
+
+
+
+
+
+ Object containing client information.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ getClients(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 clients.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ Parameters:
- dataparams
@@ -10044,6 +10091,8 @@ Parameters:
+ <optional>
+
@@ -10054,7 +10103,7 @@ Parameters:
- The user data object.
+ Clients parameters.
@@ -10068,6 +10117,8 @@ Parameters:
Type
+ Attributes
+
@@ -10080,24 +10131,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- The user id.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -10192,8 +10289,20 @@ Returns:
Example
- management.getGuardianEnrollments({ id: USER_ID }, function (err, enrollments) {
- console.log(enrollments);
+
+ 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.getClients(params, function (err, clients) {
+ console.log(clients.length);
});
@@ -10205,14 +10314,14 @@ Example
- getJob(params, cbopt) → {Promise|undefined}
+ getConnection(params, cbopt) → {Promise|undefined}
- Get a job by its ID.
+ Get an Auth0 connection.
@@ -10248,7 +10357,7 @@ getJobSource:
Parameters:
- Job parameters.
+ Connection parameters.
@@ -10362,7 +10471,7 @@ Parameters:
- Job ID.
+ Connection ID.
@@ -10457,17 +10566,12 @@ Returns:
Example
- var params = {
- id: '{JOB_ID}'
-};
-
-management.getJob(params, function (err, job) {
+ management.getConnection({ id: CONNECTION_ID }, function (err, connection) {
if (err) {
// Handle error.
}
- // Retrieved job.
- console.log(job);
+ console.log(connection);
});
@@ -10479,14 +10583,14 @@ Example
- getLog(params, cbopt) → {Promise|undefined}
+ getConnections(paramsopt, cbopt) → {Promise|undefined}
- Get an Auth0 log.
+ Get all connections.
@@ -10522,7 +10626,7 @@ getLogSource:
Parameters:
+ <optional>
+
@@ -10593,7 +10699,7 @@ Parameters:
- Log parameters.
+ Connections params.
@@ -10607,6 +10713,8 @@ Parameters:
Type
+ Attributes
+
@@ -10619,24 +10727,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- Event ID.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -10731,12 +10885,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.getConnections(params, function (err, connections) {
+ console.log(connections.length);
});
@@ -10748,14 +10910,14 @@ Example
- getLogs(paramsopt, cbopt) → {Promise|undefined}
+ getCustomDomain(params, cbopt) → {Promise|undefined}
- Get all logs.
+ Get a Custom Domain.
@@ -10791,7 +10953,7 @@ getLogsSource:
Parameters:
- <optional>
-
@@ -10864,7 +11024,7 @@ Parameters:
- Logs params.
+ Custom Domain parameters.
@@ -10878,8 +11038,6 @@ Parameters:
Type
- Attributes
-
@@ -10892,7 +11050,7 @@ Parameters:
- qid
@@ -10905,21 +11063,19 @@ Parameters:
-
-
- <optional>
-
-
+
+
+ Custom Domain ID.
-
-
+
+
-
+
+
+
-
- Search Criteria using Query String Syntax
@@ -10928,13 +11084,13 @@ Parameters:
- pagecb
-Number
+function
@@ -10955,238 +11111,134 @@ Parameters:
- Page number. Zero based
+ Callback function.
+
+
-
-
- per_page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- The amount of entries per page
-
-
-
-
-
-
- sort
-
-
-String
-
-
+
+Returns:
-
-
-
- <optional>
-
+
-
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
-
-
-
+undefined
-
-
- The field to use for sorting.
-
-
-
+
+
+
+
-
-
- fields
-
-
-String
+
+Example
-
-
+ management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ if (err) {
+ // Handle error.
+ }
-
-
-
- <optional>
-
+ console.log(customDomain);
+});
-
+
-
-
+
+
+
-
+
-
- A comma separated list of fields to include or exclude
-
-
-
+ getCustomDomains() → {Promise|undefined}
-
-
- include_fields
-
-
-Boolean
+
+ Get all Auth0 CustomDomains.
+
-
-
-
-
-
- <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
-
-
-
+
-
-
-
-
-
+
+
+ Source:
+
-
- cb
-
-
-function
+
+
+
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
@@ -11230,20 +11282,8 @@ 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
-};
-
-management.getLogs(params, function (err, logs) {
- console.log(logs.length);
+ management.getCustomDomains(function (err, customDomains) {
+ console.log(customDomains.length);
});
@@ -11255,14 +11295,14 @@ Example
- getResourceServer(params, cbopt) → {Promise|undefined}
+ getDailyStats(params, cbopt) → {Promise|undefined}
- Get a Resource Server.
+ Get the daily stats.
@@ -11298,7 +11338,7 @@ getR
Source:
Parameters:
- Resource Server parameters.
+ Stats parameters.
@@ -11395,7 +11435,7 @@ Parameters:
- idfrom
@@ -11412,7 +11452,33 @@ Parameters:
- Resource Server ID.
+ The first day in YYYYMMDD format.
+
+
+
+
+
+
+
+
+ to
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The last day in YYYYMMDD format.
@@ -11507,12 +11573,17 @@ Returns:
Example
- management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+ var params = {
+ from: '{YYYYMMDD}', // First day included in the stats.
+ to: '{YYYYMMDD}' // Last day included in the stats.
+};
+
+management.getDaily(params, function (err, stats) {
if (err) {
// Handle error.
}
- console.log(resourceServer);
+ console.log(stats);
});
@@ -11524,14 +11595,14 @@ Example
- getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+ getDeviceCredentials(cbopt) → {Promise|undefined}
- Get all resource servers.
+ Get all Auth0 credentials.
@@ -11567,7 +11638,7 @@ get
Source:
Parameters:
- paramscb
-Object
+function
@@ -11640,226 +11711,79 @@ Parameters:
- Resource Servers parameters.
+ Callback function.
-
+
+
-
-
-
-
- Name
-
+
+
+
- Type
-
- Attributes
-
-
- Description
-
-
-
-
-
-
- per_page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
+
+Returns:
-
+
-
-
- page
+ -
+ Type:
+
+ -
+
+
Promise
+|
-
-
-
-Number
+undefined
-
-
+
+
-
-
-
- <optional>
-
-
+
+
-
-
-
-
-
- Page number, zero indexed.
-
-
-
+
+Example
+
+ management.getDeviceCredentials(function (err, credentials) {
+ console.log(credentials.length);
+});
+
+
+
+
+
+
+
-
-
-
-
-
+ getEmailProvider(cbopt, paramsopt) → {Promise|undefined}
-
-
- 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);
-});
-
-
-
-
-
-
-
-
-
-
- getRule(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get an Auth0 rule.
-
+
+ Get the email provider.
+
@@ -11894,7 +11818,7 @@ getRuleSource:
Parameters:
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
paramsParameters:
+ <optional>
+
@@ -11965,7 +11927,7 @@ Parameters:
- Rule parameters.
+ Clients parameters.
@@ -11979,6 +11941,8 @@ Parameters:
Type
+ Attributes
+
@@ -11991,32 +11955,34 @@ Parameters:
- idfields
-String
+Number
+
+
+ <optional>
+
-
+
-
- Rule ID.
-
-
+
+
-
-
-
+
+
+ A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
@@ -12025,13 +11991,13 @@ Parameters:
- cbinclude_fields
-function
+Number
@@ -12052,7 +12018,15 @@ Parameters:
- Callback function.
+ true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
+
+
+
+
+
+
+
@@ -12103,12 +12077,8 @@ Returns:
Example
- management.getRule({ id: RULE_ID }, function (err, rule) {
- if (err) {
- // Handle error.
- }
-
- console.log(rule);
+ management.getEmailProvider(function (err, provider) {
+ console.log(provider.length);
});
@@ -12120,14 +12090,14 @@ Example
- getRules(paramsopt, cbopt) → {Promise|undefined}
+ getGuardianEnrollment(data, cbopt) → {Promise|undefined}
- Get all rules.
+ Get a single Guardian enrollment.
@@ -12163,7 +12133,7 @@ getRulesSource:
Parameters:
- paramsdata
@@ -12224,8 +12194,6 @@ Parameters:
- <optional>
-
@@ -12236,7 +12204,7 @@ Parameters:
- Rules parameters.
+ The Guardian enrollment data object.
@@ -12250,8 +12218,6 @@ Parameters:
Type
- Attributes
-
@@ -12264,70 +12230,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ The Guardian enrollment id.
@@ -12422,20 +12342,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 = {
- per_page: 10,
- page: 0
-};
-
-management.getRules(params, function (err, rules) {
- console.log(rules.length);
+ management.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ console.log(enrollment);
});
@@ -12447,14 +12355,14 @@ Example
- getRulesConfigs() → {Promise|undefined}
+ getGuardianEnrollments(data, cbopt) → {Promise|undefined}
- Get rules config.
+ Get a list of a user's Guardian enrollments.
@@ -12490,7 +12398,7 @@ getRul
Source:
getRul
+ Parameters:
+
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
+
+
+
-
-
- -
- Type:
-
- -
+
Name
-Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.getRulesConfigs(function (err, rulesConfigs) {
- if (err) {
- // Handle error.
- }
-
- // Get Rules Configs.
-});
-
+ Type
-
-
-
-
-
-
- getTenantSettings(cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get the tenant settings..
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
- Attributes
+
-
+
-
+ Description
+
+
+
-
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
- Parameters:
-
+
+ The user data object.
+
+
@@ -12642,8 +12483,6 @@ Parameters:
Type
- Attributes
-
@@ -12654,6 +12493,40 @@ Parameters:
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.getSettings(function (err, settings) {
- if (err) {
- // Handle error.
- }
-
- console.log(settings);
+ management.getGuardianEnrollments({ id: USER_ID }, function (err, enrollments) {
+ console.log(enrollments);
});
@@ -12751,14 +12620,14 @@ Example
- getUser(data, cbopt) → {Promise|undefined}
+ getJob(params, cbopt) → {Promise|undefined}
- Get a user by its id.
+ Get a job by its ID.
@@ -12794,7 +12663,7 @@ getUserSource:
Parameters:
- dataparams
@@ -12865,7 +12734,7 @@ Parameters:
- The user data object.
+ Job parameters.
@@ -12908,7 +12777,7 @@ Parameters:
- The user id.
+ Job ID.
@@ -13003,8 +12872,17 @@ Returns:
Example
- management.getUser({ id: USER_ID }, function (err, user) {
- console.log(user);
+ var params = {
+ id: '{JOB_ID}'
+};
+
+management.getJob(params, function (err, job) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Retrieved job.
+ console.log(job);
});
@@ -13016,14 +12894,14 @@ Example
- getUserLogs(params, cbopt) → {Promise|undefined}
+ getLog(params, cbopt) → {Promise|undefined}
- Get user's log events.
+ Get an Auth0 log.
@@ -13059,7 +12937,7 @@ getUserLog
Source:
Parameters:
- Get logs data.
+ Log parameters.
@@ -13173,7 +13051,15 @@ Parameters:
- User id.
+ Event ID.
+
+
+
+
+
+
+
+
@@ -13182,24 +13068,2952 @@ Parameters:
- per_pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Number of results per page.
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getLog({ id: EVENT_ID }, function (err, log) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(log);
+});
+
+
+
+
+
+
+
+
+
+
+ getLogs(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all logs.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Logs params.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ q
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Search Criteria using Query String Syntax
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number. Zero based
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The amount of entries per page
+
+
+
+
+
+
+
+
+ sort
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The field to use for sorting.
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 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);
+});
+
+
+
+
+
+
+
+
+
+
+ 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);
+});
+
+
+
+
+
+
+
+
+
+
+ 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() → {Promise|undefined}
+
+
+
+
+
+
+ Get rules config.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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..
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getSettings(function (err, settings) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(settings);
+});
+
+
+
+
+
+
+
+
+
+
+ getUser(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a user by its id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - 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.getUser({ id: USER_ID }, function (err, user) {
+ console.log(user);
+});
+
+
+
+
+
+
+
+
+
+
+ getUserLogs(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get user's log events.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Get logs data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ User id.
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ sort
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+
+management.getUserLogs(params, function (err, logs) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logs);
+});
+
+
+
+
+
+
+
+
+
+
+ getUsers(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all users.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Users params.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ search_engine
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The version of the search engine to use.
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
@@ -13217,24 +16031,235 @@ Parameters:
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 = {
+ search_engine: 'v3',
+ per_page: 10,
+ page: 0
+};
+
+auth0.getUsers(params, function (err, users) {
+ console.log(users.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get users for a given email address
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
-
+
+ Attributes
+
-
+
-
- Page number, zero indexed.
-
-
-
+ Description
+
+
+
- sortemail
@@ -13247,45 +16272,21 @@ Parameters:
-
-
-
-
- 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
-
+ <optional>
-Boolean
+
-
-
-
+
+
- true if a query summary must be included in the result, false otherwise. Default false;
-
-
-
-
-
-
-
-
+ Email Address of users to locate
@@ -13372,14 +16373,13 @@ Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-
-management.getUserLogs(params, function (err, logs) {
- if (err) {
- // Handle error.
- }
-
- console.log(logs);
+
+ 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);
});
@@ -13391,14 +16391,15 @@ Example
- getUsers(paramsopt, cbopt) → {Promise|undefined}
+ importUsers(data, cbopt) → {Promise|undefined}
- Get all users.
+ Given a path to a file and a connection id, create a new job that imports the
+users contained in the file and associate them with the given connection.
@@ -13434,7 +16435,7 @@ getUsersSource:
Parameters:
- paramsdata
@@ -13495,8 +16496,6 @@ Parameters:
- <optional>
-
@@ -13507,7 +16506,7 @@ Parameters:
- Users params.
+ Users import data.
@@ -13521,8 +16520,6 @@ Parameters:
Type
- Attributes
-
@@ -13535,70 +16532,24 @@ Parameters:
- search_engine
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The version of the search engine to use.
-
-
-
-
-
-
-
-
- per_pageconnectionId
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Number of results per page.
+ Connection for the users insertion.
@@ -13607,34 +16558,24 @@ Parameters:
- pageusers
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ Path to the users data file.
@@ -13729,21 +16670,15 @@ 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',
- per_page: 10,
- page: 0
+ var params = {
+ connection_id: '{CONNECTION_ID}',
+ users: '{PATH_TO_USERS_FILE}'
};
-auth0.getUsers(params, function (err, users) {
- console.log(users.length);
+management.get(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
});
@@ -13755,14 +16690,14 @@ Example
- getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+ linkUsers(userId, params, cbopt) → {Promise|undefined}
- Get users for a given email address
+ Link the user with another account.
@@ -13798,7 +16733,7 @@ getUse
Source:
getUse
- Parameters:
-
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ userId
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ID of the primary user.
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Secondary user data.
+
+
@@ -13830,8 +16852,6 @@ Parameters:
Type
- Attributes
-
@@ -13844,7 +16864,7 @@ Parameters:
- emailuser_id
@@ -13857,21 +16877,45 @@ Parameters:
-
-
- <optional>
-
+
+
+
+ ID of the user to be linked.
+
+
+
+
+
+
+
+ connection_id
+
-
+String
+
+
+
+
+
- Email Address of users to locate
+ ID of the connection to be used.
+
+
+
+
+
+
+
+
@@ -13958,13 +17002,18 @@ 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 userId = 'USER_ID';
+var params = {
+ user_id: 'OTHER_USER_ID',
+ connection_id: 'CONNECTION_ID'
+};
+
+management.linkUsers(userId, params, function (err, user) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Users linked.
});
@@ -13976,15 +17025,14 @@ Example
- importUsers(data, cbopt) → {Promise|undefined}
+ regenerateRecoveryCode(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 and associate them with the given connection.
+ Generate new Guardian recovery code.
@@ -14020,7 +17068,7 @@ importUser
Source:
Parameters:
- Users import data.
+ The user data object.
@@ -14117,33 +17165,7 @@ Parameters:
- connectionId
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Connection for the users insertion.
-
-
-
-
-
-
-
-
- usersid
@@ -14160,7 +17182,7 @@ Parameters:
- Path to the users data file.
+ The user id.
@@ -14255,15 +17277,8 @@ Returns:
Example
- var params = {
- connection_id: '{CONNECTION_ID}',
- users: '{PATH_TO_USERS_FILE}'
-};
-
-management.get(params, function (err) {
- if (err) {
- // Handle error.
- }
+ management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
+ console.log(newRecoveryCode);
});
@@ -14275,14 +17290,14 @@ Example
- linkUsers(userId, params, cbopt) → {Promise|undefined}
+ sendEmailVerification(data, cbopt) → {Promise|undefined}
- Link the user with another account.
+ Send a verification email to a user.
@@ -14318,7 +17333,7 @@ linkUsersSource:
Parameters:
- userId
-
-
-String
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ID of the primary user.
-
-
-
-
-
-
-
-
- paramsdata
@@ -14423,7 +17404,7 @@ Parameters:
- Secondary user data.
+ User data object.
@@ -14466,33 +17447,7 @@ Parameters:
- ID of the user to be linked.
-
-
-
-
-
-
-
-
- connection_id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- ID of the connection to be used.
+ ID of the user to be verified.
@@ -14587,18 +17542,14 @@ Returns:
Example
- var userId = 'USER_ID';
-var params = {
- user_id: 'OTHER_USER_ID',
- connection_id: 'CONNECTION_ID'
+ var params = {
+ user_id: '{USER_ID}'
};
-management.linkUsers(userId, params, function (err, user) {
+management.sendEmailVerification(function (err) {
if (err) {
// Handle error.
}
-
- // Users linked.
});
@@ -14610,14 +17561,14 @@ Example
- regenerateRecoveryCode(data, cbopt) → {Promise|undefined}
+ setRulesConfig(params, data, cbopt) → {Promise|undefined}
- Generate new Guardian recovery code.
+ Set a new rules config.
@@ -14653,7 +17604,7 @@ Source:
Parameters:
-
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rule Config parameters.
+
+
@@ -14685,8 +17689,6 @@ Parameters:
Type
- Attributes
-
@@ -14697,6 +17699,40 @@ Parameters:
+
+
+ key
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule Config key.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
dataParameters:
- The user data object.
+ Rule Config Data parameters.
@@ -14750,7 +17786,7 @@ Parameters:
- idvalue
@@ -14767,7 +17803,7 @@ Parameters:
- The user id.
+ Rule Config Data value.
@@ -14862,8 +17898,15 @@ Returns:
Example
- management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
- console.log(newRecoveryCode);
+ var params = { key: RULE_CONFIG_KEY };
+var data = { value: RULES_CONFIG_VALUE };
+
+management.setRulesConfig(params, data, function (err, rulesConfig) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Rules Config set.
});
@@ -14875,14 +17918,14 @@ Example
- sendEmailVerification(data, cbopt) → {Promise|undefined}
+ unlinkUsers(params, cbopt) → {Promise|undefined}
- Send a verification email to a user.
+ Unlink the given accounts.
@@ -14918,7 +17961,7 @@
Source:
Parameters:
- dataparams
@@ -14989,7 +18032,7 @@ Parameters:
- User data object.
+ Linked users data.
@@ -15013,6 +18056,58 @@ Parameters:
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Primary user ID.
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Identity provider in use.
+
+
+
+
+
+
user_idParameters:
- ID of the user to be verified.
+ Secondary user ID.
@@ -15127,14 +18222,14 @@ Returns:
Example
- var params = {
- user_id: '{USER_ID}'
-};
+ var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
-management.sendEmailVerification(function (err) {
+management.unlinkUsers(params, function (err, user) {
if (err) {
// Handle error.
}
+
+ // Users accounts unlinked.
});
@@ -15146,14 +18241,14 @@ Example
- setRulesConfig(params, data, cbopt) → {Promise|undefined}
+ updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
- Set a new rules config.
+ Update the app metadata for a user.
@@ -15189,7 +18284,7 @@ setRule
Source:
Parameters:
- Rule Config parameters.
+ The user data object..
@@ -15286,7 +18381,7 @@ Parameters:
- keyid
@@ -15303,7 +18398,7 @@ Parameters:
- Rule Config key.
+ The user id.
@@ -15320,7 +18415,7 @@ Parameters:
- datametadata
@@ -15345,58 +18440,7 @@ Parameters:
- Rule Config Data parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- value
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Rule Config Data value.
-
-
-
-
-
-
-
-
+ New app metadata.
@@ -15432,7 +18476,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -15483,15 +18527,18 @@ Returns:
Example
- var params = { key: RULE_CONFIG_KEY };
-var data = { value: RULES_CONFIG_VALUE };
+ var params = { id: USER_ID };
+var metadata = {
+ foo: 'bar'
+};
-management.setRulesConfig(params, data, function (err, rulesConfig) {
+management.updateAppMetadata(params, metadata, function (err, user) {
if (err) {
// Handle error.
}
- // Rules Config set.
+ // Updated user.
+ console.log(user);
});
@@ -15503,14 +18550,14 @@ Example
- unlinkUsers(params, cbopt) → {Promise|undefined}
+ updateClient(params, data, cbopt) → {Promise|undefined}
- Unlink the given accounts.
+ Update an Auth0 client.
@@ -15546,7 +18593,7 @@ unlinkUser
Source:
Parameters:
- Linked users data.
+ Client parameters.
@@ -15643,7 +18690,7 @@ Parameters:
- idclient_id
@@ -15660,33 +18707,15 @@ Parameters:
- Primary user ID.
+ Application client ID.
+
+
-
-
- provider
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Identity provider in use.
@@ -15695,32 +18724,32 @@ Parameters:
- user_iddata
-String
+Object
+
+
+
+
+
+
+
+
- Secondary user ID.
-
-
-
-
-
-
-
-
+ Updated client data.
@@ -15807,14 +18836,15 @@ Returns:
Example
- var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
+ var data = { name: 'newClientName' };
+var params = { client_id: CLIENT_ID };
-management.unlinkUsers(params, function (err, user) {
+management.updateClient(params, data, function (err, client) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ console.log(client.name); // 'newClientName'
});
@@ -15826,14 +18856,14 @@ Example
- updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
+ updateClientGrant(params, data, cbopt) → {Promise|undefined}
- Update the app metadata for a user.
+ Update an Auth0 client grant.
@@ -15869,7 +18899,7 @@ upda
Source:
Parameters:
- The user data object..
+ Client parameters.
@@ -15983,7 +19013,7 @@ Parameters:
- The user id.
+ Client grant ID.
@@ -16000,7 +19030,7 @@ Parameters:
- metadatadata
@@ -16025,7 +19055,7 @@ Parameters:
- New app metadata.
+ Updated client data.
@@ -16061,7 +19091,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -16112,18 +19142,19 @@ Returns:
Example
- var params = { id: USER_ID };
-var metadata = {
- foo: 'bar'
+ var data = {
+ client_id: CLIENT_ID,
+ audience: AUDIENCE,
+ scope: []
};
+var params = { id: CLIENT_GRANT_ID };
-management.updateAppMetadata(params, metadata, function (err, user) {
+management.clientGrants.update(params, data, function (err, grant) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+ console.log(grant.id);
});
@@ -16135,14 +19166,14 @@ Example
- updateClient(params, data, cbopt) → {Promise|undefined}
+ updateConnection(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client.
+ Update an existing connection.
@@ -16178,7 +19209,7 @@ updateCli
Source:
Parameters:
- Client parameters.
+ Connection parameters.
@@ -16275,7 +19306,7 @@ Parameters:
- client_idid
@@ -16292,7 +19323,7 @@ Parameters:
- Application client ID.
+ Connection ID.
@@ -16334,7 +19365,7 @@ Parameters:
- Updated client data.
+ Updated connection data.
@@ -16421,15 +19452,15 @@ Returns:
Example
- var data = { name: 'newClientName' };
-var params = { client_id: CLIENT_ID };
+ var data = { name: 'newConnectionName' };
+var params = { id: CONNECTION_ID };
-management.updateClient(params, data, function (err, client) {
+management.updateConnection(params, data, function (err, connection) {
if (err) {
// Handle error.
}
- console.log(client.name); // 'newClientName'
+ console.log(connection.name); // 'newConnectionName'
});
@@ -16441,14 +19472,14 @@ Example
- updateConnection(params, data, cbopt) → {Promise|undefined}
+ updateEmailProvider(params, data, cbopt) → {Promise|undefined}
- Update an existing connection.
+ Update the email provider.
@@ -16484,7 +19515,7 @@ updat
Source:
Parameters:
- Connection parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Connection ID.
-
-
-
-
-
-
-
-
+ Email provider parameters.
@@ -16640,7 +19620,7 @@ Parameters:
- Updated connection data.
+ Updated email provider data.
@@ -16727,15 +19707,13 @@ Returns:
Example
- var data = { name: 'newConnectionName' };
-var params = { id: CONNECTION_ID };
-
-management.updateConnection(params, data, function (err, connection) {
+ management.updateEmailProvider(params, data, function (err, provider) {
if (err) {
// Handle error.
}
- console.log(connection.name); // 'newConnectionName'
+ // Updated email provider.
+ console.log(provider);
});
@@ -16747,14 +19725,14 @@ Example
- updateEmailProvider(params, data, cbopt) → {Promise|undefined}
+ updateResourceServer(params, data, cbopt) → {Promise|undefined}
- Update the email provider.
+ Update an existing resource server.
@@ -16790,7 +19768,7 @@ up
Source:
Parameters:
- Email provider parameters.
+ Resource Server parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Resource Server ID.
+
+
+
+
+
+
+
+
@@ -16895,7 +19924,7 @@ Parameters:
- Updated email provider data.
+ Updated Resource Server data.
@@ -16982,13 +20011,15 @@ Returns:
Example
- management.updateEmailProvider(params, data, function (err, provider) {
+ var data = { name: 'newResourceServerName' };
+var params = { id: RESOURCE_SERVER_ID };
+
+management.updateResourceServer(params, data, function (err, resourceServer) {
if (err) {
// Handle error.
}
- // Updated email provider.
- console.log(provider);
+ console.log(resourceServer.name); // 'newResourceServerName'
});
@@ -17000,14 +20031,14 @@ Example
- updateResourceServer(params, data, cbopt) → {Promise|undefined}
+ updateRule(params, data, cbopt) → {Promise|undefined}
- Update an existing resource server.
+ Update an existing rule.
@@ -17043,7 +20074,7 @@ u
Source:
Parameters:
- Resource Server parameters.
+ Rule parameters.
@@ -17157,7 +20188,7 @@ Parameters:
- Resource Server ID.
+ Rule ID.
@@ -17199,7 +20230,7 @@ Parameters:
- Updated Resource Server data.
+ Updated rule data.
@@ -17286,15 +20317,14 @@ Returns:
Example
- var data = { name: 'newResourceServerName' };
-var params = { id: RESOURCE_SERVER_ID };
-
-management.updateResourceServer(params, data, function (err, resourceServer) {
+ var params = { id: RULE_ID };
+var data = { name: 'my-rule'};
+management.updateRule(params, data, function (err, rule) {
if (err) {
// Handle error.
}
- console.log(resourceServer.name); // 'newResourceServerName'
+ console.log(rule.name); // 'my-rule'.
});
@@ -17306,14 +20336,14 @@ Example
- updateRule(params, data, cbopt) → {Promise|undefined}
+ updateTenantSettings(data, cbopt) → {Promise|undefined}
- Update an existing rule.
+ Update the tenant settings.
@@ -17340,89 +20370,36 @@ updateRule<
-
-
-
-
-
-
-
- Source:
- Parameters:
-
-
-
-
-
-
- Name
-
+
- Type
+
-
- Attributes
-
+
-
+
+ Source:
+ Description
-
-
+
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
- Rule parameters.
-
-
+
+ Parameters:
+
@@ -17434,6 +20411,8 @@ Parameters:
Type
+ Attributes
+
@@ -17444,40 +20423,6 @@ Parameters:
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Rule ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
dataParameters:
- Updated rule data.
+ The new tenant settings.
@@ -17592,14 +20537,10 @@ Returns:
Example
- var params = { id: RULE_ID };
-var data = { name: 'my-rule'};
-management.updateRule(params, data, function (err, rule) {
+ management.updateTenantSettings(data, function (err) {
if (err) {
// Handle error.
}
-
- console.log(rule.name); // 'my-rule'.
});
@@ -17611,14 +20552,14 @@ Example
- updateTenantSettings(data, cbopt) → {Promise|undefined}
+ updateUser(params, data, cbopt) → {Promise|undefined}
- Update the tenant settings.
+ Update a user by its id.
@@ -17654,7 +20595,7 @@ u
Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The user parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
dataParameters:
- The new tenant settings.
+ New user data.
@@ -17761,7 +20787,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -17812,10 +20838,15 @@ Returns:
Example
- management.updateTenantSettings(data, function (err) {
+ var params = { id: USER_ID };
+
+management.updateUser(params, data, function (err, user) {
if (err) {
// Handle error.
}
+
+ // Updated user.
+ console.log(user);
});
@@ -17827,14 +20858,14 @@ Example
- updateUser(params, data, cbopt) → {Promise|undefined}
+ updateUserMetadata(params, metadata, cbopt) → {Promise|undefined}
- Update a user by its id.
+ Update the user metadata for a user.
@@ -17870,7 +20901,7 @@ updateUser<
Source:
Parameters:
- The user parameters.
+ The user data object..
@@ -18001,7 +21032,7 @@ Parameters:
- datametadata
@@ -18026,7 +21057,7 @@ Parameters:
- New user data.
+ New user metadata.
@@ -18114,8 +21145,11 @@ Returns:
Example
var params = { id: USER_ID };
+var metadata = {
+ address: '123th Node.js Street'
+};
-management.updateUser(params, data, function (err, user) {
+management.updateUserMetadata(params, metadata, function (err, user) {
if (err) {
// Handle error.
}
@@ -18133,14 +21167,14 @@ Example
- updateUserMetadata(params, metadata, cbopt) → {Promise|undefined}
+ verifyCustomDomain(params, cbopt) → {Promise|undefined}
- Update the user metadata for a user.
+ Verify a Custom Domain.
@@ -18176,7 +21210,7 @@ upd
Source:
Parameters:
- The user data object..
+ Custom Domain parameters.
@@ -18290,7 +21324,7 @@ Parameters:
- The user id.
+ Custom Domain ID.
@@ -18305,40 +21339,6 @@ Parameters:
-
-
- metadata
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- New user metadata.
-
-
-
-
-
-
cbParameters:
- Callback function
+ Callback function.
@@ -18419,18 +21419,12 @@ Returns:
Example
- var params = { id: USER_ID };
-var metadata = {
- address: '123th Node.js Street'
-};
-
-management.updateUserMetadata(params, metadata, function (err, user) {
+ management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+ console.log(customDomain);
});
@@ -18454,7 +21448,7 @@ Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 98a360c74..ff9ee87b1 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.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 0c021904e..506dcf254 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 482cb0539..7088c566b 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.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 4a371256c..502ae2f83 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 c81f2d396..b7640c53a 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 d73bbea41..ce9e4385a 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 527516334..c659e73ae 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -835,7 +835,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6cc15b131..ccc194f35 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.UsersManager.html b/docs/module-management.UsersManager.html
index 4a29c2bcb..33658deef 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5075,7 +5075,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 24524f386..138034ca4 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -150,7 +150,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index c703086b0..0a882f6e8 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -339,7 +339,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index e1092abfd..c1d593455 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -124,7 +124,7 @@ utils.js
diff --git a/package.json b/package.json
index da7529028..80138069b 100644
--- a/package.json
+++ b/package.json
@@ -1,16 +1,16 @@
{
"name": "auth0",
- "version": "2.14.0",
+ "version": "2.15.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
- "files": [
- "src"
- ],
+ "files": ["src"],
"scripts": {
"test": "mocha -R spec ./test/**/*.tests.js ./test/*.tests.js",
- "test:ci": "istanbul cover _mocha --report lcovonly -R $(find ./test -name *.tests.js) -- -R mocha-multi --reporter-options spec=-,mocha-junit-reporter=-",
+ "test:ci":
+ "istanbul cover _mocha --report lcovonly -R $(find ./test -name *.tests.js) -- -R mocha-multi --reporter-options spec=-,mocha-junit-reporter=-",
"test:coverage": "codecov",
- "test:watch": "cross-env NODE_ENV=test mocha --timeout 5000 ./test/**/*.tests.js ./test/*.tests.js --watch",
+ "test:watch":
+ "cross-env NODE_ENV=test mocha --timeout 5000 ./test/**/*.tests.js ./test/*.tests.js --watch",
"jsdoc:generate": "jsdoc --configure .jsdoc.json --verbose",
"release:clean": "node scripts/cleanup.js",
"preversion": "node scripts/prepare.js",
@@ -22,10 +22,7 @@
"type": "git",
"url": "https://github.com/auth0/node-auth0"
},
- "keywords": [
- "auth0",
- "api"
- ],
+ "keywords": ["auth0", "api"],
"author": "Auth0",
"license": "MIT",
"bugs": {
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
diff --git a/docs/index.html b/docs/index.html
index 284900d46..35675c193 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -151,7 +151,7 @@ License
This project is licensed under the MIT license. See the
diff --git a/docs/index.js.html b/docs/index.js.html
index 1c8d473a0..9e941863c 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 48fdcb021..57186a500 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_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index 02d124357..090f03820 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 ee848a5a2..c8a415528 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 15c95b0b1..70edd7e7a 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index 09e419d59..8940d287b 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 f5dc2e012..9f64551f5 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 38f961049..276f60672 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -132,7 +132,10 @@ management/EmailProviderManager.js
* });
*
* @param {Function} [cb] Callback function.
- *
+ * @param {Object} [params] Clients parameters.
+ * @param {Number} [params.fields] A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
+ * @param {Number} [params.include_fields] true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(EmailProviderManager, 'get', 'resource.getAll');
@@ -195,7 +198,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index b926f4b92..1d5725300 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_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index fd969d25b..3afa11710 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 0b1a0388d..409665611 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -98,6 +98,19 @@ management/JobsManager.js
options.tokenProvider
);
this.jobs = new RetryRestClient(auth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for consuming the
+ * {@link https://auth0.com/docs/api/v2#!/Jobs/post_users_exports Create job to export users endpoint}
+ *
+ * @type {external:RestClient}
+ */
+ const usersExportsRestClient = new Auth0RestClient(
+ options.baseUrl + '/jobs/users-exports',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.usersExports = new RetryRestClient(usersExportsRestClient, options.retry);
};
/**
@@ -155,7 +168,7 @@ management/JobsManager.js
* send_completion_email: false //optional
* };
*
- * management.jobs.get(params, function (err) {
+ * management.jobs.importUsers(params, function (err) {
* if (err) {
* // Handle error.
* }
@@ -235,6 +248,63 @@ management/JobsManager.js
return promise;
};
+/**
+ * Export all users to a file using a long running job.
+ *
+ * @method exportUsers
+ * @memberOf module:management.JobsManager.prototype
+ *
+ * @example
+ * var data = {
+ * connection_id: 'con_0000000000000001',
+ * format: 'csv',
+ * limit: 5,
+ * fields: [
+ * {
+ * "name": "user_id"
+ * },
+ * {
+ * "name": "name"
+ * },
+ * {
+ * "name": "email"
+ * },
+ * {
+ * "name": "identities[0].connection",
+ * "export_as": "provider"
+ * },
+ * {
+ * "name": "user_metadata.some_field"
+ * }
+ * ]
+ * }
+ *
+ * management.jobs.exportUsers(data, function (err, results) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Retrieved job.
+ * console.log(results);
+ * });
+ *
+ * @param {Object} data Users export data.
+ * @param {String} [data.connection_id] The connection id of the connection from which users will be exported
+ * @param {String} [data.format] The format of the file. Valid values are: "json" and "csv".
+ * @param {Number} [data.limit] Limit the number of records.
+ * @param {Object[]} [data.fields] A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+JobsManager.prototype.exportUsers = function(data, cb) {
+ if (cb && cb instanceof Function) {
+ return this.usersExports.create(data, cb);
+ }
+
+ return this.usersExports.create(data);
+};
+
/**
* Send a verification email to a user.
*
@@ -284,7 +354,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 6c9f5b9ea..02b71be8d 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 2b5b18db8..61a6fa94b 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -189,7 +189,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index 3cfaa5da4..fafbb3aca 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_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index 18de21ac5..439658b62 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
@@ -179,7 +179,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 8f51c048f..93eae695b 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 aff6e68c8..6ef638d33 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 2a14fe60a..25f65f66b 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -161,7 +161,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index ce0b83bb6..03451ef26 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_UsersManager.js.html b/docs/management_UsersManager.js.html
index 76adaeaa4..e09e07ad9 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -677,7 +677,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index 9e4daa584..a94ca9567 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -599,8 +599,8 @@ management/index.js
/**
* Get all Auth0 Client Grants.
*
- * @method getAll
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method getClientGrants
+ * @memberOf module:management.ManagementClient.prototype
*
* @example <caption>
* This method takes an optional object as first argument that may be used to
@@ -630,8 +630,8 @@ management/index.js
/**
* Create an Auth0 client grant.
*
- * @method create
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method createClientGrant
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.clientGrants.create(data, function (err) {
@@ -652,8 +652,8 @@ management/index.js
/**
* Update an Auth0 client grant.
*
- * @method update
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method updateClientGrant
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* var data = {
@@ -683,8 +683,8 @@ management/index.js
/**
* Delete an Auth0 client grant.
*
- * @method delete
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method deleteClientGrant
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.clientGrants.delete({ id: GRANT_ID }, function (err) {
@@ -1430,7 +1430,10 @@ management/index.js
* });
*
* @param {Function} [cb] Callback function.
- *
+ * @param {Object} [params] Clients parameters.
+ * @param {Number} [params.fields] A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
+ * @param {Number} [params.include_fields] true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(ManagementClient, 'getEmailProvider', 'emailProvider.get');
@@ -1649,6 +1652,57 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'importUsers', 'jobs.importUsers');
+/**
+ * Export all users to a file using a long running job.
+ *
+ * @method exportUsers
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var data = {
+ * connection_id: 'con_0000000000000001',
+ * format: 'csv',
+ * limit: 5,
+ * fields: [
+ * {
+ * "name": "user_id"
+ * },
+ * {
+ * "name": "name"
+ * },
+ * {
+ * "name": "email"
+ * },
+ * {
+ * "name": "identities[0].connection",
+ * "export_as": "provider"
+ * },
+ * {
+ * "name": "user_metadata.some_field"
+ * }
+ * ]
+ * }
+ *
+ * management.exportUsers(data, function (err, results) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Retrieved job.
+ * console.log(results);
+ * });
+ *
+ * @param {Object} data Users export data.
+ * @param {String} [data.connection_id] The connection id of the connection from which users will be exported
+ * @param {String} [data.format] The format of the file. Valid values are: "json" and "csv".
+ * @param {Number} [data.limit] Limit the number of records.
+ * @param {Object[]} [data.fields] A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'exportUsers', 'jobs.exportUsers');
+
/**
* Send a verification email to a user.
*
@@ -1982,8 +2036,8 @@ management/index.js
/**
* Create an Auth0 Custom Domain.
*
- * @method create
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method createCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.createCustomDomain(data, function (err) {
@@ -2004,8 +2058,8 @@ management/index.js
/**
* Get all Auth0 CustomDomains.
*
- * @method getAll
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method getCustomDomains
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.getCustomDomains(function (err, customDomains) {
@@ -2019,8 +2073,8 @@ management/index.js
/**
* Get a Custom Domain.
*
- * @method get
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method getCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
@@ -2042,8 +2096,8 @@ management/index.js
/**
* Verify a Custom Domain.
*
- * @method verify
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method verifyCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
@@ -2065,8 +2119,8 @@ management/index.js
/**
* Delete a Custom Domain.
*
- * @method delete
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method deleteCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
@@ -2089,7 +2143,7 @@ management/index.js
* Create a Guardian enrollment ticket.
*
* @method createGuardianEnrollmentTicket
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.createGuardianEnrollmentTicket(function (err, ticket) {
@@ -2110,7 +2164,7 @@ management/index.js
* Get a list of Guardian factors and statuses.
*
* @method getGuardianFactors
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.getGuardianFactors(function (err, factors) {
* console.log(factors.length);
@@ -2126,7 +2180,7 @@ management/index.js
* Get Guardian factor provider configuration
*
* @method getGuardianFactorProvider
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
* console.log(provider);
@@ -2147,7 +2201,7 @@ management/index.js
* Update Guardian's factor provider
*
* @method updateFactorProvider
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
* messaging_service_sid: 'XXXXXXXXXXXXXX',
@@ -2173,7 +2227,7 @@ management/index.js
* Get Guardian enrollment and verification factor templates
*
* @method getGuardianFactorTemplates
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
* console.log(templates);
@@ -2194,7 +2248,7 @@ management/index.js
* Update Guardian enrollment and verification factor templates
*
* @method updateGuardianFactorTemplates
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.updateGuardianFactorTemplates({ name: 'sms' }, {
* enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
@@ -2219,7 +2273,7 @@ management/index.js
* Update Guardian Factor
*
* @method updateGuardianFactor
- * @memberOf module.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.updateGuardianFactor({ name: 'sms' }, {
* enabled: true
@@ -2248,7 +2302,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index fb612176b..3759ff8a2 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -3894,7 +3894,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index b7b29e7b2..64f95eedb 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1590,7 +1590,7 @@ Parameters:
-Stinrg
+String
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index 8697b3777..f161a65ee 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -101,7 +101,7 @@ Source:
Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 1a653544b..9aec2c527 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1796,7 +1796,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index e81cdc6c4..e20079a2c 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index 97a1daf27..c01be4808 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 1b625dd20..f35ae1e47 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 249e89209..cc295c8ec 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-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 0451d5674..094d54110 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.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index dee679a9a..a14a07f8c 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -717,1097 +717,14 @@ Example
- create(data, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Create an Auth0 client grant.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The client data object.
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.clientGrants.create(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Client grant created.
-});
-
-
-
-
-
-
-
-
-
-
- delete(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Delete an Auth0 client grant.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Client parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Client grant ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.clientGrants.delete({ id: GRANT_ID }, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Grant deleted.
-});
-
-
-
-
-
-
-
-
-
-
- delete(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Delete an Auth0 client grant.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Client parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Client grant ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.clientGrants.delete({ id: GRANT_ID }, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Grant deleted.
-});
-
-
-
-
-
-
-
-
-
-
- getAll(paramsopt, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get all Auth0 Client Grants.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Client Grants 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.getClientGrants(params, function (err, grants) {
- console.log(grants.length);
-});
-
-
-
-
-
-
-
-
-
-
- getAll(paramsopt, cbopt) → {Promise|undefined}
+ delete(params, cbopt) → {Promise|undefined}
- Get all Auth0 Client Grants.
+ Delete an Auth0 client grant.
@@ -1843,7 +760,7 @@ getAllSource:
Parameters:
- <optional>
-
@@ -1916,7 +831,7 @@ Parameters:
- Client Grants parameters.
+ Client parameters.
@@ -1930,8 +845,6 @@ Parameters:
Type
- Attributes
-
@@ -1944,70 +857,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ Client grant ID.
@@ -2102,21 +969,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.clientGrants.delete({ id: GRANT_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
-management.clientGrants.getAll(params, function (err, grants) {
- console.log(grants.length);
+ // Grant deleted.
});
@@ -2128,14 +986,14 @@ Example
- update(params, data, cbopt) → {Promise|undefined}
+ getAll(paramsopt, cbopt) → {Promise|undefined}
- Update an Auth0 client grant.
+ Get all Auth0 Client Grants.
@@ -2171,7 +1029,7 @@ updateSource:
Parameters:
+ <optional>
+
@@ -2242,7 +1102,7 @@ Parameters:
- Client parameters.
+ Client Grants parameters.
@@ -2256,6 +1116,8 @@ Parameters:
Type
+ Attributes
+
@@ -2268,32 +1130,34 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
-
+
-
- Client grant ID.
-
-
+
+
-
-
-
+
+
+ Number of results per page.
@@ -2302,13 +1166,13 @@ Parameters:
- datapage
-Object
+Number
@@ -2317,6 +1181,8 @@ Parameters:
+ <optional>
+
@@ -2327,7 +1193,15 @@ Parameters:
- Updated client data.
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
@@ -2414,19 +1288,21 @@ Returns:
Example
- var data = {
- client_id: CLIENT_ID,
- audience: AUDIENCE,
- scope: []
+
+ 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: CLIENT_GRANT_ID };
-management.clientGrants.update(params, data, function (err, grant) {
- if (err) {
- // Handle error.
- }
- console.log(grant.id);
+management.clientGrants.getAll(params, function (err, grants) {
+ console.log(grants.length);
});
@@ -2760,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 02612947b..0b77f92d1 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 7ebfbcc77..c6a8da76d 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 6c4def656..c61671616 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -792,224 +792,6 @@ Example
-
-
-
-
- create(data, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Create an Auth0 Custom Domain.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The custom domain data object.
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.createCustomDomain(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // CustomDomain created.
-});
-
-
-
-
-
-
@@ -1057,7 +839,7 @@ deleteSource:
Returns:
Example
- management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ management.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -1283,14 +1065,14 @@ Example
- delete(params, cbopt) → {Promise|undefined}
+ get(params, cbopt) → {Promise|undefined}
- Delete a Custom Domain.
+ Get a Custom Domain.
@@ -1326,7 +1108,7 @@ deleteSource:
Returns:
Example
- management.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ management.customDomains.get({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
if (err) {
// Handle error.
}
- // CustomDomain deleted.
+ console.log(customDomain);
});
@@ -1552,14 +1334,14 @@ Example
- get(params, cbopt) → {Promise|undefined}
+ getAll() → {Promise|undefined}
- Get a Custom Domain.
+ Get all Auth0 CustomDomains.
@@ -1595,7 +1377,7 @@ getSource:
get
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Custom Domain parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Custom Domain ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
- if (err) {
- // Handle error.
- }
-
- console.log(customDomain);
-});
-
-
-
-
-
-
-
-
-
-
- get(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get a Custom Domain.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Custom Domain parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Custom Domain ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.customDomains.get({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
- if (err) {
- // Handle error.
- }
-
- console.log(customDomain);
-});
-
-
-
-
-
-
-
-
-
-
- getAll() → {Promise|undefined}
-
-
-
-
-
-
- Get all Auth0 CustomDomains.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.getCustomDomains(function (err, customDomains) {
- console.log(customDomains.length);
-});
-
-
-
-
-
-
-
-
-
-
- getAll() → {Promise|undefined}
-
-
-
-
-
-
- Get all Auth0 CustomDomains.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.customDomains.getAll(function (err, customDomains) {
- console.log(customDomains.length);
-});
-
-
-
-
-
-
-
-
-
-
- verify(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Verify a Custom Domain.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Custom Domain parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Custom Domain ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
@@ -2574,12 +1437,8 @@ Returns:
Example
- management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
- if (err) {
- // Handle error.
- }
-
- console.log(customDomain);
+ management.customDomains.getAll(function (err, customDomains) {
+ console.log(customDomains.length);
});
@@ -2872,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index 01d6666b7..c87bb56fc 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 52441ed0a..530ab5dcb 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -759,7 +759,7 @@ deleteSource:
Example
- get(cbopt) → {Promise|undefined}
+ get(cbopt, paramsopt) → {Promise|undefined}
@@ -1022,6 +1022,141 @@ Parameters:
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Clients parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ fields
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
+
+
+
+
+
+
+
+
+ include_fields
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1123,7 +1258,7 @@ updateSource:
Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index 2495916b4..ecaea5ef5 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.GuardianManager.html b/docs/module-management.GuardianManager.html
index eff768fda..59e6fb9d8 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -894,186 +894,6 @@ Example
-
-
-
-
- createGuardianEnrollmentTicket(cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Create a Guardian enrollment ticket.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.createGuardianEnrollmentTicket(function (err, ticket) {
- console.log(ticket);
-});
-
-
-
-
-
-
@@ -1620,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index a17cf8ff0..a8d359bf4 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -391,6 +391,81 @@ (inner)
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner, constant) usersExportsRestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the
+Create job to export users endpoint
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
@@ -419,6 +494,420 @@ Methods
+
+
+
+
+ exportUsers(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Export all users to a file using a long running job.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Users export data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ connection_id
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The connection id of the connection from which users will be exported
+
+
+
+
+
+
+
+
+ format
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The format of the file. Valid values are: "json" and "csv".
+
+
+
+
+
+
+
+
+ limit
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Limit the number of records.
+
+
+
+
+
+
+
+
+ fields
+
+
+Array.<Object>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = {
+ connection_id: 'con_0000000000000001',
+ format: 'csv',
+ limit: 5,
+ fields: [
+ {
+ "name": "user_id"
+ },
+ {
+ "name": "name"
+ },
+ {
+ "name": "email"
+ },
+ {
+ "name": "identities[0].connection",
+ "export_as": "provider"
+ },
+ {
+ "name": "user_metadata.some_field"
+ }
+ ]
+}
+
+management.jobs.exportUsers(data, function (err, results) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Retrieved job.
+ console.log(results);
+});
+
+
+
+
+
+
@@ -466,7 +955,7 @@ getSource:
importUser
Source:
Example
send_completion_email: false //optional
};
-management.jobs.get(params, function (err) {
+management.jobs.importUsers(params, function (err) {
if (err) {
// Handle error.
}
@@ -1120,7 +1609,7 @@ verifyEmai
Source:
Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index a476b9d52..c022c6e50 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 bc804d928..843cb3828 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -2376,7 +2376,7 @@ Source:
Example
- createConnection(data, cbopt) → {Promise|undefined}
+ createClientGrant(data, cbopt) → {Promise|undefined}
- Create a new connection.
+ Create an Auth0 client grant.
@@ -2812,7 +2812,7 @@ creat
Source:
Parameters:
- Connection data object.
+ The client data object.
@@ -2970,12 +2970,12 @@ Returns:
Example
- management.createConnection(data, function (err) {
+ management.clientGrants.create(data, function (err) {
if (err) {
// Handle error.
}
- // Conection created.
+ // Client grant created.
});
@@ -2987,14 +2987,14 @@ Example
- createDevicePublicKey(data, cbopt) → {Promise|undefined}
+ createConnection(data, cbopt) → {Promise|undefined}
- Create an Auth0 credential.
+ Create a new connection.
@@ -3030,7 +3030,7 @@
Source:
Parameters:
- The device credential data object.
+ Connection data object.
@@ -3193,7 +3193,7 @@ Example
// Handle error.
}
- // Credential created.
+ // Conection created.
});
@@ -3205,14 +3205,14 @@ Example
- createEmailVerificationTicket(cbopt) → {Promise}
+ createCustomDomain(data, cbopt) → {Promise|undefined}
- Create an email verification ticket.
+ Create an Auth0 Custom Domain.
@@ -3248,7 +3248,7 @@ Source:
Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The custom domain data object.
+
+
+
+
+
+
cbReturns:
Promise
+|
+
+undefined
@@ -3369,15 +3406,12 @@ Returns:
Example
- var data = {
- user_id: '{USER_ID}',
- result_url: '{REDIRECT_URL}' // Optional redirect after the ticket is used.
-};
-
-auth0.createEmailVerificationTicket(data, function (err) {
+ management.createCustomDomain(data, function (err) {
if (err) {
// Handle error.
}
+
+ // CustomDomain created.
});
@@ -3389,14 +3423,14 @@ Example
- createPasswordChangeTicket(cbopt) → {Promise}
+ createDevicePublicKey(data, cbopt) → {Promise|undefined}
- Create a new password change ticket.
+ Create an Auth0 credential.
@@ -3432,7 +3466,7 @@ Source:
Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The device credential data object.
+
+
+
+
+
+
cbReturns:
Promise
+|
+
+undefined
@@ -3553,17 +3624,12 @@ Returns:
Example
- var params = {
- result_url: '{REDIRECT_URL}', // Redirect after using the ticket.
- user_id: '{USER_ID}', // Optional.
- email: '{USER_EMAIL}', // Optional.
- new_password: '{PASSWORD}'
-};
-
-auth0.createPasswordChangeTicket(params, function (err) {
+ management.createConnection(data, function (err) {
if (err) {
// Handle error.
}
+
+ // Credential created.
});
@@ -3575,14 +3641,14 @@ Example
- createResourceServer(data, cbopt) → {Promise|undefined}
+ createEmailVerificationTicket(cbopt) → {Promise}
- Create a new resource server.
+ Create an email verification ticket.
@@ -3618,7 +3684,7 @@ c
Source:
Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Resource Server data object.
-
-
-
-
-
-
cbReturns:
Promise
-|
-
-undefined
@@ -3776,12 +3805,15 @@ Returns:
Example
- management.createResourceServer(data, function (err) {
+ var data = {
+ user_id: '{USER_ID}',
+ result_url: '{REDIRECT_URL}' // Optional redirect after the ticket is used.
+};
+
+auth0.createEmailVerificationTicket(data, function (err) {
if (err) {
// Handle error.
}
-
- // Resource Server created.
});
@@ -3793,14 +3825,14 @@ Example
- createRule(data, cbopt) → {Promise|undefined}
+ createGuardianEnrollmentTicket(cbopt) → {Promise|undefined}
- Create a new rule.
+ Create a Guardian enrollment ticket.
@@ -3836,7 +3868,7 @@ createRule<
Source:
Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Rule data object.
-
-
-
-
-
-
cbReturns:
Example
- management.createRule(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Rule created.
+ management.createGuardianEnrollmentTicket(function (err, ticket) {
+ console.log(ticket);
});
@@ -4011,14 +4005,14 @@ Example
- createUser(data, cbopt) → {Promise|undefined}
+ createPasswordChangeTicket(cbopt) → {Promise}
- Create a new user.
+ Create a new password change ticket.
@@ -4054,7 +4048,7 @@ createUser<
Source:
Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- User data.
-
-
-
-
-
-
cbReturns:
Promise
-|
-
-undefined
@@ -4212,12 +4169,17 @@ Returns:
Example
- management.createUser(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // User created.
+ var params = {
+ result_url: '{REDIRECT_URL}', // Redirect after using the ticket.
+ user_id: '{USER_ID}', // Optional.
+ email: '{USER_EMAIL}', // Optional.
+ new_password: '{PASSWORD}'
+};
+
+auth0.createPasswordChangeTicket(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
});
@@ -4229,14 +4191,14 @@ Example
- deleteAllUsers(cbopt) → {Promise|undefined}
+ createResourceServer(data, cbopt) → {Promise|undefined}
- Delete all users.
+ Create a new resource server.
@@ -4260,8 +4222,6 @@ deleteA
- Deprecated: - This method will be removed in the next major release.
deleteA
Source:
Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Resource Server data object.
+
+
+
+
+
+
cbParameters:
- Callback function
+ Callback function.
@@ -4398,12 +4392,12 @@ Returns:
Example
- management.deleteAllUsers(function (err) {
+ management.createResourceServer(data, function (err) {
if (err) {
// Handle error.
}
- // Users deleted
+ // Resource Server created.
});
@@ -4415,14 +4409,14 @@ Example
- deleteClient(params, cbopt) → {Promise|undefined}
+ createRule(data, cbopt) → {Promise|undefined}
- Delete an Auth0 client.
+ Create a new rule.
@@ -4458,7 +4452,7 @@ deleteCli
Source:
Parameters:
- paramsdata
@@ -4529,58 +4523,7 @@ Parameters:
- Client parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- client_id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Application client ID.
-
-
-
-
-
-
-
-
+ Rule data object.
@@ -4667,12 +4610,12 @@ Returns:
Example
- management.deleteClient({ client_id: CLIENT_ID }, function (err) {
+ management.createRule(data, function (err) {
if (err) {
// Handle error.
}
- // Client deleted.
+ // Rule created.
});
@@ -4684,14 +4627,14 @@ Example
- deleteConnection(params, cbopt) → {Promise|undefined}
+ createUser(data, cbopt) → {Promise|undefined}
- Delete an existing connection.
+ Create a new user.
@@ -4727,7 +4670,7 @@ delet
Source:
Parameters:
- paramsdata
@@ -4798,58 +4741,7 @@ Parameters:
- Connection parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Connection ID.
-
-
-
-
-
-
-
-
+ User data.
@@ -4936,12 +4828,12 @@ Returns:
Example
- management.deleteConnection({ id: CONNECTION_ID }, function (err) {
+ management.createUser(data, function (err) {
if (err) {
// Handle error.
}
- // Conection deleted.
+ // User created.
});
@@ -4953,14 +4845,14 @@ Example
- deleteDeviceCredential(params, cbopt) → {Promise|undefined}
+ deleteAllUsers(cbopt) → {Promise|undefined}
- Delete an Auth0 device credential.
+ Delete all users.
@@ -4984,6 +4876,8 @@ Deprecated:- This method will be removed in the next major release.
Source:
Parameters:
- paramscb
-Object
+function
@@ -5057,6 +4951,8 @@ Parameters:
+ <optional>
+
@@ -5067,119 +4963,32 @@ Parameters:
- Credential parameters.
+ Callback function
-
-
-
-
-
-
- Name
-
+
+
- Type
+
+
+
-
-
- Description
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
- Device credential ID.
-
-
-
-
-
-
-
-
-
-
+
+Returns:
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
+
-
@@ -5205,14 +5014,12 @@
Returns:
Example
- var params = { id: CREDENTIAL_ID };
-
-management.deleteDeviceCredential(params, function (err) {
+ management.deleteAllUsers(function (err) {
if (err) {
// Handle error.
}
- // Credential deleted.
+ // Users deleted
});
@@ -5224,14 +5031,14 @@ Example
- deleteEmailProvider(cbopt) → {Promise|undefined}
+ deleteClient(params, cbopt) → {Promise|undefined}
- Delete email provider.
+ Delete an Auth0 client.
@@ -5267,7 +5074,7 @@ de
- Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Client parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Application client ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.deleteEmailProvider(function (err) {
+ management.deleteClient({ client_id: CLIENT_ID }, function (err) {
if (err) {
// Handle error.
}
- // Email provider deleted.
+ // Client deleted.
});
@@ -5408,14 +5300,14 @@ Example
- deleteGuardianEnrollment(data, cbopt) → {Promise|undefined}
+ deleteClientGrant(params, cbopt) → {Promise|undefined}
- Delete a user's Guardian enrollment.
+ Delete an Auth0 client grant.
@@ -5451,7 +5343,7 @@ Source:
Parameters:
- dataparams
@@ -5522,7 +5414,7 @@ Parameters:
- The Guardian enrollment data object.
+ Client parameters.
@@ -5565,7 +5457,7 @@ Parameters:
- The Guardian enrollment id.
+ Client grant ID.
@@ -5660,12 +5552,12 @@ Returns:
Example
- management.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err) {
+ management.clientGrants.delete({ id: GRANT_ID }, function (err) {
if (err) {
// Handle error.
}
- // Email provider deleted.
+ // Grant deleted.
});
@@ -5677,14 +5569,14 @@ Example
- deleteResourceServer(params, cbopt) → {Promise|undefined}
+ deleteConnection(params, cbopt) → {Promise|undefined}
- Delete an existing resource server.
+ Delete an existing connection.
@@ -5720,7 +5612,7 @@ d
- Source:
Parameters:
- Resource Server parameters.
+ Connection parameters.
@@ -5834,7 +5726,7 @@ Parameters:
- Resource Server ID.
+ Connection ID.
@@ -5929,12 +5821,12 @@ Returns:
Example
- management.deleteResourceServer({ id: RESOURCE_SERVER_ID }, function (err) {
+ management.deleteConnection({ id: CONNECTION_ID }, function (err) {
if (err) {
// Handle error.
}
- // Resource Server deleted.
+ // Conection deleted.
});
@@ -5946,14 +5838,14 @@ Example
- deleteRule(params, cbopt) → {Promise|undefined}
+ deleteCustomDomain(params, cbopt) → {Promise|undefined}
- Delete an existing rule.
+ Delete a Custom Domain.
@@ -5989,7 +5881,7 @@ deleteRule<
- Source:
Parameters:
- Rule parameters.
+ Custom Domain parameters.
@@ -6103,7 +5995,7 @@ Parameters:
- Rule ID.
+ Custom Domain ID.
@@ -6198,12 +6090,12 @@ Returns:
Example
- auth0.deleteRule({ id: RULE_ID }, function (err) {
+ management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
if (err) {
// Handle error.
}
- // Rule deleted.
+ // CustomDomain deleted.
});
@@ -6215,14 +6107,14 @@ Example
- deleteRulesConfig(params, cbopt) → {Promise|undefined}
+ deleteDeviceCredential(params, cbopt) → {Promise|undefined}
- Delete rules config.
+ Delete an Auth0 device credential.
@@ -6258,7 +6150,7 @@ dele
- Source:
Parameters:
- Rule Configs parameters.
+ Credential parameters.
@@ -6355,7 +6247,7 @@ Parameters:
- keyid
@@ -6372,7 +6264,7 @@ Parameters:
- Rule Configs key.
+ Device credential ID.
@@ -6467,12 +6359,14 @@ Returns:
Example
- management.deleteRulesConfig({ key: RULE_CONFIG_KEY }, function (err) {
+ var params = { id: CREDENTIAL_ID };
+
+management.deleteDeviceCredential(params, function (err) {
if (err) {
// Handle error.
}
- // Rules Config deleted.
+ // Credential deleted.
});
@@ -6484,14 +6378,14 @@ Example
- deleteUser(params, cbopt) → {Promise|undefined}
+ deleteEmailProvider(cbopt) → {Promise|undefined}
- Delete a user by its id.
+ Delete email provider.
@@ -6527,7 +6421,7 @@ deleteUser<
- Source:
Parameters:
- paramscb
-Object
+function
@@ -6588,6 +6482,8 @@ Parameters:
+ <optional>
+
@@ -6598,101 +6494,14 @@ Parameters:
- The user data object..
+ Callback function.
-
-
-
-
-
-
- Name
-
+
+
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- The user id.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function
-
-
-
-
-
-
-
+
+
+
@@ -6736,12 +6545,12 @@ Returns:
Example
- management.deleteUser({ id: USER_ID }, function (err) {
+ management.deleteEmailProvider(function (err) {
if (err) {
// Handle error.
}
- // User deleted.
+ // Email provider deleted.
});
@@ -6753,14 +6562,14 @@ Example
- deleteUserMultifactor(params, cbopt) → {Promise|undefined}
+ deleteGuardianEnrollment(data, cbopt) → {Promise|undefined}
- Delete a multifactor provider for a user.
+ Delete a user's Guardian enrollment.
@@ -6796,7 +6605,7 @@
Source:
Parameters:
- paramsdata
@@ -6867,7 +6676,7 @@ Parameters:
- Data object.
+ The Guardian enrollment data object.
@@ -6910,33 +6719,7 @@ Parameters:
- The user id.
-
-
-
-
-
-
-
-
- provider
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Multifactor provider.
+ The Guardian enrollment id.
@@ -6980,7 +6763,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -7031,14 +6814,12 @@ Returns:
Example
- var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-
-management.deleteUserMultifactor(params, function (err, user) {
+ management.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // Email provider deleted.
});
@@ -7050,14 +6831,14 @@ Example
- deleteUserMultifcator(params, cbopt) → {Promise|undefined}
+ deleteResourceServer(params, cbopt) → {Promise|undefined}
- Delete a multifactor provider for a user.
+ Delete an existing resource server.
@@ -7081,10 +6862,6 @@
- Deprecated: - The function name has a typo.
-We're shipping this so it doesn't break compatibility.
-Use
deleteUserMultifactor instead.
Source:
Parameters:
- Data object.
+ Resource Server parameters.
@@ -7211,33 +6988,7 @@ Parameters:
- The user id.
-
-
-
-
-
-
-
-
- provider
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Multifactor provider.
+ Resource Server ID.
@@ -7281,7 +7032,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -7332,14 +7083,12 @@ Returns:
Example
- var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-
-management.deleteUserMultifcator(params, function (err, user) {
+ management.deleteResourceServer({ id: RESOURCE_SERVER_ID }, function (err) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // Resource Server deleted.
});
@@ -7351,14 +7100,14 @@ Example
- getActiveUsersCount(cbopt) → {Promise|undefined}
+ deleteRule(params, cbopt) → {Promise|undefined}
- Get a the active users count.
+ Delete an existing rule.
@@ -7394,7 +7143,7 @@ ge
Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rule parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.getActiveUsersCount(function (err, usersCount) {
+ auth0.deleteRule({ id: RULE_ID }, function (err) {
if (err) {
// Handle error.
}
- console.log(usersCount);
+ // Rule deleted.
});
@@ -7535,14 +7369,14 @@ Example
- getBlacklistedTokens(cbopt) → {Promise|undefined}
+ deleteRulesConfig(params, cbopt) → {Promise|undefined}
- Get all blacklisted tokens.
+ Delete rules config.
@@ -7578,7 +7412,7 @@ g
Source:
Parameters:
- cbparams
-function
+Object
@@ -7639,8 +7473,6 @@ Parameters:
- <optional>
-
@@ -7651,7 +7483,94 @@ Parameters:
- Callback function.
+ Rule Configs parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule Configs key.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
@@ -7702,8 +7621,12 @@ Returns:
Example
- management.getBlacklistedTokens(function (err, tokens) {
- console.log(tokens.length);
+ management.deleteRulesConfig({ key: RULE_CONFIG_KEY }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Rules Config deleted.
});
@@ -7715,14 +7638,14 @@ Example
- getClient(params, cbopt) → {Promise|undefined}
+ deleteUser(params, cbopt) → {Promise|undefined}
- Get an Auth0 client.
+ Delete a user by its id.
@@ -7758,7 +7681,7 @@ getClientSource:
Parameters:
- Client parameters.
+ The user data object..
@@ -7855,7 +7778,7 @@ Parameters:
- client_idid
@@ -7872,7 +7795,7 @@ Parameters:
- Application client ID.
+ The user id.
@@ -7916,7 +7839,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -7967,12 +7890,12 @@ Returns:
Example
- management.getClient({ client_id: CLIENT_ID }, function (err, client) {
+ management.deleteUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
- console.log(client);
+ // User deleted.
});
@@ -7984,122 +7907,14 @@ Example
- getClientInfo() → {Object}
-
-
-
-
-
-
- Return an object with information about the current client,
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Object
-
-
-
-
-
-
-
- Object containing client information.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- getClients(paramsopt, cbopt) → {Promise|undefined}
+ deleteUserMultifactor(params, cbopt) → {Promise|undefined}
- Get all Auth0 clients.
+ Delete a multifactor provider for a user.
@@ -8135,7 +7950,7 @@ getClients<
Source:
Parameters:
- <optional>
-
@@ -8208,7 +8021,7 @@ Parameters:
- Clients parameters.
+ Data object.
@@ -8222,8 +8035,6 @@ Parameters:
Type
- Attributes
-
@@ -8236,34 +8047,24 @@ Parameters:
- per_pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Number of results per page.
+ The user id.
@@ -8272,34 +8073,24 @@ Parameters:
- pageprovider
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ Multifactor provider.
@@ -8343,7 +8134,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -8394,20 +8185,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, provider: MULTIFACTOR_PROVIDER };
-management.getClients(params, function (err, clients) {
- console.log(clients.length);
+management.deleteUserMultifactor(params, function (err, user) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Users accounts unlinked.
});
@@ -8419,14 +8204,14 @@ Example
- getConnection(params, cbopt) → {Promise|undefined}
+ deleteUserMultifcator(params, cbopt) → {Promise|undefined}
- Get an Auth0 connection.
+ Delete a multifactor provider for a user.
@@ -8450,6 +8235,10 @@ getConne
+ Deprecated: - The function name has a typo.
+We're shipping this so it doesn't break compatibility.
+Use
deleteUserMultifactor instead.
getConne
Source:
Parameters:
- Connection parameters.
+ Data object.
@@ -8576,7 +8365,33 @@ Parameters:
- Connection ID.
+ The user id.
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Multifactor provider.
@@ -8620,7 +8435,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -8671,12 +8486,14 @@ Returns:
Example
- management.getConnection({ id: CONNECTION_ID }, function (err, connection) {
+ var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
+
+management.deleteUserMultifcator(params, function (err, user) {
if (err) {
// Handle error.
}
- console.log(connection);
+ // Users accounts unlinked.
});
@@ -8688,14 +8505,14 @@ Example
- getConnections(paramsopt, cbopt) → {Promise|undefined}
+ exportUsers(data, cbopt) → {Promise|undefined}
- Get all connections.
+ Export all users to a file using a long running job.
@@ -8731,7 +8548,7 @@ getConn
Source:
Parameters:
- paramsdata
@@ -8792,8 +8609,6 @@ Parameters:
- <optional>
-
@@ -8804,7 +8619,7 @@ Parameters:
- Connections params.
+ Users export data.
@@ -8832,13 +8647,13 @@ Parameters:
- per_pageconnection_id
-Number
+String
@@ -8859,7 +8674,7 @@ Parameters:
- Number of results per page.
+ The connection id of the connection from which users will be exported
@@ -8868,7 +8683,43 @@ Parameters:
- pageformat
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The format of the file. Valid values are: "json" and "csv".
+
+
+
+
+
+
+
+
+ limit
@@ -8895,7 +8746,43 @@ Parameters:
- Page number, zero indexed.
+ Limit the number of records.
+
+
+
+
+
+
+
+
+ fields
+
+
+Array.<Object>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
@@ -8990,20 +8877,37 @@ 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 data = {
+ connection_id: 'con_0000000000000001',
+ format: 'csv',
+ limit: 5,
+ fields: [
+ {
+ "name": "user_id"
+ },
+ {
+ "name": "name"
+ },
+ {
+ "name": "email"
+ },
+ {
+ "name": "identities[0].connection",
+ "export_as": "provider"
+ },
+ {
+ "name": "user_metadata.some_field"
+ }
+ ]
+}
+
+management.exportUsers(data, function (err, results) {
+ if (err) {
+ // Handle error.
+ }
-management.getConnections(params, function (err, connections) {
- console.log(connections.length);
+ // Retrieved job.
+ console.log(results);
});
@@ -9015,14 +8919,14 @@ Example
- getDailyStats(params, cbopt) → {Promise|undefined}
+ getActiveUsersCount(cbopt) → {Promise|undefined}
- Get the daily stats.
+ Get a the active users count.
@@ -9058,7 +8962,7 @@ getDaily
Source:
Parameters:
- paramscb
-Object
+function
@@ -9119,6 +9023,8 @@ Parameters:
+ <optional>
+
@@ -9129,156 +9035,43 @@ Parameters:
- Stats parameters.
+ Callback function.
-
-
-
-
-
-
- Name
-
+
+
- Type
+
+
+
-
-
- Description
-
-
-
-
-
-
- from
-
-
-String
-
-
-
-
-
- The first day in YYYYMMDD format.
-
-
-
-
-
-
- to
-
-
-String
+
+Returns:
+
-
-
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
-
-
-
-
-
- The last day in YYYYMMDD format.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
+undefined
@@ -9293,17 +9086,12 @@ Returns:
Example
- var params = {
- from: '{YYYYMMDD}', // First day included in the stats.
- to: '{YYYYMMDD}' // Last day included in the stats.
-};
-
-management.getDaily(params, function (err, stats) {
+ management.getActiveUsersCount(function (err, usersCount) {
if (err) {
// Handle error.
}
- console.log(stats);
+ console.log(usersCount);
});
@@ -9315,14 +9103,14 @@ Example
- getDeviceCredentials(cbopt) → {Promise|undefined}
+ getBlacklistedTokens(cbopt) → {Promise|undefined}
- Get all Auth0 credentials.
+ Get all blacklisted tokens.
@@ -9358,7 +9146,7 @@ g
- Source:
Returns:
Example
- management.getDeviceCredentials(function (err, credentials) {
- console.log(credentials.length);
+ management.getBlacklistedTokens(function (err, tokens) {
+ console.log(tokens.length);
});
@@ -9495,14 +9283,14 @@ Example
- getEmailProvider(cbopt) → {Promise|undefined}
+ getClient(params, cbopt) → {Promise|undefined}
- Get the email provider.
+ Get an Auth0 client.
@@ -9538,7 +9326,7 @@ getEm
- Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Client parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Application client ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.getEmailProvider(function (err, provider) {
- console.log(provider.length);
+ management.getClient({ client_id: CLIENT_ID }, function (err, client) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(client);
});
@@ -9675,14 +9552,14 @@ Example
- getGuardianEnrollment(data, cbopt) → {Promise|undefined}
+ getClientGrants(paramsopt, cbopt) → {Promise|undefined}
- Get a single Guardian enrollment.
+ Get all Auth0 Client Grants.
@@ -9718,7 +9595,7 @@
- Source:
Parameters:
- dataparams
@@ -9779,6 +9656,8 @@ Parameters:
+ <optional>
+
@@ -9789,7 +9668,7 @@ Parameters:
- The Guardian enrollment data object.
+ Client Grants parameters.
@@ -9803,6 +9682,8 @@ Parameters:
Type
+ Attributes
+
@@ -9815,32 +9696,34 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
-
+
-
- The Guardian enrollment id.
-
-
+
+
-
-
-
+
+
+ Number of results per page.
@@ -9849,13 +9732,13 @@ Parameters:
- cbpage
-function
+Number
@@ -9876,7 +9759,7 @@ Parameters:
- Callback function.
+ Page number, zero indexed.
@@ -9885,6 +9768,53 @@ Parameters:
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
@@ -9895,9 +9825,6 @@ Parameters:
-
-
-
Returns:
@@ -9927,8 +9854,20 @@ Returns:
Example
- management.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
- console.log(enrollment);
+
+ 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.getClientGrants(params, function (err, grants) {
+ console.log(grants.length);
});
@@ -9940,14 +9879,14 @@ Example
- getGuardianEnrollments(data, cbopt) → {Promise|undefined}
+ getClientInfo() → {Object}
- Get a list of a user's Guardian enrollments.
+ Return an object with information about the current client,
@@ -9983,7 +9922,115 @@ Source:
Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Object
+
+
+
+
+
+
+
+ Object containing client information.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ getClients(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 clients.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ Parameters:
- dataparams
@@ -10044,6 +10091,8 @@ Parameters:
+ <optional>
+
@@ -10054,7 +10103,7 @@ Parameters:
- The user data object.
+ Clients parameters.
@@ -10068,6 +10117,8 @@ Parameters:
Type
+ Attributes
+
@@ -10080,24 +10131,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- The user id.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -10192,8 +10289,20 @@ Returns:
Example
- management.getGuardianEnrollments({ id: USER_ID }, function (err, enrollments) {
- console.log(enrollments);
+
+ 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.getClients(params, function (err, clients) {
+ console.log(clients.length);
});
@@ -10205,14 +10314,14 @@ Example
- getJob(params, cbopt) → {Promise|undefined}
+ getConnection(params, cbopt) → {Promise|undefined}
- Get a job by its ID.
+ Get an Auth0 connection.
@@ -10248,7 +10357,7 @@ getJobSource:
Parameters:
- Job parameters.
+ Connection parameters.
@@ -10362,7 +10471,7 @@ Parameters:
- Job ID.
+ Connection ID.
@@ -10457,17 +10566,12 @@ Returns:
Example
- var params = {
- id: '{JOB_ID}'
-};
-
-management.getJob(params, function (err, job) {
+ management.getConnection({ id: CONNECTION_ID }, function (err, connection) {
if (err) {
// Handle error.
}
- // Retrieved job.
- console.log(job);
+ console.log(connection);
});
@@ -10479,14 +10583,14 @@ Example
- getLog(params, cbopt) → {Promise|undefined}
+ getConnections(paramsopt, cbopt) → {Promise|undefined}
- Get an Auth0 log.
+ Get all connections.
@@ -10522,7 +10626,7 @@ getLogSource:
Parameters:
+ <optional>
+
@@ -10593,7 +10699,7 @@ Parameters:
- Log parameters.
+ Connections params.
@@ -10607,6 +10713,8 @@ Parameters:
Type
+ Attributes
+
@@ -10619,24 +10727,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- Event ID.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -10731,12 +10885,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.getConnections(params, function (err, connections) {
+ console.log(connections.length);
});
@@ -10748,14 +10910,14 @@ Example
- getLogs(paramsopt, cbopt) → {Promise|undefined}
+ getCustomDomain(params, cbopt) → {Promise|undefined}
- Get all logs.
+ Get a Custom Domain.
@@ -10791,7 +10953,7 @@ getLogsSource:
Parameters:
- <optional>
-
@@ -10864,7 +11024,7 @@ Parameters:
- Logs params.
+ Custom Domain parameters.
@@ -10878,8 +11038,6 @@ Parameters:
Type
- Attributes
-
@@ -10892,7 +11050,7 @@ Parameters:
- qid
@@ -10905,21 +11063,19 @@ Parameters:
-
-
- <optional>
-
-
+
+
+ Custom Domain ID.
-
-
+
+
-
+
+
+
-
- Search Criteria using Query String Syntax
@@ -10928,13 +11084,13 @@ Parameters:
- pagecb
-Number
+function
@@ -10955,238 +11111,134 @@ Parameters:
- Page number. Zero based
+ Callback function.
+
+
-
-
- per_page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- The amount of entries per page
-
-
-
-
-
-
- sort
-
-
-String
-
-
+
+Returns:
-
-
-
- <optional>
-
+
-
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
-
-
-
+undefined
-
-
- The field to use for sorting.
-
-
-
+
+
+
+
-
-
- fields
-
-
-String
+
+Example
-
-
+ management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ if (err) {
+ // Handle error.
+ }
-
-
-
- <optional>
-
+ console.log(customDomain);
+});
-
+
-
-
+
+
+
-
+
-
- A comma separated list of fields to include or exclude
-
-
-
+ getCustomDomains() → {Promise|undefined}
-
-
- include_fields
-
-
-Boolean
+
+ Get all Auth0 CustomDomains.
+
-
-
-
-
-
- <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
-
-
-
+
-
-
-
-
-
+
+
+ Source:
+
-
- cb
-
-
-function
+
+
+
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
@@ -11230,20 +11282,8 @@ 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
-};
-
-management.getLogs(params, function (err, logs) {
- console.log(logs.length);
+ management.getCustomDomains(function (err, customDomains) {
+ console.log(customDomains.length);
});
@@ -11255,14 +11295,14 @@ Example
- getResourceServer(params, cbopt) → {Promise|undefined}
+ getDailyStats(params, cbopt) → {Promise|undefined}
- Get a Resource Server.
+ Get the daily stats.
@@ -11298,7 +11338,7 @@ getR
Source:
Parameters:
- Resource Server parameters.
+ Stats parameters.
@@ -11395,7 +11435,7 @@ Parameters:
- idfrom
@@ -11412,7 +11452,33 @@ Parameters:
- Resource Server ID.
+ The first day in YYYYMMDD format.
+
+
+
+
+
+
+
+
+ to
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The last day in YYYYMMDD format.
@@ -11507,12 +11573,17 @@ Returns:
Example
- management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+ var params = {
+ from: '{YYYYMMDD}', // First day included in the stats.
+ to: '{YYYYMMDD}' // Last day included in the stats.
+};
+
+management.getDaily(params, function (err, stats) {
if (err) {
// Handle error.
}
- console.log(resourceServer);
+ console.log(stats);
});
@@ -11524,14 +11595,14 @@ Example
- getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+ getDeviceCredentials(cbopt) → {Promise|undefined}
- Get all resource servers.
+ Get all Auth0 credentials.
@@ -11567,7 +11638,7 @@ get
Source:
Parameters:
- paramscb
-Object
+function
@@ -11640,226 +11711,79 @@ Parameters:
- Resource Servers parameters.
+ Callback function.
-
+
+
-
-
-
-
- Name
-
+
+
+
- Type
-
- Attributes
-
-
- Description
-
-
-
-
-
-
- per_page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
+
+Returns:
-
+
-
-
- page
+ -
+ Type:
+
+ -
+
+
Promise
+|
-
-
-
-Number
+undefined
-
-
+
+
-
-
-
- <optional>
-
-
+
+
-
-
-
-
-
- Page number, zero indexed.
-
-
-
+
+Example
+
+ management.getDeviceCredentials(function (err, credentials) {
+ console.log(credentials.length);
+});
+
+
+
+
+
+
+
-
-
-
-
-
+ getEmailProvider(cbopt, paramsopt) → {Promise|undefined}
-
-
- 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);
-});
-
-
-
-
-
-
-
-
-
-
- getRule(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get an Auth0 rule.
-
+
+ Get the email provider.
+
@@ -11894,7 +11818,7 @@ getRuleSource:
Parameters:
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
paramsParameters:
+ <optional>
+
@@ -11965,7 +11927,7 @@ Parameters:
- Rule parameters.
+ Clients parameters.
@@ -11979,6 +11941,8 @@ Parameters:
Type
+ Attributes
+
@@ -11991,32 +11955,34 @@ Parameters:
- idfields
-String
+Number
+
+
+ <optional>
+
-
+
-
- Rule ID.
-
-
+
+
-
-
-
+
+
+ A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
@@ -12025,13 +11991,13 @@ Parameters:
- cbinclude_fields
-function
+Number
@@ -12052,7 +12018,15 @@ Parameters:
- Callback function.
+ true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
+
+
+
+
+
+
+
@@ -12103,12 +12077,8 @@ Returns:
Example
- management.getRule({ id: RULE_ID }, function (err, rule) {
- if (err) {
- // Handle error.
- }
-
- console.log(rule);
+ management.getEmailProvider(function (err, provider) {
+ console.log(provider.length);
});
@@ -12120,14 +12090,14 @@ Example
- getRules(paramsopt, cbopt) → {Promise|undefined}
+ getGuardianEnrollment(data, cbopt) → {Promise|undefined}
- Get all rules.
+ Get a single Guardian enrollment.
@@ -12163,7 +12133,7 @@ getRulesSource:
Parameters:
- paramsdata
@@ -12224,8 +12194,6 @@ Parameters:
- <optional>
-
@@ -12236,7 +12204,7 @@ Parameters:
- Rules parameters.
+ The Guardian enrollment data object.
@@ -12250,8 +12218,6 @@ Parameters:
Type
- Attributes
-
@@ -12264,70 +12230,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ The Guardian enrollment id.
@@ -12422,20 +12342,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 = {
- per_page: 10,
- page: 0
-};
-
-management.getRules(params, function (err, rules) {
- console.log(rules.length);
+ management.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ console.log(enrollment);
});
@@ -12447,14 +12355,14 @@ Example
- getRulesConfigs() → {Promise|undefined}
+ getGuardianEnrollments(data, cbopt) → {Promise|undefined}
- Get rules config.
+ Get a list of a user's Guardian enrollments.
@@ -12490,7 +12398,7 @@ getRul
Source:
getRul
+ Parameters:
+
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
+
+
+
-
-
- -
- Type:
-
- -
+
Name
-Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.getRulesConfigs(function (err, rulesConfigs) {
- if (err) {
- // Handle error.
- }
-
- // Get Rules Configs.
-});
-
+ Type
-
-
-
-
-
-
- getTenantSettings(cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get the tenant settings..
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
- Attributes
+
-
+
-
+ Description
+
+
+
-
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
- Parameters:
-
+
+ The user data object.
+
+
@@ -12642,8 +12483,6 @@ Parameters:
Type
- Attributes
-
@@ -12654,6 +12493,40 @@ Parameters:
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.getSettings(function (err, settings) {
- if (err) {
- // Handle error.
- }
-
- console.log(settings);
+ management.getGuardianEnrollments({ id: USER_ID }, function (err, enrollments) {
+ console.log(enrollments);
});
@@ -12751,14 +12620,14 @@ Example
- getUser(data, cbopt) → {Promise|undefined}
+ getJob(params, cbopt) → {Promise|undefined}
- Get a user by its id.
+ Get a job by its ID.
@@ -12794,7 +12663,7 @@ getUserSource:
Parameters:
- dataparams
@@ -12865,7 +12734,7 @@ Parameters:
- The user data object.
+ Job parameters.
@@ -12908,7 +12777,7 @@ Parameters:
- The user id.
+ Job ID.
@@ -13003,8 +12872,17 @@ Returns:
Example
- management.getUser({ id: USER_ID }, function (err, user) {
- console.log(user);
+ var params = {
+ id: '{JOB_ID}'
+};
+
+management.getJob(params, function (err, job) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Retrieved job.
+ console.log(job);
});
@@ -13016,14 +12894,14 @@ Example
- getUserLogs(params, cbopt) → {Promise|undefined}
+ getLog(params, cbopt) → {Promise|undefined}
- Get user's log events.
+ Get an Auth0 log.
@@ -13059,7 +12937,7 @@ getUserLog
Source:
Parameters:
- Get logs data.
+ Log parameters.
@@ -13173,7 +13051,15 @@ Parameters:
- User id.
+ Event ID.
+
+
+
+
+
+
+
+
@@ -13182,24 +13068,2952 @@ Parameters:
- per_pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Number of results per page.
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getLog({ id: EVENT_ID }, function (err, log) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(log);
+});
+
+
+
+
+
+
+
+
+
+
+ getLogs(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all logs.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Logs params.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ q
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Search Criteria using Query String Syntax
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number. Zero based
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The amount of entries per page
+
+
+
+
+
+
+
+
+ sort
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The field to use for sorting.
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 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);
+});
+
+
+
+
+
+
+
+
+
+
+ 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);
+});
+
+
+
+
+
+
+
+
+
+
+ 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() → {Promise|undefined}
+
+
+
+
+
+
+ Get rules config.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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..
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getSettings(function (err, settings) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(settings);
+});
+
+
+
+
+
+
+
+
+
+
+ getUser(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a user by its id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - 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.getUser({ id: USER_ID }, function (err, user) {
+ console.log(user);
+});
+
+
+
+
+
+
+
+
+
+
+ getUserLogs(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get user's log events.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Get logs data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ User id.
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ sort
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+
+management.getUserLogs(params, function (err, logs) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logs);
+});
+
+
+
+
+
+
+
+
+
+
+ getUsers(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all users.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Users params.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ search_engine
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The version of the search engine to use.
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
@@ -13217,24 +16031,235 @@ Parameters:
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 = {
+ search_engine: 'v3',
+ per_page: 10,
+ page: 0
+};
+
+auth0.getUsers(params, function (err, users) {
+ console.log(users.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get users for a given email address
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
-
+
+ Attributes
+
-
+
-
- Page number, zero indexed.
-
-
-
+ Description
+
+
+
- sortemail
@@ -13247,45 +16272,21 @@ Parameters:
-
-
-
-
- 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
-
+ <optional>
-Boolean
+
-
-
-
+
+
- true if a query summary must be included in the result, false otherwise. Default false;
-
-
-
-
-
-
-
-
+ Email Address of users to locate
@@ -13372,14 +16373,13 @@ Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-
-management.getUserLogs(params, function (err, logs) {
- if (err) {
- // Handle error.
- }
-
- console.log(logs);
+
+ 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);
});
@@ -13391,14 +16391,15 @@ Example
- getUsers(paramsopt, cbopt) → {Promise|undefined}
+ importUsers(data, cbopt) → {Promise|undefined}
- Get all users.
+ Given a path to a file and a connection id, create a new job that imports the
+users contained in the file and associate them with the given connection.
@@ -13434,7 +16435,7 @@ getUsersSource:
Parameters:
- paramsdata
@@ -13495,8 +16496,6 @@ Parameters:
- <optional>
-
@@ -13507,7 +16506,7 @@ Parameters:
- Users params.
+ Users import data.
@@ -13521,8 +16520,6 @@ Parameters:
Type
- Attributes
-
@@ -13535,70 +16532,24 @@ Parameters:
- search_engine
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The version of the search engine to use.
-
-
-
-
-
-
-
-
- per_pageconnectionId
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Number of results per page.
+ Connection for the users insertion.
@@ -13607,34 +16558,24 @@ Parameters:
- pageusers
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ Path to the users data file.
@@ -13729,21 +16670,15 @@ 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',
- per_page: 10,
- page: 0
+ var params = {
+ connection_id: '{CONNECTION_ID}',
+ users: '{PATH_TO_USERS_FILE}'
};
-auth0.getUsers(params, function (err, users) {
- console.log(users.length);
+management.get(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
});
@@ -13755,14 +16690,14 @@ Example
- getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+ linkUsers(userId, params, cbopt) → {Promise|undefined}
- Get users for a given email address
+ Link the user with another account.
@@ -13798,7 +16733,7 @@ getUse
Source:
getUse
- Parameters:
-
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ userId
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ID of the primary user.
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Secondary user data.
+
+
@@ -13830,8 +16852,6 @@ Parameters:
Type
- Attributes
-
@@ -13844,7 +16864,7 @@ Parameters:
- emailuser_id
@@ -13857,21 +16877,45 @@ Parameters:
-
-
- <optional>
-
+
+
+
+ ID of the user to be linked.
+
+
+
+
+
+
+
+ connection_id
+
-
+String
+
+
+
+
+
- Email Address of users to locate
+ ID of the connection to be used.
+
+
+
+
+
+
+
+
@@ -13958,13 +17002,18 @@ 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 userId = 'USER_ID';
+var params = {
+ user_id: 'OTHER_USER_ID',
+ connection_id: 'CONNECTION_ID'
+};
+
+management.linkUsers(userId, params, function (err, user) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Users linked.
});
@@ -13976,15 +17025,14 @@ Example
- importUsers(data, cbopt) → {Promise|undefined}
+ regenerateRecoveryCode(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 and associate them with the given connection.
+ Generate new Guardian recovery code.
@@ -14020,7 +17068,7 @@ importUser
Source:
Parameters:
- Users import data.
+ The user data object.
@@ -14117,33 +17165,7 @@ Parameters:
- connectionId
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Connection for the users insertion.
-
-
-
-
-
-
-
-
- usersid
@@ -14160,7 +17182,7 @@ Parameters:
- Path to the users data file.
+ The user id.
@@ -14255,15 +17277,8 @@ Returns:
Example
- var params = {
- connection_id: '{CONNECTION_ID}',
- users: '{PATH_TO_USERS_FILE}'
-};
-
-management.get(params, function (err) {
- if (err) {
- // Handle error.
- }
+ management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
+ console.log(newRecoveryCode);
});
@@ -14275,14 +17290,14 @@ Example
- linkUsers(userId, params, cbopt) → {Promise|undefined}
+ sendEmailVerification(data, cbopt) → {Promise|undefined}
- Link the user with another account.
+ Send a verification email to a user.
@@ -14318,7 +17333,7 @@ linkUsersSource:
Parameters:
- userId
-
-
-String
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ID of the primary user.
-
-
-
-
-
-
-
-
- paramsdata
@@ -14423,7 +17404,7 @@ Parameters:
- Secondary user data.
+ User data object.
@@ -14466,33 +17447,7 @@ Parameters:
- ID of the user to be linked.
-
-
-
-
-
-
-
-
- connection_id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- ID of the connection to be used.
+ ID of the user to be verified.
@@ -14587,18 +17542,14 @@ Returns:
Example
- var userId = 'USER_ID';
-var params = {
- user_id: 'OTHER_USER_ID',
- connection_id: 'CONNECTION_ID'
+ var params = {
+ user_id: '{USER_ID}'
};
-management.linkUsers(userId, params, function (err, user) {
+management.sendEmailVerification(function (err) {
if (err) {
// Handle error.
}
-
- // Users linked.
});
@@ -14610,14 +17561,14 @@ Example
- regenerateRecoveryCode(data, cbopt) → {Promise|undefined}
+ setRulesConfig(params, data, cbopt) → {Promise|undefined}
- Generate new Guardian recovery code.
+ Set a new rules config.
@@ -14653,7 +17604,7 @@ Source:
Parameters:
-
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rule Config parameters.
+
+
@@ -14685,8 +17689,6 @@ Parameters:
Type
- Attributes
-
@@ -14697,6 +17699,40 @@ Parameters:
+
+
+ key
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule Config key.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
dataParameters:
- The user data object.
+ Rule Config Data parameters.
@@ -14750,7 +17786,7 @@ Parameters:
- idvalue
@@ -14767,7 +17803,7 @@ Parameters:
- The user id.
+ Rule Config Data value.
@@ -14862,8 +17898,15 @@ Returns:
Example
- management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
- console.log(newRecoveryCode);
+ var params = { key: RULE_CONFIG_KEY };
+var data = { value: RULES_CONFIG_VALUE };
+
+management.setRulesConfig(params, data, function (err, rulesConfig) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Rules Config set.
});
@@ -14875,14 +17918,14 @@ Example
- sendEmailVerification(data, cbopt) → {Promise|undefined}
+ unlinkUsers(params, cbopt) → {Promise|undefined}
- Send a verification email to a user.
+ Unlink the given accounts.
@@ -14918,7 +17961,7 @@
Source:
Parameters:
- dataparams
@@ -14989,7 +18032,7 @@ Parameters:
- User data object.
+ Linked users data.
@@ -15013,6 +18056,58 @@ Parameters:
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Primary user ID.
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Identity provider in use.
+
+
+
+
+
+
user_idParameters:
- ID of the user to be verified.
+ Secondary user ID.
@@ -15127,14 +18222,14 @@ Returns:
Example
- var params = {
- user_id: '{USER_ID}'
-};
+ var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
-management.sendEmailVerification(function (err) {
+management.unlinkUsers(params, function (err, user) {
if (err) {
// Handle error.
}
+
+ // Users accounts unlinked.
});
@@ -15146,14 +18241,14 @@ Example
- setRulesConfig(params, data, cbopt) → {Promise|undefined}
+ updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
- Set a new rules config.
+ Update the app metadata for a user.
@@ -15189,7 +18284,7 @@ setRule
Source:
Parameters:
- Rule Config parameters.
+ The user data object..
@@ -15286,7 +18381,7 @@ Parameters:
- keyid
@@ -15303,7 +18398,7 @@ Parameters:
- Rule Config key.
+ The user id.
@@ -15320,7 +18415,7 @@ Parameters:
- datametadata
@@ -15345,58 +18440,7 @@ Parameters:
- Rule Config Data parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- value
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Rule Config Data value.
-
-
-
-
-
-
-
-
+ New app metadata.
@@ -15432,7 +18476,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -15483,15 +18527,18 @@ Returns:
Example
- var params = { key: RULE_CONFIG_KEY };
-var data = { value: RULES_CONFIG_VALUE };
+ var params = { id: USER_ID };
+var metadata = {
+ foo: 'bar'
+};
-management.setRulesConfig(params, data, function (err, rulesConfig) {
+management.updateAppMetadata(params, metadata, function (err, user) {
if (err) {
// Handle error.
}
- // Rules Config set.
+ // Updated user.
+ console.log(user);
});
@@ -15503,14 +18550,14 @@ Example
- unlinkUsers(params, cbopt) → {Promise|undefined}
+ updateClient(params, data, cbopt) → {Promise|undefined}
- Unlink the given accounts.
+ Update an Auth0 client.
@@ -15546,7 +18593,7 @@ unlinkUser
Source:
Parameters:
- Linked users data.
+ Client parameters.
@@ -15643,7 +18690,7 @@ Parameters:
- idclient_id
@@ -15660,33 +18707,15 @@ Parameters:
- Primary user ID.
+ Application client ID.
+
+
-
-
- provider
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Identity provider in use.
@@ -15695,32 +18724,32 @@ Parameters:
- user_iddata
-String
+Object
+
+
+
+
+
+
+
+
- Secondary user ID.
-
-
-
-
-
-
-
-
+ Updated client data.
@@ -15807,14 +18836,15 @@ Returns:
Example
- var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
+ var data = { name: 'newClientName' };
+var params = { client_id: CLIENT_ID };
-management.unlinkUsers(params, function (err, user) {
+management.updateClient(params, data, function (err, client) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ console.log(client.name); // 'newClientName'
});
@@ -15826,14 +18856,14 @@ Example
- updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
+ updateClientGrant(params, data, cbopt) → {Promise|undefined}
- Update the app metadata for a user.
+ Update an Auth0 client grant.
@@ -15869,7 +18899,7 @@ upda
Source:
Parameters:
- The user data object..
+ Client parameters.
@@ -15983,7 +19013,7 @@ Parameters:
- The user id.
+ Client grant ID.
@@ -16000,7 +19030,7 @@ Parameters:
- metadatadata
@@ -16025,7 +19055,7 @@ Parameters:
- New app metadata.
+ Updated client data.
@@ -16061,7 +19091,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -16112,18 +19142,19 @@ Returns:
Example
- var params = { id: USER_ID };
-var metadata = {
- foo: 'bar'
+ var data = {
+ client_id: CLIENT_ID,
+ audience: AUDIENCE,
+ scope: []
};
+var params = { id: CLIENT_GRANT_ID };
-management.updateAppMetadata(params, metadata, function (err, user) {
+management.clientGrants.update(params, data, function (err, grant) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+ console.log(grant.id);
});
@@ -16135,14 +19166,14 @@ Example
- updateClient(params, data, cbopt) → {Promise|undefined}
+ updateConnection(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client.
+ Update an existing connection.
@@ -16178,7 +19209,7 @@ updateCli
Source:
Parameters:
- Client parameters.
+ Connection parameters.
@@ -16275,7 +19306,7 @@ Parameters:
- client_idid
@@ -16292,7 +19323,7 @@ Parameters:
- Application client ID.
+ Connection ID.
@@ -16334,7 +19365,7 @@ Parameters:
- Updated client data.
+ Updated connection data.
@@ -16421,15 +19452,15 @@ Returns:
Example
- var data = { name: 'newClientName' };
-var params = { client_id: CLIENT_ID };
+ var data = { name: 'newConnectionName' };
+var params = { id: CONNECTION_ID };
-management.updateClient(params, data, function (err, client) {
+management.updateConnection(params, data, function (err, connection) {
if (err) {
// Handle error.
}
- console.log(client.name); // 'newClientName'
+ console.log(connection.name); // 'newConnectionName'
});
@@ -16441,14 +19472,14 @@ Example
- updateConnection(params, data, cbopt) → {Promise|undefined}
+ updateEmailProvider(params, data, cbopt) → {Promise|undefined}
- Update an existing connection.
+ Update the email provider.
@@ -16484,7 +19515,7 @@ updat
Source:
Parameters:
- Connection parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Connection ID.
-
-
-
-
-
-
-
-
+ Email provider parameters.
@@ -16640,7 +19620,7 @@ Parameters:
- Updated connection data.
+ Updated email provider data.
@@ -16727,15 +19707,13 @@ Returns:
Example
- var data = { name: 'newConnectionName' };
-var params = { id: CONNECTION_ID };
-
-management.updateConnection(params, data, function (err, connection) {
+ management.updateEmailProvider(params, data, function (err, provider) {
if (err) {
// Handle error.
}
- console.log(connection.name); // 'newConnectionName'
+ // Updated email provider.
+ console.log(provider);
});
@@ -16747,14 +19725,14 @@ Example
- updateEmailProvider(params, data, cbopt) → {Promise|undefined}
+ updateResourceServer(params, data, cbopt) → {Promise|undefined}
- Update the email provider.
+ Update an existing resource server.
@@ -16790,7 +19768,7 @@ up
Source:
Parameters:
- Email provider parameters.
+ Resource Server parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Resource Server ID.
+
+
+
+
+
+
+
+
@@ -16895,7 +19924,7 @@ Parameters:
- Updated email provider data.
+ Updated Resource Server data.
@@ -16982,13 +20011,15 @@ Returns:
Example
- management.updateEmailProvider(params, data, function (err, provider) {
+ var data = { name: 'newResourceServerName' };
+var params = { id: RESOURCE_SERVER_ID };
+
+management.updateResourceServer(params, data, function (err, resourceServer) {
if (err) {
// Handle error.
}
- // Updated email provider.
- console.log(provider);
+ console.log(resourceServer.name); // 'newResourceServerName'
});
@@ -17000,14 +20031,14 @@ Example
- updateResourceServer(params, data, cbopt) → {Promise|undefined}
+ updateRule(params, data, cbopt) → {Promise|undefined}
- Update an existing resource server.
+ Update an existing rule.
@@ -17043,7 +20074,7 @@ u
Source:
Parameters:
- Resource Server parameters.
+ Rule parameters.
@@ -17157,7 +20188,7 @@ Parameters:
- Resource Server ID.
+ Rule ID.
@@ -17199,7 +20230,7 @@ Parameters:
- Updated Resource Server data.
+ Updated rule data.
@@ -17286,15 +20317,14 @@ Returns:
Example
- var data = { name: 'newResourceServerName' };
-var params = { id: RESOURCE_SERVER_ID };
-
-management.updateResourceServer(params, data, function (err, resourceServer) {
+ var params = { id: RULE_ID };
+var data = { name: 'my-rule'};
+management.updateRule(params, data, function (err, rule) {
if (err) {
// Handle error.
}
- console.log(resourceServer.name); // 'newResourceServerName'
+ console.log(rule.name); // 'my-rule'.
});
@@ -17306,14 +20336,14 @@ Example
- updateRule(params, data, cbopt) → {Promise|undefined}
+ updateTenantSettings(data, cbopt) → {Promise|undefined}
- Update an existing rule.
+ Update the tenant settings.
@@ -17340,89 +20370,36 @@ updateRule<
-
-
-
-
-
-
-
- Source:
- Parameters:
-
-
-
-
-
-
- Name
-
+
- Type
+
-
- Attributes
-
+
-
+
+ Source:
+ Description
-
-
+
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
- Rule parameters.
-
-
+
+ Parameters:
+
@@ -17434,6 +20411,8 @@ Parameters:
Type
+ Attributes
+
@@ -17444,40 +20423,6 @@ Parameters:
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Rule ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
dataParameters:
- Updated rule data.
+ The new tenant settings.
@@ -17592,14 +20537,10 @@ Returns:
Example
- var params = { id: RULE_ID };
-var data = { name: 'my-rule'};
-management.updateRule(params, data, function (err, rule) {
+ management.updateTenantSettings(data, function (err) {
if (err) {
// Handle error.
}
-
- console.log(rule.name); // 'my-rule'.
});
@@ -17611,14 +20552,14 @@ Example
- updateTenantSettings(data, cbopt) → {Promise|undefined}
+ updateUser(params, data, cbopt) → {Promise|undefined}
- Update the tenant settings.
+ Update a user by its id.
@@ -17654,7 +20595,7 @@ u
Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The user parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
dataParameters:
- The new tenant settings.
+ New user data.
@@ -17761,7 +20787,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -17812,10 +20838,15 @@ Returns:
Example
- management.updateTenantSettings(data, function (err) {
+ var params = { id: USER_ID };
+
+management.updateUser(params, data, function (err, user) {
if (err) {
// Handle error.
}
+
+ // Updated user.
+ console.log(user);
});
@@ -17827,14 +20858,14 @@ Example
- updateUser(params, data, cbopt) → {Promise|undefined}
+ updateUserMetadata(params, metadata, cbopt) → {Promise|undefined}
- Update a user by its id.
+ Update the user metadata for a user.
@@ -17870,7 +20901,7 @@ updateUser<
Source:
Parameters:
- The user parameters.
+ The user data object..
@@ -18001,7 +21032,7 @@ Parameters:
- datametadata
@@ -18026,7 +21057,7 @@ Parameters:
- New user data.
+ New user metadata.
@@ -18114,8 +21145,11 @@ Returns:
Example
var params = { id: USER_ID };
+var metadata = {
+ address: '123th Node.js Street'
+};
-management.updateUser(params, data, function (err, user) {
+management.updateUserMetadata(params, metadata, function (err, user) {
if (err) {
// Handle error.
}
@@ -18133,14 +21167,14 @@ Example
- updateUserMetadata(params, metadata, cbopt) → {Promise|undefined}
+ verifyCustomDomain(params, cbopt) → {Promise|undefined}
- Update the user metadata for a user.
+ Verify a Custom Domain.
@@ -18176,7 +21210,7 @@ upd
Source:
Parameters:
- The user data object..
+ Custom Domain parameters.
@@ -18290,7 +21324,7 @@ Parameters:
- The user id.
+ Custom Domain ID.
@@ -18305,40 +21339,6 @@ Parameters:
-
-
- metadata
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- New user metadata.
-
-
-
-
-
-
cbParameters:
- Callback function
+ Callback function.
@@ -18419,18 +21419,12 @@ Returns:
Example
- var params = { id: USER_ID };
-var metadata = {
- address: '123th Node.js Street'
-};
-
-management.updateUserMetadata(params, metadata, function (err, user) {
+ management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+ console.log(customDomain);
});
@@ -18454,7 +21448,7 @@ Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 98a360c74..ff9ee87b1 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.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 0c021904e..506dcf254 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 482cb0539..7088c566b 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.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 4a371256c..502ae2f83 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 c81f2d396..b7640c53a 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 d73bbea41..ce9e4385a 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 527516334..c659e73ae 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -835,7 +835,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6cc15b131..ccc194f35 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.UsersManager.html b/docs/module-management.UsersManager.html
index 4a29c2bcb..33658deef 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5075,7 +5075,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 24524f386..138034ca4 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -150,7 +150,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index c703086b0..0a882f6e8 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -339,7 +339,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index e1092abfd..c1d593455 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -124,7 +124,7 @@ utils.js
diff --git a/package.json b/package.json
index da7529028..80138069b 100644
--- a/package.json
+++ b/package.json
@@ -1,16 +1,16 @@
{
"name": "auth0",
- "version": "2.14.0",
+ "version": "2.15.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
- "files": [
- "src"
- ],
+ "files": ["src"],
"scripts": {
"test": "mocha -R spec ./test/**/*.tests.js ./test/*.tests.js",
- "test:ci": "istanbul cover _mocha --report lcovonly -R $(find ./test -name *.tests.js) -- -R mocha-multi --reporter-options spec=-,mocha-junit-reporter=-",
+ "test:ci":
+ "istanbul cover _mocha --report lcovonly -R $(find ./test -name *.tests.js) -- -R mocha-multi --reporter-options spec=-,mocha-junit-reporter=-",
"test:coverage": "codecov",
- "test:watch": "cross-env NODE_ENV=test mocha --timeout 5000 ./test/**/*.tests.js ./test/*.tests.js --watch",
+ "test:watch":
+ "cross-env NODE_ENV=test mocha --timeout 5000 ./test/**/*.tests.js ./test/*.tests.js --watch",
"jsdoc:generate": "jsdoc --configure .jsdoc.json --verbose",
"release:clean": "node scripts/cleanup.js",
"preversion": "node scripts/prepare.js",
@@ -22,10 +22,7 @@
"type": "git",
"url": "https://github.com/auth0/node-auth0"
},
- "keywords": [
- "auth0",
- "api"
- ],
+ "keywords": ["auth0", "api"],
"author": "Auth0",
"license": "MIT",
"bugs": {
Source:
Source:
Source:
Source:
Source:
Source:
diff --git a/docs/index.html b/docs/index.html
index 284900d46..35675c193 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -151,7 +151,7 @@ License
This project is licensed under the MIT license. See the
diff --git a/docs/index.js.html b/docs/index.js.html
index 1c8d473a0..9e941863c 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 48fdcb021..57186a500 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_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index 02d124357..090f03820 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 ee848a5a2..c8a415528 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 15c95b0b1..70edd7e7a 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index 09e419d59..8940d287b 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 f5dc2e012..9f64551f5 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 38f961049..276f60672 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -132,7 +132,10 @@ management/EmailProviderManager.js
* });
*
* @param {Function} [cb] Callback function.
- *
+ * @param {Object} [params] Clients parameters.
+ * @param {Number} [params.fields] A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
+ * @param {Number} [params.include_fields] true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(EmailProviderManager, 'get', 'resource.getAll');
@@ -195,7 +198,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index b926f4b92..1d5725300 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_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index fd969d25b..3afa11710 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 0b1a0388d..409665611 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -98,6 +98,19 @@ management/JobsManager.js
options.tokenProvider
);
this.jobs = new RetryRestClient(auth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for consuming the
+ * {@link https://auth0.com/docs/api/v2#!/Jobs/post_users_exports Create job to export users endpoint}
+ *
+ * @type {external:RestClient}
+ */
+ const usersExportsRestClient = new Auth0RestClient(
+ options.baseUrl + '/jobs/users-exports',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.usersExports = new RetryRestClient(usersExportsRestClient, options.retry);
};
/**
@@ -155,7 +168,7 @@ management/JobsManager.js
* send_completion_email: false //optional
* };
*
- * management.jobs.get(params, function (err) {
+ * management.jobs.importUsers(params, function (err) {
* if (err) {
* // Handle error.
* }
@@ -235,6 +248,63 @@ management/JobsManager.js
return promise;
};
+/**
+ * Export all users to a file using a long running job.
+ *
+ * @method exportUsers
+ * @memberOf module:management.JobsManager.prototype
+ *
+ * @example
+ * var data = {
+ * connection_id: 'con_0000000000000001',
+ * format: 'csv',
+ * limit: 5,
+ * fields: [
+ * {
+ * "name": "user_id"
+ * },
+ * {
+ * "name": "name"
+ * },
+ * {
+ * "name": "email"
+ * },
+ * {
+ * "name": "identities[0].connection",
+ * "export_as": "provider"
+ * },
+ * {
+ * "name": "user_metadata.some_field"
+ * }
+ * ]
+ * }
+ *
+ * management.jobs.exportUsers(data, function (err, results) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Retrieved job.
+ * console.log(results);
+ * });
+ *
+ * @param {Object} data Users export data.
+ * @param {String} [data.connection_id] The connection id of the connection from which users will be exported
+ * @param {String} [data.format] The format of the file. Valid values are: "json" and "csv".
+ * @param {Number} [data.limit] Limit the number of records.
+ * @param {Object[]} [data.fields] A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+JobsManager.prototype.exportUsers = function(data, cb) {
+ if (cb && cb instanceof Function) {
+ return this.usersExports.create(data, cb);
+ }
+
+ return this.usersExports.create(data);
+};
+
/**
* Send a verification email to a user.
*
@@ -284,7 +354,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 6c9f5b9ea..02b71be8d 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 2b5b18db8..61a6fa94b 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -189,7 +189,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index 3cfaa5da4..fafbb3aca 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_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index 18de21ac5..439658b62 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
@@ -179,7 +179,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 8f51c048f..93eae695b 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 aff6e68c8..6ef638d33 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 2a14fe60a..25f65f66b 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -161,7 +161,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index ce0b83bb6..03451ef26 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_UsersManager.js.html b/docs/management_UsersManager.js.html
index 76adaeaa4..e09e07ad9 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -677,7 +677,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index 9e4daa584..a94ca9567 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -599,8 +599,8 @@ management/index.js
/**
* Get all Auth0 Client Grants.
*
- * @method getAll
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method getClientGrants
+ * @memberOf module:management.ManagementClient.prototype
*
* @example <caption>
* This method takes an optional object as first argument that may be used to
@@ -630,8 +630,8 @@ management/index.js
/**
* Create an Auth0 client grant.
*
- * @method create
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method createClientGrant
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.clientGrants.create(data, function (err) {
@@ -652,8 +652,8 @@ management/index.js
/**
* Update an Auth0 client grant.
*
- * @method update
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method updateClientGrant
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* var data = {
@@ -683,8 +683,8 @@ management/index.js
/**
* Delete an Auth0 client grant.
*
- * @method delete
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method deleteClientGrant
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.clientGrants.delete({ id: GRANT_ID }, function (err) {
@@ -1430,7 +1430,10 @@ management/index.js
* });
*
* @param {Function} [cb] Callback function.
- *
+ * @param {Object} [params] Clients parameters.
+ * @param {Number} [params.fields] A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
+ * @param {Number} [params.include_fields] true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(ManagementClient, 'getEmailProvider', 'emailProvider.get');
@@ -1649,6 +1652,57 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'importUsers', 'jobs.importUsers');
+/**
+ * Export all users to a file using a long running job.
+ *
+ * @method exportUsers
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var data = {
+ * connection_id: 'con_0000000000000001',
+ * format: 'csv',
+ * limit: 5,
+ * fields: [
+ * {
+ * "name": "user_id"
+ * },
+ * {
+ * "name": "name"
+ * },
+ * {
+ * "name": "email"
+ * },
+ * {
+ * "name": "identities[0].connection",
+ * "export_as": "provider"
+ * },
+ * {
+ * "name": "user_metadata.some_field"
+ * }
+ * ]
+ * }
+ *
+ * management.exportUsers(data, function (err, results) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Retrieved job.
+ * console.log(results);
+ * });
+ *
+ * @param {Object} data Users export data.
+ * @param {String} [data.connection_id] The connection id of the connection from which users will be exported
+ * @param {String} [data.format] The format of the file. Valid values are: "json" and "csv".
+ * @param {Number} [data.limit] Limit the number of records.
+ * @param {Object[]} [data.fields] A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'exportUsers', 'jobs.exportUsers');
+
/**
* Send a verification email to a user.
*
@@ -1982,8 +2036,8 @@ management/index.js
/**
* Create an Auth0 Custom Domain.
*
- * @method create
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method createCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.createCustomDomain(data, function (err) {
@@ -2004,8 +2058,8 @@ management/index.js
/**
* Get all Auth0 CustomDomains.
*
- * @method getAll
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method getCustomDomains
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.getCustomDomains(function (err, customDomains) {
@@ -2019,8 +2073,8 @@ management/index.js
/**
* Get a Custom Domain.
*
- * @method get
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method getCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
@@ -2042,8 +2096,8 @@ management/index.js
/**
* Verify a Custom Domain.
*
- * @method verify
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method verifyCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
@@ -2065,8 +2119,8 @@ management/index.js
/**
* Delete a Custom Domain.
*
- * @method delete
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method deleteCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
@@ -2089,7 +2143,7 @@ management/index.js
* Create a Guardian enrollment ticket.
*
* @method createGuardianEnrollmentTicket
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.createGuardianEnrollmentTicket(function (err, ticket) {
@@ -2110,7 +2164,7 @@ management/index.js
* Get a list of Guardian factors and statuses.
*
* @method getGuardianFactors
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.getGuardianFactors(function (err, factors) {
* console.log(factors.length);
@@ -2126,7 +2180,7 @@ management/index.js
* Get Guardian factor provider configuration
*
* @method getGuardianFactorProvider
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
* console.log(provider);
@@ -2147,7 +2201,7 @@ management/index.js
* Update Guardian's factor provider
*
* @method updateFactorProvider
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
* messaging_service_sid: 'XXXXXXXXXXXXXX',
@@ -2173,7 +2227,7 @@ management/index.js
* Get Guardian enrollment and verification factor templates
*
* @method getGuardianFactorTemplates
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
* console.log(templates);
@@ -2194,7 +2248,7 @@ management/index.js
* Update Guardian enrollment and verification factor templates
*
* @method updateGuardianFactorTemplates
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.updateGuardianFactorTemplates({ name: 'sms' }, {
* enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
@@ -2219,7 +2273,7 @@ management/index.js
* Update Guardian Factor
*
* @method updateGuardianFactor
- * @memberOf module.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.updateGuardianFactor({ name: 'sms' }, {
* enabled: true
@@ -2248,7 +2302,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index fb612176b..3759ff8a2 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -3894,7 +3894,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index b7b29e7b2..64f95eedb 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1590,7 +1590,7 @@ Parameters:
-Stinrg
+String
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index 8697b3777..f161a65ee 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -101,7 +101,7 @@ Source:
Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 1a653544b..9aec2c527 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1796,7 +1796,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index e81cdc6c4..e20079a2c 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index 97a1daf27..c01be4808 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 1b625dd20..f35ae1e47 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 249e89209..cc295c8ec 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-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 0451d5674..094d54110 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.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index dee679a9a..a14a07f8c 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -717,1097 +717,14 @@ Example
- create(data, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Create an Auth0 client grant.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The client data object.
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.clientGrants.create(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Client grant created.
-});
-
-
-
-
-
-
-
-
-
-
- delete(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Delete an Auth0 client grant.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Client parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Client grant ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.clientGrants.delete({ id: GRANT_ID }, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Grant deleted.
-});
-
-
-
-
-
-
-
-
-
-
- delete(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Delete an Auth0 client grant.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Client parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Client grant ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.clientGrants.delete({ id: GRANT_ID }, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Grant deleted.
-});
-
-
-
-
-
-
-
-
-
-
- getAll(paramsopt, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get all Auth0 Client Grants.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Client Grants 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.getClientGrants(params, function (err, grants) {
- console.log(grants.length);
-});
-
-
-
-
-
-
-
-
-
-
- getAll(paramsopt, cbopt) → {Promise|undefined}
+ delete(params, cbopt) → {Promise|undefined}
- Get all Auth0 Client Grants.
+ Delete an Auth0 client grant.
@@ -1843,7 +760,7 @@ getAllSource:
Parameters:
- <optional>
-
@@ -1916,7 +831,7 @@ Parameters:
- Client Grants parameters.
+ Client parameters.
@@ -1930,8 +845,6 @@ Parameters:
Type
- Attributes
-
@@ -1944,70 +857,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ Client grant ID.
@@ -2102,21 +969,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.clientGrants.delete({ id: GRANT_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
-management.clientGrants.getAll(params, function (err, grants) {
- console.log(grants.length);
+ // Grant deleted.
});
@@ -2128,14 +986,14 @@ Example
- update(params, data, cbopt) → {Promise|undefined}
+ getAll(paramsopt, cbopt) → {Promise|undefined}
- Update an Auth0 client grant.
+ Get all Auth0 Client Grants.
@@ -2171,7 +1029,7 @@ updateSource:
Parameters:
+ <optional>
+
@@ -2242,7 +1102,7 @@ Parameters:
- Client parameters.
+ Client Grants parameters.
@@ -2256,6 +1116,8 @@ Parameters:
Type
+ Attributes
+
@@ -2268,32 +1130,34 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
-
+
-
- Client grant ID.
-
-
+
+
-
-
-
+
+
+ Number of results per page.
@@ -2302,13 +1166,13 @@ Parameters:
- datapage
-Object
+Number
@@ -2317,6 +1181,8 @@ Parameters:
+ <optional>
+
@@ -2327,7 +1193,15 @@ Parameters:
- Updated client data.
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
@@ -2414,19 +1288,21 @@ Returns:
Example
- var data = {
- client_id: CLIENT_ID,
- audience: AUDIENCE,
- scope: []
+
+ 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: CLIENT_GRANT_ID };
-management.clientGrants.update(params, data, function (err, grant) {
- if (err) {
- // Handle error.
- }
- console.log(grant.id);
+management.clientGrants.getAll(params, function (err, grants) {
+ console.log(grants.length);
});
@@ -2760,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 02612947b..0b77f92d1 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 7ebfbcc77..c6a8da76d 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 6c4def656..c61671616 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -792,224 +792,6 @@ Example
-
-
-
-
- create(data, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Create an Auth0 Custom Domain.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The custom domain data object.
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.createCustomDomain(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // CustomDomain created.
-});
-
-
-
-
-
-
@@ -1057,7 +839,7 @@ deleteSource:
Returns:
Example
- management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ management.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -1283,14 +1065,14 @@ Example
- delete(params, cbopt) → {Promise|undefined}
+ get(params, cbopt) → {Promise|undefined}
- Delete a Custom Domain.
+ Get a Custom Domain.
@@ -1326,7 +1108,7 @@ deleteSource:
Returns:
Example
- management.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ management.customDomains.get({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
if (err) {
// Handle error.
}
- // CustomDomain deleted.
+ console.log(customDomain);
});
@@ -1552,14 +1334,14 @@ Example
- get(params, cbopt) → {Promise|undefined}
+ getAll() → {Promise|undefined}
- Get a Custom Domain.
+ Get all Auth0 CustomDomains.
@@ -1595,7 +1377,7 @@ getSource:
get
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Custom Domain parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Custom Domain ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
- if (err) {
- // Handle error.
- }
-
- console.log(customDomain);
-});
-
-
-
-
-
-
-
-
-
-
- get(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get a Custom Domain.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Custom Domain parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Custom Domain ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.customDomains.get({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
- if (err) {
- // Handle error.
- }
-
- console.log(customDomain);
-});
-
-
-
-
-
-
-
-
-
-
- getAll() → {Promise|undefined}
-
-
-
-
-
-
- Get all Auth0 CustomDomains.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.getCustomDomains(function (err, customDomains) {
- console.log(customDomains.length);
-});
-
-
-
-
-
-
-
-
-
-
- getAll() → {Promise|undefined}
-
-
-
-
-
-
- Get all Auth0 CustomDomains.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.customDomains.getAll(function (err, customDomains) {
- console.log(customDomains.length);
-});
-
-
-
-
-
-
-
-
-
-
- verify(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Verify a Custom Domain.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Custom Domain parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Custom Domain ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
@@ -2574,12 +1437,8 @@ Returns:
Example
- management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
- if (err) {
- // Handle error.
- }
-
- console.log(customDomain);
+ management.customDomains.getAll(function (err, customDomains) {
+ console.log(customDomains.length);
});
@@ -2872,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index 01d6666b7..c87bb56fc 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 52441ed0a..530ab5dcb 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -759,7 +759,7 @@ deleteSource:
Example
- get(cbopt) → {Promise|undefined}
+ get(cbopt, paramsopt) → {Promise|undefined}
@@ -1022,6 +1022,141 @@ Parameters:
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Clients parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ fields
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
+
+
+
+
+
+
+
+
+ include_fields
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1123,7 +1258,7 @@ updateSource:
Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index 2495916b4..ecaea5ef5 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.GuardianManager.html b/docs/module-management.GuardianManager.html
index eff768fda..59e6fb9d8 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -894,186 +894,6 @@ Example
-
-
-
-
- createGuardianEnrollmentTicket(cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Create a Guardian enrollment ticket.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.createGuardianEnrollmentTicket(function (err, ticket) {
- console.log(ticket);
-});
-
-
-
-
-
-
@@ -1620,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index a17cf8ff0..a8d359bf4 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -391,6 +391,81 @@ (inner)
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner, constant) usersExportsRestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the
+Create job to export users endpoint
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
@@ -419,6 +494,420 @@ Methods
+
+
+
+
+ exportUsers(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Export all users to a file using a long running job.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Users export data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ connection_id
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The connection id of the connection from which users will be exported
+
+
+
+
+
+
+
+
+ format
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The format of the file. Valid values are: "json" and "csv".
+
+
+
+
+
+
+
+
+ limit
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Limit the number of records.
+
+
+
+
+
+
+
+
+ fields
+
+
+Array.<Object>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = {
+ connection_id: 'con_0000000000000001',
+ format: 'csv',
+ limit: 5,
+ fields: [
+ {
+ "name": "user_id"
+ },
+ {
+ "name": "name"
+ },
+ {
+ "name": "email"
+ },
+ {
+ "name": "identities[0].connection",
+ "export_as": "provider"
+ },
+ {
+ "name": "user_metadata.some_field"
+ }
+ ]
+}
+
+management.jobs.exportUsers(data, function (err, results) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Retrieved job.
+ console.log(results);
+});
+
+
+
+
+
+
@@ -466,7 +955,7 @@ getSource:
importUser
Source:
Example
send_completion_email: false //optional
};
-management.jobs.get(params, function (err) {
+management.jobs.importUsers(params, function (err) {
if (err) {
// Handle error.
}
@@ -1120,7 +1609,7 @@ verifyEmai
Source:
Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index a476b9d52..c022c6e50 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 bc804d928..843cb3828 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -2376,7 +2376,7 @@ Source:
Example
- createConnection(data, cbopt) → {Promise|undefined}
+ createClientGrant(data, cbopt) → {Promise|undefined}
- Create a new connection.
+ Create an Auth0 client grant.
@@ -2812,7 +2812,7 @@ creat
Source:
Parameters:
- Connection data object.
+ The client data object.
@@ -2970,12 +2970,12 @@ Returns:
Example
- management.createConnection(data, function (err) {
+ management.clientGrants.create(data, function (err) {
if (err) {
// Handle error.
}
- // Conection created.
+ // Client grant created.
});
@@ -2987,14 +2987,14 @@ Example
- createDevicePublicKey(data, cbopt) → {Promise|undefined}
+ createConnection(data, cbopt) → {Promise|undefined}
- Create an Auth0 credential.
+ Create a new connection.
@@ -3030,7 +3030,7 @@
Source:
Parameters:
- The device credential data object.
+ Connection data object.
@@ -3193,7 +3193,7 @@ Example
// Handle error.
}
- // Credential created.
+ // Conection created.
});
@@ -3205,14 +3205,14 @@ Example
- createEmailVerificationTicket(cbopt) → {Promise}
+ createCustomDomain(data, cbopt) → {Promise|undefined}
- Create an email verification ticket.
+ Create an Auth0 Custom Domain.
@@ -3248,7 +3248,7 @@ Source:
Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The custom domain data object.
+
+
+
+
+
+
cbReturns:
Promise
+|
+
+undefined
@@ -3369,15 +3406,12 @@ Returns:
Example
- var data = {
- user_id: '{USER_ID}',
- result_url: '{REDIRECT_URL}' // Optional redirect after the ticket is used.
-};
-
-auth0.createEmailVerificationTicket(data, function (err) {
+ management.createCustomDomain(data, function (err) {
if (err) {
// Handle error.
}
+
+ // CustomDomain created.
});
@@ -3389,14 +3423,14 @@ Example
- createPasswordChangeTicket(cbopt) → {Promise}
+ createDevicePublicKey(data, cbopt) → {Promise|undefined}
- Create a new password change ticket.
+ Create an Auth0 credential.
@@ -3432,7 +3466,7 @@ Source:
Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The device credential data object.
+
+
+
+
+
+
cbReturns:
Promise
+|
+
+undefined
@@ -3553,17 +3624,12 @@ Returns:
Example
- var params = {
- result_url: '{REDIRECT_URL}', // Redirect after using the ticket.
- user_id: '{USER_ID}', // Optional.
- email: '{USER_EMAIL}', // Optional.
- new_password: '{PASSWORD}'
-};
-
-auth0.createPasswordChangeTicket(params, function (err) {
+ management.createConnection(data, function (err) {
if (err) {
// Handle error.
}
+
+ // Credential created.
});
@@ -3575,14 +3641,14 @@ Example
- createResourceServer(data, cbopt) → {Promise|undefined}
+ createEmailVerificationTicket(cbopt) → {Promise}
- Create a new resource server.
+ Create an email verification ticket.
@@ -3618,7 +3684,7 @@ c
Source:
Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Resource Server data object.
-
-
-
-
-
-
cbReturns:
Promise
-|
-
-undefined
@@ -3776,12 +3805,15 @@ Returns:
Example
- management.createResourceServer(data, function (err) {
+ var data = {
+ user_id: '{USER_ID}',
+ result_url: '{REDIRECT_URL}' // Optional redirect after the ticket is used.
+};
+
+auth0.createEmailVerificationTicket(data, function (err) {
if (err) {
// Handle error.
}
-
- // Resource Server created.
});
@@ -3793,14 +3825,14 @@ Example
- createRule(data, cbopt) → {Promise|undefined}
+ createGuardianEnrollmentTicket(cbopt) → {Promise|undefined}
- Create a new rule.
+ Create a Guardian enrollment ticket.
@@ -3836,7 +3868,7 @@ createRule<
Source:
Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Rule data object.
-
-
-
-
-
-
cbReturns:
Example
- management.createRule(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Rule created.
+ management.createGuardianEnrollmentTicket(function (err, ticket) {
+ console.log(ticket);
});
@@ -4011,14 +4005,14 @@ Example
- createUser(data, cbopt) → {Promise|undefined}
+ createPasswordChangeTicket(cbopt) → {Promise}
- Create a new user.
+ Create a new password change ticket.
@@ -4054,7 +4048,7 @@ createUser<
Source:
Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- User data.
-
-
-
-
-
-
cbReturns:
Promise
-|
-
-undefined
@@ -4212,12 +4169,17 @@ Returns:
Example
- management.createUser(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // User created.
+ var params = {
+ result_url: '{REDIRECT_URL}', // Redirect after using the ticket.
+ user_id: '{USER_ID}', // Optional.
+ email: '{USER_EMAIL}', // Optional.
+ new_password: '{PASSWORD}'
+};
+
+auth0.createPasswordChangeTicket(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
});
@@ -4229,14 +4191,14 @@ Example
- deleteAllUsers(cbopt) → {Promise|undefined}
+ createResourceServer(data, cbopt) → {Promise|undefined}
- Delete all users.
+ Create a new resource server.
@@ -4260,8 +4222,6 @@ deleteA
- Deprecated: - This method will be removed in the next major release.
deleteA
Source:
Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Resource Server data object.
+
+
+
+
+
+
cbParameters:
- Callback function
+ Callback function.
@@ -4398,12 +4392,12 @@ Returns:
Example
- management.deleteAllUsers(function (err) {
+ management.createResourceServer(data, function (err) {
if (err) {
// Handle error.
}
- // Users deleted
+ // Resource Server created.
});
@@ -4415,14 +4409,14 @@ Example
- deleteClient(params, cbopt) → {Promise|undefined}
+ createRule(data, cbopt) → {Promise|undefined}
- Delete an Auth0 client.
+ Create a new rule.
@@ -4458,7 +4452,7 @@ deleteCli
Source:
Parameters:
- paramsdata
@@ -4529,58 +4523,7 @@ Parameters:
- Client parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- client_id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Application client ID.
-
-
-
-
-
-
-
-
+ Rule data object.
@@ -4667,12 +4610,12 @@ Returns:
Example
- management.deleteClient({ client_id: CLIENT_ID }, function (err) {
+ management.createRule(data, function (err) {
if (err) {
// Handle error.
}
- // Client deleted.
+ // Rule created.
});
@@ -4684,14 +4627,14 @@ Example
- deleteConnection(params, cbopt) → {Promise|undefined}
+ createUser(data, cbopt) → {Promise|undefined}
- Delete an existing connection.
+ Create a new user.
@@ -4727,7 +4670,7 @@ delet
Source:
Parameters:
- paramsdata
@@ -4798,58 +4741,7 @@ Parameters:
- Connection parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Connection ID.
-
-
-
-
-
-
-
-
+ User data.
@@ -4936,12 +4828,12 @@ Returns:
Example
- management.deleteConnection({ id: CONNECTION_ID }, function (err) {
+ management.createUser(data, function (err) {
if (err) {
// Handle error.
}
- // Conection deleted.
+ // User created.
});
@@ -4953,14 +4845,14 @@ Example
- deleteDeviceCredential(params, cbopt) → {Promise|undefined}
+ deleteAllUsers(cbopt) → {Promise|undefined}
- Delete an Auth0 device credential.
+ Delete all users.
@@ -4984,6 +4876,8 @@ Deprecated:- This method will be removed in the next major release.
Source:
Parameters:
- paramscb
-Object
+function
@@ -5057,6 +4951,8 @@ Parameters:
+ <optional>
+
@@ -5067,119 +4963,32 @@ Parameters:
- Credential parameters.
+ Callback function
-
-
-
-
-
-
- Name
-
+
+
- Type
+
+
+
-
-
- Description
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
- Device credential ID.
-
-
-
-
-
-
-
-
-
-
+
+Returns:
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
+
-
@@ -5205,14 +5014,12 @@
Returns:
Example
- var params = { id: CREDENTIAL_ID };
-
-management.deleteDeviceCredential(params, function (err) {
+ management.deleteAllUsers(function (err) {
if (err) {
// Handle error.
}
- // Credential deleted.
+ // Users deleted
});
@@ -5224,14 +5031,14 @@ Example
- deleteEmailProvider(cbopt) → {Promise|undefined}
+ deleteClient(params, cbopt) → {Promise|undefined}
- Delete email provider.
+ Delete an Auth0 client.
@@ -5267,7 +5074,7 @@ de
- Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Client parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Application client ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.deleteEmailProvider(function (err) {
+ management.deleteClient({ client_id: CLIENT_ID }, function (err) {
if (err) {
// Handle error.
}
- // Email provider deleted.
+ // Client deleted.
});
@@ -5408,14 +5300,14 @@ Example
- deleteGuardianEnrollment(data, cbopt) → {Promise|undefined}
+ deleteClientGrant(params, cbopt) → {Promise|undefined}
- Delete a user's Guardian enrollment.
+ Delete an Auth0 client grant.
@@ -5451,7 +5343,7 @@ Source:
Parameters:
- dataparams
@@ -5522,7 +5414,7 @@ Parameters:
- The Guardian enrollment data object.
+ Client parameters.
@@ -5565,7 +5457,7 @@ Parameters:
- The Guardian enrollment id.
+ Client grant ID.
@@ -5660,12 +5552,12 @@ Returns:
Example
- management.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err) {
+ management.clientGrants.delete({ id: GRANT_ID }, function (err) {
if (err) {
// Handle error.
}
- // Email provider deleted.
+ // Grant deleted.
});
@@ -5677,14 +5569,14 @@ Example
- deleteResourceServer(params, cbopt) → {Promise|undefined}
+ deleteConnection(params, cbopt) → {Promise|undefined}
- Delete an existing resource server.
+ Delete an existing connection.
@@ -5720,7 +5612,7 @@ d
- Source:
Parameters:
- Resource Server parameters.
+ Connection parameters.
@@ -5834,7 +5726,7 @@ Parameters:
- Resource Server ID.
+ Connection ID.
@@ -5929,12 +5821,12 @@ Returns:
Example
- management.deleteResourceServer({ id: RESOURCE_SERVER_ID }, function (err) {
+ management.deleteConnection({ id: CONNECTION_ID }, function (err) {
if (err) {
// Handle error.
}
- // Resource Server deleted.
+ // Conection deleted.
});
@@ -5946,14 +5838,14 @@ Example
- deleteRule(params, cbopt) → {Promise|undefined}
+ deleteCustomDomain(params, cbopt) → {Promise|undefined}
- Delete an existing rule.
+ Delete a Custom Domain.
@@ -5989,7 +5881,7 @@ deleteRule<
- Source:
Parameters:
- Rule parameters.
+ Custom Domain parameters.
@@ -6103,7 +5995,7 @@ Parameters:
- Rule ID.
+ Custom Domain ID.
@@ -6198,12 +6090,12 @@ Returns:
Example
- auth0.deleteRule({ id: RULE_ID }, function (err) {
+ management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
if (err) {
// Handle error.
}
- // Rule deleted.
+ // CustomDomain deleted.
});
@@ -6215,14 +6107,14 @@ Example
- deleteRulesConfig(params, cbopt) → {Promise|undefined}
+ deleteDeviceCredential(params, cbopt) → {Promise|undefined}
- Delete rules config.
+ Delete an Auth0 device credential.
@@ -6258,7 +6150,7 @@ dele
- Source:
Parameters:
- Rule Configs parameters.
+ Credential parameters.
@@ -6355,7 +6247,7 @@ Parameters:
- keyid
@@ -6372,7 +6264,7 @@ Parameters:
- Rule Configs key.
+ Device credential ID.
@@ -6467,12 +6359,14 @@ Returns:
Example
- management.deleteRulesConfig({ key: RULE_CONFIG_KEY }, function (err) {
+ var params = { id: CREDENTIAL_ID };
+
+management.deleteDeviceCredential(params, function (err) {
if (err) {
// Handle error.
}
- // Rules Config deleted.
+ // Credential deleted.
});
@@ -6484,14 +6378,14 @@ Example
- deleteUser(params, cbopt) → {Promise|undefined}
+ deleteEmailProvider(cbopt) → {Promise|undefined}
- Delete a user by its id.
+ Delete email provider.
@@ -6527,7 +6421,7 @@ deleteUser<
- Source:
Parameters:
- paramscb
-Object
+function
@@ -6588,6 +6482,8 @@ Parameters:
+ <optional>
+
@@ -6598,101 +6494,14 @@ Parameters:
- The user data object..
+ Callback function.
-
-
-
-
-
-
- Name
-
+
+
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- The user id.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function
-
-
-
-
-
-
-
+
+
+
@@ -6736,12 +6545,12 @@ Returns:
Example
- management.deleteUser({ id: USER_ID }, function (err) {
+ management.deleteEmailProvider(function (err) {
if (err) {
// Handle error.
}
- // User deleted.
+ // Email provider deleted.
});
@@ -6753,14 +6562,14 @@ Example
- deleteUserMultifactor(params, cbopt) → {Promise|undefined}
+ deleteGuardianEnrollment(data, cbopt) → {Promise|undefined}
- Delete a multifactor provider for a user.
+ Delete a user's Guardian enrollment.
@@ -6796,7 +6605,7 @@
Source:
Parameters:
- paramsdata
@@ -6867,7 +6676,7 @@ Parameters:
- Data object.
+ The Guardian enrollment data object.
@@ -6910,33 +6719,7 @@ Parameters:
- The user id.
-
-
-
-
-
-
-
-
- provider
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Multifactor provider.
+ The Guardian enrollment id.
@@ -6980,7 +6763,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -7031,14 +6814,12 @@ Returns:
Example
- var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-
-management.deleteUserMultifactor(params, function (err, user) {
+ management.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // Email provider deleted.
});
@@ -7050,14 +6831,14 @@ Example
- deleteUserMultifcator(params, cbopt) → {Promise|undefined}
+ deleteResourceServer(params, cbopt) → {Promise|undefined}
- Delete a multifactor provider for a user.
+ Delete an existing resource server.
@@ -7081,10 +6862,6 @@
- Deprecated: - The function name has a typo.
-We're shipping this so it doesn't break compatibility.
-Use
deleteUserMultifactor instead.
Source:
Parameters:
- Data object.
+ Resource Server parameters.
@@ -7211,33 +6988,7 @@ Parameters:
- The user id.
-
-
-
-
-
-
-
-
- provider
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Multifactor provider.
+ Resource Server ID.
@@ -7281,7 +7032,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -7332,14 +7083,12 @@ Returns:
Example
- var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-
-management.deleteUserMultifcator(params, function (err, user) {
+ management.deleteResourceServer({ id: RESOURCE_SERVER_ID }, function (err) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // Resource Server deleted.
});
@@ -7351,14 +7100,14 @@ Example
- getActiveUsersCount(cbopt) → {Promise|undefined}
+ deleteRule(params, cbopt) → {Promise|undefined}
- Get a the active users count.
+ Delete an existing rule.
@@ -7394,7 +7143,7 @@ ge
Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rule parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.getActiveUsersCount(function (err, usersCount) {
+ auth0.deleteRule({ id: RULE_ID }, function (err) {
if (err) {
// Handle error.
}
- console.log(usersCount);
+ // Rule deleted.
});
@@ -7535,14 +7369,14 @@ Example
- getBlacklistedTokens(cbopt) → {Promise|undefined}
+ deleteRulesConfig(params, cbopt) → {Promise|undefined}
- Get all blacklisted tokens.
+ Delete rules config.
@@ -7578,7 +7412,7 @@ g
Source:
Parameters:
- cbparams
-function
+Object
@@ -7639,8 +7473,6 @@ Parameters:
- <optional>
-
@@ -7651,7 +7483,94 @@ Parameters:
- Callback function.
+ Rule Configs parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule Configs key.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
@@ -7702,8 +7621,12 @@ Returns:
Example
- management.getBlacklistedTokens(function (err, tokens) {
- console.log(tokens.length);
+ management.deleteRulesConfig({ key: RULE_CONFIG_KEY }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Rules Config deleted.
});
@@ -7715,14 +7638,14 @@ Example
- getClient(params, cbopt) → {Promise|undefined}
+ deleteUser(params, cbopt) → {Promise|undefined}
- Get an Auth0 client.
+ Delete a user by its id.
@@ -7758,7 +7681,7 @@ getClientSource:
Parameters:
- Client parameters.
+ The user data object..
@@ -7855,7 +7778,7 @@ Parameters:
- client_idid
@@ -7872,7 +7795,7 @@ Parameters:
- Application client ID.
+ The user id.
@@ -7916,7 +7839,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -7967,12 +7890,12 @@ Returns:
Example
- management.getClient({ client_id: CLIENT_ID }, function (err, client) {
+ management.deleteUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
- console.log(client);
+ // User deleted.
});
@@ -7984,122 +7907,14 @@ Example
- getClientInfo() → {Object}
-
-
-
-
-
-
- Return an object with information about the current client,
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Object
-
-
-
-
-
-
-
- Object containing client information.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- getClients(paramsopt, cbopt) → {Promise|undefined}
+ deleteUserMultifactor(params, cbopt) → {Promise|undefined}
- Get all Auth0 clients.
+ Delete a multifactor provider for a user.
@@ -8135,7 +7950,7 @@ getClients<
Source:
Parameters:
- <optional>
-
@@ -8208,7 +8021,7 @@ Parameters:
- Clients parameters.
+ Data object.
@@ -8222,8 +8035,6 @@ Parameters:
Type
- Attributes
-
@@ -8236,34 +8047,24 @@ Parameters:
- per_pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Number of results per page.
+ The user id.
@@ -8272,34 +8073,24 @@ Parameters:
- pageprovider
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ Multifactor provider.
@@ -8343,7 +8134,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -8394,20 +8185,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, provider: MULTIFACTOR_PROVIDER };
-management.getClients(params, function (err, clients) {
- console.log(clients.length);
+management.deleteUserMultifactor(params, function (err, user) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Users accounts unlinked.
});
@@ -8419,14 +8204,14 @@ Example
- getConnection(params, cbopt) → {Promise|undefined}
+ deleteUserMultifcator(params, cbopt) → {Promise|undefined}
- Get an Auth0 connection.
+ Delete a multifactor provider for a user.
@@ -8450,6 +8235,10 @@ getConne
+ Deprecated: - The function name has a typo.
+We're shipping this so it doesn't break compatibility.
+Use
deleteUserMultifactor instead.
getConne
Source:
Parameters:
- Connection parameters.
+ Data object.
@@ -8576,7 +8365,33 @@ Parameters:
- Connection ID.
+ The user id.
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Multifactor provider.
@@ -8620,7 +8435,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -8671,12 +8486,14 @@ Returns:
Example
- management.getConnection({ id: CONNECTION_ID }, function (err, connection) {
+ var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
+
+management.deleteUserMultifcator(params, function (err, user) {
if (err) {
// Handle error.
}
- console.log(connection);
+ // Users accounts unlinked.
});
@@ -8688,14 +8505,14 @@ Example
- getConnections(paramsopt, cbopt) → {Promise|undefined}
+ exportUsers(data, cbopt) → {Promise|undefined}
- Get all connections.
+ Export all users to a file using a long running job.
@@ -8731,7 +8548,7 @@ getConn
Source:
Parameters:
- paramsdata
@@ -8792,8 +8609,6 @@ Parameters:
- <optional>
-
@@ -8804,7 +8619,7 @@ Parameters:
- Connections params.
+ Users export data.
@@ -8832,13 +8647,13 @@ Parameters:
- per_pageconnection_id
-Number
+String
@@ -8859,7 +8674,7 @@ Parameters:
- Number of results per page.
+ The connection id of the connection from which users will be exported
@@ -8868,7 +8683,43 @@ Parameters:
- pageformat
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The format of the file. Valid values are: "json" and "csv".
+
+
+
+
+
+
+
+
+ limit
@@ -8895,7 +8746,43 @@ Parameters:
- Page number, zero indexed.
+ Limit the number of records.
+
+
+
+
+
+
+
+
+ fields
+
+
+Array.<Object>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
@@ -8990,20 +8877,37 @@ 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 data = {
+ connection_id: 'con_0000000000000001',
+ format: 'csv',
+ limit: 5,
+ fields: [
+ {
+ "name": "user_id"
+ },
+ {
+ "name": "name"
+ },
+ {
+ "name": "email"
+ },
+ {
+ "name": "identities[0].connection",
+ "export_as": "provider"
+ },
+ {
+ "name": "user_metadata.some_field"
+ }
+ ]
+}
+
+management.exportUsers(data, function (err, results) {
+ if (err) {
+ // Handle error.
+ }
-management.getConnections(params, function (err, connections) {
- console.log(connections.length);
+ // Retrieved job.
+ console.log(results);
});
@@ -9015,14 +8919,14 @@ Example
- getDailyStats(params, cbopt) → {Promise|undefined}
+ getActiveUsersCount(cbopt) → {Promise|undefined}
- Get the daily stats.
+ Get a the active users count.
@@ -9058,7 +8962,7 @@ getDaily
Source:
Parameters:
- paramscb
-Object
+function
@@ -9119,6 +9023,8 @@ Parameters:
+ <optional>
+
@@ -9129,156 +9035,43 @@ Parameters:
- Stats parameters.
+ Callback function.
-
-
-
-
-
-
- Name
-
+
+
- Type
+
+
+
-
-
- Description
-
-
-
-
-
-
- from
-
-
-String
-
-
-
-
-
- The first day in YYYYMMDD format.
-
-
-
-
-
-
- to
-
-
-String
+
+Returns:
+
-
-
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
-
-
-
-
-
- The last day in YYYYMMDD format.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
+undefined
@@ -9293,17 +9086,12 @@ Returns:
Example
- var params = {
- from: '{YYYYMMDD}', // First day included in the stats.
- to: '{YYYYMMDD}' // Last day included in the stats.
-};
-
-management.getDaily(params, function (err, stats) {
+ management.getActiveUsersCount(function (err, usersCount) {
if (err) {
// Handle error.
}
- console.log(stats);
+ console.log(usersCount);
});
@@ -9315,14 +9103,14 @@ Example
- getDeviceCredentials(cbopt) → {Promise|undefined}
+ getBlacklistedTokens(cbopt) → {Promise|undefined}
- Get all Auth0 credentials.
+ Get all blacklisted tokens.
@@ -9358,7 +9146,7 @@ g
- Source:
Returns:
Example
- management.getDeviceCredentials(function (err, credentials) {
- console.log(credentials.length);
+ management.getBlacklistedTokens(function (err, tokens) {
+ console.log(tokens.length);
});
@@ -9495,14 +9283,14 @@ Example
- getEmailProvider(cbopt) → {Promise|undefined}
+ getClient(params, cbopt) → {Promise|undefined}
- Get the email provider.
+ Get an Auth0 client.
@@ -9538,7 +9326,7 @@ getEm
- Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Client parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Application client ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.getEmailProvider(function (err, provider) {
- console.log(provider.length);
+ management.getClient({ client_id: CLIENT_ID }, function (err, client) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(client);
});
@@ -9675,14 +9552,14 @@ Example
- getGuardianEnrollment(data, cbopt) → {Promise|undefined}
+ getClientGrants(paramsopt, cbopt) → {Promise|undefined}
- Get a single Guardian enrollment.
+ Get all Auth0 Client Grants.
@@ -9718,7 +9595,7 @@
- Source:
Parameters:
- dataparams
@@ -9779,6 +9656,8 @@ Parameters:
+ <optional>
+
@@ -9789,7 +9668,7 @@ Parameters:
- The Guardian enrollment data object.
+ Client Grants parameters.
@@ -9803,6 +9682,8 @@ Parameters:
Type
+ Attributes
+
@@ -9815,32 +9696,34 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
-
+
-
- The Guardian enrollment id.
-
-
+
+
-
-
-
+
+
+ Number of results per page.
@@ -9849,13 +9732,13 @@ Parameters:
- cbpage
-function
+Number
@@ -9876,7 +9759,7 @@ Parameters:
- Callback function.
+ Page number, zero indexed.
@@ -9885,6 +9768,53 @@ Parameters:
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
@@ -9895,9 +9825,6 @@ Parameters:
-
-
-
Returns:
@@ -9927,8 +9854,20 @@ Returns:
Example
- management.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
- console.log(enrollment);
+
+ 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.getClientGrants(params, function (err, grants) {
+ console.log(grants.length);
});
@@ -9940,14 +9879,14 @@ Example
- getGuardianEnrollments(data, cbopt) → {Promise|undefined}
+ getClientInfo() → {Object}
- Get a list of a user's Guardian enrollments.
+ Return an object with information about the current client,
@@ -9983,7 +9922,115 @@ Source:
Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Object
+
+
+
+
+
+
+
+ Object containing client information.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ getClients(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 clients.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ Parameters:
- dataparams
@@ -10044,6 +10091,8 @@ Parameters:
+ <optional>
+
@@ -10054,7 +10103,7 @@ Parameters:
- The user data object.
+ Clients parameters.
@@ -10068,6 +10117,8 @@ Parameters:
Type
+ Attributes
+
@@ -10080,24 +10131,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- The user id.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -10192,8 +10289,20 @@ Returns:
Example
- management.getGuardianEnrollments({ id: USER_ID }, function (err, enrollments) {
- console.log(enrollments);
+
+ 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.getClients(params, function (err, clients) {
+ console.log(clients.length);
});
@@ -10205,14 +10314,14 @@ Example
- getJob(params, cbopt) → {Promise|undefined}
+ getConnection(params, cbopt) → {Promise|undefined}
- Get a job by its ID.
+ Get an Auth0 connection.
@@ -10248,7 +10357,7 @@ getJobSource:
Parameters:
- Job parameters.
+ Connection parameters.
@@ -10362,7 +10471,7 @@ Parameters:
- Job ID.
+ Connection ID.
@@ -10457,17 +10566,12 @@ Returns:
Example
- var params = {
- id: '{JOB_ID}'
-};
-
-management.getJob(params, function (err, job) {
+ management.getConnection({ id: CONNECTION_ID }, function (err, connection) {
if (err) {
// Handle error.
}
- // Retrieved job.
- console.log(job);
+ console.log(connection);
});
@@ -10479,14 +10583,14 @@ Example
- getLog(params, cbopt) → {Promise|undefined}
+ getConnections(paramsopt, cbopt) → {Promise|undefined}
- Get an Auth0 log.
+ Get all connections.
@@ -10522,7 +10626,7 @@ getLogSource:
Parameters:
+ <optional>
+
@@ -10593,7 +10699,7 @@ Parameters:
- Log parameters.
+ Connections params.
@@ -10607,6 +10713,8 @@ Parameters:
Type
+ Attributes
+
@@ -10619,24 +10727,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- Event ID.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -10731,12 +10885,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.getConnections(params, function (err, connections) {
+ console.log(connections.length);
});
@@ -10748,14 +10910,14 @@ Example
- getLogs(paramsopt, cbopt) → {Promise|undefined}
+ getCustomDomain(params, cbopt) → {Promise|undefined}
- Get all logs.
+ Get a Custom Domain.
@@ -10791,7 +10953,7 @@ getLogsSource:
Parameters:
- <optional>
-
@@ -10864,7 +11024,7 @@ Parameters:
- Logs params.
+ Custom Domain parameters.
@@ -10878,8 +11038,6 @@ Parameters:
Type
- Attributes
-
@@ -10892,7 +11050,7 @@ Parameters:
- qid
@@ -10905,21 +11063,19 @@ Parameters:
-
-
- <optional>
-
-
+
+
+ Custom Domain ID.
-
-
+
+
-
+
+
+
-
- Search Criteria using Query String Syntax
@@ -10928,13 +11084,13 @@ Parameters:
- pagecb
-Number
+function
@@ -10955,238 +11111,134 @@ Parameters:
- Page number. Zero based
+ Callback function.
+
+
-
-
- per_page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- The amount of entries per page
-
-
-
-
-
-
- sort
-
-
-String
-
-
+
+Returns:
-
-
-
- <optional>
-
+
-
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
-
-
-
+undefined
-
-
- The field to use for sorting.
-
-
-
+
+
+
+
-
-
- fields
-
-
-String
+
+Example
-
-
+ management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ if (err) {
+ // Handle error.
+ }
-
-
-
- <optional>
-
+ console.log(customDomain);
+});
-
+
-
-
+
+
+
-
+
-
- A comma separated list of fields to include or exclude
-
-
-
+ getCustomDomains() → {Promise|undefined}
-
-
- include_fields
-
-
-Boolean
+
+ Get all Auth0 CustomDomains.
+
-
-
-
-
-
- <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
-
-
-
+
-
-
-
-
-
+
+
+ Source:
+
-
- cb
-
-
-function
+
+
+
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
@@ -11230,20 +11282,8 @@ 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
-};
-
-management.getLogs(params, function (err, logs) {
- console.log(logs.length);
+ management.getCustomDomains(function (err, customDomains) {
+ console.log(customDomains.length);
});
@@ -11255,14 +11295,14 @@ Example
- getResourceServer(params, cbopt) → {Promise|undefined}
+ getDailyStats(params, cbopt) → {Promise|undefined}
- Get a Resource Server.
+ Get the daily stats.
@@ -11298,7 +11338,7 @@ getR
Source:
Parameters:
- Resource Server parameters.
+ Stats parameters.
@@ -11395,7 +11435,7 @@ Parameters:
- idfrom
@@ -11412,7 +11452,33 @@ Parameters:
- Resource Server ID.
+ The first day in YYYYMMDD format.
+
+
+
+
+
+
+
+
+ to
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The last day in YYYYMMDD format.
@@ -11507,12 +11573,17 @@ Returns:
Example
- management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+ var params = {
+ from: '{YYYYMMDD}', // First day included in the stats.
+ to: '{YYYYMMDD}' // Last day included in the stats.
+};
+
+management.getDaily(params, function (err, stats) {
if (err) {
// Handle error.
}
- console.log(resourceServer);
+ console.log(stats);
});
@@ -11524,14 +11595,14 @@ Example
- getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+ getDeviceCredentials(cbopt) → {Promise|undefined}
- Get all resource servers.
+ Get all Auth0 credentials.
@@ -11567,7 +11638,7 @@ get
Source:
Parameters:
- paramscb
-Object
+function
@@ -11640,226 +11711,79 @@ Parameters:
- Resource Servers parameters.
+ Callback function.
-
+
+
-
-
-
-
- Name
-
+
+
+
- Type
-
- Attributes
-
-
- Description
-
-
-
-
-
-
- per_page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
+
+Returns:
-
+
-
-
- page
+ -
+ Type:
+
+ -
+
+
Promise
+|
-
-
-
-Number
+undefined
-
-
+
+
-
-
-
- <optional>
-
-
+
+
-
-
-
-
-
- Page number, zero indexed.
-
-
-
+
+Example
+
+ management.getDeviceCredentials(function (err, credentials) {
+ console.log(credentials.length);
+});
+
+
+
+
+
+
+
-
-
-
-
-
+ getEmailProvider(cbopt, paramsopt) → {Promise|undefined}
-
-
- 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);
-});
-
-
-
-
-
-
-
-
-
-
- getRule(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get an Auth0 rule.
-
+
+ Get the email provider.
+
@@ -11894,7 +11818,7 @@ getRuleSource:
Parameters:
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
paramsParameters:
+ <optional>
+
@@ -11965,7 +11927,7 @@ Parameters:
- Rule parameters.
+ Clients parameters.
@@ -11979,6 +11941,8 @@ Parameters:
Type
+ Attributes
+
@@ -11991,32 +11955,34 @@ Parameters:
- idfields
-String
+Number
+
+
+ <optional>
+
-
+
-
- Rule ID.
-
-
+
+
-
-
-
+
+
+ A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
@@ -12025,13 +11991,13 @@ Parameters:
- cbinclude_fields
-function
+Number
@@ -12052,7 +12018,15 @@ Parameters:
- Callback function.
+ true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
+
+
+
+
+
+
+
@@ -12103,12 +12077,8 @@ Returns:
Example
- management.getRule({ id: RULE_ID }, function (err, rule) {
- if (err) {
- // Handle error.
- }
-
- console.log(rule);
+ management.getEmailProvider(function (err, provider) {
+ console.log(provider.length);
});
@@ -12120,14 +12090,14 @@ Example
- getRules(paramsopt, cbopt) → {Promise|undefined}
+ getGuardianEnrollment(data, cbopt) → {Promise|undefined}
- Get all rules.
+ Get a single Guardian enrollment.
@@ -12163,7 +12133,7 @@ getRulesSource:
Parameters:
- paramsdata
@@ -12224,8 +12194,6 @@ Parameters:
- <optional>
-
@@ -12236,7 +12204,7 @@ Parameters:
- Rules parameters.
+ The Guardian enrollment data object.
@@ -12250,8 +12218,6 @@ Parameters:
Type
- Attributes
-
@@ -12264,70 +12230,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ The Guardian enrollment id.
@@ -12422,20 +12342,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 = {
- per_page: 10,
- page: 0
-};
-
-management.getRules(params, function (err, rules) {
- console.log(rules.length);
+ management.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ console.log(enrollment);
});
@@ -12447,14 +12355,14 @@ Example
- getRulesConfigs() → {Promise|undefined}
+ getGuardianEnrollments(data, cbopt) → {Promise|undefined}
- Get rules config.
+ Get a list of a user's Guardian enrollments.
@@ -12490,7 +12398,7 @@ getRul
Source:
getRul
+ Parameters:
+
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
+
+
+
-
-
- -
- Type:
-
- -
+
Name
-Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.getRulesConfigs(function (err, rulesConfigs) {
- if (err) {
- // Handle error.
- }
-
- // Get Rules Configs.
-});
-
+ Type
-
-
-
-
-
-
- getTenantSettings(cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get the tenant settings..
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
- Attributes
+
-
+
-
+ Description
+
+
+
-
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
- Parameters:
-
+
+ The user data object.
+
+
@@ -12642,8 +12483,6 @@ Parameters:
Type
- Attributes
-
@@ -12654,6 +12493,40 @@ Parameters:
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.getSettings(function (err, settings) {
- if (err) {
- // Handle error.
- }
-
- console.log(settings);
+ management.getGuardianEnrollments({ id: USER_ID }, function (err, enrollments) {
+ console.log(enrollments);
});
@@ -12751,14 +12620,14 @@ Example
- getUser(data, cbopt) → {Promise|undefined}
+ getJob(params, cbopt) → {Promise|undefined}
- Get a user by its id.
+ Get a job by its ID.
@@ -12794,7 +12663,7 @@ getUserSource:
Parameters:
- dataparams
@@ -12865,7 +12734,7 @@ Parameters:
- The user data object.
+ Job parameters.
@@ -12908,7 +12777,7 @@ Parameters:
- The user id.
+ Job ID.
@@ -13003,8 +12872,17 @@ Returns:
Example
- management.getUser({ id: USER_ID }, function (err, user) {
- console.log(user);
+ var params = {
+ id: '{JOB_ID}'
+};
+
+management.getJob(params, function (err, job) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Retrieved job.
+ console.log(job);
});
@@ -13016,14 +12894,14 @@ Example
- getUserLogs(params, cbopt) → {Promise|undefined}
+ getLog(params, cbopt) → {Promise|undefined}
- Get user's log events.
+ Get an Auth0 log.
@@ -13059,7 +12937,7 @@ getUserLog
Source:
Parameters:
- Get logs data.
+ Log parameters.
@@ -13173,7 +13051,15 @@ Parameters:
- User id.
+ Event ID.
+
+
+
+
+
+
+
+
@@ -13182,24 +13068,2952 @@ Parameters:
- per_pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Number of results per page.
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getLog({ id: EVENT_ID }, function (err, log) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(log);
+});
+
+
+
+
+
+
+
+
+
+
+ getLogs(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all logs.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Logs params.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ q
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Search Criteria using Query String Syntax
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number. Zero based
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The amount of entries per page
+
+
+
+
+
+
+
+
+ sort
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The field to use for sorting.
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 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);
+});
+
+
+
+
+
+
+
+
+
+
+ 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);
+});
+
+
+
+
+
+
+
+
+
+
+ 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() → {Promise|undefined}
+
+
+
+
+
+
+ Get rules config.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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..
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getSettings(function (err, settings) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(settings);
+});
+
+
+
+
+
+
+
+
+
+
+ getUser(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a user by its id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - 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.getUser({ id: USER_ID }, function (err, user) {
+ console.log(user);
+});
+
+
+
+
+
+
+
+
+
+
+ getUserLogs(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get user's log events.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Get logs data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ User id.
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ sort
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+
+management.getUserLogs(params, function (err, logs) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logs);
+});
+
+
+
+
+
+
+
+
+
+
+ getUsers(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all users.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Users params.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ search_engine
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The version of the search engine to use.
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
@@ -13217,24 +16031,235 @@ Parameters:
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 = {
+ search_engine: 'v3',
+ per_page: 10,
+ page: 0
+};
+
+auth0.getUsers(params, function (err, users) {
+ console.log(users.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get users for a given email address
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
-
+
+ Attributes
+
-
+
-
- Page number, zero indexed.
-
-
-
+ Description
+
+
+
- sortemail
@@ -13247,45 +16272,21 @@ Parameters:
-
-
-
-
- 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
-
+ <optional>
-Boolean
+
-
-
-
+
+
- true if a query summary must be included in the result, false otherwise. Default false;
-
-
-
-
-
-
-
-
+ Email Address of users to locate
@@ -13372,14 +16373,13 @@ Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-
-management.getUserLogs(params, function (err, logs) {
- if (err) {
- // Handle error.
- }
-
- console.log(logs);
+
+ 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);
});
@@ -13391,14 +16391,15 @@ Example
- getUsers(paramsopt, cbopt) → {Promise|undefined}
+ importUsers(data, cbopt) → {Promise|undefined}
- Get all users.
+ Given a path to a file and a connection id, create a new job that imports the
+users contained in the file and associate them with the given connection.
@@ -13434,7 +16435,7 @@ getUsersSource:
Parameters:
- paramsdata
@@ -13495,8 +16496,6 @@ Parameters:
- <optional>
-
@@ -13507,7 +16506,7 @@ Parameters:
- Users params.
+ Users import data.
@@ -13521,8 +16520,6 @@ Parameters:
Type
- Attributes
-
@@ -13535,70 +16532,24 @@ Parameters:
- search_engine
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The version of the search engine to use.
-
-
-
-
-
-
-
-
- per_pageconnectionId
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Number of results per page.
+ Connection for the users insertion.
@@ -13607,34 +16558,24 @@ Parameters:
- pageusers
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ Path to the users data file.
@@ -13729,21 +16670,15 @@ 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',
- per_page: 10,
- page: 0
+ var params = {
+ connection_id: '{CONNECTION_ID}',
+ users: '{PATH_TO_USERS_FILE}'
};
-auth0.getUsers(params, function (err, users) {
- console.log(users.length);
+management.get(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
});
@@ -13755,14 +16690,14 @@ Example
- getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+ linkUsers(userId, params, cbopt) → {Promise|undefined}
- Get users for a given email address
+ Link the user with another account.
@@ -13798,7 +16733,7 @@ getUse
Source:
getUse
- Parameters:
-
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ userId
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ID of the primary user.
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Secondary user data.
+
+
@@ -13830,8 +16852,6 @@ Parameters:
Type
- Attributes
-
@@ -13844,7 +16864,7 @@ Parameters:
- emailuser_id
@@ -13857,21 +16877,45 @@ Parameters:
-
-
- <optional>
-
+
+
+
+ ID of the user to be linked.
+
+
+
+
+
+
+
+ connection_id
+
-
+String
+
+
+
+
+
- Email Address of users to locate
+ ID of the connection to be used.
+
+
+
+
+
+
+
+
@@ -13958,13 +17002,18 @@ 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 userId = 'USER_ID';
+var params = {
+ user_id: 'OTHER_USER_ID',
+ connection_id: 'CONNECTION_ID'
+};
+
+management.linkUsers(userId, params, function (err, user) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Users linked.
});
@@ -13976,15 +17025,14 @@ Example
- importUsers(data, cbopt) → {Promise|undefined}
+ regenerateRecoveryCode(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 and associate them with the given connection.
+ Generate new Guardian recovery code.
@@ -14020,7 +17068,7 @@ importUser
Source:
Parameters:
- Users import data.
+ The user data object.
@@ -14117,33 +17165,7 @@ Parameters:
- connectionId
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Connection for the users insertion.
-
-
-
-
-
-
-
-
- usersid
@@ -14160,7 +17182,7 @@ Parameters:
- Path to the users data file.
+ The user id.
@@ -14255,15 +17277,8 @@ Returns:
Example
- var params = {
- connection_id: '{CONNECTION_ID}',
- users: '{PATH_TO_USERS_FILE}'
-};
-
-management.get(params, function (err) {
- if (err) {
- // Handle error.
- }
+ management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
+ console.log(newRecoveryCode);
});
@@ -14275,14 +17290,14 @@ Example
- linkUsers(userId, params, cbopt) → {Promise|undefined}
+ sendEmailVerification(data, cbopt) → {Promise|undefined}
- Link the user with another account.
+ Send a verification email to a user.
@@ -14318,7 +17333,7 @@ linkUsersSource:
Parameters:
- userId
-
-
-String
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ID of the primary user.
-
-
-
-
-
-
-
-
- paramsdata
@@ -14423,7 +17404,7 @@ Parameters:
- Secondary user data.
+ User data object.
@@ -14466,33 +17447,7 @@ Parameters:
- ID of the user to be linked.
-
-
-
-
-
-
-
-
- connection_id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- ID of the connection to be used.
+ ID of the user to be verified.
@@ -14587,18 +17542,14 @@ Returns:
Example
- var userId = 'USER_ID';
-var params = {
- user_id: 'OTHER_USER_ID',
- connection_id: 'CONNECTION_ID'
+ var params = {
+ user_id: '{USER_ID}'
};
-management.linkUsers(userId, params, function (err, user) {
+management.sendEmailVerification(function (err) {
if (err) {
// Handle error.
}
-
- // Users linked.
});
@@ -14610,14 +17561,14 @@ Example
- regenerateRecoveryCode(data, cbopt) → {Promise|undefined}
+ setRulesConfig(params, data, cbopt) → {Promise|undefined}
- Generate new Guardian recovery code.
+ Set a new rules config.
@@ -14653,7 +17604,7 @@ Source:
Parameters:
-
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rule Config parameters.
+
+
@@ -14685,8 +17689,6 @@ Parameters:
Type
- Attributes
-
@@ -14697,6 +17699,40 @@ Parameters:
+
+
+ key
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule Config key.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
dataParameters:
- The user data object.
+ Rule Config Data parameters.
@@ -14750,7 +17786,7 @@ Parameters:
- idvalue
@@ -14767,7 +17803,7 @@ Parameters:
- The user id.
+ Rule Config Data value.
@@ -14862,8 +17898,15 @@ Returns:
Example
- management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
- console.log(newRecoveryCode);
+ var params = { key: RULE_CONFIG_KEY };
+var data = { value: RULES_CONFIG_VALUE };
+
+management.setRulesConfig(params, data, function (err, rulesConfig) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Rules Config set.
});
@@ -14875,14 +17918,14 @@ Example
- sendEmailVerification(data, cbopt) → {Promise|undefined}
+ unlinkUsers(params, cbopt) → {Promise|undefined}
- Send a verification email to a user.
+ Unlink the given accounts.
@@ -14918,7 +17961,7 @@
Source:
Parameters:
- dataparams
@@ -14989,7 +18032,7 @@ Parameters:
- User data object.
+ Linked users data.
@@ -15013,6 +18056,58 @@ Parameters:
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Primary user ID.
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Identity provider in use.
+
+
+
+
+
+
user_idParameters:
- ID of the user to be verified.
+ Secondary user ID.
@@ -15127,14 +18222,14 @@ Returns:
Example
- var params = {
- user_id: '{USER_ID}'
-};
+ var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
-management.sendEmailVerification(function (err) {
+management.unlinkUsers(params, function (err, user) {
if (err) {
// Handle error.
}
+
+ // Users accounts unlinked.
});
@@ -15146,14 +18241,14 @@ Example
- setRulesConfig(params, data, cbopt) → {Promise|undefined}
+ updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
- Set a new rules config.
+ Update the app metadata for a user.
@@ -15189,7 +18284,7 @@ setRule
Source:
Parameters:
- Rule Config parameters.
+ The user data object..
@@ -15286,7 +18381,7 @@ Parameters:
- keyid
@@ -15303,7 +18398,7 @@ Parameters:
- Rule Config key.
+ The user id.
@@ -15320,7 +18415,7 @@ Parameters:
- datametadata
@@ -15345,58 +18440,7 @@ Parameters:
- Rule Config Data parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- value
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Rule Config Data value.
-
-
-
-
-
-
-
-
+ New app metadata.
@@ -15432,7 +18476,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -15483,15 +18527,18 @@ Returns:
Example
- var params = { key: RULE_CONFIG_KEY };
-var data = { value: RULES_CONFIG_VALUE };
+ var params = { id: USER_ID };
+var metadata = {
+ foo: 'bar'
+};
-management.setRulesConfig(params, data, function (err, rulesConfig) {
+management.updateAppMetadata(params, metadata, function (err, user) {
if (err) {
// Handle error.
}
- // Rules Config set.
+ // Updated user.
+ console.log(user);
});
@@ -15503,14 +18550,14 @@ Example
- unlinkUsers(params, cbopt) → {Promise|undefined}
+ updateClient(params, data, cbopt) → {Promise|undefined}
- Unlink the given accounts.
+ Update an Auth0 client.
@@ -15546,7 +18593,7 @@ unlinkUser
Source:
Parameters:
- Linked users data.
+ Client parameters.
@@ -15643,7 +18690,7 @@ Parameters:
- idclient_id
@@ -15660,33 +18707,15 @@ Parameters:
- Primary user ID.
+ Application client ID.
+
+
-
-
- provider
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Identity provider in use.
@@ -15695,32 +18724,32 @@ Parameters:
- user_iddata
-String
+Object
+
+
+
+
+
+
+
+
- Secondary user ID.
-
-
-
-
-
-
-
-
+ Updated client data.
@@ -15807,14 +18836,15 @@ Returns:
Example
- var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
+ var data = { name: 'newClientName' };
+var params = { client_id: CLIENT_ID };
-management.unlinkUsers(params, function (err, user) {
+management.updateClient(params, data, function (err, client) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ console.log(client.name); // 'newClientName'
});
@@ -15826,14 +18856,14 @@ Example
- updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
+ updateClientGrant(params, data, cbopt) → {Promise|undefined}
- Update the app metadata for a user.
+ Update an Auth0 client grant.
@@ -15869,7 +18899,7 @@ upda
Source:
Parameters:
- The user data object..
+ Client parameters.
@@ -15983,7 +19013,7 @@ Parameters:
- The user id.
+ Client grant ID.
@@ -16000,7 +19030,7 @@ Parameters:
- metadatadata
@@ -16025,7 +19055,7 @@ Parameters:
- New app metadata.
+ Updated client data.
@@ -16061,7 +19091,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -16112,18 +19142,19 @@ Returns:
Example
- var params = { id: USER_ID };
-var metadata = {
- foo: 'bar'
+ var data = {
+ client_id: CLIENT_ID,
+ audience: AUDIENCE,
+ scope: []
};
+var params = { id: CLIENT_GRANT_ID };
-management.updateAppMetadata(params, metadata, function (err, user) {
+management.clientGrants.update(params, data, function (err, grant) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+ console.log(grant.id);
});
@@ -16135,14 +19166,14 @@ Example
- updateClient(params, data, cbopt) → {Promise|undefined}
+ updateConnection(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client.
+ Update an existing connection.
@@ -16178,7 +19209,7 @@ updateCli
Source:
Parameters:
- Client parameters.
+ Connection parameters.
@@ -16275,7 +19306,7 @@ Parameters:
- client_idid
@@ -16292,7 +19323,7 @@ Parameters:
- Application client ID.
+ Connection ID.
@@ -16334,7 +19365,7 @@ Parameters:
- Updated client data.
+ Updated connection data.
@@ -16421,15 +19452,15 @@ Returns:
Example
- var data = { name: 'newClientName' };
-var params = { client_id: CLIENT_ID };
+ var data = { name: 'newConnectionName' };
+var params = { id: CONNECTION_ID };
-management.updateClient(params, data, function (err, client) {
+management.updateConnection(params, data, function (err, connection) {
if (err) {
// Handle error.
}
- console.log(client.name); // 'newClientName'
+ console.log(connection.name); // 'newConnectionName'
});
@@ -16441,14 +19472,14 @@ Example
- updateConnection(params, data, cbopt) → {Promise|undefined}
+ updateEmailProvider(params, data, cbopt) → {Promise|undefined}
- Update an existing connection.
+ Update the email provider.
@@ -16484,7 +19515,7 @@ updat
Source:
Parameters:
- Connection parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Connection ID.
-
-
-
-
-
-
-
-
+ Email provider parameters.
@@ -16640,7 +19620,7 @@ Parameters:
- Updated connection data.
+ Updated email provider data.
@@ -16727,15 +19707,13 @@ Returns:
Example
- var data = { name: 'newConnectionName' };
-var params = { id: CONNECTION_ID };
-
-management.updateConnection(params, data, function (err, connection) {
+ management.updateEmailProvider(params, data, function (err, provider) {
if (err) {
// Handle error.
}
- console.log(connection.name); // 'newConnectionName'
+ // Updated email provider.
+ console.log(provider);
});
@@ -16747,14 +19725,14 @@ Example
- updateEmailProvider(params, data, cbopt) → {Promise|undefined}
+ updateResourceServer(params, data, cbopt) → {Promise|undefined}
- Update the email provider.
+ Update an existing resource server.
@@ -16790,7 +19768,7 @@ up
Source:
Parameters:
- Email provider parameters.
+ Resource Server parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Resource Server ID.
+
+
+
+
+
+
+
+
@@ -16895,7 +19924,7 @@ Parameters:
- Updated email provider data.
+ Updated Resource Server data.
@@ -16982,13 +20011,15 @@ Returns:
Example
- management.updateEmailProvider(params, data, function (err, provider) {
+ var data = { name: 'newResourceServerName' };
+var params = { id: RESOURCE_SERVER_ID };
+
+management.updateResourceServer(params, data, function (err, resourceServer) {
if (err) {
// Handle error.
}
- // Updated email provider.
- console.log(provider);
+ console.log(resourceServer.name); // 'newResourceServerName'
});
@@ -17000,14 +20031,14 @@ Example
- updateResourceServer(params, data, cbopt) → {Promise|undefined}
+ updateRule(params, data, cbopt) → {Promise|undefined}
- Update an existing resource server.
+ Update an existing rule.
@@ -17043,7 +20074,7 @@ u
Source:
Parameters:
- Resource Server parameters.
+ Rule parameters.
@@ -17157,7 +20188,7 @@ Parameters:
- Resource Server ID.
+ Rule ID.
@@ -17199,7 +20230,7 @@ Parameters:
- Updated Resource Server data.
+ Updated rule data.
@@ -17286,15 +20317,14 @@ Returns:
Example
- var data = { name: 'newResourceServerName' };
-var params = { id: RESOURCE_SERVER_ID };
-
-management.updateResourceServer(params, data, function (err, resourceServer) {
+ var params = { id: RULE_ID };
+var data = { name: 'my-rule'};
+management.updateRule(params, data, function (err, rule) {
if (err) {
// Handle error.
}
- console.log(resourceServer.name); // 'newResourceServerName'
+ console.log(rule.name); // 'my-rule'.
});
@@ -17306,14 +20336,14 @@ Example
- updateRule(params, data, cbopt) → {Promise|undefined}
+ updateTenantSettings(data, cbopt) → {Promise|undefined}
- Update an existing rule.
+ Update the tenant settings.
@@ -17340,89 +20370,36 @@ updateRule<
-
-
-
-
-
-
-
- Source:
- Parameters:
-
-
-
-
-
-
- Name
-
+
- Type
+
-
- Attributes
-
+
-
+
+ Source:
+ Description
-
-
+
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
- Rule parameters.
-
-
+
+ Parameters:
+
@@ -17434,6 +20411,8 @@ Parameters:
Type
+ Attributes
+
@@ -17444,40 +20423,6 @@ Parameters:
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Rule ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
dataParameters:
- Updated rule data.
+ The new tenant settings.
@@ -17592,14 +20537,10 @@ Returns:
Example
- var params = { id: RULE_ID };
-var data = { name: 'my-rule'};
-management.updateRule(params, data, function (err, rule) {
+ management.updateTenantSettings(data, function (err) {
if (err) {
// Handle error.
}
-
- console.log(rule.name); // 'my-rule'.
});
@@ -17611,14 +20552,14 @@ Example
- updateTenantSettings(data, cbopt) → {Promise|undefined}
+ updateUser(params, data, cbopt) → {Promise|undefined}
- Update the tenant settings.
+ Update a user by its id.
@@ -17654,7 +20595,7 @@ u
Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The user parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
dataParameters:
- The new tenant settings.
+ New user data.
@@ -17761,7 +20787,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -17812,10 +20838,15 @@ Returns:
Example
- management.updateTenantSettings(data, function (err) {
+ var params = { id: USER_ID };
+
+management.updateUser(params, data, function (err, user) {
if (err) {
// Handle error.
}
+
+ // Updated user.
+ console.log(user);
});
@@ -17827,14 +20858,14 @@ Example
- updateUser(params, data, cbopt) → {Promise|undefined}
+ updateUserMetadata(params, metadata, cbopt) → {Promise|undefined}
- Update a user by its id.
+ Update the user metadata for a user.
@@ -17870,7 +20901,7 @@ updateUser<
Source:
Parameters:
- The user parameters.
+ The user data object..
@@ -18001,7 +21032,7 @@ Parameters:
- datametadata
@@ -18026,7 +21057,7 @@ Parameters:
- New user data.
+ New user metadata.
@@ -18114,8 +21145,11 @@ Returns:
Example
var params = { id: USER_ID };
+var metadata = {
+ address: '123th Node.js Street'
+};
-management.updateUser(params, data, function (err, user) {
+management.updateUserMetadata(params, metadata, function (err, user) {
if (err) {
// Handle error.
}
@@ -18133,14 +21167,14 @@ Example
- updateUserMetadata(params, metadata, cbopt) → {Promise|undefined}
+ verifyCustomDomain(params, cbopt) → {Promise|undefined}
- Update the user metadata for a user.
+ Verify a Custom Domain.
@@ -18176,7 +21210,7 @@ upd
Source:
Parameters:
- The user data object..
+ Custom Domain parameters.
@@ -18290,7 +21324,7 @@ Parameters:
- The user id.
+ Custom Domain ID.
@@ -18305,40 +21339,6 @@ Parameters:
-
-
- metadata
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- New user metadata.
-
-
-
-
-
-
cbParameters:
- Callback function
+ Callback function.
@@ -18419,18 +21419,12 @@ Returns:
Example
- var params = { id: USER_ID };
-var metadata = {
- address: '123th Node.js Street'
-};
-
-management.updateUserMetadata(params, metadata, function (err, user) {
+ management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+ console.log(customDomain);
});
@@ -18454,7 +21448,7 @@ Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 98a360c74..ff9ee87b1 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.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 0c021904e..506dcf254 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 482cb0539..7088c566b 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.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 4a371256c..502ae2f83 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 c81f2d396..b7640c53a 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 d73bbea41..ce9e4385a 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 527516334..c659e73ae 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -835,7 +835,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6cc15b131..ccc194f35 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.UsersManager.html b/docs/module-management.UsersManager.html
index 4a29c2bcb..33658deef 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5075,7 +5075,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 24524f386..138034ca4 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -150,7 +150,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index c703086b0..0a882f6e8 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -339,7 +339,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index e1092abfd..c1d593455 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -124,7 +124,7 @@ utils.js
diff --git a/package.json b/package.json
index da7529028..80138069b 100644
--- a/package.json
+++ b/package.json
@@ -1,16 +1,16 @@
{
"name": "auth0",
- "version": "2.14.0",
+ "version": "2.15.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
- "files": [
- "src"
- ],
+ "files": ["src"],
"scripts": {
"test": "mocha -R spec ./test/**/*.tests.js ./test/*.tests.js",
- "test:ci": "istanbul cover _mocha --report lcovonly -R $(find ./test -name *.tests.js) -- -R mocha-multi --reporter-options spec=-,mocha-junit-reporter=-",
+ "test:ci":
+ "istanbul cover _mocha --report lcovonly -R $(find ./test -name *.tests.js) -- -R mocha-multi --reporter-options spec=-,mocha-junit-reporter=-",
"test:coverage": "codecov",
- "test:watch": "cross-env NODE_ENV=test mocha --timeout 5000 ./test/**/*.tests.js ./test/*.tests.js --watch",
+ "test:watch":
+ "cross-env NODE_ENV=test mocha --timeout 5000 ./test/**/*.tests.js ./test/*.tests.js --watch",
"jsdoc:generate": "jsdoc --configure .jsdoc.json --verbose",
"release:clean": "node scripts/cleanup.js",
"preversion": "node scripts/prepare.js",
@@ -22,10 +22,7 @@
"type": "git",
"url": "https://github.com/auth0/node-auth0"
},
- "keywords": [
- "auth0",
- "api"
- ],
+ "keywords": ["auth0", "api"],
"author": "Auth0",
"license": "MIT",
"bugs": {
Source:
Source:
Source:
Source:
diff --git a/docs/index.html b/docs/index.html
index 284900d46..35675c193 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -151,7 +151,7 @@ License
This project is licensed under the MIT license. See the
diff --git a/docs/index.js.html b/docs/index.js.html
index 1c8d473a0..9e941863c 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 48fdcb021..57186a500 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_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index 02d124357..090f03820 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 ee848a5a2..c8a415528 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 15c95b0b1..70edd7e7a 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index 09e419d59..8940d287b 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 f5dc2e012..9f64551f5 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 38f961049..276f60672 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -132,7 +132,10 @@ management/EmailProviderManager.js
* });
*
* @param {Function} [cb] Callback function.
- *
+ * @param {Object} [params] Clients parameters.
+ * @param {Number} [params.fields] A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
+ * @param {Number} [params.include_fields] true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(EmailProviderManager, 'get', 'resource.getAll');
@@ -195,7 +198,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index b926f4b92..1d5725300 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_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index fd969d25b..3afa11710 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 0b1a0388d..409665611 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -98,6 +98,19 @@ management/JobsManager.js
options.tokenProvider
);
this.jobs = new RetryRestClient(auth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for consuming the
+ * {@link https://auth0.com/docs/api/v2#!/Jobs/post_users_exports Create job to export users endpoint}
+ *
+ * @type {external:RestClient}
+ */
+ const usersExportsRestClient = new Auth0RestClient(
+ options.baseUrl + '/jobs/users-exports',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.usersExports = new RetryRestClient(usersExportsRestClient, options.retry);
};
/**
@@ -155,7 +168,7 @@ management/JobsManager.js
* send_completion_email: false //optional
* };
*
- * management.jobs.get(params, function (err) {
+ * management.jobs.importUsers(params, function (err) {
* if (err) {
* // Handle error.
* }
@@ -235,6 +248,63 @@ management/JobsManager.js
return promise;
};
+/**
+ * Export all users to a file using a long running job.
+ *
+ * @method exportUsers
+ * @memberOf module:management.JobsManager.prototype
+ *
+ * @example
+ * var data = {
+ * connection_id: 'con_0000000000000001',
+ * format: 'csv',
+ * limit: 5,
+ * fields: [
+ * {
+ * "name": "user_id"
+ * },
+ * {
+ * "name": "name"
+ * },
+ * {
+ * "name": "email"
+ * },
+ * {
+ * "name": "identities[0].connection",
+ * "export_as": "provider"
+ * },
+ * {
+ * "name": "user_metadata.some_field"
+ * }
+ * ]
+ * }
+ *
+ * management.jobs.exportUsers(data, function (err, results) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Retrieved job.
+ * console.log(results);
+ * });
+ *
+ * @param {Object} data Users export data.
+ * @param {String} [data.connection_id] The connection id of the connection from which users will be exported
+ * @param {String} [data.format] The format of the file. Valid values are: "json" and "csv".
+ * @param {Number} [data.limit] Limit the number of records.
+ * @param {Object[]} [data.fields] A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+JobsManager.prototype.exportUsers = function(data, cb) {
+ if (cb && cb instanceof Function) {
+ return this.usersExports.create(data, cb);
+ }
+
+ return this.usersExports.create(data);
+};
+
/**
* Send a verification email to a user.
*
@@ -284,7 +354,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 6c9f5b9ea..02b71be8d 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 2b5b18db8..61a6fa94b 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -189,7 +189,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index 3cfaa5da4..fafbb3aca 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_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index 18de21ac5..439658b62 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
@@ -179,7 +179,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 8f51c048f..93eae695b 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 aff6e68c8..6ef638d33 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 2a14fe60a..25f65f66b 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -161,7 +161,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index ce0b83bb6..03451ef26 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_UsersManager.js.html b/docs/management_UsersManager.js.html
index 76adaeaa4..e09e07ad9 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -677,7 +677,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index 9e4daa584..a94ca9567 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -599,8 +599,8 @@ management/index.js
/**
* Get all Auth0 Client Grants.
*
- * @method getAll
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method getClientGrants
+ * @memberOf module:management.ManagementClient.prototype
*
* @example <caption>
* This method takes an optional object as first argument that may be used to
@@ -630,8 +630,8 @@ management/index.js
/**
* Create an Auth0 client grant.
*
- * @method create
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method createClientGrant
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.clientGrants.create(data, function (err) {
@@ -652,8 +652,8 @@ management/index.js
/**
* Update an Auth0 client grant.
*
- * @method update
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method updateClientGrant
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* var data = {
@@ -683,8 +683,8 @@ management/index.js
/**
* Delete an Auth0 client grant.
*
- * @method delete
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method deleteClientGrant
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.clientGrants.delete({ id: GRANT_ID }, function (err) {
@@ -1430,7 +1430,10 @@ management/index.js
* });
*
* @param {Function} [cb] Callback function.
- *
+ * @param {Object} [params] Clients parameters.
+ * @param {Number} [params.fields] A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
+ * @param {Number} [params.include_fields] true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(ManagementClient, 'getEmailProvider', 'emailProvider.get');
@@ -1649,6 +1652,57 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'importUsers', 'jobs.importUsers');
+/**
+ * Export all users to a file using a long running job.
+ *
+ * @method exportUsers
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var data = {
+ * connection_id: 'con_0000000000000001',
+ * format: 'csv',
+ * limit: 5,
+ * fields: [
+ * {
+ * "name": "user_id"
+ * },
+ * {
+ * "name": "name"
+ * },
+ * {
+ * "name": "email"
+ * },
+ * {
+ * "name": "identities[0].connection",
+ * "export_as": "provider"
+ * },
+ * {
+ * "name": "user_metadata.some_field"
+ * }
+ * ]
+ * }
+ *
+ * management.exportUsers(data, function (err, results) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Retrieved job.
+ * console.log(results);
+ * });
+ *
+ * @param {Object} data Users export data.
+ * @param {String} [data.connection_id] The connection id of the connection from which users will be exported
+ * @param {String} [data.format] The format of the file. Valid values are: "json" and "csv".
+ * @param {Number} [data.limit] Limit the number of records.
+ * @param {Object[]} [data.fields] A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'exportUsers', 'jobs.exportUsers');
+
/**
* Send a verification email to a user.
*
@@ -1982,8 +2036,8 @@ management/index.js
/**
* Create an Auth0 Custom Domain.
*
- * @method create
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method createCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.createCustomDomain(data, function (err) {
@@ -2004,8 +2058,8 @@ management/index.js
/**
* Get all Auth0 CustomDomains.
*
- * @method getAll
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method getCustomDomains
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.getCustomDomains(function (err, customDomains) {
@@ -2019,8 +2073,8 @@ management/index.js
/**
* Get a Custom Domain.
*
- * @method get
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method getCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
@@ -2042,8 +2096,8 @@ management/index.js
/**
* Verify a Custom Domain.
*
- * @method verify
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method verifyCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
@@ -2065,8 +2119,8 @@ management/index.js
/**
* Delete a Custom Domain.
*
- * @method delete
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method deleteCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
@@ -2089,7 +2143,7 @@ management/index.js
* Create a Guardian enrollment ticket.
*
* @method createGuardianEnrollmentTicket
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.createGuardianEnrollmentTicket(function (err, ticket) {
@@ -2110,7 +2164,7 @@ management/index.js
* Get a list of Guardian factors and statuses.
*
* @method getGuardianFactors
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.getGuardianFactors(function (err, factors) {
* console.log(factors.length);
@@ -2126,7 +2180,7 @@ management/index.js
* Get Guardian factor provider configuration
*
* @method getGuardianFactorProvider
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
* console.log(provider);
@@ -2147,7 +2201,7 @@ management/index.js
* Update Guardian's factor provider
*
* @method updateFactorProvider
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
* messaging_service_sid: 'XXXXXXXXXXXXXX',
@@ -2173,7 +2227,7 @@ management/index.js
* Get Guardian enrollment and verification factor templates
*
* @method getGuardianFactorTemplates
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
* console.log(templates);
@@ -2194,7 +2248,7 @@ management/index.js
* Update Guardian enrollment and verification factor templates
*
* @method updateGuardianFactorTemplates
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.updateGuardianFactorTemplates({ name: 'sms' }, {
* enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
@@ -2219,7 +2273,7 @@ management/index.js
* Update Guardian Factor
*
* @method updateGuardianFactor
- * @memberOf module.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.updateGuardianFactor({ name: 'sms' }, {
* enabled: true
@@ -2248,7 +2302,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index fb612176b..3759ff8a2 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -3894,7 +3894,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index b7b29e7b2..64f95eedb 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1590,7 +1590,7 @@ Parameters:
-Stinrg
+String
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index 8697b3777..f161a65ee 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -101,7 +101,7 @@ Source:
Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 1a653544b..9aec2c527 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1796,7 +1796,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index e81cdc6c4..e20079a2c 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index 97a1daf27..c01be4808 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 1b625dd20..f35ae1e47 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 249e89209..cc295c8ec 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-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 0451d5674..094d54110 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.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index dee679a9a..a14a07f8c 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -717,1097 +717,14 @@ Example
- create(data, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Create an Auth0 client grant.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The client data object.
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.clientGrants.create(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Client grant created.
-});
-
-
-
-
-
-
-
-
-
-
- delete(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Delete an Auth0 client grant.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Client parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Client grant ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.clientGrants.delete({ id: GRANT_ID }, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Grant deleted.
-});
-
-
-
-
-
-
-
-
-
-
- delete(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Delete an Auth0 client grant.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Client parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Client grant ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.clientGrants.delete({ id: GRANT_ID }, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Grant deleted.
-});
-
-
-
-
-
-
-
-
-
-
- getAll(paramsopt, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get all Auth0 Client Grants.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Client Grants 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.getClientGrants(params, function (err, grants) {
- console.log(grants.length);
-});
-
-
-
-
-
-
-
-
-
-
- getAll(paramsopt, cbopt) → {Promise|undefined}
+ delete(params, cbopt) → {Promise|undefined}
- Get all Auth0 Client Grants.
+ Delete an Auth0 client grant.
@@ -1843,7 +760,7 @@ getAllSource:
Parameters:
- <optional>
-
@@ -1916,7 +831,7 @@ Parameters:
- Client Grants parameters.
+ Client parameters.
@@ -1930,8 +845,6 @@ Parameters:
Type
- Attributes
-
@@ -1944,70 +857,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ Client grant ID.
@@ -2102,21 +969,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.clientGrants.delete({ id: GRANT_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
-management.clientGrants.getAll(params, function (err, grants) {
- console.log(grants.length);
+ // Grant deleted.
});
@@ -2128,14 +986,14 @@ Example
- update(params, data, cbopt) → {Promise|undefined}
+ getAll(paramsopt, cbopt) → {Promise|undefined}
- Update an Auth0 client grant.
+ Get all Auth0 Client Grants.
@@ -2171,7 +1029,7 @@ updateSource:
Parameters:
+ <optional>
+
@@ -2242,7 +1102,7 @@ Parameters:
- Client parameters.
+ Client Grants parameters.
@@ -2256,6 +1116,8 @@ Parameters:
Type
+ Attributes
+
@@ -2268,32 +1130,34 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
-
+
-
- Client grant ID.
-
-
+
+
-
-
-
+
+
+ Number of results per page.
@@ -2302,13 +1166,13 @@ Parameters:
- datapage
-Object
+Number
@@ -2317,6 +1181,8 @@ Parameters:
+ <optional>
+
@@ -2327,7 +1193,15 @@ Parameters:
- Updated client data.
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
@@ -2414,19 +1288,21 @@ Returns:
Example
- var data = {
- client_id: CLIENT_ID,
- audience: AUDIENCE,
- scope: []
+
+ 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: CLIENT_GRANT_ID };
-management.clientGrants.update(params, data, function (err, grant) {
- if (err) {
- // Handle error.
- }
- console.log(grant.id);
+management.clientGrants.getAll(params, function (err, grants) {
+ console.log(grants.length);
});
@@ -2760,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 02612947b..0b77f92d1 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 7ebfbcc77..c6a8da76d 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 6c4def656..c61671616 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -792,224 +792,6 @@ Example
-
-
-
-
- create(data, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Create an Auth0 Custom Domain.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The custom domain data object.
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.createCustomDomain(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // CustomDomain created.
-});
-
-
-
-
-
-
@@ -1057,7 +839,7 @@ deleteSource:
Returns:
Example
- management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ management.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -1283,14 +1065,14 @@ Example
- delete(params, cbopt) → {Promise|undefined}
+ get(params, cbopt) → {Promise|undefined}
- Delete a Custom Domain.
+ Get a Custom Domain.
@@ -1326,7 +1108,7 @@ deleteSource:
Returns:
Example
- management.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ management.customDomains.get({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
if (err) {
// Handle error.
}
- // CustomDomain deleted.
+ console.log(customDomain);
});
@@ -1552,14 +1334,14 @@ Example
- get(params, cbopt) → {Promise|undefined}
+ getAll() → {Promise|undefined}
- Get a Custom Domain.
+ Get all Auth0 CustomDomains.
@@ -1595,7 +1377,7 @@ getSource:
get
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Custom Domain parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Custom Domain ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
- if (err) {
- // Handle error.
- }
-
- console.log(customDomain);
-});
-
-
-
-
-
-
-
-
-
-
- get(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get a Custom Domain.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Custom Domain parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Custom Domain ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.customDomains.get({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
- if (err) {
- // Handle error.
- }
-
- console.log(customDomain);
-});
-
-
-
-
-
-
-
-
-
-
- getAll() → {Promise|undefined}
-
-
-
-
-
-
- Get all Auth0 CustomDomains.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.getCustomDomains(function (err, customDomains) {
- console.log(customDomains.length);
-});
-
-
-
-
-
-
-
-
-
-
- getAll() → {Promise|undefined}
-
-
-
-
-
-
- Get all Auth0 CustomDomains.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.customDomains.getAll(function (err, customDomains) {
- console.log(customDomains.length);
-});
-
-
-
-
-
-
-
-
-
-
- verify(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Verify a Custom Domain.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Custom Domain parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Custom Domain ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
@@ -2574,12 +1437,8 @@ Returns:
Example
- management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
- if (err) {
- // Handle error.
- }
-
- console.log(customDomain);
+ management.customDomains.getAll(function (err, customDomains) {
+ console.log(customDomains.length);
});
@@ -2872,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index 01d6666b7..c87bb56fc 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 52441ed0a..530ab5dcb 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -759,7 +759,7 @@ deleteSource:
Example
- get(cbopt) → {Promise|undefined}
+ get(cbopt, paramsopt) → {Promise|undefined}
@@ -1022,6 +1022,141 @@ Parameters:
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Clients parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ fields
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
+
+
+
+
+
+
+
+
+ include_fields
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1123,7 +1258,7 @@ updateSource:
Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index 2495916b4..ecaea5ef5 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.GuardianManager.html b/docs/module-management.GuardianManager.html
index eff768fda..59e6fb9d8 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -894,186 +894,6 @@ Example
-
-
-
-
- createGuardianEnrollmentTicket(cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Create a Guardian enrollment ticket.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.createGuardianEnrollmentTicket(function (err, ticket) {
- console.log(ticket);
-});
-
-
-
-
-
-
@@ -1620,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index a17cf8ff0..a8d359bf4 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -391,6 +391,81 @@ (inner)
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner, constant) usersExportsRestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the
+Create job to export users endpoint
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
@@ -419,6 +494,420 @@ Methods
+
+
+
+
+ exportUsers(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Export all users to a file using a long running job.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Users export data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ connection_id
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The connection id of the connection from which users will be exported
+
+
+
+
+
+
+
+
+ format
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The format of the file. Valid values are: "json" and "csv".
+
+
+
+
+
+
+
+
+ limit
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Limit the number of records.
+
+
+
+
+
+
+
+
+ fields
+
+
+Array.<Object>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = {
+ connection_id: 'con_0000000000000001',
+ format: 'csv',
+ limit: 5,
+ fields: [
+ {
+ "name": "user_id"
+ },
+ {
+ "name": "name"
+ },
+ {
+ "name": "email"
+ },
+ {
+ "name": "identities[0].connection",
+ "export_as": "provider"
+ },
+ {
+ "name": "user_metadata.some_field"
+ }
+ ]
+}
+
+management.jobs.exportUsers(data, function (err, results) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Retrieved job.
+ console.log(results);
+});
+
+
+
+
+
+
@@ -466,7 +955,7 @@ getSource:
importUser
Source:
Example
send_completion_email: false //optional
};
-management.jobs.get(params, function (err) {
+management.jobs.importUsers(params, function (err) {
if (err) {
// Handle error.
}
@@ -1120,7 +1609,7 @@ verifyEmai
Source:
Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index a476b9d52..c022c6e50 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 bc804d928..843cb3828 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -2376,7 +2376,7 @@ Source:
Example
- createConnection(data, cbopt) → {Promise|undefined}
+ createClientGrant(data, cbopt) → {Promise|undefined}
- Create a new connection.
+ Create an Auth0 client grant.
@@ -2812,7 +2812,7 @@ creat
Source:
Parameters:
- Connection data object.
+ The client data object.
@@ -2970,12 +2970,12 @@ Returns:
Example
- management.createConnection(data, function (err) {
+ management.clientGrants.create(data, function (err) {
if (err) {
// Handle error.
}
- // Conection created.
+ // Client grant created.
});
@@ -2987,14 +2987,14 @@ Example
- createDevicePublicKey(data, cbopt) → {Promise|undefined}
+ createConnection(data, cbopt) → {Promise|undefined}
- Create an Auth0 credential.
+ Create a new connection.
@@ -3030,7 +3030,7 @@
Source:
Parameters:
- The device credential data object.
+ Connection data object.
@@ -3193,7 +3193,7 @@ Example
// Handle error.
}
- // Credential created.
+ // Conection created.
});
@@ -3205,14 +3205,14 @@ Example
- createEmailVerificationTicket(cbopt) → {Promise}
+ createCustomDomain(data, cbopt) → {Promise|undefined}
- Create an email verification ticket.
+ Create an Auth0 Custom Domain.
@@ -3248,7 +3248,7 @@ Source:
Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The custom domain data object.
+
+
+
+
+
+
cbReturns:
Promise
+|
+
+undefined
@@ -3369,15 +3406,12 @@ Returns:
Example
- var data = {
- user_id: '{USER_ID}',
- result_url: '{REDIRECT_URL}' // Optional redirect after the ticket is used.
-};
-
-auth0.createEmailVerificationTicket(data, function (err) {
+ management.createCustomDomain(data, function (err) {
if (err) {
// Handle error.
}
+
+ // CustomDomain created.
});
@@ -3389,14 +3423,14 @@ Example
- createPasswordChangeTicket(cbopt) → {Promise}
+ createDevicePublicKey(data, cbopt) → {Promise|undefined}
- Create a new password change ticket.
+ Create an Auth0 credential.
@@ -3432,7 +3466,7 @@ Source:
Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The device credential data object.
+
+
+
+
+
+
cbReturns:
Promise
+|
+
+undefined
@@ -3553,17 +3624,12 @@ Returns:
Example
- var params = {
- result_url: '{REDIRECT_URL}', // Redirect after using the ticket.
- user_id: '{USER_ID}', // Optional.
- email: '{USER_EMAIL}', // Optional.
- new_password: '{PASSWORD}'
-};
-
-auth0.createPasswordChangeTicket(params, function (err) {
+ management.createConnection(data, function (err) {
if (err) {
// Handle error.
}
+
+ // Credential created.
});
@@ -3575,14 +3641,14 @@ Example
- createResourceServer(data, cbopt) → {Promise|undefined}
+ createEmailVerificationTicket(cbopt) → {Promise}
- Create a new resource server.
+ Create an email verification ticket.
@@ -3618,7 +3684,7 @@ c
Source:
Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Resource Server data object.
-
-
-
-
-
-
cbReturns:
Promise
-|
-
-undefined
@@ -3776,12 +3805,15 @@ Returns:
Example
- management.createResourceServer(data, function (err) {
+ var data = {
+ user_id: '{USER_ID}',
+ result_url: '{REDIRECT_URL}' // Optional redirect after the ticket is used.
+};
+
+auth0.createEmailVerificationTicket(data, function (err) {
if (err) {
// Handle error.
}
-
- // Resource Server created.
});
@@ -3793,14 +3825,14 @@ Example
- createRule(data, cbopt) → {Promise|undefined}
+ createGuardianEnrollmentTicket(cbopt) → {Promise|undefined}
- Create a new rule.
+ Create a Guardian enrollment ticket.
@@ -3836,7 +3868,7 @@ createRule<
Source:
Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Rule data object.
-
-
-
-
-
-
cbReturns:
Example
- management.createRule(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Rule created.
+ management.createGuardianEnrollmentTicket(function (err, ticket) {
+ console.log(ticket);
});
@@ -4011,14 +4005,14 @@ Example
- createUser(data, cbopt) → {Promise|undefined}
+ createPasswordChangeTicket(cbopt) → {Promise}
- Create a new user.
+ Create a new password change ticket.
@@ -4054,7 +4048,7 @@ createUser<
Source:
Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- User data.
-
-
-
-
-
-
cbReturns:
Promise
-|
-
-undefined
@@ -4212,12 +4169,17 @@ Returns:
Example
- management.createUser(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // User created.
+ var params = {
+ result_url: '{REDIRECT_URL}', // Redirect after using the ticket.
+ user_id: '{USER_ID}', // Optional.
+ email: '{USER_EMAIL}', // Optional.
+ new_password: '{PASSWORD}'
+};
+
+auth0.createPasswordChangeTicket(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
});
@@ -4229,14 +4191,14 @@ Example
- deleteAllUsers(cbopt) → {Promise|undefined}
+ createResourceServer(data, cbopt) → {Promise|undefined}
- Delete all users.
+ Create a new resource server.
@@ -4260,8 +4222,6 @@ deleteA
- Deprecated: - This method will be removed in the next major release.
deleteA
Source:
Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Resource Server data object.
+
+
+
+
+
+
cbParameters:
- Callback function
+ Callback function.
@@ -4398,12 +4392,12 @@ Returns:
Example
- management.deleteAllUsers(function (err) {
+ management.createResourceServer(data, function (err) {
if (err) {
// Handle error.
}
- // Users deleted
+ // Resource Server created.
});
@@ -4415,14 +4409,14 @@ Example
- deleteClient(params, cbopt) → {Promise|undefined}
+ createRule(data, cbopt) → {Promise|undefined}
- Delete an Auth0 client.
+ Create a new rule.
@@ -4458,7 +4452,7 @@ deleteCli
Source:
Parameters:
- paramsdata
@@ -4529,58 +4523,7 @@ Parameters:
- Client parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- client_id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Application client ID.
-
-
-
-
-
-
-
-
+ Rule data object.
@@ -4667,12 +4610,12 @@ Returns:
Example
- management.deleteClient({ client_id: CLIENT_ID }, function (err) {
+ management.createRule(data, function (err) {
if (err) {
// Handle error.
}
- // Client deleted.
+ // Rule created.
});
@@ -4684,14 +4627,14 @@ Example
- deleteConnection(params, cbopt) → {Promise|undefined}
+ createUser(data, cbopt) → {Promise|undefined}
- Delete an existing connection.
+ Create a new user.
@@ -4727,7 +4670,7 @@ delet
Source:
Parameters:
- paramsdata
@@ -4798,58 +4741,7 @@ Parameters:
- Connection parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Connection ID.
-
-
-
-
-
-
-
-
+ User data.
@@ -4936,12 +4828,12 @@ Returns:
Example
- management.deleteConnection({ id: CONNECTION_ID }, function (err) {
+ management.createUser(data, function (err) {
if (err) {
// Handle error.
}
- // Conection deleted.
+ // User created.
});
@@ -4953,14 +4845,14 @@ Example
- deleteDeviceCredential(params, cbopt) → {Promise|undefined}
+ deleteAllUsers(cbopt) → {Promise|undefined}
- Delete an Auth0 device credential.
+ Delete all users.
@@ -4984,6 +4876,8 @@ Deprecated:- This method will be removed in the next major release.
Source:
Parameters:
- paramscb
-Object
+function
@@ -5057,6 +4951,8 @@ Parameters:
+ <optional>
+
@@ -5067,119 +4963,32 @@ Parameters:
- Credential parameters.
+ Callback function
-
-
-
-
-
-
- Name
-
+
+
- Type
+
+
+
-
-
- Description
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
- Device credential ID.
-
-
-
-
-
-
-
-
-
-
+
+Returns:
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
+
-
@@ -5205,14 +5014,12 @@
Returns:
Example
- var params = { id: CREDENTIAL_ID };
-
-management.deleteDeviceCredential(params, function (err) {
+ management.deleteAllUsers(function (err) {
if (err) {
// Handle error.
}
- // Credential deleted.
+ // Users deleted
});
@@ -5224,14 +5031,14 @@ Example
- deleteEmailProvider(cbopt) → {Promise|undefined}
+ deleteClient(params, cbopt) → {Promise|undefined}
- Delete email provider.
+ Delete an Auth0 client.
@@ -5267,7 +5074,7 @@ de
- Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Client parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Application client ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.deleteEmailProvider(function (err) {
+ management.deleteClient({ client_id: CLIENT_ID }, function (err) {
if (err) {
// Handle error.
}
- // Email provider deleted.
+ // Client deleted.
});
@@ -5408,14 +5300,14 @@ Example
- deleteGuardianEnrollment(data, cbopt) → {Promise|undefined}
+ deleteClientGrant(params, cbopt) → {Promise|undefined}
- Delete a user's Guardian enrollment.
+ Delete an Auth0 client grant.
@@ -5451,7 +5343,7 @@ Source:
Parameters:
- dataparams
@@ -5522,7 +5414,7 @@ Parameters:
- The Guardian enrollment data object.
+ Client parameters.
@@ -5565,7 +5457,7 @@ Parameters:
- The Guardian enrollment id.
+ Client grant ID.
@@ -5660,12 +5552,12 @@ Returns:
Example
- management.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err) {
+ management.clientGrants.delete({ id: GRANT_ID }, function (err) {
if (err) {
// Handle error.
}
- // Email provider deleted.
+ // Grant deleted.
});
@@ -5677,14 +5569,14 @@ Example
- deleteResourceServer(params, cbopt) → {Promise|undefined}
+ deleteConnection(params, cbopt) → {Promise|undefined}
- Delete an existing resource server.
+ Delete an existing connection.
@@ -5720,7 +5612,7 @@ d
- Source:
Parameters:
- Resource Server parameters.
+ Connection parameters.
@@ -5834,7 +5726,7 @@ Parameters:
- Resource Server ID.
+ Connection ID.
@@ -5929,12 +5821,12 @@ Returns:
Example
- management.deleteResourceServer({ id: RESOURCE_SERVER_ID }, function (err) {
+ management.deleteConnection({ id: CONNECTION_ID }, function (err) {
if (err) {
// Handle error.
}
- // Resource Server deleted.
+ // Conection deleted.
});
@@ -5946,14 +5838,14 @@ Example
- deleteRule(params, cbopt) → {Promise|undefined}
+ deleteCustomDomain(params, cbopt) → {Promise|undefined}
- Delete an existing rule.
+ Delete a Custom Domain.
@@ -5989,7 +5881,7 @@ deleteRule<
- Source:
Parameters:
- Rule parameters.
+ Custom Domain parameters.
@@ -6103,7 +5995,7 @@ Parameters:
- Rule ID.
+ Custom Domain ID.
@@ -6198,12 +6090,12 @@ Returns:
Example
- auth0.deleteRule({ id: RULE_ID }, function (err) {
+ management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
if (err) {
// Handle error.
}
- // Rule deleted.
+ // CustomDomain deleted.
});
@@ -6215,14 +6107,14 @@ Example
- deleteRulesConfig(params, cbopt) → {Promise|undefined}
+ deleteDeviceCredential(params, cbopt) → {Promise|undefined}
- Delete rules config.
+ Delete an Auth0 device credential.
@@ -6258,7 +6150,7 @@ dele
- Source:
Parameters:
- Rule Configs parameters.
+ Credential parameters.
@@ -6355,7 +6247,7 @@ Parameters:
- keyid
@@ -6372,7 +6264,7 @@ Parameters:
- Rule Configs key.
+ Device credential ID.
@@ -6467,12 +6359,14 @@ Returns:
Example
- management.deleteRulesConfig({ key: RULE_CONFIG_KEY }, function (err) {
+ var params = { id: CREDENTIAL_ID };
+
+management.deleteDeviceCredential(params, function (err) {
if (err) {
// Handle error.
}
- // Rules Config deleted.
+ // Credential deleted.
});
@@ -6484,14 +6378,14 @@ Example
- deleteUser(params, cbopt) → {Promise|undefined}
+ deleteEmailProvider(cbopt) → {Promise|undefined}
- Delete a user by its id.
+ Delete email provider.
@@ -6527,7 +6421,7 @@ deleteUser<
- Source:
Parameters:
- paramscb
-Object
+function
@@ -6588,6 +6482,8 @@ Parameters:
+ <optional>
+
@@ -6598,101 +6494,14 @@ Parameters:
- The user data object..
+ Callback function.
-
-
-
-
-
-
- Name
-
+
+
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- The user id.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function
-
-
-
-
-
-
-
+
+
+
@@ -6736,12 +6545,12 @@ Returns:
Example
- management.deleteUser({ id: USER_ID }, function (err) {
+ management.deleteEmailProvider(function (err) {
if (err) {
// Handle error.
}
- // User deleted.
+ // Email provider deleted.
});
@@ -6753,14 +6562,14 @@ Example
- deleteUserMultifactor(params, cbopt) → {Promise|undefined}
+ deleteGuardianEnrollment(data, cbopt) → {Promise|undefined}
- Delete a multifactor provider for a user.
+ Delete a user's Guardian enrollment.
@@ -6796,7 +6605,7 @@
Source:
Parameters:
- paramsdata
@@ -6867,7 +6676,7 @@ Parameters:
- Data object.
+ The Guardian enrollment data object.
@@ -6910,33 +6719,7 @@ Parameters:
- The user id.
-
-
-
-
-
-
-
-
- provider
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Multifactor provider.
+ The Guardian enrollment id.
@@ -6980,7 +6763,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -7031,14 +6814,12 @@ Returns:
Example
- var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-
-management.deleteUserMultifactor(params, function (err, user) {
+ management.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // Email provider deleted.
});
@@ -7050,14 +6831,14 @@ Example
- deleteUserMultifcator(params, cbopt) → {Promise|undefined}
+ deleteResourceServer(params, cbopt) → {Promise|undefined}
- Delete a multifactor provider for a user.
+ Delete an existing resource server.
@@ -7081,10 +6862,6 @@
- Deprecated: - The function name has a typo.
-We're shipping this so it doesn't break compatibility.
-Use
deleteUserMultifactor instead.
Source:
Parameters:
- Data object.
+ Resource Server parameters.
@@ -7211,33 +6988,7 @@ Parameters:
- The user id.
-
-
-
-
-
-
-
-
- provider
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Multifactor provider.
+ Resource Server ID.
@@ -7281,7 +7032,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -7332,14 +7083,12 @@ Returns:
Example
- var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-
-management.deleteUserMultifcator(params, function (err, user) {
+ management.deleteResourceServer({ id: RESOURCE_SERVER_ID }, function (err) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // Resource Server deleted.
});
@@ -7351,14 +7100,14 @@ Example
- getActiveUsersCount(cbopt) → {Promise|undefined}
+ deleteRule(params, cbopt) → {Promise|undefined}
- Get a the active users count.
+ Delete an existing rule.
@@ -7394,7 +7143,7 @@ ge
Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rule parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.getActiveUsersCount(function (err, usersCount) {
+ auth0.deleteRule({ id: RULE_ID }, function (err) {
if (err) {
// Handle error.
}
- console.log(usersCount);
+ // Rule deleted.
});
@@ -7535,14 +7369,14 @@ Example
- getBlacklistedTokens(cbopt) → {Promise|undefined}
+ deleteRulesConfig(params, cbopt) → {Promise|undefined}
- Get all blacklisted tokens.
+ Delete rules config.
@@ -7578,7 +7412,7 @@ g
Source:
Parameters:
- cbparams
-function
+Object
@@ -7639,8 +7473,6 @@ Parameters:
- <optional>
-
@@ -7651,7 +7483,94 @@ Parameters:
- Callback function.
+ Rule Configs parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule Configs key.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
@@ -7702,8 +7621,12 @@ Returns:
Example
- management.getBlacklistedTokens(function (err, tokens) {
- console.log(tokens.length);
+ management.deleteRulesConfig({ key: RULE_CONFIG_KEY }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Rules Config deleted.
});
@@ -7715,14 +7638,14 @@ Example
- getClient(params, cbopt) → {Promise|undefined}
+ deleteUser(params, cbopt) → {Promise|undefined}
- Get an Auth0 client.
+ Delete a user by its id.
@@ -7758,7 +7681,7 @@ getClientSource:
Parameters:
- Client parameters.
+ The user data object..
@@ -7855,7 +7778,7 @@ Parameters:
- client_idid
@@ -7872,7 +7795,7 @@ Parameters:
- Application client ID.
+ The user id.
@@ -7916,7 +7839,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -7967,12 +7890,12 @@ Returns:
Example
- management.getClient({ client_id: CLIENT_ID }, function (err, client) {
+ management.deleteUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
- console.log(client);
+ // User deleted.
});
@@ -7984,122 +7907,14 @@ Example
- getClientInfo() → {Object}
-
-
-
-
-
-
- Return an object with information about the current client,
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Object
-
-
-
-
-
-
-
- Object containing client information.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- getClients(paramsopt, cbopt) → {Promise|undefined}
+ deleteUserMultifactor(params, cbopt) → {Promise|undefined}
- Get all Auth0 clients.
+ Delete a multifactor provider for a user.
@@ -8135,7 +7950,7 @@ getClients<
Source:
Parameters:
- <optional>
-
@@ -8208,7 +8021,7 @@ Parameters:
- Clients parameters.
+ Data object.
@@ -8222,8 +8035,6 @@ Parameters:
Type
- Attributes
-
@@ -8236,34 +8047,24 @@ Parameters:
- per_pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Number of results per page.
+ The user id.
@@ -8272,34 +8073,24 @@ Parameters:
- pageprovider
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ Multifactor provider.
@@ -8343,7 +8134,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -8394,20 +8185,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, provider: MULTIFACTOR_PROVIDER };
-management.getClients(params, function (err, clients) {
- console.log(clients.length);
+management.deleteUserMultifactor(params, function (err, user) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Users accounts unlinked.
});
@@ -8419,14 +8204,14 @@ Example
- getConnection(params, cbopt) → {Promise|undefined}
+ deleteUserMultifcator(params, cbopt) → {Promise|undefined}
- Get an Auth0 connection.
+ Delete a multifactor provider for a user.
@@ -8450,6 +8235,10 @@ getConne
+ Deprecated: - The function name has a typo.
+We're shipping this so it doesn't break compatibility.
+Use
deleteUserMultifactor instead.
getConne
Source:
Parameters:
- Connection parameters.
+ Data object.
@@ -8576,7 +8365,33 @@ Parameters:
- Connection ID.
+ The user id.
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Multifactor provider.
@@ -8620,7 +8435,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -8671,12 +8486,14 @@ Returns:
Example
- management.getConnection({ id: CONNECTION_ID }, function (err, connection) {
+ var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
+
+management.deleteUserMultifcator(params, function (err, user) {
if (err) {
// Handle error.
}
- console.log(connection);
+ // Users accounts unlinked.
});
@@ -8688,14 +8505,14 @@ Example
- getConnections(paramsopt, cbopt) → {Promise|undefined}
+ exportUsers(data, cbopt) → {Promise|undefined}
- Get all connections.
+ Export all users to a file using a long running job.
@@ -8731,7 +8548,7 @@ getConn
Source:
Parameters:
- paramsdata
@@ -8792,8 +8609,6 @@ Parameters:
- <optional>
-
@@ -8804,7 +8619,7 @@ Parameters:
- Connections params.
+ Users export data.
@@ -8832,13 +8647,13 @@ Parameters:
- per_pageconnection_id
-Number
+String
@@ -8859,7 +8674,7 @@ Parameters:
- Number of results per page.
+ The connection id of the connection from which users will be exported
@@ -8868,7 +8683,43 @@ Parameters:
- pageformat
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The format of the file. Valid values are: "json" and "csv".
+
+
+
+
+
+
+
+
+ limit
@@ -8895,7 +8746,43 @@ Parameters:
- Page number, zero indexed.
+ Limit the number of records.
+
+
+
+
+
+
+
+
+ fields
+
+
+Array.<Object>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
@@ -8990,20 +8877,37 @@ 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 data = {
+ connection_id: 'con_0000000000000001',
+ format: 'csv',
+ limit: 5,
+ fields: [
+ {
+ "name": "user_id"
+ },
+ {
+ "name": "name"
+ },
+ {
+ "name": "email"
+ },
+ {
+ "name": "identities[0].connection",
+ "export_as": "provider"
+ },
+ {
+ "name": "user_metadata.some_field"
+ }
+ ]
+}
+
+management.exportUsers(data, function (err, results) {
+ if (err) {
+ // Handle error.
+ }
-management.getConnections(params, function (err, connections) {
- console.log(connections.length);
+ // Retrieved job.
+ console.log(results);
});
@@ -9015,14 +8919,14 @@ Example
- getDailyStats(params, cbopt) → {Promise|undefined}
+ getActiveUsersCount(cbopt) → {Promise|undefined}
- Get the daily stats.
+ Get a the active users count.
@@ -9058,7 +8962,7 @@ getDaily
Source:
Parameters:
- paramscb
-Object
+function
@@ -9119,6 +9023,8 @@ Parameters:
+ <optional>
+
@@ -9129,156 +9035,43 @@ Parameters:
- Stats parameters.
+ Callback function.
-
-
-
-
-
-
- Name
-
+
+
- Type
+
+
+
-
-
- Description
-
-
-
-
-
-
- from
-
-
-String
-
-
-
-
-
- The first day in YYYYMMDD format.
-
-
-
-
-
-
- to
-
-
-String
+
+Returns:
+
-
-
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
-
-
-
-
-
- The last day in YYYYMMDD format.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
+undefined
@@ -9293,17 +9086,12 @@ Returns:
Example
- var params = {
- from: '{YYYYMMDD}', // First day included in the stats.
- to: '{YYYYMMDD}' // Last day included in the stats.
-};
-
-management.getDaily(params, function (err, stats) {
+ management.getActiveUsersCount(function (err, usersCount) {
if (err) {
// Handle error.
}
- console.log(stats);
+ console.log(usersCount);
});
@@ -9315,14 +9103,14 @@ Example
- getDeviceCredentials(cbopt) → {Promise|undefined}
+ getBlacklistedTokens(cbopt) → {Promise|undefined}
- Get all Auth0 credentials.
+ Get all blacklisted tokens.
@@ -9358,7 +9146,7 @@ g
- Source:
Returns:
Example
- management.getDeviceCredentials(function (err, credentials) {
- console.log(credentials.length);
+ management.getBlacklistedTokens(function (err, tokens) {
+ console.log(tokens.length);
});
@@ -9495,14 +9283,14 @@ Example
- getEmailProvider(cbopt) → {Promise|undefined}
+ getClient(params, cbopt) → {Promise|undefined}
- Get the email provider.
+ Get an Auth0 client.
@@ -9538,7 +9326,7 @@ getEm
- Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Client parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Application client ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.getEmailProvider(function (err, provider) {
- console.log(provider.length);
+ management.getClient({ client_id: CLIENT_ID }, function (err, client) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(client);
});
@@ -9675,14 +9552,14 @@ Example
- getGuardianEnrollment(data, cbopt) → {Promise|undefined}
+ getClientGrants(paramsopt, cbopt) → {Promise|undefined}
- Get a single Guardian enrollment.
+ Get all Auth0 Client Grants.
@@ -9718,7 +9595,7 @@
- Source:
Parameters:
- dataparams
@@ -9779,6 +9656,8 @@ Parameters:
+ <optional>
+
@@ -9789,7 +9668,7 @@ Parameters:
- The Guardian enrollment data object.
+ Client Grants parameters.
@@ -9803,6 +9682,8 @@ Parameters:
Type
+ Attributes
+
@@ -9815,32 +9696,34 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
-
+
-
- The Guardian enrollment id.
-
-
+
+
-
-
-
+
+
+ Number of results per page.
@@ -9849,13 +9732,13 @@ Parameters:
- cbpage
-function
+Number
@@ -9876,7 +9759,7 @@ Parameters:
- Callback function.
+ Page number, zero indexed.
@@ -9885,6 +9768,53 @@ Parameters:
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
@@ -9895,9 +9825,6 @@ Parameters:
-
-
-
Returns:
@@ -9927,8 +9854,20 @@ Returns:
Example
- management.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
- console.log(enrollment);
+
+ 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.getClientGrants(params, function (err, grants) {
+ console.log(grants.length);
});
@@ -9940,14 +9879,14 @@ Example
- getGuardianEnrollments(data, cbopt) → {Promise|undefined}
+ getClientInfo() → {Object}
- Get a list of a user's Guardian enrollments.
+ Return an object with information about the current client,
@@ -9983,7 +9922,115 @@ Source:
Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Object
+
+
+
+
+
+
+
+ Object containing client information.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ getClients(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 clients.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ Parameters:
- dataparams
@@ -10044,6 +10091,8 @@ Parameters:
+ <optional>
+
@@ -10054,7 +10103,7 @@ Parameters:
- The user data object.
+ Clients parameters.
@@ -10068,6 +10117,8 @@ Parameters:
Type
+ Attributes
+
@@ -10080,24 +10131,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- The user id.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -10192,8 +10289,20 @@ Returns:
Example
- management.getGuardianEnrollments({ id: USER_ID }, function (err, enrollments) {
- console.log(enrollments);
+
+ 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.getClients(params, function (err, clients) {
+ console.log(clients.length);
});
@@ -10205,14 +10314,14 @@ Example
- getJob(params, cbopt) → {Promise|undefined}
+ getConnection(params, cbopt) → {Promise|undefined}
- Get a job by its ID.
+ Get an Auth0 connection.
@@ -10248,7 +10357,7 @@ getJobSource:
Parameters:
- Job parameters.
+ Connection parameters.
@@ -10362,7 +10471,7 @@ Parameters:
- Job ID.
+ Connection ID.
@@ -10457,17 +10566,12 @@ Returns:
Example
- var params = {
- id: '{JOB_ID}'
-};
-
-management.getJob(params, function (err, job) {
+ management.getConnection({ id: CONNECTION_ID }, function (err, connection) {
if (err) {
// Handle error.
}
- // Retrieved job.
- console.log(job);
+ console.log(connection);
});
@@ -10479,14 +10583,14 @@ Example
- getLog(params, cbopt) → {Promise|undefined}
+ getConnections(paramsopt, cbopt) → {Promise|undefined}
- Get an Auth0 log.
+ Get all connections.
@@ -10522,7 +10626,7 @@ getLogSource:
Parameters:
+ <optional>
+
@@ -10593,7 +10699,7 @@ Parameters:
- Log parameters.
+ Connections params.
@@ -10607,6 +10713,8 @@ Parameters:
Type
+ Attributes
+
@@ -10619,24 +10727,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- Event ID.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -10731,12 +10885,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.getConnections(params, function (err, connections) {
+ console.log(connections.length);
});
@@ -10748,14 +10910,14 @@ Example
- getLogs(paramsopt, cbopt) → {Promise|undefined}
+ getCustomDomain(params, cbopt) → {Promise|undefined}
- Get all logs.
+ Get a Custom Domain.
@@ -10791,7 +10953,7 @@ getLogsSource:
Parameters:
- <optional>
-
@@ -10864,7 +11024,7 @@ Parameters:
- Logs params.
+ Custom Domain parameters.
@@ -10878,8 +11038,6 @@ Parameters:
Type
- Attributes
-
@@ -10892,7 +11050,7 @@ Parameters:
- qid
@@ -10905,21 +11063,19 @@ Parameters:
-
-
- <optional>
-
-
+
+
+ Custom Domain ID.
-
-
+
+
-
+
+
+
-
- Search Criteria using Query String Syntax
@@ -10928,13 +11084,13 @@ Parameters:
- pagecb
-Number
+function
@@ -10955,238 +11111,134 @@ Parameters:
- Page number. Zero based
+ Callback function.
+
+
-
-
- per_page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- The amount of entries per page
-
-
-
-
-
-
- sort
-
-
-String
-
-
+
+Returns:
-
-
-
- <optional>
-
+
-
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
-
-
-
+undefined
-
-
- The field to use for sorting.
-
-
-
+
+
+
+
-
-
- fields
-
-
-String
+
+Example
-
-
+ management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ if (err) {
+ // Handle error.
+ }
-
-
-
- <optional>
-
+ console.log(customDomain);
+});
-
+
-
-
+
+
+
-
+
-
- A comma separated list of fields to include or exclude
-
-
-
+ getCustomDomains() → {Promise|undefined}
-
-
- include_fields
-
-
-Boolean
+
+ Get all Auth0 CustomDomains.
+
-
-
-
-
-
- <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
-
-
-
+
-
-
-
-
-
+
+
+ Source:
+
-
- cb
-
-
-function
+
+
+
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
@@ -11230,20 +11282,8 @@ 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
-};
-
-management.getLogs(params, function (err, logs) {
- console.log(logs.length);
+ management.getCustomDomains(function (err, customDomains) {
+ console.log(customDomains.length);
});
@@ -11255,14 +11295,14 @@ Example
- getResourceServer(params, cbopt) → {Promise|undefined}
+ getDailyStats(params, cbopt) → {Promise|undefined}
- Get a Resource Server.
+ Get the daily stats.
@@ -11298,7 +11338,7 @@ getR
Source:
Parameters:
- Resource Server parameters.
+ Stats parameters.
@@ -11395,7 +11435,7 @@ Parameters:
- idfrom
@@ -11412,7 +11452,33 @@ Parameters:
- Resource Server ID.
+ The first day in YYYYMMDD format.
+
+
+
+
+
+
+
+
+ to
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The last day in YYYYMMDD format.
@@ -11507,12 +11573,17 @@ Returns:
Example
- management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+ var params = {
+ from: '{YYYYMMDD}', // First day included in the stats.
+ to: '{YYYYMMDD}' // Last day included in the stats.
+};
+
+management.getDaily(params, function (err, stats) {
if (err) {
// Handle error.
}
- console.log(resourceServer);
+ console.log(stats);
});
@@ -11524,14 +11595,14 @@ Example
- getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+ getDeviceCredentials(cbopt) → {Promise|undefined}
- Get all resource servers.
+ Get all Auth0 credentials.
@@ -11567,7 +11638,7 @@ get
Source:
Parameters:
- paramscb
-Object
+function
@@ -11640,226 +11711,79 @@ Parameters:
- Resource Servers parameters.
+ Callback function.
-
+
+
-
-
-
-
- Name
-
+
+
+
- Type
-
- Attributes
-
-
- Description
-
-
-
-
-
-
- per_page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
+
+Returns:
-
+
-
-
- page
+ -
+ Type:
+
+ -
+
+
Promise
+|
-
-
-
-Number
+undefined
-
-
+
+
-
-
-
- <optional>
-
-
+
+
-
-
-
-
-
- Page number, zero indexed.
-
-
-
+
+Example
+
+ management.getDeviceCredentials(function (err, credentials) {
+ console.log(credentials.length);
+});
+
+
+
+
+
+
+
-
-
-
-
-
+ getEmailProvider(cbopt, paramsopt) → {Promise|undefined}
-
-
- 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);
-});
-
-
-
-
-
-
-
-
-
-
- getRule(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get an Auth0 rule.
-
+
+ Get the email provider.
+
@@ -11894,7 +11818,7 @@ getRuleSource:
Parameters:
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
paramsParameters:
+ <optional>
+
@@ -11965,7 +11927,7 @@ Parameters:
- Rule parameters.
+ Clients parameters.
@@ -11979,6 +11941,8 @@ Parameters:
Type
+ Attributes
+
@@ -11991,32 +11955,34 @@ Parameters:
- idfields
-String
+Number
+
+
+ <optional>
+
-
+
-
- Rule ID.
-
-
+
+
-
-
-
+
+
+ A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
@@ -12025,13 +11991,13 @@ Parameters:
- cbinclude_fields
-function
+Number
@@ -12052,7 +12018,15 @@ Parameters:
- Callback function.
+ true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
+
+
+
+
+
+
+
@@ -12103,12 +12077,8 @@ Returns:
Example
- management.getRule({ id: RULE_ID }, function (err, rule) {
- if (err) {
- // Handle error.
- }
-
- console.log(rule);
+ management.getEmailProvider(function (err, provider) {
+ console.log(provider.length);
});
@@ -12120,14 +12090,14 @@ Example
- getRules(paramsopt, cbopt) → {Promise|undefined}
+ getGuardianEnrollment(data, cbopt) → {Promise|undefined}
- Get all rules.
+ Get a single Guardian enrollment.
@@ -12163,7 +12133,7 @@ getRulesSource:
Parameters:
- paramsdata
@@ -12224,8 +12194,6 @@ Parameters:
- <optional>
-
@@ -12236,7 +12204,7 @@ Parameters:
- Rules parameters.
+ The Guardian enrollment data object.
@@ -12250,8 +12218,6 @@ Parameters:
Type
- Attributes
-
@@ -12264,70 +12230,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ The Guardian enrollment id.
@@ -12422,20 +12342,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 = {
- per_page: 10,
- page: 0
-};
-
-management.getRules(params, function (err, rules) {
- console.log(rules.length);
+ management.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ console.log(enrollment);
});
@@ -12447,14 +12355,14 @@ Example
- getRulesConfigs() → {Promise|undefined}
+ getGuardianEnrollments(data, cbopt) → {Promise|undefined}
- Get rules config.
+ Get a list of a user's Guardian enrollments.
@@ -12490,7 +12398,7 @@ getRul
Source:
getRul
+ Parameters:
+
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
+
+
+
-
-
- -
- Type:
-
- -
+
Name
-Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.getRulesConfigs(function (err, rulesConfigs) {
- if (err) {
- // Handle error.
- }
-
- // Get Rules Configs.
-});
-
+ Type
-
-
-
-
-
-
- getTenantSettings(cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get the tenant settings..
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
- Attributes
+
-
+
-
+ Description
+
+
+
-
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
- Parameters:
-
+
+ The user data object.
+
+
@@ -12642,8 +12483,6 @@ Parameters:
Type
- Attributes
-
@@ -12654,6 +12493,40 @@ Parameters:
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.getSettings(function (err, settings) {
- if (err) {
- // Handle error.
- }
-
- console.log(settings);
+ management.getGuardianEnrollments({ id: USER_ID }, function (err, enrollments) {
+ console.log(enrollments);
});
@@ -12751,14 +12620,14 @@ Example
- getUser(data, cbopt) → {Promise|undefined}
+ getJob(params, cbopt) → {Promise|undefined}
- Get a user by its id.
+ Get a job by its ID.
@@ -12794,7 +12663,7 @@ getUserSource:
Parameters:
- dataparams
@@ -12865,7 +12734,7 @@ Parameters:
- The user data object.
+ Job parameters.
@@ -12908,7 +12777,7 @@ Parameters:
- The user id.
+ Job ID.
@@ -13003,8 +12872,17 @@ Returns:
Example
- management.getUser({ id: USER_ID }, function (err, user) {
- console.log(user);
+ var params = {
+ id: '{JOB_ID}'
+};
+
+management.getJob(params, function (err, job) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Retrieved job.
+ console.log(job);
});
@@ -13016,14 +12894,14 @@ Example
- getUserLogs(params, cbopt) → {Promise|undefined}
+ getLog(params, cbopt) → {Promise|undefined}
- Get user's log events.
+ Get an Auth0 log.
@@ -13059,7 +12937,7 @@ getUserLog
Source:
Parameters:
- Get logs data.
+ Log parameters.
@@ -13173,7 +13051,15 @@ Parameters:
- User id.
+ Event ID.
+
+
+
+
+
+
+
+
@@ -13182,24 +13068,2952 @@ Parameters:
- per_pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Number of results per page.
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getLog({ id: EVENT_ID }, function (err, log) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(log);
+});
+
+
+
+
+
+
+
+
+
+
+ getLogs(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all logs.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Logs params.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ q
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Search Criteria using Query String Syntax
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number. Zero based
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The amount of entries per page
+
+
+
+
+
+
+
+
+ sort
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The field to use for sorting.
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 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);
+});
+
+
+
+
+
+
+
+
+
+
+ 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);
+});
+
+
+
+
+
+
+
+
+
+
+ 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() → {Promise|undefined}
+
+
+
+
+
+
+ Get rules config.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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..
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getSettings(function (err, settings) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(settings);
+});
+
+
+
+
+
+
+
+
+
+
+ getUser(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a user by its id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - 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.getUser({ id: USER_ID }, function (err, user) {
+ console.log(user);
+});
+
+
+
+
+
+
+
+
+
+
+ getUserLogs(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get user's log events.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Get logs data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ User id.
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ sort
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+
+management.getUserLogs(params, function (err, logs) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logs);
+});
+
+
+
+
+
+
+
+
+
+
+ getUsers(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all users.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Users params.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ search_engine
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The version of the search engine to use.
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
@@ -13217,24 +16031,235 @@ Parameters:
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 = {
+ search_engine: 'v3',
+ per_page: 10,
+ page: 0
+};
+
+auth0.getUsers(params, function (err, users) {
+ console.log(users.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get users for a given email address
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
-
+
+ Attributes
+
-
+
-
- Page number, zero indexed.
-
-
-
+ Description
+
+
+
- sortemail
@@ -13247,45 +16272,21 @@ Parameters:
-
-
-
-
- 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
-
+ <optional>
-Boolean
+
-
-
-
+
+
- true if a query summary must be included in the result, false otherwise. Default false;
-
-
-
-
-
-
-
-
+ Email Address of users to locate
@@ -13372,14 +16373,13 @@ Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-
-management.getUserLogs(params, function (err, logs) {
- if (err) {
- // Handle error.
- }
-
- console.log(logs);
+
+ 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);
});
@@ -13391,14 +16391,15 @@ Example
- getUsers(paramsopt, cbopt) → {Promise|undefined}
+ importUsers(data, cbopt) → {Promise|undefined}
- Get all users.
+ Given a path to a file and a connection id, create a new job that imports the
+users contained in the file and associate them with the given connection.
@@ -13434,7 +16435,7 @@ getUsersSource:
Parameters:
- paramsdata
@@ -13495,8 +16496,6 @@ Parameters:
- <optional>
-
@@ -13507,7 +16506,7 @@ Parameters:
- Users params.
+ Users import data.
@@ -13521,8 +16520,6 @@ Parameters:
Type
- Attributes
-
@@ -13535,70 +16532,24 @@ Parameters:
- search_engine
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The version of the search engine to use.
-
-
-
-
-
-
-
-
- per_pageconnectionId
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Number of results per page.
+ Connection for the users insertion.
@@ -13607,34 +16558,24 @@ Parameters:
- pageusers
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ Path to the users data file.
@@ -13729,21 +16670,15 @@ 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',
- per_page: 10,
- page: 0
+ var params = {
+ connection_id: '{CONNECTION_ID}',
+ users: '{PATH_TO_USERS_FILE}'
};
-auth0.getUsers(params, function (err, users) {
- console.log(users.length);
+management.get(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
});
@@ -13755,14 +16690,14 @@ Example
- getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+ linkUsers(userId, params, cbopt) → {Promise|undefined}
- Get users for a given email address
+ Link the user with another account.
@@ -13798,7 +16733,7 @@ getUse
Source:
getUse
- Parameters:
-
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ userId
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ID of the primary user.
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Secondary user data.
+
+
@@ -13830,8 +16852,6 @@ Parameters:
Type
- Attributes
-
@@ -13844,7 +16864,7 @@ Parameters:
- emailuser_id
@@ -13857,21 +16877,45 @@ Parameters:
-
-
- <optional>
-
+
+
+
+ ID of the user to be linked.
+
+
+
+
+
+
+
+ connection_id
+
-
+String
+
+
+
+
+
- Email Address of users to locate
+ ID of the connection to be used.
+
+
+
+
+
+
+
+
@@ -13958,13 +17002,18 @@ 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 userId = 'USER_ID';
+var params = {
+ user_id: 'OTHER_USER_ID',
+ connection_id: 'CONNECTION_ID'
+};
+
+management.linkUsers(userId, params, function (err, user) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Users linked.
});
@@ -13976,15 +17025,14 @@ Example
- importUsers(data, cbopt) → {Promise|undefined}
+ regenerateRecoveryCode(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 and associate them with the given connection.
+ Generate new Guardian recovery code.
@@ -14020,7 +17068,7 @@ importUser
Source:
Parameters:
- Users import data.
+ The user data object.
@@ -14117,33 +17165,7 @@ Parameters:
- connectionId
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Connection for the users insertion.
-
-
-
-
-
-
-
-
- usersid
@@ -14160,7 +17182,7 @@ Parameters:
- Path to the users data file.
+ The user id.
@@ -14255,15 +17277,8 @@ Returns:
Example
- var params = {
- connection_id: '{CONNECTION_ID}',
- users: '{PATH_TO_USERS_FILE}'
-};
-
-management.get(params, function (err) {
- if (err) {
- // Handle error.
- }
+ management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
+ console.log(newRecoveryCode);
});
@@ -14275,14 +17290,14 @@ Example
- linkUsers(userId, params, cbopt) → {Promise|undefined}
+ sendEmailVerification(data, cbopt) → {Promise|undefined}
- Link the user with another account.
+ Send a verification email to a user.
@@ -14318,7 +17333,7 @@ linkUsersSource:
Parameters:
- userId
-
-
-String
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ID of the primary user.
-
-
-
-
-
-
-
-
- paramsdata
@@ -14423,7 +17404,7 @@ Parameters:
- Secondary user data.
+ User data object.
@@ -14466,33 +17447,7 @@ Parameters:
- ID of the user to be linked.
-
-
-
-
-
-
-
-
- connection_id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- ID of the connection to be used.
+ ID of the user to be verified.
@@ -14587,18 +17542,14 @@ Returns:
Example
- var userId = 'USER_ID';
-var params = {
- user_id: 'OTHER_USER_ID',
- connection_id: 'CONNECTION_ID'
+ var params = {
+ user_id: '{USER_ID}'
};
-management.linkUsers(userId, params, function (err, user) {
+management.sendEmailVerification(function (err) {
if (err) {
// Handle error.
}
-
- // Users linked.
});
@@ -14610,14 +17561,14 @@ Example
- regenerateRecoveryCode(data, cbopt) → {Promise|undefined}
+ setRulesConfig(params, data, cbopt) → {Promise|undefined}
- Generate new Guardian recovery code.
+ Set a new rules config.
@@ -14653,7 +17604,7 @@ Source:
Parameters:
-
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rule Config parameters.
+
+
@@ -14685,8 +17689,6 @@ Parameters:
Type
- Attributes
-
@@ -14697,6 +17699,40 @@ Parameters:
+
+
+ key
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule Config key.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
dataParameters:
- The user data object.
+ Rule Config Data parameters.
@@ -14750,7 +17786,7 @@ Parameters:
- idvalue
@@ -14767,7 +17803,7 @@ Parameters:
- The user id.
+ Rule Config Data value.
@@ -14862,8 +17898,15 @@ Returns:
Example
- management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
- console.log(newRecoveryCode);
+ var params = { key: RULE_CONFIG_KEY };
+var data = { value: RULES_CONFIG_VALUE };
+
+management.setRulesConfig(params, data, function (err, rulesConfig) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Rules Config set.
});
@@ -14875,14 +17918,14 @@ Example
- sendEmailVerification(data, cbopt) → {Promise|undefined}
+ unlinkUsers(params, cbopt) → {Promise|undefined}
- Send a verification email to a user.
+ Unlink the given accounts.
@@ -14918,7 +17961,7 @@
Source:
Parameters:
- dataparams
@@ -14989,7 +18032,7 @@ Parameters:
- User data object.
+ Linked users data.
@@ -15013,6 +18056,58 @@ Parameters:
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Primary user ID.
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Identity provider in use.
+
+
+
+
+
+
user_idParameters:
- ID of the user to be verified.
+ Secondary user ID.
@@ -15127,14 +18222,14 @@ Returns:
Example
- var params = {
- user_id: '{USER_ID}'
-};
+ var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
-management.sendEmailVerification(function (err) {
+management.unlinkUsers(params, function (err, user) {
if (err) {
// Handle error.
}
+
+ // Users accounts unlinked.
});
@@ -15146,14 +18241,14 @@ Example
- setRulesConfig(params, data, cbopt) → {Promise|undefined}
+ updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
- Set a new rules config.
+ Update the app metadata for a user.
@@ -15189,7 +18284,7 @@ setRule
Source:
Parameters:
- Rule Config parameters.
+ The user data object..
@@ -15286,7 +18381,7 @@ Parameters:
- keyid
@@ -15303,7 +18398,7 @@ Parameters:
- Rule Config key.
+ The user id.
@@ -15320,7 +18415,7 @@ Parameters:
- datametadata
@@ -15345,58 +18440,7 @@ Parameters:
- Rule Config Data parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- value
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Rule Config Data value.
-
-
-
-
-
-
-
-
+ New app metadata.
@@ -15432,7 +18476,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -15483,15 +18527,18 @@ Returns:
Example
- var params = { key: RULE_CONFIG_KEY };
-var data = { value: RULES_CONFIG_VALUE };
+ var params = { id: USER_ID };
+var metadata = {
+ foo: 'bar'
+};
-management.setRulesConfig(params, data, function (err, rulesConfig) {
+management.updateAppMetadata(params, metadata, function (err, user) {
if (err) {
// Handle error.
}
- // Rules Config set.
+ // Updated user.
+ console.log(user);
});
@@ -15503,14 +18550,14 @@ Example
- unlinkUsers(params, cbopt) → {Promise|undefined}
+ updateClient(params, data, cbopt) → {Promise|undefined}
- Unlink the given accounts.
+ Update an Auth0 client.
@@ -15546,7 +18593,7 @@ unlinkUser
Source:
Parameters:
- Linked users data.
+ Client parameters.
@@ -15643,7 +18690,7 @@ Parameters:
- idclient_id
@@ -15660,33 +18707,15 @@ Parameters:
- Primary user ID.
+ Application client ID.
+
+
-
-
- provider
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Identity provider in use.
@@ -15695,32 +18724,32 @@ Parameters:
- user_iddata
-String
+Object
+
+
+
+
+
+
+
+
- Secondary user ID.
-
-
-
-
-
-
-
-
+ Updated client data.
@@ -15807,14 +18836,15 @@ Returns:
Example
- var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
+ var data = { name: 'newClientName' };
+var params = { client_id: CLIENT_ID };
-management.unlinkUsers(params, function (err, user) {
+management.updateClient(params, data, function (err, client) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ console.log(client.name); // 'newClientName'
});
@@ -15826,14 +18856,14 @@ Example
- updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
+ updateClientGrant(params, data, cbopt) → {Promise|undefined}
- Update the app metadata for a user.
+ Update an Auth0 client grant.
@@ -15869,7 +18899,7 @@ upda
Source:
Parameters:
- The user data object..
+ Client parameters.
@@ -15983,7 +19013,7 @@ Parameters:
- The user id.
+ Client grant ID.
@@ -16000,7 +19030,7 @@ Parameters:
- metadatadata
@@ -16025,7 +19055,7 @@ Parameters:
- New app metadata.
+ Updated client data.
@@ -16061,7 +19091,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -16112,18 +19142,19 @@ Returns:
Example
- var params = { id: USER_ID };
-var metadata = {
- foo: 'bar'
+ var data = {
+ client_id: CLIENT_ID,
+ audience: AUDIENCE,
+ scope: []
};
+var params = { id: CLIENT_GRANT_ID };
-management.updateAppMetadata(params, metadata, function (err, user) {
+management.clientGrants.update(params, data, function (err, grant) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+ console.log(grant.id);
});
@@ -16135,14 +19166,14 @@ Example
- updateClient(params, data, cbopt) → {Promise|undefined}
+ updateConnection(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client.
+ Update an existing connection.
@@ -16178,7 +19209,7 @@ updateCli
Source:
Parameters:
- Client parameters.
+ Connection parameters.
@@ -16275,7 +19306,7 @@ Parameters:
- client_idid
@@ -16292,7 +19323,7 @@ Parameters:
- Application client ID.
+ Connection ID.
@@ -16334,7 +19365,7 @@ Parameters:
- Updated client data.
+ Updated connection data.
@@ -16421,15 +19452,15 @@ Returns:
Example
- var data = { name: 'newClientName' };
-var params = { client_id: CLIENT_ID };
+ var data = { name: 'newConnectionName' };
+var params = { id: CONNECTION_ID };
-management.updateClient(params, data, function (err, client) {
+management.updateConnection(params, data, function (err, connection) {
if (err) {
// Handle error.
}
- console.log(client.name); // 'newClientName'
+ console.log(connection.name); // 'newConnectionName'
});
@@ -16441,14 +19472,14 @@ Example
- updateConnection(params, data, cbopt) → {Promise|undefined}
+ updateEmailProvider(params, data, cbopt) → {Promise|undefined}
- Update an existing connection.
+ Update the email provider.
@@ -16484,7 +19515,7 @@ updat
Source:
Parameters:
- Connection parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Connection ID.
-
-
-
-
-
-
-
-
+ Email provider parameters.
@@ -16640,7 +19620,7 @@ Parameters:
- Updated connection data.
+ Updated email provider data.
@@ -16727,15 +19707,13 @@ Returns:
Example
- var data = { name: 'newConnectionName' };
-var params = { id: CONNECTION_ID };
-
-management.updateConnection(params, data, function (err, connection) {
+ management.updateEmailProvider(params, data, function (err, provider) {
if (err) {
// Handle error.
}
- console.log(connection.name); // 'newConnectionName'
+ // Updated email provider.
+ console.log(provider);
});
@@ -16747,14 +19725,14 @@ Example
- updateEmailProvider(params, data, cbopt) → {Promise|undefined}
+ updateResourceServer(params, data, cbopt) → {Promise|undefined}
- Update the email provider.
+ Update an existing resource server.
@@ -16790,7 +19768,7 @@ up
Source:
Parameters:
- Email provider parameters.
+ Resource Server parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Resource Server ID.
+
+
+
+
+
+
+
+
@@ -16895,7 +19924,7 @@ Parameters:
- Updated email provider data.
+ Updated Resource Server data.
@@ -16982,13 +20011,15 @@ Returns:
Example
- management.updateEmailProvider(params, data, function (err, provider) {
+ var data = { name: 'newResourceServerName' };
+var params = { id: RESOURCE_SERVER_ID };
+
+management.updateResourceServer(params, data, function (err, resourceServer) {
if (err) {
// Handle error.
}
- // Updated email provider.
- console.log(provider);
+ console.log(resourceServer.name); // 'newResourceServerName'
});
@@ -17000,14 +20031,14 @@ Example
- updateResourceServer(params, data, cbopt) → {Promise|undefined}
+ updateRule(params, data, cbopt) → {Promise|undefined}
- Update an existing resource server.
+ Update an existing rule.
@@ -17043,7 +20074,7 @@ u
Source:
Parameters:
- Resource Server parameters.
+ Rule parameters.
@@ -17157,7 +20188,7 @@ Parameters:
- Resource Server ID.
+ Rule ID.
@@ -17199,7 +20230,7 @@ Parameters:
- Updated Resource Server data.
+ Updated rule data.
@@ -17286,15 +20317,14 @@ Returns:
Example
- var data = { name: 'newResourceServerName' };
-var params = { id: RESOURCE_SERVER_ID };
-
-management.updateResourceServer(params, data, function (err, resourceServer) {
+ var params = { id: RULE_ID };
+var data = { name: 'my-rule'};
+management.updateRule(params, data, function (err, rule) {
if (err) {
// Handle error.
}
- console.log(resourceServer.name); // 'newResourceServerName'
+ console.log(rule.name); // 'my-rule'.
});
@@ -17306,14 +20336,14 @@ Example
- updateRule(params, data, cbopt) → {Promise|undefined}
+ updateTenantSettings(data, cbopt) → {Promise|undefined}
- Update an existing rule.
+ Update the tenant settings.
@@ -17340,89 +20370,36 @@ updateRule<
-
-
-
-
-
-
-
- Source:
- Parameters:
-
-
-
-
-
-
- Name
-
+
- Type
+
-
- Attributes
-
+
-
+
+ Source:
+ Description
-
-
+
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
- Rule parameters.
-
-
+
+ Parameters:
+
@@ -17434,6 +20411,8 @@ Parameters:
Type
+ Attributes
+
@@ -17444,40 +20423,6 @@ Parameters:
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Rule ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
dataParameters:
- Updated rule data.
+ The new tenant settings.
@@ -17592,14 +20537,10 @@ Returns:
Example
- var params = { id: RULE_ID };
-var data = { name: 'my-rule'};
-management.updateRule(params, data, function (err, rule) {
+ management.updateTenantSettings(data, function (err) {
if (err) {
// Handle error.
}
-
- console.log(rule.name); // 'my-rule'.
});
@@ -17611,14 +20552,14 @@ Example
- updateTenantSettings(data, cbopt) → {Promise|undefined}
+ updateUser(params, data, cbopt) → {Promise|undefined}
- Update the tenant settings.
+ Update a user by its id.
@@ -17654,7 +20595,7 @@ u
Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The user parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
dataParameters:
- The new tenant settings.
+ New user data.
@@ -17761,7 +20787,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -17812,10 +20838,15 @@ Returns:
Example
- management.updateTenantSettings(data, function (err) {
+ var params = { id: USER_ID };
+
+management.updateUser(params, data, function (err, user) {
if (err) {
// Handle error.
}
+
+ // Updated user.
+ console.log(user);
});
@@ -17827,14 +20858,14 @@ Example
- updateUser(params, data, cbopt) → {Promise|undefined}
+ updateUserMetadata(params, metadata, cbopt) → {Promise|undefined}
- Update a user by its id.
+ Update the user metadata for a user.
@@ -17870,7 +20901,7 @@ updateUser<
Source:
Parameters:
- The user parameters.
+ The user data object..
@@ -18001,7 +21032,7 @@ Parameters:
- datametadata
@@ -18026,7 +21057,7 @@ Parameters:
- New user data.
+ New user metadata.
@@ -18114,8 +21145,11 @@ Returns:
Example
var params = { id: USER_ID };
+var metadata = {
+ address: '123th Node.js Street'
+};
-management.updateUser(params, data, function (err, user) {
+management.updateUserMetadata(params, metadata, function (err, user) {
if (err) {
// Handle error.
}
@@ -18133,14 +21167,14 @@ Example
- updateUserMetadata(params, metadata, cbopt) → {Promise|undefined}
+ verifyCustomDomain(params, cbopt) → {Promise|undefined}
- Update the user metadata for a user.
+ Verify a Custom Domain.
@@ -18176,7 +21210,7 @@ upd
Source:
Parameters:
- The user data object..
+ Custom Domain parameters.
@@ -18290,7 +21324,7 @@ Parameters:
- The user id.
+ Custom Domain ID.
@@ -18305,40 +21339,6 @@ Parameters:
-
-
- metadata
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- New user metadata.
-
-
-
-
-
-
cbParameters:
- Callback function
+ Callback function.
@@ -18419,18 +21419,12 @@ Returns:
Example
- var params = { id: USER_ID };
-var metadata = {
- address: '123th Node.js Street'
-};
-
-management.updateUserMetadata(params, metadata, function (err, user) {
+ management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+ console.log(customDomain);
});
@@ -18454,7 +21448,7 @@ Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 98a360c74..ff9ee87b1 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.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 0c021904e..506dcf254 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 482cb0539..7088c566b 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.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 4a371256c..502ae2f83 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 c81f2d396..b7640c53a 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 d73bbea41..ce9e4385a 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 527516334..c659e73ae 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -835,7 +835,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6cc15b131..ccc194f35 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.UsersManager.html b/docs/module-management.UsersManager.html
index 4a29c2bcb..33658deef 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5075,7 +5075,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 24524f386..138034ca4 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -150,7 +150,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index c703086b0..0a882f6e8 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -339,7 +339,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index e1092abfd..c1d593455 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -124,7 +124,7 @@ utils.js
diff --git a/package.json b/package.json
index da7529028..80138069b 100644
--- a/package.json
+++ b/package.json
@@ -1,16 +1,16 @@
{
"name": "auth0",
- "version": "2.14.0",
+ "version": "2.15.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
- "files": [
- "src"
- ],
+ "files": ["src"],
"scripts": {
"test": "mocha -R spec ./test/**/*.tests.js ./test/*.tests.js",
- "test:ci": "istanbul cover _mocha --report lcovonly -R $(find ./test -name *.tests.js) -- -R mocha-multi --reporter-options spec=-,mocha-junit-reporter=-",
+ "test:ci":
+ "istanbul cover _mocha --report lcovonly -R $(find ./test -name *.tests.js) -- -R mocha-multi --reporter-options spec=-,mocha-junit-reporter=-",
"test:coverage": "codecov",
- "test:watch": "cross-env NODE_ENV=test mocha --timeout 5000 ./test/**/*.tests.js ./test/*.tests.js --watch",
+ "test:watch":
+ "cross-env NODE_ENV=test mocha --timeout 5000 ./test/**/*.tests.js ./test/*.tests.js --watch",
"jsdoc:generate": "jsdoc --configure .jsdoc.json --verbose",
"release:clean": "node scripts/cleanup.js",
"preversion": "node scripts/prepare.js",
@@ -22,10 +22,7 @@
"type": "git",
"url": "https://github.com/auth0/node-auth0"
},
- "keywords": [
- "auth0",
- "api"
- ],
+ "keywords": ["auth0", "api"],
"author": "Auth0",
"license": "MIT",
"bugs": {
Source:
Source:
diff --git a/docs/index.html b/docs/index.html
index 284900d46..35675c193 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -151,7 +151,7 @@ License
This project is licensed under the MIT license. See the
diff --git a/docs/index.js.html b/docs/index.js.html
index 1c8d473a0..9e941863c 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 48fdcb021..57186a500 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_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index 02d124357..090f03820 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 ee848a5a2..c8a415528 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 15c95b0b1..70edd7e7a 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index 09e419d59..8940d287b 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 f5dc2e012..9f64551f5 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 38f961049..276f60672 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -132,7 +132,10 @@ management/EmailProviderManager.js
* });
*
* @param {Function} [cb] Callback function.
- *
+ * @param {Object} [params] Clients parameters.
+ * @param {Number} [params.fields] A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
+ * @param {Number} [params.include_fields] true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(EmailProviderManager, 'get', 'resource.getAll');
@@ -195,7 +198,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index b926f4b92..1d5725300 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_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index fd969d25b..3afa11710 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 0b1a0388d..409665611 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -98,6 +98,19 @@ management/JobsManager.js
options.tokenProvider
);
this.jobs = new RetryRestClient(auth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for consuming the
+ * {@link https://auth0.com/docs/api/v2#!/Jobs/post_users_exports Create job to export users endpoint}
+ *
+ * @type {external:RestClient}
+ */
+ const usersExportsRestClient = new Auth0RestClient(
+ options.baseUrl + '/jobs/users-exports',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.usersExports = new RetryRestClient(usersExportsRestClient, options.retry);
};
/**
@@ -155,7 +168,7 @@ management/JobsManager.js
* send_completion_email: false //optional
* };
*
- * management.jobs.get(params, function (err) {
+ * management.jobs.importUsers(params, function (err) {
* if (err) {
* // Handle error.
* }
@@ -235,6 +248,63 @@ management/JobsManager.js
return promise;
};
+/**
+ * Export all users to a file using a long running job.
+ *
+ * @method exportUsers
+ * @memberOf module:management.JobsManager.prototype
+ *
+ * @example
+ * var data = {
+ * connection_id: 'con_0000000000000001',
+ * format: 'csv',
+ * limit: 5,
+ * fields: [
+ * {
+ * "name": "user_id"
+ * },
+ * {
+ * "name": "name"
+ * },
+ * {
+ * "name": "email"
+ * },
+ * {
+ * "name": "identities[0].connection",
+ * "export_as": "provider"
+ * },
+ * {
+ * "name": "user_metadata.some_field"
+ * }
+ * ]
+ * }
+ *
+ * management.jobs.exportUsers(data, function (err, results) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Retrieved job.
+ * console.log(results);
+ * });
+ *
+ * @param {Object} data Users export data.
+ * @param {String} [data.connection_id] The connection id of the connection from which users will be exported
+ * @param {String} [data.format] The format of the file. Valid values are: "json" and "csv".
+ * @param {Number} [data.limit] Limit the number of records.
+ * @param {Object[]} [data.fields] A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+JobsManager.prototype.exportUsers = function(data, cb) {
+ if (cb && cb instanceof Function) {
+ return this.usersExports.create(data, cb);
+ }
+
+ return this.usersExports.create(data);
+};
+
/**
* Send a verification email to a user.
*
@@ -284,7 +354,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 6c9f5b9ea..02b71be8d 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 2b5b18db8..61a6fa94b 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -189,7 +189,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index 3cfaa5da4..fafbb3aca 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_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index 18de21ac5..439658b62 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
@@ -179,7 +179,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 8f51c048f..93eae695b 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 aff6e68c8..6ef638d33 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 2a14fe60a..25f65f66b 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -161,7 +161,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index ce0b83bb6..03451ef26 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_UsersManager.js.html b/docs/management_UsersManager.js.html
index 76adaeaa4..e09e07ad9 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -677,7 +677,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index 9e4daa584..a94ca9567 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -599,8 +599,8 @@ management/index.js
/**
* Get all Auth0 Client Grants.
*
- * @method getAll
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method getClientGrants
+ * @memberOf module:management.ManagementClient.prototype
*
* @example <caption>
* This method takes an optional object as first argument that may be used to
@@ -630,8 +630,8 @@ management/index.js
/**
* Create an Auth0 client grant.
*
- * @method create
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method createClientGrant
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.clientGrants.create(data, function (err) {
@@ -652,8 +652,8 @@ management/index.js
/**
* Update an Auth0 client grant.
*
- * @method update
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method updateClientGrant
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* var data = {
@@ -683,8 +683,8 @@ management/index.js
/**
* Delete an Auth0 client grant.
*
- * @method delete
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method deleteClientGrant
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.clientGrants.delete({ id: GRANT_ID }, function (err) {
@@ -1430,7 +1430,10 @@ management/index.js
* });
*
* @param {Function} [cb] Callback function.
- *
+ * @param {Object} [params] Clients parameters.
+ * @param {Number} [params.fields] A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
+ * @param {Number} [params.include_fields] true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(ManagementClient, 'getEmailProvider', 'emailProvider.get');
@@ -1649,6 +1652,57 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'importUsers', 'jobs.importUsers');
+/**
+ * Export all users to a file using a long running job.
+ *
+ * @method exportUsers
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var data = {
+ * connection_id: 'con_0000000000000001',
+ * format: 'csv',
+ * limit: 5,
+ * fields: [
+ * {
+ * "name": "user_id"
+ * },
+ * {
+ * "name": "name"
+ * },
+ * {
+ * "name": "email"
+ * },
+ * {
+ * "name": "identities[0].connection",
+ * "export_as": "provider"
+ * },
+ * {
+ * "name": "user_metadata.some_field"
+ * }
+ * ]
+ * }
+ *
+ * management.exportUsers(data, function (err, results) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Retrieved job.
+ * console.log(results);
+ * });
+ *
+ * @param {Object} data Users export data.
+ * @param {String} [data.connection_id] The connection id of the connection from which users will be exported
+ * @param {String} [data.format] The format of the file. Valid values are: "json" and "csv".
+ * @param {Number} [data.limit] Limit the number of records.
+ * @param {Object[]} [data.fields] A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'exportUsers', 'jobs.exportUsers');
+
/**
* Send a verification email to a user.
*
@@ -1982,8 +2036,8 @@ management/index.js
/**
* Create an Auth0 Custom Domain.
*
- * @method create
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method createCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.createCustomDomain(data, function (err) {
@@ -2004,8 +2058,8 @@ management/index.js
/**
* Get all Auth0 CustomDomains.
*
- * @method getAll
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method getCustomDomains
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.getCustomDomains(function (err, customDomains) {
@@ -2019,8 +2073,8 @@ management/index.js
/**
* Get a Custom Domain.
*
- * @method get
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method getCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
@@ -2042,8 +2096,8 @@ management/index.js
/**
* Verify a Custom Domain.
*
- * @method verify
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method verifyCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
@@ -2065,8 +2119,8 @@ management/index.js
/**
* Delete a Custom Domain.
*
- * @method delete
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method deleteCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
@@ -2089,7 +2143,7 @@ management/index.js
* Create a Guardian enrollment ticket.
*
* @method createGuardianEnrollmentTicket
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.createGuardianEnrollmentTicket(function (err, ticket) {
@@ -2110,7 +2164,7 @@ management/index.js
* Get a list of Guardian factors and statuses.
*
* @method getGuardianFactors
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.getGuardianFactors(function (err, factors) {
* console.log(factors.length);
@@ -2126,7 +2180,7 @@ management/index.js
* Get Guardian factor provider configuration
*
* @method getGuardianFactorProvider
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
* console.log(provider);
@@ -2147,7 +2201,7 @@ management/index.js
* Update Guardian's factor provider
*
* @method updateFactorProvider
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
* messaging_service_sid: 'XXXXXXXXXXXXXX',
@@ -2173,7 +2227,7 @@ management/index.js
* Get Guardian enrollment and verification factor templates
*
* @method getGuardianFactorTemplates
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
* console.log(templates);
@@ -2194,7 +2248,7 @@ management/index.js
* Update Guardian enrollment and verification factor templates
*
* @method updateGuardianFactorTemplates
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.updateGuardianFactorTemplates({ name: 'sms' }, {
* enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
@@ -2219,7 +2273,7 @@ management/index.js
* Update Guardian Factor
*
* @method updateGuardianFactor
- * @memberOf module.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.updateGuardianFactor({ name: 'sms' }, {
* enabled: true
@@ -2248,7 +2302,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index fb612176b..3759ff8a2 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -3894,7 +3894,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index b7b29e7b2..64f95eedb 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1590,7 +1590,7 @@ Parameters:
-Stinrg
+String
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index 8697b3777..f161a65ee 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -101,7 +101,7 @@ Source:
Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 1a653544b..9aec2c527 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1796,7 +1796,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index e81cdc6c4..e20079a2c 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index 97a1daf27..c01be4808 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 1b625dd20..f35ae1e47 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 249e89209..cc295c8ec 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-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 0451d5674..094d54110 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.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index dee679a9a..a14a07f8c 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -717,1097 +717,14 @@ Example
- create(data, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Create an Auth0 client grant.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The client data object.
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.clientGrants.create(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Client grant created.
-});
-
-
-
-
-
-
-
-
-
-
- delete(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Delete an Auth0 client grant.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Client parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Client grant ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.clientGrants.delete({ id: GRANT_ID }, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Grant deleted.
-});
-
-
-
-
-
-
-
-
-
-
- delete(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Delete an Auth0 client grant.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Client parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Client grant ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.clientGrants.delete({ id: GRANT_ID }, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Grant deleted.
-});
-
-
-
-
-
-
-
-
-
-
- getAll(paramsopt, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get all Auth0 Client Grants.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Client Grants 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.getClientGrants(params, function (err, grants) {
- console.log(grants.length);
-});
-
-
-
-
-
-
-
-
-
-
- getAll(paramsopt, cbopt) → {Promise|undefined}
+ delete(params, cbopt) → {Promise|undefined}
- Get all Auth0 Client Grants.
+ Delete an Auth0 client grant.
@@ -1843,7 +760,7 @@ getAllSource:
Parameters:
- <optional>
-
@@ -1916,7 +831,7 @@ Parameters:
- Client Grants parameters.
+ Client parameters.
@@ -1930,8 +845,6 @@ Parameters:
Type
- Attributes
-
@@ -1944,70 +857,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ Client grant ID.
@@ -2102,21 +969,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.clientGrants.delete({ id: GRANT_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
-management.clientGrants.getAll(params, function (err, grants) {
- console.log(grants.length);
+ // Grant deleted.
});
@@ -2128,14 +986,14 @@ Example
- update(params, data, cbopt) → {Promise|undefined}
+ getAll(paramsopt, cbopt) → {Promise|undefined}
- Update an Auth0 client grant.
+ Get all Auth0 Client Grants.
@@ -2171,7 +1029,7 @@ updateSource:
Parameters:
+ <optional>
+
@@ -2242,7 +1102,7 @@ Parameters:
- Client parameters.
+ Client Grants parameters.
@@ -2256,6 +1116,8 @@ Parameters:
Type
+ Attributes
+
@@ -2268,32 +1130,34 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
-
+
-
- Client grant ID.
-
-
+
+
-
-
-
+
+
+ Number of results per page.
@@ -2302,13 +1166,13 @@ Parameters:
- datapage
-Object
+Number
@@ -2317,6 +1181,8 @@ Parameters:
+ <optional>
+
@@ -2327,7 +1193,15 @@ Parameters:
- Updated client data.
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
@@ -2414,19 +1288,21 @@ Returns:
Example
- var data = {
- client_id: CLIENT_ID,
- audience: AUDIENCE,
- scope: []
+
+ 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: CLIENT_GRANT_ID };
-management.clientGrants.update(params, data, function (err, grant) {
- if (err) {
- // Handle error.
- }
- console.log(grant.id);
+management.clientGrants.getAll(params, function (err, grants) {
+ console.log(grants.length);
});
@@ -2760,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 02612947b..0b77f92d1 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 7ebfbcc77..c6a8da76d 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 6c4def656..c61671616 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -792,224 +792,6 @@ Example
-
-
-
-
- create(data, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Create an Auth0 Custom Domain.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The custom domain data object.
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.createCustomDomain(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // CustomDomain created.
-});
-
-
-
-
-
-
@@ -1057,7 +839,7 @@ deleteSource:
Returns:
Example
- management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ management.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -1283,14 +1065,14 @@ Example
- delete(params, cbopt) → {Promise|undefined}
+ get(params, cbopt) → {Promise|undefined}
- Delete a Custom Domain.
+ Get a Custom Domain.
@@ -1326,7 +1108,7 @@ deleteSource:
Returns:
Example
- management.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ management.customDomains.get({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
if (err) {
// Handle error.
}
- // CustomDomain deleted.
+ console.log(customDomain);
});
@@ -1552,14 +1334,14 @@ Example
- get(params, cbopt) → {Promise|undefined}
+ getAll() → {Promise|undefined}
- Get a Custom Domain.
+ Get all Auth0 CustomDomains.
@@ -1595,7 +1377,7 @@ getSource:
get
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Custom Domain parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Custom Domain ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
- if (err) {
- // Handle error.
- }
-
- console.log(customDomain);
-});
-
-
-
-
-
-
-
-
-
-
- get(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get a Custom Domain.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Custom Domain parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Custom Domain ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.customDomains.get({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
- if (err) {
- // Handle error.
- }
-
- console.log(customDomain);
-});
-
-
-
-
-
-
-
-
-
-
- getAll() → {Promise|undefined}
-
-
-
-
-
-
- Get all Auth0 CustomDomains.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.getCustomDomains(function (err, customDomains) {
- console.log(customDomains.length);
-});
-
-
-
-
-
-
-
-
-
-
- getAll() → {Promise|undefined}
-
-
-
-
-
-
- Get all Auth0 CustomDomains.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.customDomains.getAll(function (err, customDomains) {
- console.log(customDomains.length);
-});
-
-
-
-
-
-
-
-
-
-
- verify(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Verify a Custom Domain.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Custom Domain parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Custom Domain ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
@@ -2574,12 +1437,8 @@ Returns:
Example
- management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
- if (err) {
- // Handle error.
- }
-
- console.log(customDomain);
+ management.customDomains.getAll(function (err, customDomains) {
+ console.log(customDomains.length);
});
@@ -2872,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index 01d6666b7..c87bb56fc 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 52441ed0a..530ab5dcb 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -759,7 +759,7 @@ deleteSource:
Example
- get(cbopt) → {Promise|undefined}
+ get(cbopt, paramsopt) → {Promise|undefined}
@@ -1022,6 +1022,141 @@ Parameters:
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Clients parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ fields
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
+
+
+
+
+
+
+
+
+ include_fields
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1123,7 +1258,7 @@ updateSource:
Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index 2495916b4..ecaea5ef5 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.GuardianManager.html b/docs/module-management.GuardianManager.html
index eff768fda..59e6fb9d8 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -894,186 +894,6 @@ Example
-
-
-
-
- createGuardianEnrollmentTicket(cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Create a Guardian enrollment ticket.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.createGuardianEnrollmentTicket(function (err, ticket) {
- console.log(ticket);
-});
-
-
-
-
-
-
@@ -1620,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index a17cf8ff0..a8d359bf4 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -391,6 +391,81 @@ (inner)
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner, constant) usersExportsRestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the
+Create job to export users endpoint
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
@@ -419,6 +494,420 @@ Methods
+
+
+
+
+ exportUsers(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Export all users to a file using a long running job.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Users export data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ connection_id
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The connection id of the connection from which users will be exported
+
+
+
+
+
+
+
+
+ format
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The format of the file. Valid values are: "json" and "csv".
+
+
+
+
+
+
+
+
+ limit
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Limit the number of records.
+
+
+
+
+
+
+
+
+ fields
+
+
+Array.<Object>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = {
+ connection_id: 'con_0000000000000001',
+ format: 'csv',
+ limit: 5,
+ fields: [
+ {
+ "name": "user_id"
+ },
+ {
+ "name": "name"
+ },
+ {
+ "name": "email"
+ },
+ {
+ "name": "identities[0].connection",
+ "export_as": "provider"
+ },
+ {
+ "name": "user_metadata.some_field"
+ }
+ ]
+}
+
+management.jobs.exportUsers(data, function (err, results) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Retrieved job.
+ console.log(results);
+});
+
+
+
+
+
+
@@ -466,7 +955,7 @@ getSource:
importUser
Source:
Example
send_completion_email: false //optional
};
-management.jobs.get(params, function (err) {
+management.jobs.importUsers(params, function (err) {
if (err) {
// Handle error.
}
@@ -1120,7 +1609,7 @@ verifyEmai
Source:
Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index a476b9d52..c022c6e50 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 bc804d928..843cb3828 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -2376,7 +2376,7 @@ Source:
Example
- createConnection(data, cbopt) → {Promise|undefined}
+ createClientGrant(data, cbopt) → {Promise|undefined}
- Create a new connection.
+ Create an Auth0 client grant.
@@ -2812,7 +2812,7 @@ creat
Source:
Parameters:
- Connection data object.
+ The client data object.
@@ -2970,12 +2970,12 @@ Returns:
Example
- management.createConnection(data, function (err) {
+ management.clientGrants.create(data, function (err) {
if (err) {
// Handle error.
}
- // Conection created.
+ // Client grant created.
});
@@ -2987,14 +2987,14 @@ Example
- createDevicePublicKey(data, cbopt) → {Promise|undefined}
+ createConnection(data, cbopt) → {Promise|undefined}
- Create an Auth0 credential.
+ Create a new connection.
@@ -3030,7 +3030,7 @@
Source:
Parameters:
- The device credential data object.
+ Connection data object.
@@ -3193,7 +3193,7 @@ Example
// Handle error.
}
- // Credential created.
+ // Conection created.
});
@@ -3205,14 +3205,14 @@ Example
- createEmailVerificationTicket(cbopt) → {Promise}
+ createCustomDomain(data, cbopt) → {Promise|undefined}
- Create an email verification ticket.
+ Create an Auth0 Custom Domain.
@@ -3248,7 +3248,7 @@ Source:
Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The custom domain data object.
+
+
+
+
+
+
cbReturns:
Promise
+|
+
+undefined
@@ -3369,15 +3406,12 @@ Returns:
Example
- var data = {
- user_id: '{USER_ID}',
- result_url: '{REDIRECT_URL}' // Optional redirect after the ticket is used.
-};
-
-auth0.createEmailVerificationTicket(data, function (err) {
+ management.createCustomDomain(data, function (err) {
if (err) {
// Handle error.
}
+
+ // CustomDomain created.
});
@@ -3389,14 +3423,14 @@ Example
- createPasswordChangeTicket(cbopt) → {Promise}
+ createDevicePublicKey(data, cbopt) → {Promise|undefined}
- Create a new password change ticket.
+ Create an Auth0 credential.
@@ -3432,7 +3466,7 @@ Source:
Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The device credential data object.
+
+
+
+
+
+
cbReturns:
Promise
+|
+
+undefined
@@ -3553,17 +3624,12 @@ Returns:
Example
- var params = {
- result_url: '{REDIRECT_URL}', // Redirect after using the ticket.
- user_id: '{USER_ID}', // Optional.
- email: '{USER_EMAIL}', // Optional.
- new_password: '{PASSWORD}'
-};
-
-auth0.createPasswordChangeTicket(params, function (err) {
+ management.createConnection(data, function (err) {
if (err) {
// Handle error.
}
+
+ // Credential created.
});
@@ -3575,14 +3641,14 @@ Example
- createResourceServer(data, cbopt) → {Promise|undefined}
+ createEmailVerificationTicket(cbopt) → {Promise}
- Create a new resource server.
+ Create an email verification ticket.
@@ -3618,7 +3684,7 @@ c
Source:
Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Resource Server data object.
-
-
-
-
-
-
cbReturns:
Promise
-|
-
-undefined
@@ -3776,12 +3805,15 @@ Returns:
Example
- management.createResourceServer(data, function (err) {
+ var data = {
+ user_id: '{USER_ID}',
+ result_url: '{REDIRECT_URL}' // Optional redirect after the ticket is used.
+};
+
+auth0.createEmailVerificationTicket(data, function (err) {
if (err) {
// Handle error.
}
-
- // Resource Server created.
});
@@ -3793,14 +3825,14 @@ Example
- createRule(data, cbopt) → {Promise|undefined}
+ createGuardianEnrollmentTicket(cbopt) → {Promise|undefined}
- Create a new rule.
+ Create a Guardian enrollment ticket.
@@ -3836,7 +3868,7 @@ createRule<
Source:
Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Rule data object.
-
-
-
-
-
-
cbReturns:
Example
- management.createRule(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Rule created.
+ management.createGuardianEnrollmentTicket(function (err, ticket) {
+ console.log(ticket);
});
@@ -4011,14 +4005,14 @@ Example
- createUser(data, cbopt) → {Promise|undefined}
+ createPasswordChangeTicket(cbopt) → {Promise}
- Create a new user.
+ Create a new password change ticket.
@@ -4054,7 +4048,7 @@ createUser<
Source:
Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- User data.
-
-
-
-
-
-
cbReturns:
Promise
-|
-
-undefined
@@ -4212,12 +4169,17 @@ Returns:
Example
- management.createUser(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // User created.
+ var params = {
+ result_url: '{REDIRECT_URL}', // Redirect after using the ticket.
+ user_id: '{USER_ID}', // Optional.
+ email: '{USER_EMAIL}', // Optional.
+ new_password: '{PASSWORD}'
+};
+
+auth0.createPasswordChangeTicket(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
});
@@ -4229,14 +4191,14 @@ Example
- deleteAllUsers(cbopt) → {Promise|undefined}
+ createResourceServer(data, cbopt) → {Promise|undefined}
- Delete all users.
+ Create a new resource server.
@@ -4260,8 +4222,6 @@ deleteA
- Deprecated: - This method will be removed in the next major release.
deleteA
Source:
Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Resource Server data object.
+
+
+
+
+
+
cbParameters:
- Callback function
+ Callback function.
@@ -4398,12 +4392,12 @@ Returns:
Example
- management.deleteAllUsers(function (err) {
+ management.createResourceServer(data, function (err) {
if (err) {
// Handle error.
}
- // Users deleted
+ // Resource Server created.
});
@@ -4415,14 +4409,14 @@ Example
- deleteClient(params, cbopt) → {Promise|undefined}
+ createRule(data, cbopt) → {Promise|undefined}
- Delete an Auth0 client.
+ Create a new rule.
@@ -4458,7 +4452,7 @@ deleteCli
Source:
Parameters:
- paramsdata
@@ -4529,58 +4523,7 @@ Parameters:
- Client parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- client_id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Application client ID.
-
-
-
-
-
-
-
-
+ Rule data object.
@@ -4667,12 +4610,12 @@ Returns:
Example
- management.deleteClient({ client_id: CLIENT_ID }, function (err) {
+ management.createRule(data, function (err) {
if (err) {
// Handle error.
}
- // Client deleted.
+ // Rule created.
});
@@ -4684,14 +4627,14 @@ Example
- deleteConnection(params, cbopt) → {Promise|undefined}
+ createUser(data, cbopt) → {Promise|undefined}
- Delete an existing connection.
+ Create a new user.
@@ -4727,7 +4670,7 @@ delet
Source:
Parameters:
- paramsdata
@@ -4798,58 +4741,7 @@ Parameters:
- Connection parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Connection ID.
-
-
-
-
-
-
-
-
+ User data.
@@ -4936,12 +4828,12 @@ Returns:
Example
- management.deleteConnection({ id: CONNECTION_ID }, function (err) {
+ management.createUser(data, function (err) {
if (err) {
// Handle error.
}
- // Conection deleted.
+ // User created.
});
@@ -4953,14 +4845,14 @@ Example
- deleteDeviceCredential(params, cbopt) → {Promise|undefined}
+ deleteAllUsers(cbopt) → {Promise|undefined}
- Delete an Auth0 device credential.
+ Delete all users.
@@ -4984,6 +4876,8 @@ Deprecated:- This method will be removed in the next major release.
Source:
Parameters:
- paramscb
-Object
+function
@@ -5057,6 +4951,8 @@ Parameters:
+ <optional>
+
@@ -5067,119 +4963,32 @@ Parameters:
- Credential parameters.
+ Callback function
-
-
-
-
-
-
- Name
-
+
+
- Type
+
+
+
-
-
- Description
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
- Device credential ID.
-
-
-
-
-
-
-
-
-
-
+
+Returns:
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
+
-
@@ -5205,14 +5014,12 @@
Returns:
Example
- var params = { id: CREDENTIAL_ID };
-
-management.deleteDeviceCredential(params, function (err) {
+ management.deleteAllUsers(function (err) {
if (err) {
// Handle error.
}
- // Credential deleted.
+ // Users deleted
});
@@ -5224,14 +5031,14 @@ Example
- deleteEmailProvider(cbopt) → {Promise|undefined}
+ deleteClient(params, cbopt) → {Promise|undefined}
- Delete email provider.
+ Delete an Auth0 client.
@@ -5267,7 +5074,7 @@ de
- Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Client parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Application client ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.deleteEmailProvider(function (err) {
+ management.deleteClient({ client_id: CLIENT_ID }, function (err) {
if (err) {
// Handle error.
}
- // Email provider deleted.
+ // Client deleted.
});
@@ -5408,14 +5300,14 @@ Example
- deleteGuardianEnrollment(data, cbopt) → {Promise|undefined}
+ deleteClientGrant(params, cbopt) → {Promise|undefined}
- Delete a user's Guardian enrollment.
+ Delete an Auth0 client grant.
@@ -5451,7 +5343,7 @@ Source:
Parameters:
- dataparams
@@ -5522,7 +5414,7 @@ Parameters:
- The Guardian enrollment data object.
+ Client parameters.
@@ -5565,7 +5457,7 @@ Parameters:
- The Guardian enrollment id.
+ Client grant ID.
@@ -5660,12 +5552,12 @@ Returns:
Example
- management.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err) {
+ management.clientGrants.delete({ id: GRANT_ID }, function (err) {
if (err) {
// Handle error.
}
- // Email provider deleted.
+ // Grant deleted.
});
@@ -5677,14 +5569,14 @@ Example
- deleteResourceServer(params, cbopt) → {Promise|undefined}
+ deleteConnection(params, cbopt) → {Promise|undefined}
- Delete an existing resource server.
+ Delete an existing connection.
@@ -5720,7 +5612,7 @@ d
- Source:
Parameters:
- Resource Server parameters.
+ Connection parameters.
@@ -5834,7 +5726,7 @@ Parameters:
- Resource Server ID.
+ Connection ID.
@@ -5929,12 +5821,12 @@ Returns:
Example
- management.deleteResourceServer({ id: RESOURCE_SERVER_ID }, function (err) {
+ management.deleteConnection({ id: CONNECTION_ID }, function (err) {
if (err) {
// Handle error.
}
- // Resource Server deleted.
+ // Conection deleted.
});
@@ -5946,14 +5838,14 @@ Example
- deleteRule(params, cbopt) → {Promise|undefined}
+ deleteCustomDomain(params, cbopt) → {Promise|undefined}
- Delete an existing rule.
+ Delete a Custom Domain.
@@ -5989,7 +5881,7 @@ deleteRule<
- Source:
Parameters:
- Rule parameters.
+ Custom Domain parameters.
@@ -6103,7 +5995,7 @@ Parameters:
- Rule ID.
+ Custom Domain ID.
@@ -6198,12 +6090,12 @@ Returns:
Example
- auth0.deleteRule({ id: RULE_ID }, function (err) {
+ management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
if (err) {
// Handle error.
}
- // Rule deleted.
+ // CustomDomain deleted.
});
@@ -6215,14 +6107,14 @@ Example
- deleteRulesConfig(params, cbopt) → {Promise|undefined}
+ deleteDeviceCredential(params, cbopt) → {Promise|undefined}
- Delete rules config.
+ Delete an Auth0 device credential.
@@ -6258,7 +6150,7 @@ dele
- Source:
Parameters:
- Rule Configs parameters.
+ Credential parameters.
@@ -6355,7 +6247,7 @@ Parameters:
- keyid
@@ -6372,7 +6264,7 @@ Parameters:
- Rule Configs key.
+ Device credential ID.
@@ -6467,12 +6359,14 @@ Returns:
Example
- management.deleteRulesConfig({ key: RULE_CONFIG_KEY }, function (err) {
+ var params = { id: CREDENTIAL_ID };
+
+management.deleteDeviceCredential(params, function (err) {
if (err) {
// Handle error.
}
- // Rules Config deleted.
+ // Credential deleted.
});
@@ -6484,14 +6378,14 @@ Example
- deleteUser(params, cbopt) → {Promise|undefined}
+ deleteEmailProvider(cbopt) → {Promise|undefined}
- Delete a user by its id.
+ Delete email provider.
@@ -6527,7 +6421,7 @@ deleteUser<
- Source:
Parameters:
- paramscb
-Object
+function
@@ -6588,6 +6482,8 @@ Parameters:
+ <optional>
+
@@ -6598,101 +6494,14 @@ Parameters:
- The user data object..
+ Callback function.
-
-
-
-
-
-
- Name
-
+
+
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- The user id.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function
-
-
-
-
-
-
-
+
+
+
@@ -6736,12 +6545,12 @@ Returns:
Example
- management.deleteUser({ id: USER_ID }, function (err) {
+ management.deleteEmailProvider(function (err) {
if (err) {
// Handle error.
}
- // User deleted.
+ // Email provider deleted.
});
@@ -6753,14 +6562,14 @@ Example
- deleteUserMultifactor(params, cbopt) → {Promise|undefined}
+ deleteGuardianEnrollment(data, cbopt) → {Promise|undefined}
- Delete a multifactor provider for a user.
+ Delete a user's Guardian enrollment.
@@ -6796,7 +6605,7 @@
Source:
Parameters:
- paramsdata
@@ -6867,7 +6676,7 @@ Parameters:
- Data object.
+ The Guardian enrollment data object.
@@ -6910,33 +6719,7 @@ Parameters:
- The user id.
-
-
-
-
-
-
-
-
- provider
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Multifactor provider.
+ The Guardian enrollment id.
@@ -6980,7 +6763,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -7031,14 +6814,12 @@ Returns:
Example
- var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-
-management.deleteUserMultifactor(params, function (err, user) {
+ management.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // Email provider deleted.
});
@@ -7050,14 +6831,14 @@ Example
- deleteUserMultifcator(params, cbopt) → {Promise|undefined}
+ deleteResourceServer(params, cbopt) → {Promise|undefined}
- Delete a multifactor provider for a user.
+ Delete an existing resource server.
@@ -7081,10 +6862,6 @@
- Deprecated: - The function name has a typo.
-We're shipping this so it doesn't break compatibility.
-Use
deleteUserMultifactor instead.
Source:
Parameters:
- Data object.
+ Resource Server parameters.
@@ -7211,33 +6988,7 @@ Parameters:
- The user id.
-
-
-
-
-
-
-
-
- provider
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Multifactor provider.
+ Resource Server ID.
@@ -7281,7 +7032,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -7332,14 +7083,12 @@ Returns:
Example
- var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-
-management.deleteUserMultifcator(params, function (err, user) {
+ management.deleteResourceServer({ id: RESOURCE_SERVER_ID }, function (err) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // Resource Server deleted.
});
@@ -7351,14 +7100,14 @@ Example
- getActiveUsersCount(cbopt) → {Promise|undefined}
+ deleteRule(params, cbopt) → {Promise|undefined}
- Get a the active users count.
+ Delete an existing rule.
@@ -7394,7 +7143,7 @@ ge
Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rule parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.getActiveUsersCount(function (err, usersCount) {
+ auth0.deleteRule({ id: RULE_ID }, function (err) {
if (err) {
// Handle error.
}
- console.log(usersCount);
+ // Rule deleted.
});
@@ -7535,14 +7369,14 @@ Example
- getBlacklistedTokens(cbopt) → {Promise|undefined}
+ deleteRulesConfig(params, cbopt) → {Promise|undefined}
- Get all blacklisted tokens.
+ Delete rules config.
@@ -7578,7 +7412,7 @@ g
Source:
Parameters:
- cbparams
-function
+Object
@@ -7639,8 +7473,6 @@ Parameters:
- <optional>
-
@@ -7651,7 +7483,94 @@ Parameters:
- Callback function.
+ Rule Configs parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule Configs key.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
@@ -7702,8 +7621,12 @@ Returns:
Example
- management.getBlacklistedTokens(function (err, tokens) {
- console.log(tokens.length);
+ management.deleteRulesConfig({ key: RULE_CONFIG_KEY }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Rules Config deleted.
});
@@ -7715,14 +7638,14 @@ Example
- getClient(params, cbopt) → {Promise|undefined}
+ deleteUser(params, cbopt) → {Promise|undefined}
- Get an Auth0 client.
+ Delete a user by its id.
@@ -7758,7 +7681,7 @@ getClientSource:
Parameters:
- Client parameters.
+ The user data object..
@@ -7855,7 +7778,7 @@ Parameters:
- client_idid
@@ -7872,7 +7795,7 @@ Parameters:
- Application client ID.
+ The user id.
@@ -7916,7 +7839,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -7967,12 +7890,12 @@ Returns:
Example
- management.getClient({ client_id: CLIENT_ID }, function (err, client) {
+ management.deleteUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
- console.log(client);
+ // User deleted.
});
@@ -7984,122 +7907,14 @@ Example
- getClientInfo() → {Object}
-
-
-
-
-
-
- Return an object with information about the current client,
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Object
-
-
-
-
-
-
-
- Object containing client information.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- getClients(paramsopt, cbopt) → {Promise|undefined}
+ deleteUserMultifactor(params, cbopt) → {Promise|undefined}
- Get all Auth0 clients.
+ Delete a multifactor provider for a user.
@@ -8135,7 +7950,7 @@ getClients<
Source:
Parameters:
- <optional>
-
@@ -8208,7 +8021,7 @@ Parameters:
- Clients parameters.
+ Data object.
@@ -8222,8 +8035,6 @@ Parameters:
Type
- Attributes
-
@@ -8236,34 +8047,24 @@ Parameters:
- per_pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Number of results per page.
+ The user id.
@@ -8272,34 +8073,24 @@ Parameters:
- pageprovider
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ Multifactor provider.
@@ -8343,7 +8134,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -8394,20 +8185,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, provider: MULTIFACTOR_PROVIDER };
-management.getClients(params, function (err, clients) {
- console.log(clients.length);
+management.deleteUserMultifactor(params, function (err, user) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Users accounts unlinked.
});
@@ -8419,14 +8204,14 @@ Example
- getConnection(params, cbopt) → {Promise|undefined}
+ deleteUserMultifcator(params, cbopt) → {Promise|undefined}
- Get an Auth0 connection.
+ Delete a multifactor provider for a user.
@@ -8450,6 +8235,10 @@ getConne
+ Deprecated: - The function name has a typo.
+We're shipping this so it doesn't break compatibility.
+Use
deleteUserMultifactor instead.
getConne
Source:
Parameters:
- Connection parameters.
+ Data object.
@@ -8576,7 +8365,33 @@ Parameters:
- Connection ID.
+ The user id.
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Multifactor provider.
@@ -8620,7 +8435,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -8671,12 +8486,14 @@ Returns:
Example
- management.getConnection({ id: CONNECTION_ID }, function (err, connection) {
+ var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
+
+management.deleteUserMultifcator(params, function (err, user) {
if (err) {
// Handle error.
}
- console.log(connection);
+ // Users accounts unlinked.
});
@@ -8688,14 +8505,14 @@ Example
- getConnections(paramsopt, cbopt) → {Promise|undefined}
+ exportUsers(data, cbopt) → {Promise|undefined}
- Get all connections.
+ Export all users to a file using a long running job.
@@ -8731,7 +8548,7 @@ getConn
Source:
Parameters:
- paramsdata
@@ -8792,8 +8609,6 @@ Parameters:
- <optional>
-
@@ -8804,7 +8619,7 @@ Parameters:
- Connections params.
+ Users export data.
@@ -8832,13 +8647,13 @@ Parameters:
- per_pageconnection_id
-Number
+String
@@ -8859,7 +8674,7 @@ Parameters:
- Number of results per page.
+ The connection id of the connection from which users will be exported
@@ -8868,7 +8683,43 @@ Parameters:
- pageformat
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The format of the file. Valid values are: "json" and "csv".
+
+
+
+
+
+
+
+
+ limit
@@ -8895,7 +8746,43 @@ Parameters:
- Page number, zero indexed.
+ Limit the number of records.
+
+
+
+
+
+
+
+
+ fields
+
+
+Array.<Object>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
@@ -8990,20 +8877,37 @@ 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 data = {
+ connection_id: 'con_0000000000000001',
+ format: 'csv',
+ limit: 5,
+ fields: [
+ {
+ "name": "user_id"
+ },
+ {
+ "name": "name"
+ },
+ {
+ "name": "email"
+ },
+ {
+ "name": "identities[0].connection",
+ "export_as": "provider"
+ },
+ {
+ "name": "user_metadata.some_field"
+ }
+ ]
+}
+
+management.exportUsers(data, function (err, results) {
+ if (err) {
+ // Handle error.
+ }
-management.getConnections(params, function (err, connections) {
- console.log(connections.length);
+ // Retrieved job.
+ console.log(results);
});
@@ -9015,14 +8919,14 @@ Example
- getDailyStats(params, cbopt) → {Promise|undefined}
+ getActiveUsersCount(cbopt) → {Promise|undefined}
- Get the daily stats.
+ Get a the active users count.
@@ -9058,7 +8962,7 @@ getDaily
Source:
Parameters:
- paramscb
-Object
+function
@@ -9119,6 +9023,8 @@ Parameters:
+ <optional>
+
@@ -9129,156 +9035,43 @@ Parameters:
- Stats parameters.
+ Callback function.
-
-
-
-
-
-
- Name
-
+
+
- Type
+
+
+
-
-
- Description
-
-
-
-
-
-
- from
-
-
-String
-
-
-
-
-
- The first day in YYYYMMDD format.
-
-
-
-
-
-
- to
-
-
-String
+
+Returns:
+
-
-
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
-
-
-
-
-
- The last day in YYYYMMDD format.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
+undefined
@@ -9293,17 +9086,12 @@ Returns:
Example
- var params = {
- from: '{YYYYMMDD}', // First day included in the stats.
- to: '{YYYYMMDD}' // Last day included in the stats.
-};
-
-management.getDaily(params, function (err, stats) {
+ management.getActiveUsersCount(function (err, usersCount) {
if (err) {
// Handle error.
}
- console.log(stats);
+ console.log(usersCount);
});
@@ -9315,14 +9103,14 @@ Example
- getDeviceCredentials(cbopt) → {Promise|undefined}
+ getBlacklistedTokens(cbopt) → {Promise|undefined}
- Get all Auth0 credentials.
+ Get all blacklisted tokens.
@@ -9358,7 +9146,7 @@ g
- Source:
Returns:
Example
- management.getDeviceCredentials(function (err, credentials) {
- console.log(credentials.length);
+ management.getBlacklistedTokens(function (err, tokens) {
+ console.log(tokens.length);
});
@@ -9495,14 +9283,14 @@ Example
- getEmailProvider(cbopt) → {Promise|undefined}
+ getClient(params, cbopt) → {Promise|undefined}
- Get the email provider.
+ Get an Auth0 client.
@@ -9538,7 +9326,7 @@ getEm
- Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Client parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Application client ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.getEmailProvider(function (err, provider) {
- console.log(provider.length);
+ management.getClient({ client_id: CLIENT_ID }, function (err, client) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(client);
});
@@ -9675,14 +9552,14 @@ Example
- getGuardianEnrollment(data, cbopt) → {Promise|undefined}
+ getClientGrants(paramsopt, cbopt) → {Promise|undefined}
- Get a single Guardian enrollment.
+ Get all Auth0 Client Grants.
@@ -9718,7 +9595,7 @@
- Source:
Parameters:
- dataparams
@@ -9779,6 +9656,8 @@ Parameters:
+ <optional>
+
@@ -9789,7 +9668,7 @@ Parameters:
- The Guardian enrollment data object.
+ Client Grants parameters.
@@ -9803,6 +9682,8 @@ Parameters:
Type
+ Attributes
+
@@ -9815,32 +9696,34 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
-
+
-
- The Guardian enrollment id.
-
-
+
+
-
-
-
+
+
+ Number of results per page.
@@ -9849,13 +9732,13 @@ Parameters:
- cbpage
-function
+Number
@@ -9876,7 +9759,7 @@ Parameters:
- Callback function.
+ Page number, zero indexed.
@@ -9885,6 +9768,53 @@ Parameters:
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
@@ -9895,9 +9825,6 @@ Parameters:
-
-
-
Returns:
@@ -9927,8 +9854,20 @@ Returns:
Example
- management.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
- console.log(enrollment);
+
+ 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.getClientGrants(params, function (err, grants) {
+ console.log(grants.length);
});
@@ -9940,14 +9879,14 @@ Example
- getGuardianEnrollments(data, cbopt) → {Promise|undefined}
+ getClientInfo() → {Object}
- Get a list of a user's Guardian enrollments.
+ Return an object with information about the current client,
@@ -9983,7 +9922,115 @@ Source:
Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Object
+
+
+
+
+
+
+
+ Object containing client information.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ getClients(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 clients.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ Parameters:
- dataparams
@@ -10044,6 +10091,8 @@ Parameters:
+ <optional>
+
@@ -10054,7 +10103,7 @@ Parameters:
- The user data object.
+ Clients parameters.
@@ -10068,6 +10117,8 @@ Parameters:
Type
+ Attributes
+
@@ -10080,24 +10131,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- The user id.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -10192,8 +10289,20 @@ Returns:
Example
- management.getGuardianEnrollments({ id: USER_ID }, function (err, enrollments) {
- console.log(enrollments);
+
+ 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.getClients(params, function (err, clients) {
+ console.log(clients.length);
});
@@ -10205,14 +10314,14 @@ Example
- getJob(params, cbopt) → {Promise|undefined}
+ getConnection(params, cbopt) → {Promise|undefined}
- Get a job by its ID.
+ Get an Auth0 connection.
@@ -10248,7 +10357,7 @@ getJobSource:
Parameters:
- Job parameters.
+ Connection parameters.
@@ -10362,7 +10471,7 @@ Parameters:
- Job ID.
+ Connection ID.
@@ -10457,17 +10566,12 @@ Returns:
Example
- var params = {
- id: '{JOB_ID}'
-};
-
-management.getJob(params, function (err, job) {
+ management.getConnection({ id: CONNECTION_ID }, function (err, connection) {
if (err) {
// Handle error.
}
- // Retrieved job.
- console.log(job);
+ console.log(connection);
});
@@ -10479,14 +10583,14 @@ Example
- getLog(params, cbopt) → {Promise|undefined}
+ getConnections(paramsopt, cbopt) → {Promise|undefined}
- Get an Auth0 log.
+ Get all connections.
@@ -10522,7 +10626,7 @@ getLogSource:
Parameters:
+ <optional>
+
@@ -10593,7 +10699,7 @@ Parameters:
- Log parameters.
+ Connections params.
@@ -10607,6 +10713,8 @@ Parameters:
Type
+ Attributes
+
@@ -10619,24 +10727,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- Event ID.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -10731,12 +10885,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.getConnections(params, function (err, connections) {
+ console.log(connections.length);
});
@@ -10748,14 +10910,14 @@ Example
- getLogs(paramsopt, cbopt) → {Promise|undefined}
+ getCustomDomain(params, cbopt) → {Promise|undefined}
- Get all logs.
+ Get a Custom Domain.
@@ -10791,7 +10953,7 @@ getLogsSource:
Parameters:
- <optional>
-
@@ -10864,7 +11024,7 @@ Parameters:
- Logs params.
+ Custom Domain parameters.
@@ -10878,8 +11038,6 @@ Parameters:
Type
- Attributes
-
@@ -10892,7 +11050,7 @@ Parameters:
- qid
@@ -10905,21 +11063,19 @@ Parameters:
-
-
- <optional>
-
-
+
+
+ Custom Domain ID.
-
-
+
+
-
+
+
+
-
- Search Criteria using Query String Syntax
@@ -10928,13 +11084,13 @@ Parameters:
- pagecb
-Number
+function
@@ -10955,238 +11111,134 @@ Parameters:
- Page number. Zero based
+ Callback function.
+
+
-
-
- per_page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- The amount of entries per page
-
-
-
-
-
-
- sort
-
-
-String
-
-
+
+Returns:
-
-
-
- <optional>
-
+
-
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
-
-
-
+undefined
-
-
- The field to use for sorting.
-
-
-
+
+
+
+
-
-
- fields
-
-
-String
+
+Example
-
-
+ management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ if (err) {
+ // Handle error.
+ }
-
-
-
- <optional>
-
+ console.log(customDomain);
+});
-
+
-
-
+
+
+
-
+
-
- A comma separated list of fields to include or exclude
-
-
-
+ getCustomDomains() → {Promise|undefined}
-
-
- include_fields
-
-
-Boolean
+
+ Get all Auth0 CustomDomains.
+
-
-
-
-
-
- <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
-
-
-
+
-
-
-
-
-
+
+
+ Source:
+
-
- cb
-
-
-function
+
+
+
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
@@ -11230,20 +11282,8 @@ 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
-};
-
-management.getLogs(params, function (err, logs) {
- console.log(logs.length);
+ management.getCustomDomains(function (err, customDomains) {
+ console.log(customDomains.length);
});
@@ -11255,14 +11295,14 @@ Example
- getResourceServer(params, cbopt) → {Promise|undefined}
+ getDailyStats(params, cbopt) → {Promise|undefined}
- Get a Resource Server.
+ Get the daily stats.
@@ -11298,7 +11338,7 @@ getR
Source:
Parameters:
- Resource Server parameters.
+ Stats parameters.
@@ -11395,7 +11435,7 @@ Parameters:
- idfrom
@@ -11412,7 +11452,33 @@ Parameters:
- Resource Server ID.
+ The first day in YYYYMMDD format.
+
+
+
+
+
+
+
+
+ to
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The last day in YYYYMMDD format.
@@ -11507,12 +11573,17 @@ Returns:
Example
- management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+ var params = {
+ from: '{YYYYMMDD}', // First day included in the stats.
+ to: '{YYYYMMDD}' // Last day included in the stats.
+};
+
+management.getDaily(params, function (err, stats) {
if (err) {
// Handle error.
}
- console.log(resourceServer);
+ console.log(stats);
});
@@ -11524,14 +11595,14 @@ Example
- getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+ getDeviceCredentials(cbopt) → {Promise|undefined}
- Get all resource servers.
+ Get all Auth0 credentials.
@@ -11567,7 +11638,7 @@ get
Source:
Parameters:
- paramscb
-Object
+function
@@ -11640,226 +11711,79 @@ Parameters:
- Resource Servers parameters.
+ Callback function.
-
+
+
-
-
-
-
- Name
-
+
+
+
- Type
-
- Attributes
-
-
- Description
-
-
-
-
-
-
- per_page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
+
+Returns:
-
+
-
-
- page
+ -
+ Type:
+
+ -
+
+
Promise
+|
-
-
-
-Number
+undefined
-
-
+
+
-
-
-
- <optional>
-
-
+
+
-
-
-
-
-
- Page number, zero indexed.
-
-
-
+
+Example
+
+ management.getDeviceCredentials(function (err, credentials) {
+ console.log(credentials.length);
+});
+
+
+
+
+
+
+
-
-
-
-
-
+ getEmailProvider(cbopt, paramsopt) → {Promise|undefined}
-
-
- 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);
-});
-
-
-
-
-
-
-
-
-
-
- getRule(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get an Auth0 rule.
-
+
+ Get the email provider.
+
@@ -11894,7 +11818,7 @@ getRuleSource:
Parameters:
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
paramsParameters:
+ <optional>
+
@@ -11965,7 +11927,7 @@ Parameters:
- Rule parameters.
+ Clients parameters.
@@ -11979,6 +11941,8 @@ Parameters:
Type
+ Attributes
+
@@ -11991,32 +11955,34 @@ Parameters:
- idfields
-String
+Number
+
+
+ <optional>
+
-
+
-
- Rule ID.
-
-
+
+
-
-
-
+
+
+ A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
@@ -12025,13 +11991,13 @@ Parameters:
- cbinclude_fields
-function
+Number
@@ -12052,7 +12018,15 @@ Parameters:
- Callback function.
+ true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
+
+
+
+
+
+
+
@@ -12103,12 +12077,8 @@ Returns:
Example
- management.getRule({ id: RULE_ID }, function (err, rule) {
- if (err) {
- // Handle error.
- }
-
- console.log(rule);
+ management.getEmailProvider(function (err, provider) {
+ console.log(provider.length);
});
@@ -12120,14 +12090,14 @@ Example
- getRules(paramsopt, cbopt) → {Promise|undefined}
+ getGuardianEnrollment(data, cbopt) → {Promise|undefined}
- Get all rules.
+ Get a single Guardian enrollment.
@@ -12163,7 +12133,7 @@ getRulesSource:
Parameters:
- paramsdata
@@ -12224,8 +12194,6 @@ Parameters:
- <optional>
-
@@ -12236,7 +12204,7 @@ Parameters:
- Rules parameters.
+ The Guardian enrollment data object.
@@ -12250,8 +12218,6 @@ Parameters:
Type
- Attributes
-
@@ -12264,70 +12230,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ The Guardian enrollment id.
@@ -12422,20 +12342,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 = {
- per_page: 10,
- page: 0
-};
-
-management.getRules(params, function (err, rules) {
- console.log(rules.length);
+ management.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ console.log(enrollment);
});
@@ -12447,14 +12355,14 @@ Example
- getRulesConfigs() → {Promise|undefined}
+ getGuardianEnrollments(data, cbopt) → {Promise|undefined}
- Get rules config.
+ Get a list of a user's Guardian enrollments.
@@ -12490,7 +12398,7 @@ getRul
Source:
getRul
+ Parameters:
+
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
+
+
+
-
-
- -
- Type:
-
- -
+
Name
-Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.getRulesConfigs(function (err, rulesConfigs) {
- if (err) {
- // Handle error.
- }
-
- // Get Rules Configs.
-});
-
+ Type
-
-
-
-
-
-
- getTenantSettings(cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get the tenant settings..
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
- Attributes
+
-
+
-
+ Description
+
+
+
-
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
- Parameters:
-
+
+ The user data object.
+
+
@@ -12642,8 +12483,6 @@ Parameters:
Type
- Attributes
-
@@ -12654,6 +12493,40 @@ Parameters:
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.getSettings(function (err, settings) {
- if (err) {
- // Handle error.
- }
-
- console.log(settings);
+ management.getGuardianEnrollments({ id: USER_ID }, function (err, enrollments) {
+ console.log(enrollments);
});
@@ -12751,14 +12620,14 @@ Example
- getUser(data, cbopt) → {Promise|undefined}
+ getJob(params, cbopt) → {Promise|undefined}
- Get a user by its id.
+ Get a job by its ID.
@@ -12794,7 +12663,7 @@ getUserSource:
Parameters:
- dataparams
@@ -12865,7 +12734,7 @@ Parameters:
- The user data object.
+ Job parameters.
@@ -12908,7 +12777,7 @@ Parameters:
- The user id.
+ Job ID.
@@ -13003,8 +12872,17 @@ Returns:
Example
- management.getUser({ id: USER_ID }, function (err, user) {
- console.log(user);
+ var params = {
+ id: '{JOB_ID}'
+};
+
+management.getJob(params, function (err, job) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Retrieved job.
+ console.log(job);
});
@@ -13016,14 +12894,14 @@ Example
- getUserLogs(params, cbopt) → {Promise|undefined}
+ getLog(params, cbopt) → {Promise|undefined}
- Get user's log events.
+ Get an Auth0 log.
@@ -13059,7 +12937,7 @@ getUserLog
Source:
Parameters:
- Get logs data.
+ Log parameters.
@@ -13173,7 +13051,15 @@ Parameters:
- User id.
+ Event ID.
+
+
+
+
+
+
+
+
@@ -13182,24 +13068,2952 @@ Parameters:
- per_pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Number of results per page.
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getLog({ id: EVENT_ID }, function (err, log) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(log);
+});
+
+
+
+
+
+
+
+
+
+
+ getLogs(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all logs.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Logs params.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ q
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Search Criteria using Query String Syntax
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number. Zero based
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The amount of entries per page
+
+
+
+
+
+
+
+
+ sort
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The field to use for sorting.
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 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);
+});
+
+
+
+
+
+
+
+
+
+
+ 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);
+});
+
+
+
+
+
+
+
+
+
+
+ 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() → {Promise|undefined}
+
+
+
+
+
+
+ Get rules config.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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..
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getSettings(function (err, settings) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(settings);
+});
+
+
+
+
+
+
+
+
+
+
+ getUser(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a user by its id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - 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.getUser({ id: USER_ID }, function (err, user) {
+ console.log(user);
+});
+
+
+
+
+
+
+
+
+
+
+ getUserLogs(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get user's log events.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Get logs data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ User id.
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ sort
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+
+management.getUserLogs(params, function (err, logs) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logs);
+});
+
+
+
+
+
+
+
+
+
+
+ getUsers(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all users.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Users params.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ search_engine
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The version of the search engine to use.
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
@@ -13217,24 +16031,235 @@ Parameters:
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 = {
+ search_engine: 'v3',
+ per_page: 10,
+ page: 0
+};
+
+auth0.getUsers(params, function (err, users) {
+ console.log(users.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get users for a given email address
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
-
+
+ Attributes
+
-
+
-
- Page number, zero indexed.
-
-
-
+ Description
+
+
+
- sortemail
@@ -13247,45 +16272,21 @@ Parameters:
-
-
-
-
- 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
-
+ <optional>
-Boolean
+
-
-
-
+
+
- true if a query summary must be included in the result, false otherwise. Default false;
-
-
-
-
-
-
-
-
+ Email Address of users to locate
@@ -13372,14 +16373,13 @@ Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-
-management.getUserLogs(params, function (err, logs) {
- if (err) {
- // Handle error.
- }
-
- console.log(logs);
+
+ 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);
});
@@ -13391,14 +16391,15 @@ Example
- getUsers(paramsopt, cbopt) → {Promise|undefined}
+ importUsers(data, cbopt) → {Promise|undefined}
- Get all users.
+ Given a path to a file and a connection id, create a new job that imports the
+users contained in the file and associate them with the given connection.
@@ -13434,7 +16435,7 @@ getUsersSource:
Parameters:
- paramsdata
@@ -13495,8 +16496,6 @@ Parameters:
- <optional>
-
@@ -13507,7 +16506,7 @@ Parameters:
- Users params.
+ Users import data.
@@ -13521,8 +16520,6 @@ Parameters:
Type
- Attributes
-
@@ -13535,70 +16532,24 @@ Parameters:
- search_engine
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The version of the search engine to use.
-
-
-
-
-
-
-
-
- per_pageconnectionId
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Number of results per page.
+ Connection for the users insertion.
@@ -13607,34 +16558,24 @@ Parameters:
- pageusers
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ Path to the users data file.
@@ -13729,21 +16670,15 @@ 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',
- per_page: 10,
- page: 0
+ var params = {
+ connection_id: '{CONNECTION_ID}',
+ users: '{PATH_TO_USERS_FILE}'
};
-auth0.getUsers(params, function (err, users) {
- console.log(users.length);
+management.get(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
});
@@ -13755,14 +16690,14 @@ Example
- getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+ linkUsers(userId, params, cbopt) → {Promise|undefined}
- Get users for a given email address
+ Link the user with another account.
@@ -13798,7 +16733,7 @@ getUse
Source:
getUse
- Parameters:
-
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ userId
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ID of the primary user.
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Secondary user data.
+
+
@@ -13830,8 +16852,6 @@ Parameters:
Type
- Attributes
-
@@ -13844,7 +16864,7 @@ Parameters:
- emailuser_id
@@ -13857,21 +16877,45 @@ Parameters:
-
-
- <optional>
-
+
+
+
+ ID of the user to be linked.
+
+
+
+
+
+
+
+ connection_id
+
-
+String
+
+
+
+
+
- Email Address of users to locate
+ ID of the connection to be used.
+
+
+
+
+
+
+
+
@@ -13958,13 +17002,18 @@ 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 userId = 'USER_ID';
+var params = {
+ user_id: 'OTHER_USER_ID',
+ connection_id: 'CONNECTION_ID'
+};
+
+management.linkUsers(userId, params, function (err, user) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Users linked.
});
@@ -13976,15 +17025,14 @@ Example
- importUsers(data, cbopt) → {Promise|undefined}
+ regenerateRecoveryCode(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 and associate them with the given connection.
+ Generate new Guardian recovery code.
@@ -14020,7 +17068,7 @@ importUser
Source:
Parameters:
- Users import data.
+ The user data object.
@@ -14117,33 +17165,7 @@ Parameters:
- connectionId
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Connection for the users insertion.
-
-
-
-
-
-
-
-
- usersid
@@ -14160,7 +17182,7 @@ Parameters:
- Path to the users data file.
+ The user id.
@@ -14255,15 +17277,8 @@ Returns:
Example
- var params = {
- connection_id: '{CONNECTION_ID}',
- users: '{PATH_TO_USERS_FILE}'
-};
-
-management.get(params, function (err) {
- if (err) {
- // Handle error.
- }
+ management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
+ console.log(newRecoveryCode);
});
@@ -14275,14 +17290,14 @@ Example
- linkUsers(userId, params, cbopt) → {Promise|undefined}
+ sendEmailVerification(data, cbopt) → {Promise|undefined}
- Link the user with another account.
+ Send a verification email to a user.
@@ -14318,7 +17333,7 @@ linkUsersSource:
Parameters:
- userId
-
-
-String
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ID of the primary user.
-
-
-
-
-
-
-
-
- paramsdata
@@ -14423,7 +17404,7 @@ Parameters:
- Secondary user data.
+ User data object.
@@ -14466,33 +17447,7 @@ Parameters:
- ID of the user to be linked.
-
-
-
-
-
-
-
-
- connection_id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- ID of the connection to be used.
+ ID of the user to be verified.
@@ -14587,18 +17542,14 @@ Returns:
Example
- var userId = 'USER_ID';
-var params = {
- user_id: 'OTHER_USER_ID',
- connection_id: 'CONNECTION_ID'
+ var params = {
+ user_id: '{USER_ID}'
};
-management.linkUsers(userId, params, function (err, user) {
+management.sendEmailVerification(function (err) {
if (err) {
// Handle error.
}
-
- // Users linked.
});
@@ -14610,14 +17561,14 @@ Example
- regenerateRecoveryCode(data, cbopt) → {Promise|undefined}
+ setRulesConfig(params, data, cbopt) → {Promise|undefined}
- Generate new Guardian recovery code.
+ Set a new rules config.
@@ -14653,7 +17604,7 @@ Source:
Parameters:
-
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rule Config parameters.
+
+
@@ -14685,8 +17689,6 @@ Parameters:
Type
- Attributes
-
@@ -14697,6 +17699,40 @@ Parameters:
+
+
+ key
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule Config key.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
dataParameters:
- The user data object.
+ Rule Config Data parameters.
@@ -14750,7 +17786,7 @@ Parameters:
- idvalue
@@ -14767,7 +17803,7 @@ Parameters:
- The user id.
+ Rule Config Data value.
@@ -14862,8 +17898,15 @@ Returns:
Example
- management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
- console.log(newRecoveryCode);
+ var params = { key: RULE_CONFIG_KEY };
+var data = { value: RULES_CONFIG_VALUE };
+
+management.setRulesConfig(params, data, function (err, rulesConfig) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Rules Config set.
});
@@ -14875,14 +17918,14 @@ Example
- sendEmailVerification(data, cbopt) → {Promise|undefined}
+ unlinkUsers(params, cbopt) → {Promise|undefined}
- Send a verification email to a user.
+ Unlink the given accounts.
@@ -14918,7 +17961,7 @@
Source:
Parameters:
- dataparams
@@ -14989,7 +18032,7 @@ Parameters:
- User data object.
+ Linked users data.
@@ -15013,6 +18056,58 @@ Parameters:
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Primary user ID.
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Identity provider in use.
+
+
+
+
+
+
user_idParameters:
- ID of the user to be verified.
+ Secondary user ID.
@@ -15127,14 +18222,14 @@ Returns:
Example
- var params = {
- user_id: '{USER_ID}'
-};
+ var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
-management.sendEmailVerification(function (err) {
+management.unlinkUsers(params, function (err, user) {
if (err) {
// Handle error.
}
+
+ // Users accounts unlinked.
});
@@ -15146,14 +18241,14 @@ Example
- setRulesConfig(params, data, cbopt) → {Promise|undefined}
+ updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
- Set a new rules config.
+ Update the app metadata for a user.
@@ -15189,7 +18284,7 @@ setRule
Source:
Parameters:
- Rule Config parameters.
+ The user data object..
@@ -15286,7 +18381,7 @@ Parameters:
- keyid
@@ -15303,7 +18398,7 @@ Parameters:
- Rule Config key.
+ The user id.
@@ -15320,7 +18415,7 @@ Parameters:
- datametadata
@@ -15345,58 +18440,7 @@ Parameters:
- Rule Config Data parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- value
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Rule Config Data value.
-
-
-
-
-
-
-
-
+ New app metadata.
@@ -15432,7 +18476,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -15483,15 +18527,18 @@ Returns:
Example
- var params = { key: RULE_CONFIG_KEY };
-var data = { value: RULES_CONFIG_VALUE };
+ var params = { id: USER_ID };
+var metadata = {
+ foo: 'bar'
+};
-management.setRulesConfig(params, data, function (err, rulesConfig) {
+management.updateAppMetadata(params, metadata, function (err, user) {
if (err) {
// Handle error.
}
- // Rules Config set.
+ // Updated user.
+ console.log(user);
});
@@ -15503,14 +18550,14 @@ Example
- unlinkUsers(params, cbopt) → {Promise|undefined}
+ updateClient(params, data, cbopt) → {Promise|undefined}
- Unlink the given accounts.
+ Update an Auth0 client.
@@ -15546,7 +18593,7 @@ unlinkUser
Source:
Parameters:
- Linked users data.
+ Client parameters.
@@ -15643,7 +18690,7 @@ Parameters:
- idclient_id
@@ -15660,33 +18707,15 @@ Parameters:
- Primary user ID.
+ Application client ID.
+
+
-
-
- provider
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Identity provider in use.
@@ -15695,32 +18724,32 @@ Parameters:
- user_iddata
-String
+Object
+
+
+
+
+
+
+
+
- Secondary user ID.
-
-
-
-
-
-
-
-
+ Updated client data.
@@ -15807,14 +18836,15 @@ Returns:
Example
- var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
+ var data = { name: 'newClientName' };
+var params = { client_id: CLIENT_ID };
-management.unlinkUsers(params, function (err, user) {
+management.updateClient(params, data, function (err, client) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ console.log(client.name); // 'newClientName'
});
@@ -15826,14 +18856,14 @@ Example
- updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
+ updateClientGrant(params, data, cbopt) → {Promise|undefined}
- Update the app metadata for a user.
+ Update an Auth0 client grant.
@@ -15869,7 +18899,7 @@ upda
Source:
Parameters:
- The user data object..
+ Client parameters.
@@ -15983,7 +19013,7 @@ Parameters:
- The user id.
+ Client grant ID.
@@ -16000,7 +19030,7 @@ Parameters:
- metadatadata
@@ -16025,7 +19055,7 @@ Parameters:
- New app metadata.
+ Updated client data.
@@ -16061,7 +19091,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -16112,18 +19142,19 @@ Returns:
Example
- var params = { id: USER_ID };
-var metadata = {
- foo: 'bar'
+ var data = {
+ client_id: CLIENT_ID,
+ audience: AUDIENCE,
+ scope: []
};
+var params = { id: CLIENT_GRANT_ID };
-management.updateAppMetadata(params, metadata, function (err, user) {
+management.clientGrants.update(params, data, function (err, grant) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+ console.log(grant.id);
});
@@ -16135,14 +19166,14 @@ Example
- updateClient(params, data, cbopt) → {Promise|undefined}
+ updateConnection(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client.
+ Update an existing connection.
@@ -16178,7 +19209,7 @@ updateCli
Source:
Parameters:
- Client parameters.
+ Connection parameters.
@@ -16275,7 +19306,7 @@ Parameters:
- client_idid
@@ -16292,7 +19323,7 @@ Parameters:
- Application client ID.
+ Connection ID.
@@ -16334,7 +19365,7 @@ Parameters:
- Updated client data.
+ Updated connection data.
@@ -16421,15 +19452,15 @@ Returns:
Example
- var data = { name: 'newClientName' };
-var params = { client_id: CLIENT_ID };
+ var data = { name: 'newConnectionName' };
+var params = { id: CONNECTION_ID };
-management.updateClient(params, data, function (err, client) {
+management.updateConnection(params, data, function (err, connection) {
if (err) {
// Handle error.
}
- console.log(client.name); // 'newClientName'
+ console.log(connection.name); // 'newConnectionName'
});
@@ -16441,14 +19472,14 @@ Example
- updateConnection(params, data, cbopt) → {Promise|undefined}
+ updateEmailProvider(params, data, cbopt) → {Promise|undefined}
- Update an existing connection.
+ Update the email provider.
@@ -16484,7 +19515,7 @@ updat
Source:
Parameters:
- Connection parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Connection ID.
-
-
-
-
-
-
-
-
+ Email provider parameters.
@@ -16640,7 +19620,7 @@ Parameters:
- Updated connection data.
+ Updated email provider data.
@@ -16727,15 +19707,13 @@ Returns:
Example
- var data = { name: 'newConnectionName' };
-var params = { id: CONNECTION_ID };
-
-management.updateConnection(params, data, function (err, connection) {
+ management.updateEmailProvider(params, data, function (err, provider) {
if (err) {
// Handle error.
}
- console.log(connection.name); // 'newConnectionName'
+ // Updated email provider.
+ console.log(provider);
});
@@ -16747,14 +19725,14 @@ Example
- updateEmailProvider(params, data, cbopt) → {Promise|undefined}
+ updateResourceServer(params, data, cbopt) → {Promise|undefined}
- Update the email provider.
+ Update an existing resource server.
@@ -16790,7 +19768,7 @@ up
Source:
Parameters:
- Email provider parameters.
+ Resource Server parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Resource Server ID.
+
+
+
+
+
+
+
+
@@ -16895,7 +19924,7 @@ Parameters:
- Updated email provider data.
+ Updated Resource Server data.
@@ -16982,13 +20011,15 @@ Returns:
Example
- management.updateEmailProvider(params, data, function (err, provider) {
+ var data = { name: 'newResourceServerName' };
+var params = { id: RESOURCE_SERVER_ID };
+
+management.updateResourceServer(params, data, function (err, resourceServer) {
if (err) {
// Handle error.
}
- // Updated email provider.
- console.log(provider);
+ console.log(resourceServer.name); // 'newResourceServerName'
});
@@ -17000,14 +20031,14 @@ Example
- updateResourceServer(params, data, cbopt) → {Promise|undefined}
+ updateRule(params, data, cbopt) → {Promise|undefined}
- Update an existing resource server.
+ Update an existing rule.
@@ -17043,7 +20074,7 @@ u
Source:
Parameters:
- Resource Server parameters.
+ Rule parameters.
@@ -17157,7 +20188,7 @@ Parameters:
- Resource Server ID.
+ Rule ID.
@@ -17199,7 +20230,7 @@ Parameters:
- Updated Resource Server data.
+ Updated rule data.
@@ -17286,15 +20317,14 @@ Returns:
Example
- var data = { name: 'newResourceServerName' };
-var params = { id: RESOURCE_SERVER_ID };
-
-management.updateResourceServer(params, data, function (err, resourceServer) {
+ var params = { id: RULE_ID };
+var data = { name: 'my-rule'};
+management.updateRule(params, data, function (err, rule) {
if (err) {
// Handle error.
}
- console.log(resourceServer.name); // 'newResourceServerName'
+ console.log(rule.name); // 'my-rule'.
});
@@ -17306,14 +20336,14 @@ Example
- updateRule(params, data, cbopt) → {Promise|undefined}
+ updateTenantSettings(data, cbopt) → {Promise|undefined}
- Update an existing rule.
+ Update the tenant settings.
@@ -17340,89 +20370,36 @@ updateRule<
-
-
-
-
-
-
-
- Source:
- Parameters:
-
-
-
-
-
-
- Name
-
+
- Type
+
-
- Attributes
-
+
-
+
+ Source:
+ Description
-
-
+
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
- Rule parameters.
-
-
+
+ Parameters:
+
@@ -17434,6 +20411,8 @@ Parameters:
Type
+ Attributes
+
@@ -17444,40 +20423,6 @@ Parameters:
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Rule ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
dataParameters:
- Updated rule data.
+ The new tenant settings.
@@ -17592,14 +20537,10 @@ Returns:
Example
- var params = { id: RULE_ID };
-var data = { name: 'my-rule'};
-management.updateRule(params, data, function (err, rule) {
+ management.updateTenantSettings(data, function (err) {
if (err) {
// Handle error.
}
-
- console.log(rule.name); // 'my-rule'.
});
@@ -17611,14 +20552,14 @@ Example
- updateTenantSettings(data, cbopt) → {Promise|undefined}
+ updateUser(params, data, cbopt) → {Promise|undefined}
- Update the tenant settings.
+ Update a user by its id.
@@ -17654,7 +20595,7 @@ u
Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The user parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
dataParameters:
- The new tenant settings.
+ New user data.
@@ -17761,7 +20787,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -17812,10 +20838,15 @@ Returns:
Example
- management.updateTenantSettings(data, function (err) {
+ var params = { id: USER_ID };
+
+management.updateUser(params, data, function (err, user) {
if (err) {
// Handle error.
}
+
+ // Updated user.
+ console.log(user);
});
@@ -17827,14 +20858,14 @@ Example
- updateUser(params, data, cbopt) → {Promise|undefined}
+ updateUserMetadata(params, metadata, cbopt) → {Promise|undefined}
- Update a user by its id.
+ Update the user metadata for a user.
@@ -17870,7 +20901,7 @@ updateUser<
Source:
Parameters:
- The user parameters.
+ The user data object..
@@ -18001,7 +21032,7 @@ Parameters:
- datametadata
@@ -18026,7 +21057,7 @@ Parameters:
- New user data.
+ New user metadata.
@@ -18114,8 +21145,11 @@ Returns:
Example
var params = { id: USER_ID };
+var metadata = {
+ address: '123th Node.js Street'
+};
-management.updateUser(params, data, function (err, user) {
+management.updateUserMetadata(params, metadata, function (err, user) {
if (err) {
// Handle error.
}
@@ -18133,14 +21167,14 @@ Example
- updateUserMetadata(params, metadata, cbopt) → {Promise|undefined}
+ verifyCustomDomain(params, cbopt) → {Promise|undefined}
- Update the user metadata for a user.
+ Verify a Custom Domain.
@@ -18176,7 +21210,7 @@ upd
Source:
Parameters:
- The user data object..
+ Custom Domain parameters.
@@ -18290,7 +21324,7 @@ Parameters:
- The user id.
+ Custom Domain ID.
@@ -18305,40 +21339,6 @@ Parameters:
-
-
- metadata
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- New user metadata.
-
-
-
-
-
-
cbParameters:
- Callback function
+ Callback function.
@@ -18419,18 +21419,12 @@ Returns:
Example
- var params = { id: USER_ID };
-var metadata = {
- address: '123th Node.js Street'
-};
-
-management.updateUserMetadata(params, metadata, function (err, user) {
+ management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+ console.log(customDomain);
});
@@ -18454,7 +21448,7 @@ Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 98a360c74..ff9ee87b1 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.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 0c021904e..506dcf254 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 482cb0539..7088c566b 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.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 4a371256c..502ae2f83 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 c81f2d396..b7640c53a 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 d73bbea41..ce9e4385a 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 527516334..c659e73ae 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -835,7 +835,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6cc15b131..ccc194f35 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.UsersManager.html b/docs/module-management.UsersManager.html
index 4a29c2bcb..33658deef 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5075,7 +5075,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 24524f386..138034ca4 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -150,7 +150,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index c703086b0..0a882f6e8 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -339,7 +339,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index e1092abfd..c1d593455 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -124,7 +124,7 @@ utils.js
diff --git a/package.json b/package.json
index da7529028..80138069b 100644
--- a/package.json
+++ b/package.json
@@ -1,16 +1,16 @@
{
"name": "auth0",
- "version": "2.14.0",
+ "version": "2.15.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
- "files": [
- "src"
- ],
+ "files": ["src"],
"scripts": {
"test": "mocha -R spec ./test/**/*.tests.js ./test/*.tests.js",
- "test:ci": "istanbul cover _mocha --report lcovonly -R $(find ./test -name *.tests.js) -- -R mocha-multi --reporter-options spec=-,mocha-junit-reporter=-",
+ "test:ci":
+ "istanbul cover _mocha --report lcovonly -R $(find ./test -name *.tests.js) -- -R mocha-multi --reporter-options spec=-,mocha-junit-reporter=-",
"test:coverage": "codecov",
- "test:watch": "cross-env NODE_ENV=test mocha --timeout 5000 ./test/**/*.tests.js ./test/*.tests.js --watch",
+ "test:watch":
+ "cross-env NODE_ENV=test mocha --timeout 5000 ./test/**/*.tests.js ./test/*.tests.js --watch",
"jsdoc:generate": "jsdoc --configure .jsdoc.json --verbose",
"release:clean": "node scripts/cleanup.js",
"preversion": "node scripts/prepare.js",
@@ -22,10 +22,7 @@
"type": "git",
"url": "https://github.com/auth0/node-auth0"
},
- "keywords": [
- "auth0",
- "api"
- ],
+ "keywords": ["auth0", "api"],
"author": "Auth0",
"license": "MIT",
"bugs": {
diff --git a/docs/index.html b/docs/index.html
index 284900d46..35675c193 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -24,7 +24,7 @@
@@ -151,7 +151,7 @@ License
This project is licensed under the MIT license. See the
diff --git a/docs/index.js.html b/docs/index.js.html
index 1c8d473a0..9e941863c 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 48fdcb021..57186a500 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_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index 02d124357..090f03820 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 ee848a5a2..c8a415528 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 15c95b0b1..70edd7e7a 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@ management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index 09e419d59..8940d287b 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 f5dc2e012..9f64551f5 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 38f961049..276f60672 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -132,7 +132,10 @@ management/EmailProviderManager.js
* });
*
* @param {Function} [cb] Callback function.
- *
+ * @param {Object} [params] Clients parameters.
+ * @param {Number} [params.fields] A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
+ * @param {Number} [params.include_fields] true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(EmailProviderManager, 'get', 'resource.getAll');
@@ -195,7 +198,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index b926f4b92..1d5725300 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_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index fd969d25b..3afa11710 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 0b1a0388d..409665611 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -98,6 +98,19 @@ management/JobsManager.js
options.tokenProvider
);
this.jobs = new RetryRestClient(auth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for consuming the
+ * {@link https://auth0.com/docs/api/v2#!/Jobs/post_users_exports Create job to export users endpoint}
+ *
+ * @type {external:RestClient}
+ */
+ const usersExportsRestClient = new Auth0RestClient(
+ options.baseUrl + '/jobs/users-exports',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.usersExports = new RetryRestClient(usersExportsRestClient, options.retry);
};
/**
@@ -155,7 +168,7 @@ management/JobsManager.js
* send_completion_email: false //optional
* };
*
- * management.jobs.get(params, function (err) {
+ * management.jobs.importUsers(params, function (err) {
* if (err) {
* // Handle error.
* }
@@ -235,6 +248,63 @@ management/JobsManager.js
return promise;
};
+/**
+ * Export all users to a file using a long running job.
+ *
+ * @method exportUsers
+ * @memberOf module:management.JobsManager.prototype
+ *
+ * @example
+ * var data = {
+ * connection_id: 'con_0000000000000001',
+ * format: 'csv',
+ * limit: 5,
+ * fields: [
+ * {
+ * "name": "user_id"
+ * },
+ * {
+ * "name": "name"
+ * },
+ * {
+ * "name": "email"
+ * },
+ * {
+ * "name": "identities[0].connection",
+ * "export_as": "provider"
+ * },
+ * {
+ * "name": "user_metadata.some_field"
+ * }
+ * ]
+ * }
+ *
+ * management.jobs.exportUsers(data, function (err, results) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Retrieved job.
+ * console.log(results);
+ * });
+ *
+ * @param {Object} data Users export data.
+ * @param {String} [data.connection_id] The connection id of the connection from which users will be exported
+ * @param {String} [data.format] The format of the file. Valid values are: "json" and "csv".
+ * @param {Number} [data.limit] Limit the number of records.
+ * @param {Object[]} [data.fields] A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+JobsManager.prototype.exportUsers = function(data, cb) {
+ if (cb && cb instanceof Function) {
+ return this.usersExports.create(data, cb);
+ }
+
+ return this.usersExports.create(data);
+};
+
/**
* Send a verification email to a user.
*
@@ -284,7 +354,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 6c9f5b9ea..02b71be8d 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 2b5b18db8..61a6fa94b 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
@@ -189,7 +189,7 @@ management/ManagementTokenProvider.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index 3cfaa5da4..fafbb3aca 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_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index 18de21ac5..439658b62 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
@@ -179,7 +179,7 @@ management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 8f51c048f..93eae695b 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 aff6e68c8..6ef638d33 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 2a14fe60a..25f65f66b 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
@@ -161,7 +161,7 @@ management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index ce0b83bb6..03451ef26 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_UsersManager.js.html b/docs/management_UsersManager.js.html
index 76adaeaa4..e09e07ad9 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -677,7 +677,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index 9e4daa584..a94ca9567 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -599,8 +599,8 @@ management/index.js
/**
* Get all Auth0 Client Grants.
*
- * @method getAll
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method getClientGrants
+ * @memberOf module:management.ManagementClient.prototype
*
* @example <caption>
* This method takes an optional object as first argument that may be used to
@@ -630,8 +630,8 @@ management/index.js
/**
* Create an Auth0 client grant.
*
- * @method create
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method createClientGrant
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.clientGrants.create(data, function (err) {
@@ -652,8 +652,8 @@ management/index.js
/**
* Update an Auth0 client grant.
*
- * @method update
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method updateClientGrant
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* var data = {
@@ -683,8 +683,8 @@ management/index.js
/**
* Delete an Auth0 client grant.
*
- * @method delete
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method deleteClientGrant
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.clientGrants.delete({ id: GRANT_ID }, function (err) {
@@ -1430,7 +1430,10 @@ management/index.js
* });
*
* @param {Function} [cb] Callback function.
- *
+ * @param {Object} [params] Clients parameters.
+ * @param {Number} [params.fields] A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
+ * @param {Number} [params.include_fields] true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(ManagementClient, 'getEmailProvider', 'emailProvider.get');
@@ -1649,6 +1652,57 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'importUsers', 'jobs.importUsers');
+/**
+ * Export all users to a file using a long running job.
+ *
+ * @method exportUsers
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var data = {
+ * connection_id: 'con_0000000000000001',
+ * format: 'csv',
+ * limit: 5,
+ * fields: [
+ * {
+ * "name": "user_id"
+ * },
+ * {
+ * "name": "name"
+ * },
+ * {
+ * "name": "email"
+ * },
+ * {
+ * "name": "identities[0].connection",
+ * "export_as": "provider"
+ * },
+ * {
+ * "name": "user_metadata.some_field"
+ * }
+ * ]
+ * }
+ *
+ * management.exportUsers(data, function (err, results) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Retrieved job.
+ * console.log(results);
+ * });
+ *
+ * @param {Object} data Users export data.
+ * @param {String} [data.connection_id] The connection id of the connection from which users will be exported
+ * @param {String} [data.format] The format of the file. Valid values are: "json" and "csv".
+ * @param {Number} [data.limit] Limit the number of records.
+ * @param {Object[]} [data.fields] A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'exportUsers', 'jobs.exportUsers');
+
/**
* Send a verification email to a user.
*
@@ -1982,8 +2036,8 @@ management/index.js
/**
* Create an Auth0 Custom Domain.
*
- * @method create
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method createCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.createCustomDomain(data, function (err) {
@@ -2004,8 +2058,8 @@ management/index.js
/**
* Get all Auth0 CustomDomains.
*
- * @method getAll
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method getCustomDomains
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.getCustomDomains(function (err, customDomains) {
@@ -2019,8 +2073,8 @@ management/index.js
/**
* Get a Custom Domain.
*
- * @method get
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method getCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
@@ -2042,8 +2096,8 @@ management/index.js
/**
* Verify a Custom Domain.
*
- * @method verify
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method verifyCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
@@ -2065,8 +2119,8 @@ management/index.js
/**
* Delete a Custom Domain.
*
- * @method delete
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method deleteCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
@@ -2089,7 +2143,7 @@ management/index.js
* Create a Guardian enrollment ticket.
*
* @method createGuardianEnrollmentTicket
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.createGuardianEnrollmentTicket(function (err, ticket) {
@@ -2110,7 +2164,7 @@ management/index.js
* Get a list of Guardian factors and statuses.
*
* @method getGuardianFactors
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.getGuardianFactors(function (err, factors) {
* console.log(factors.length);
@@ -2126,7 +2180,7 @@ management/index.js
* Get Guardian factor provider configuration
*
* @method getGuardianFactorProvider
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
* console.log(provider);
@@ -2147,7 +2201,7 @@ management/index.js
* Update Guardian's factor provider
*
* @method updateFactorProvider
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
* messaging_service_sid: 'XXXXXXXXXXXXXX',
@@ -2173,7 +2227,7 @@ management/index.js
* Get Guardian enrollment and verification factor templates
*
* @method getGuardianFactorTemplates
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
* console.log(templates);
@@ -2194,7 +2248,7 @@ management/index.js
* Update Guardian enrollment and verification factor templates
*
* @method updateGuardianFactorTemplates
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.updateGuardianFactorTemplates({ name: 'sms' }, {
* enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
@@ -2219,7 +2273,7 @@ management/index.js
* Update Guardian Factor
*
* @method updateGuardianFactor
- * @memberOf module.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.updateGuardianFactor({ name: 'sms' }, {
* enabled: true
@@ -2248,7 +2302,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index fb612176b..3759ff8a2 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -3894,7 +3894,7 @@ Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index b7b29e7b2..64f95eedb 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1590,7 +1590,7 @@ Parameters:
-Stinrg
+String
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index 8697b3777..f161a65ee 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
@@ -101,7 +101,7 @@ Source:
Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 1a653544b..9aec2c527 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1796,7 +1796,7 @@ Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index e81cdc6c4..e20079a2c 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@ Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index 97a1daf27..c01be4808 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 1b625dd20..f35ae1e47 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 249e89209..cc295c8ec 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-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 0451d5674..094d54110 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.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index dee679a9a..a14a07f8c 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -717,1097 +717,14 @@ Example
- create(data, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Create an Auth0 client grant.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The client data object.
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.clientGrants.create(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Client grant created.
-});
-
-
-
-
-
-
-
-
-
-
- delete(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Delete an Auth0 client grant.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Client parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Client grant ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.clientGrants.delete({ id: GRANT_ID }, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Grant deleted.
-});
-
-
-
-
-
-
-
-
-
-
- delete(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Delete an Auth0 client grant.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Client parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Client grant ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.clientGrants.delete({ id: GRANT_ID }, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Grant deleted.
-});
-
-
-
-
-
-
-
-
-
-
- getAll(paramsopt, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get all Auth0 Client Grants.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Client Grants 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.getClientGrants(params, function (err, grants) {
- console.log(grants.length);
-});
-
-
-
-
-
-
-
-
-
-
- getAll(paramsopt, cbopt) → {Promise|undefined}
+ delete(params, cbopt) → {Promise|undefined}
- Get all Auth0 Client Grants.
+ Delete an Auth0 client grant.
@@ -1843,7 +760,7 @@ getAllSource:
Parameters:
- <optional>
-
@@ -1916,7 +831,7 @@ Parameters:
- Client Grants parameters.
+ Client parameters.
@@ -1930,8 +845,6 @@ Parameters:
Type
- Attributes
-
@@ -1944,70 +857,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ Client grant ID.
@@ -2102,21 +969,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.clientGrants.delete({ id: GRANT_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
-management.clientGrants.getAll(params, function (err, grants) {
- console.log(grants.length);
+ // Grant deleted.
});
@@ -2128,14 +986,14 @@ Example
- update(params, data, cbopt) → {Promise|undefined}
+ getAll(paramsopt, cbopt) → {Promise|undefined}
- Update an Auth0 client grant.
+ Get all Auth0 Client Grants.
@@ -2171,7 +1029,7 @@ updateSource:
Parameters:
+ <optional>
+
@@ -2242,7 +1102,7 @@ Parameters:
- Client parameters.
+ Client Grants parameters.
@@ -2256,6 +1116,8 @@ Parameters:
Type
+ Attributes
+
@@ -2268,32 +1130,34 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
-
+
-
- Client grant ID.
-
-
+
+
-
-
-
+
+
+ Number of results per page.
@@ -2302,13 +1166,13 @@ Parameters:
- datapage
-Object
+Number
@@ -2317,6 +1181,8 @@ Parameters:
+ <optional>
+
@@ -2327,7 +1193,15 @@ Parameters:
- Updated client data.
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
@@ -2414,19 +1288,21 @@ Returns:
Example
- var data = {
- client_id: CLIENT_ID,
- audience: AUDIENCE,
- scope: []
+
+ 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: CLIENT_GRANT_ID };
-management.clientGrants.update(params, data, function (err, grant) {
- if (err) {
- // Handle error.
- }
- console.log(grant.id);
+management.clientGrants.getAll(params, function (err, grants) {
+ console.log(grants.length);
});
@@ -2760,7 +1636,7 @@ Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 02612947b..0b77f92d1 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 7ebfbcc77..c6a8da76d 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@ Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 6c4def656..c61671616 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
@@ -792,224 +792,6 @@ Example
-
-
-
-
- create(data, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Create an Auth0 Custom Domain.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The custom domain data object.
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.createCustomDomain(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // CustomDomain created.
-});
-
-
-
-
-
-
@@ -1057,7 +839,7 @@ deleteSource:
Returns:
Example
- management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ management.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -1283,14 +1065,14 @@ Example
- delete(params, cbopt) → {Promise|undefined}
+ get(params, cbopt) → {Promise|undefined}
- Delete a Custom Domain.
+ Get a Custom Domain.
@@ -1326,7 +1108,7 @@ deleteSource:
Returns:
Example
- management.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ management.customDomains.get({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
if (err) {
// Handle error.
}
- // CustomDomain deleted.
+ console.log(customDomain);
});
@@ -1552,14 +1334,14 @@ Example
- get(params, cbopt) → {Promise|undefined}
+ getAll() → {Promise|undefined}
- Get a Custom Domain.
+ Get all Auth0 CustomDomains.
@@ -1595,7 +1377,7 @@ getSource:
get
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Custom Domain parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Custom Domain ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
- if (err) {
- // Handle error.
- }
-
- console.log(customDomain);
-});
-
-
-
-
-
-
-
-
-
-
- get(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get a Custom Domain.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Custom Domain parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Custom Domain ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.customDomains.get({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
- if (err) {
- // Handle error.
- }
-
- console.log(customDomain);
-});
-
-
-
-
-
-
-
-
-
-
- getAll() → {Promise|undefined}
-
-
-
-
-
-
- Get all Auth0 CustomDomains.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.getCustomDomains(function (err, customDomains) {
- console.log(customDomains.length);
-});
-
-
-
-
-
-
-
-
-
-
- getAll() → {Promise|undefined}
-
-
-
-
-
-
- Get all Auth0 CustomDomains.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.customDomains.getAll(function (err, customDomains) {
- console.log(customDomains.length);
-});
-
-
-
-
-
-
-
-
-
-
- verify(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Verify a Custom Domain.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Custom Domain parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Custom Domain ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
@@ -2574,12 +1437,8 @@ Returns:
Example
- management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
- if (err) {
- // Handle error.
- }
-
- console.log(customDomain);
+ management.customDomains.getAll(function (err, customDomains) {
+ console.log(customDomains.length);
});
@@ -2872,7 +1731,7 @@ Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index 01d6666b7..c87bb56fc 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 52441ed0a..530ab5dcb 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -759,7 +759,7 @@ deleteSource:
Example
- get(cbopt) → {Promise|undefined}
+ get(cbopt, paramsopt) → {Promise|undefined}
@@ -1022,6 +1022,141 @@ Parameters:
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Clients parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ fields
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
+
+
+
+
+
+
+
+
+ include_fields
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1123,7 +1258,7 @@ updateSource:
Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index 2495916b4..ecaea5ef5 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.GuardianManager.html b/docs/module-management.GuardianManager.html
index eff768fda..59e6fb9d8 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -894,186 +894,6 @@ Example
-
-
-
-
- createGuardianEnrollmentTicket(cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Create a Guardian enrollment ticket.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.createGuardianEnrollmentTicket(function (err, ticket) {
- console.log(ticket);
-});
-
-
-
-
-
-
@@ -1620,7 +1440,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index a17cf8ff0..a8d359bf4 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -391,6 +391,81 @@ (inner)
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner, constant) usersExportsRestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the
+Create job to export users endpoint
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
@@ -419,6 +494,420 @@ Methods
+
+
+
+
+ exportUsers(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Export all users to a file using a long running job.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Users export data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ connection_id
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The connection id of the connection from which users will be exported
+
+
+
+
+
+
+
+
+ format
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The format of the file. Valid values are: "json" and "csv".
+
+
+
+
+
+
+
+
+ limit
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Limit the number of records.
+
+
+
+
+
+
+
+
+ fields
+
+
+Array.<Object>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var data = {
+ connection_id: 'con_0000000000000001',
+ format: 'csv',
+ limit: 5,
+ fields: [
+ {
+ "name": "user_id"
+ },
+ {
+ "name": "name"
+ },
+ {
+ "name": "email"
+ },
+ {
+ "name": "identities[0].connection",
+ "export_as": "provider"
+ },
+ {
+ "name": "user_metadata.some_field"
+ }
+ ]
+}
+
+management.jobs.exportUsers(data, function (err, results) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Retrieved job.
+ console.log(results);
+});
+
+
+
+
+
+
@@ -466,7 +955,7 @@ getSource:
importUser
Source:
Example
send_completion_email: false //optional
};
-management.jobs.get(params, function (err) {
+management.jobs.importUsers(params, function (err) {
if (err) {
// Handle error.
}
@@ -1120,7 +1609,7 @@ verifyEmai
Source:
Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index a476b9d52..c022c6e50 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 bc804d928..843cb3828 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -2376,7 +2376,7 @@ Source:
Example
- createConnection(data, cbopt) → {Promise|undefined}
+ createClientGrant(data, cbopt) → {Promise|undefined}
- Create a new connection.
+ Create an Auth0 client grant.
@@ -2812,7 +2812,7 @@ creat
Source:
Parameters:
- Connection data object.
+ The client data object.
@@ -2970,12 +2970,12 @@ Returns:
Example
- management.createConnection(data, function (err) {
+ management.clientGrants.create(data, function (err) {
if (err) {
// Handle error.
}
- // Conection created.
+ // Client grant created.
});
@@ -2987,14 +2987,14 @@ Example
- createDevicePublicKey(data, cbopt) → {Promise|undefined}
+ createConnection(data, cbopt) → {Promise|undefined}
- Create an Auth0 credential.
+ Create a new connection.
@@ -3030,7 +3030,7 @@
Source:
Parameters:
- The device credential data object.
+ Connection data object.
@@ -3193,7 +3193,7 @@ Example
// Handle error.
}
- // Credential created.
+ // Conection created.
});
@@ -3205,14 +3205,14 @@ Example
- createEmailVerificationTicket(cbopt) → {Promise}
+ createCustomDomain(data, cbopt) → {Promise|undefined}
- Create an email verification ticket.
+ Create an Auth0 Custom Domain.
@@ -3248,7 +3248,7 @@ Source:
Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The custom domain data object.
+
+
+
+
+
+
cbReturns:
Promise
+|
+
+undefined
@@ -3369,15 +3406,12 @@ Returns:
Example
- var data = {
- user_id: '{USER_ID}',
- result_url: '{REDIRECT_URL}' // Optional redirect after the ticket is used.
-};
-
-auth0.createEmailVerificationTicket(data, function (err) {
+ management.createCustomDomain(data, function (err) {
if (err) {
// Handle error.
}
+
+ // CustomDomain created.
});
@@ -3389,14 +3423,14 @@ Example
- createPasswordChangeTicket(cbopt) → {Promise}
+ createDevicePublicKey(data, cbopt) → {Promise|undefined}
- Create a new password change ticket.
+ Create an Auth0 credential.
@@ -3432,7 +3466,7 @@ Source:
Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The device credential data object.
+
+
+
+
+
+
cbReturns:
Promise
+|
+
+undefined
@@ -3553,17 +3624,12 @@ Returns:
Example
- var params = {
- result_url: '{REDIRECT_URL}', // Redirect after using the ticket.
- user_id: '{USER_ID}', // Optional.
- email: '{USER_EMAIL}', // Optional.
- new_password: '{PASSWORD}'
-};
-
-auth0.createPasswordChangeTicket(params, function (err) {
+ management.createConnection(data, function (err) {
if (err) {
// Handle error.
}
+
+ // Credential created.
});
@@ -3575,14 +3641,14 @@ Example
- createResourceServer(data, cbopt) → {Promise|undefined}
+ createEmailVerificationTicket(cbopt) → {Promise}
- Create a new resource server.
+ Create an email verification ticket.
@@ -3618,7 +3684,7 @@ c
Source:
Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Resource Server data object.
-
-
-
-
-
-
cbReturns:
Promise
-|
-
-undefined
@@ -3776,12 +3805,15 @@ Returns:
Example
- management.createResourceServer(data, function (err) {
+ var data = {
+ user_id: '{USER_ID}',
+ result_url: '{REDIRECT_URL}' // Optional redirect after the ticket is used.
+};
+
+auth0.createEmailVerificationTicket(data, function (err) {
if (err) {
// Handle error.
}
-
- // Resource Server created.
});
@@ -3793,14 +3825,14 @@ Example
- createRule(data, cbopt) → {Promise|undefined}
+ createGuardianEnrollmentTicket(cbopt) → {Promise|undefined}
- Create a new rule.
+ Create a Guardian enrollment ticket.
@@ -3836,7 +3868,7 @@ createRule<
Source:
Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Rule data object.
-
-
-
-
-
-
cbReturns:
Example
- management.createRule(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Rule created.
+ management.createGuardianEnrollmentTicket(function (err, ticket) {
+ console.log(ticket);
});
@@ -4011,14 +4005,14 @@ Example
- createUser(data, cbopt) → {Promise|undefined}
+ createPasswordChangeTicket(cbopt) → {Promise}
- Create a new user.
+ Create a new password change ticket.
@@ -4054,7 +4048,7 @@ createUser<
Source:
Parameters:
-
-
- data
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- User data.
-
-
-
-
-
-
cbReturns:
Promise
-|
-
-undefined
@@ -4212,12 +4169,17 @@ Returns:
Example
- management.createUser(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // User created.
+ var params = {
+ result_url: '{REDIRECT_URL}', // Redirect after using the ticket.
+ user_id: '{USER_ID}', // Optional.
+ email: '{USER_EMAIL}', // Optional.
+ new_password: '{PASSWORD}'
+};
+
+auth0.createPasswordChangeTicket(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
});
@@ -4229,14 +4191,14 @@ Example
- deleteAllUsers(cbopt) → {Promise|undefined}
+ createResourceServer(data, cbopt) → {Promise|undefined}
- Delete all users.
+ Create a new resource server.
@@ -4260,8 +4222,6 @@ deleteA
- Deprecated: - This method will be removed in the next major release.
deleteA
Source:
Parameters:
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Resource Server data object.
+
+
+
+
+
+
cbParameters:
- Callback function
+ Callback function.
@@ -4398,12 +4392,12 @@ Returns:
Example
- management.deleteAllUsers(function (err) {
+ management.createResourceServer(data, function (err) {
if (err) {
// Handle error.
}
- // Users deleted
+ // Resource Server created.
});
@@ -4415,14 +4409,14 @@ Example
- deleteClient(params, cbopt) → {Promise|undefined}
+ createRule(data, cbopt) → {Promise|undefined}
- Delete an Auth0 client.
+ Create a new rule.
@@ -4458,7 +4452,7 @@ deleteCli
Source:
Parameters:
- paramsdata
@@ -4529,58 +4523,7 @@ Parameters:
- Client parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- client_id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Application client ID.
-
-
-
-
-
-
-
-
+ Rule data object.
@@ -4667,12 +4610,12 @@ Returns:
Example
- management.deleteClient({ client_id: CLIENT_ID }, function (err) {
+ management.createRule(data, function (err) {
if (err) {
// Handle error.
}
- // Client deleted.
+ // Rule created.
});
@@ -4684,14 +4627,14 @@ Example
- deleteConnection(params, cbopt) → {Promise|undefined}
+ createUser(data, cbopt) → {Promise|undefined}
- Delete an existing connection.
+ Create a new user.
@@ -4727,7 +4670,7 @@ delet
Source:
Parameters:
- paramsdata
@@ -4798,58 +4741,7 @@ Parameters:
- Connection parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Connection ID.
-
-
-
-
-
-
-
-
+ User data.
@@ -4936,12 +4828,12 @@ Returns:
Example
- management.deleteConnection({ id: CONNECTION_ID }, function (err) {
+ management.createUser(data, function (err) {
if (err) {
// Handle error.
}
- // Conection deleted.
+ // User created.
});
@@ -4953,14 +4845,14 @@ Example
- deleteDeviceCredential(params, cbopt) → {Promise|undefined}
+ deleteAllUsers(cbopt) → {Promise|undefined}
- Delete an Auth0 device credential.
+ Delete all users.
@@ -4984,6 +4876,8 @@ Deprecated:- This method will be removed in the next major release.
Source:
Parameters:
- paramscb
-Object
+function
@@ -5057,6 +4951,8 @@ Parameters:
+ <optional>
+
@@ -5067,119 +4963,32 @@ Parameters:
- Credential parameters.
+ Callback function
-
-
-
-
-
-
- Name
-
+
+
- Type
+
+
+
-
-
- Description
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
- Device credential ID.
-
-
-
-
-
-
-
-
-
-
+
+Returns:
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
+
-
@@ -5205,14 +5014,12 @@
Returns:
Example
- var params = { id: CREDENTIAL_ID };
-
-management.deleteDeviceCredential(params, function (err) {
+ management.deleteAllUsers(function (err) {
if (err) {
// Handle error.
}
- // Credential deleted.
+ // Users deleted
});
@@ -5224,14 +5031,14 @@ Example
- deleteEmailProvider(cbopt) → {Promise|undefined}
+ deleteClient(params, cbopt) → {Promise|undefined}
- Delete email provider.
+ Delete an Auth0 client.
@@ -5267,7 +5074,7 @@ de
- Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Client parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Application client ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.deleteEmailProvider(function (err) {
+ management.deleteClient({ client_id: CLIENT_ID }, function (err) {
if (err) {
// Handle error.
}
- // Email provider deleted.
+ // Client deleted.
});
@@ -5408,14 +5300,14 @@ Example
- deleteGuardianEnrollment(data, cbopt) → {Promise|undefined}
+ deleteClientGrant(params, cbopt) → {Promise|undefined}
- Delete a user's Guardian enrollment.
+ Delete an Auth0 client grant.
@@ -5451,7 +5343,7 @@ Source:
Parameters:
- dataparams
@@ -5522,7 +5414,7 @@ Parameters:
- The Guardian enrollment data object.
+ Client parameters.
@@ -5565,7 +5457,7 @@ Parameters:
- The Guardian enrollment id.
+ Client grant ID.
@@ -5660,12 +5552,12 @@ Returns:
Example
- management.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err) {
+ management.clientGrants.delete({ id: GRANT_ID }, function (err) {
if (err) {
// Handle error.
}
- // Email provider deleted.
+ // Grant deleted.
});
@@ -5677,14 +5569,14 @@ Example
- deleteResourceServer(params, cbopt) → {Promise|undefined}
+ deleteConnection(params, cbopt) → {Promise|undefined}
- Delete an existing resource server.
+ Delete an existing connection.
@@ -5720,7 +5612,7 @@ d
- Source:
Parameters:
- Resource Server parameters.
+ Connection parameters.
@@ -5834,7 +5726,7 @@ Parameters:
- Resource Server ID.
+ Connection ID.
@@ -5929,12 +5821,12 @@ Returns:
Example
- management.deleteResourceServer({ id: RESOURCE_SERVER_ID }, function (err) {
+ management.deleteConnection({ id: CONNECTION_ID }, function (err) {
if (err) {
// Handle error.
}
- // Resource Server deleted.
+ // Conection deleted.
});
@@ -5946,14 +5838,14 @@ Example
- deleteRule(params, cbopt) → {Promise|undefined}
+ deleteCustomDomain(params, cbopt) → {Promise|undefined}
- Delete an existing rule.
+ Delete a Custom Domain.
@@ -5989,7 +5881,7 @@ deleteRule<
- Source:
Parameters:
- Rule parameters.
+ Custom Domain parameters.
@@ -6103,7 +5995,7 @@ Parameters:
- Rule ID.
+ Custom Domain ID.
@@ -6198,12 +6090,12 @@ Returns:
Example
- auth0.deleteRule({ id: RULE_ID }, function (err) {
+ management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
if (err) {
// Handle error.
}
- // Rule deleted.
+ // CustomDomain deleted.
});
@@ -6215,14 +6107,14 @@ Example
- deleteRulesConfig(params, cbopt) → {Promise|undefined}
+ deleteDeviceCredential(params, cbopt) → {Promise|undefined}
- Delete rules config.
+ Delete an Auth0 device credential.
@@ -6258,7 +6150,7 @@ dele
- Source:
Parameters:
- Rule Configs parameters.
+ Credential parameters.
@@ -6355,7 +6247,7 @@ Parameters:
- keyid
@@ -6372,7 +6264,7 @@ Parameters:
- Rule Configs key.
+ Device credential ID.
@@ -6467,12 +6359,14 @@ Returns:
Example
- management.deleteRulesConfig({ key: RULE_CONFIG_KEY }, function (err) {
+ var params = { id: CREDENTIAL_ID };
+
+management.deleteDeviceCredential(params, function (err) {
if (err) {
// Handle error.
}
- // Rules Config deleted.
+ // Credential deleted.
});
@@ -6484,14 +6378,14 @@ Example
- deleteUser(params, cbopt) → {Promise|undefined}
+ deleteEmailProvider(cbopt) → {Promise|undefined}
- Delete a user by its id.
+ Delete email provider.
@@ -6527,7 +6421,7 @@ deleteUser<
- Source:
Parameters:
- paramscb
-Object
+function
@@ -6588,6 +6482,8 @@ Parameters:
+ <optional>
+
@@ -6598,101 +6494,14 @@ Parameters:
- The user data object..
+ Callback function.
-
-
-
-
-
-
- Name
-
+
+
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- The user id.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function
-
-
-
-
-
-
-
+
+
+
@@ -6736,12 +6545,12 @@ Returns:
Example
- management.deleteUser({ id: USER_ID }, function (err) {
+ management.deleteEmailProvider(function (err) {
if (err) {
// Handle error.
}
- // User deleted.
+ // Email provider deleted.
});
@@ -6753,14 +6562,14 @@ Example
- deleteUserMultifactor(params, cbopt) → {Promise|undefined}
+ deleteGuardianEnrollment(data, cbopt) → {Promise|undefined}
- Delete a multifactor provider for a user.
+ Delete a user's Guardian enrollment.
@@ -6796,7 +6605,7 @@
Source:
Parameters:
- paramsdata
@@ -6867,7 +6676,7 @@ Parameters:
- Data object.
+ The Guardian enrollment data object.
@@ -6910,33 +6719,7 @@ Parameters:
- The user id.
-
-
-
-
-
-
-
-
- provider
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Multifactor provider.
+ The Guardian enrollment id.
@@ -6980,7 +6763,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -7031,14 +6814,12 @@ Returns:
Example
- var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-
-management.deleteUserMultifactor(params, function (err, user) {
+ management.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // Email provider deleted.
});
@@ -7050,14 +6831,14 @@ Example
- deleteUserMultifcator(params, cbopt) → {Promise|undefined}
+ deleteResourceServer(params, cbopt) → {Promise|undefined}
- Delete a multifactor provider for a user.
+ Delete an existing resource server.
@@ -7081,10 +6862,6 @@
- Deprecated: - The function name has a typo.
-We're shipping this so it doesn't break compatibility.
-Use
deleteUserMultifactor instead.
Source:
Parameters:
- Data object.
+ Resource Server parameters.
@@ -7211,33 +6988,7 @@ Parameters:
- The user id.
-
-
-
-
-
-
-
-
- provider
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Multifactor provider.
+ Resource Server ID.
@@ -7281,7 +7032,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -7332,14 +7083,12 @@ Returns:
Example
- var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-
-management.deleteUserMultifcator(params, function (err, user) {
+ management.deleteResourceServer({ id: RESOURCE_SERVER_ID }, function (err) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // Resource Server deleted.
});
@@ -7351,14 +7100,14 @@ Example
- getActiveUsersCount(cbopt) → {Promise|undefined}
+ deleteRule(params, cbopt) → {Promise|undefined}
- Get a the active users count.
+ Delete an existing rule.
@@ -7394,7 +7143,7 @@ ge
Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rule parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.getActiveUsersCount(function (err, usersCount) {
+ auth0.deleteRule({ id: RULE_ID }, function (err) {
if (err) {
// Handle error.
}
- console.log(usersCount);
+ // Rule deleted.
});
@@ -7535,14 +7369,14 @@ Example
- getBlacklistedTokens(cbopt) → {Promise|undefined}
+ deleteRulesConfig(params, cbopt) → {Promise|undefined}
- Get all blacklisted tokens.
+ Delete rules config.
@@ -7578,7 +7412,7 @@ g
Source:
Parameters:
- cbparams
-function
+Object
@@ -7639,8 +7473,6 @@ Parameters:
- <optional>
-
@@ -7651,7 +7483,94 @@ Parameters:
- Callback function.
+ Rule Configs parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ key
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule Configs key.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
@@ -7702,8 +7621,12 @@ Returns:
Example
- management.getBlacklistedTokens(function (err, tokens) {
- console.log(tokens.length);
+ management.deleteRulesConfig({ key: RULE_CONFIG_KEY }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Rules Config deleted.
});
@@ -7715,14 +7638,14 @@ Example
- getClient(params, cbopt) → {Promise|undefined}
+ deleteUser(params, cbopt) → {Promise|undefined}
- Get an Auth0 client.
+ Delete a user by its id.
@@ -7758,7 +7681,7 @@ getClientSource:
Parameters:
- Client parameters.
+ The user data object..
@@ -7855,7 +7778,7 @@ Parameters:
- client_idid
@@ -7872,7 +7795,7 @@ Parameters:
- Application client ID.
+ The user id.
@@ -7916,7 +7839,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -7967,12 +7890,12 @@ Returns:
Example
- management.getClient({ client_id: CLIENT_ID }, function (err, client) {
+ management.deleteUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
- console.log(client);
+ // User deleted.
});
@@ -7984,122 +7907,14 @@ Example
- getClientInfo() → {Object}
-
-
-
-
-
-
- Return an object with information about the current client,
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Object
-
-
-
-
-
-
-
- Object containing client information.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- getClients(paramsopt, cbopt) → {Promise|undefined}
+ deleteUserMultifactor(params, cbopt) → {Promise|undefined}
- Get all Auth0 clients.
+ Delete a multifactor provider for a user.
@@ -8135,7 +7950,7 @@ getClients<
Source:
Parameters:
- <optional>
-
@@ -8208,7 +8021,7 @@ Parameters:
- Clients parameters.
+ Data object.
@@ -8222,8 +8035,6 @@ Parameters:
Type
- Attributes
-
@@ -8236,34 +8047,24 @@ Parameters:
- per_pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Number of results per page.
+ The user id.
@@ -8272,34 +8073,24 @@ Parameters:
- pageprovider
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ Multifactor provider.
@@ -8343,7 +8134,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -8394,20 +8185,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, provider: MULTIFACTOR_PROVIDER };
-management.getClients(params, function (err, clients) {
- console.log(clients.length);
+management.deleteUserMultifactor(params, function (err, user) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Users accounts unlinked.
});
@@ -8419,14 +8204,14 @@ Example
- getConnection(params, cbopt) → {Promise|undefined}
+ deleteUserMultifcator(params, cbopt) → {Promise|undefined}
- Get an Auth0 connection.
+ Delete a multifactor provider for a user.
@@ -8450,6 +8235,10 @@ getConne
+ Deprecated: - The function name has a typo.
+We're shipping this so it doesn't break compatibility.
+Use
deleteUserMultifactor instead.
getConne
Source:
Parameters:
- Connection parameters.
+ Data object.
@@ -8576,7 +8365,33 @@ Parameters:
- Connection ID.
+ The user id.
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Multifactor provider.
@@ -8620,7 +8435,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -8671,12 +8486,14 @@ Returns:
Example
- management.getConnection({ id: CONNECTION_ID }, function (err, connection) {
+ var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
+
+management.deleteUserMultifcator(params, function (err, user) {
if (err) {
// Handle error.
}
- console.log(connection);
+ // Users accounts unlinked.
});
@@ -8688,14 +8505,14 @@ Example
- getConnections(paramsopt, cbopt) → {Promise|undefined}
+ exportUsers(data, cbopt) → {Promise|undefined}
- Get all connections.
+ Export all users to a file using a long running job.
@@ -8731,7 +8548,7 @@ getConn
Source:
Parameters:
- paramsdata
@@ -8792,8 +8609,6 @@ Parameters:
- <optional>
-
@@ -8804,7 +8619,7 @@ Parameters:
- Connections params.
+ Users export data.
@@ -8832,13 +8647,13 @@ Parameters:
- per_pageconnection_id
-Number
+String
@@ -8859,7 +8674,7 @@ Parameters:
- Number of results per page.
+ The connection id of the connection from which users will be exported
@@ -8868,7 +8683,43 @@ Parameters:
- pageformat
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The format of the file. Valid values are: "json" and "csv".
+
+
+
+
+
+
+
+
+ limit
@@ -8895,7 +8746,43 @@ Parameters:
- Page number, zero indexed.
+ Limit the number of records.
+
+
+
+
+
+
+
+
+ fields
+
+
+Array.<Object>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
@@ -8990,20 +8877,37 @@ 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 data = {
+ connection_id: 'con_0000000000000001',
+ format: 'csv',
+ limit: 5,
+ fields: [
+ {
+ "name": "user_id"
+ },
+ {
+ "name": "name"
+ },
+ {
+ "name": "email"
+ },
+ {
+ "name": "identities[0].connection",
+ "export_as": "provider"
+ },
+ {
+ "name": "user_metadata.some_field"
+ }
+ ]
+}
+
+management.exportUsers(data, function (err, results) {
+ if (err) {
+ // Handle error.
+ }
-management.getConnections(params, function (err, connections) {
- console.log(connections.length);
+ // Retrieved job.
+ console.log(results);
});
@@ -9015,14 +8919,14 @@ Example
- getDailyStats(params, cbopt) → {Promise|undefined}
+ getActiveUsersCount(cbopt) → {Promise|undefined}
- Get the daily stats.
+ Get a the active users count.
@@ -9058,7 +8962,7 @@ getDaily
Source:
Parameters:
- paramscb
-Object
+function
@@ -9119,6 +9023,8 @@ Parameters:
+ <optional>
+
@@ -9129,156 +9035,43 @@ Parameters:
- Stats parameters.
+ Callback function.
-
-
-
-
-
-
- Name
-
+
+
- Type
+
+
+
-
-
- Description
-
-
-
-
-
-
- from
-
-
-String
-
-
-
-
-
- The first day in YYYYMMDD format.
-
-
-
-
-
-
- to
-
-
-String
+
+Returns:
+
-
-
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
-
-
-
-
-
- The last day in YYYYMMDD format.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-function
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
Promise
-|
-
-undefined
+undefined
@@ -9293,17 +9086,12 @@ Returns:
Example
- var params = {
- from: '{YYYYMMDD}', // First day included in the stats.
- to: '{YYYYMMDD}' // Last day included in the stats.
-};
-
-management.getDaily(params, function (err, stats) {
+ management.getActiveUsersCount(function (err, usersCount) {
if (err) {
// Handle error.
}
- console.log(stats);
+ console.log(usersCount);
});
@@ -9315,14 +9103,14 @@ Example
- getDeviceCredentials(cbopt) → {Promise|undefined}
+ getBlacklistedTokens(cbopt) → {Promise|undefined}
- Get all Auth0 credentials.
+ Get all blacklisted tokens.
@@ -9358,7 +9146,7 @@ g
- Source:
Returns:
Example
- management.getDeviceCredentials(function (err, credentials) {
- console.log(credentials.length);
+ management.getBlacklistedTokens(function (err, tokens) {
+ console.log(tokens.length);
});
@@ -9495,14 +9283,14 @@ Example
- getEmailProvider(cbopt) → {Promise|undefined}
+ getClient(params, cbopt) → {Promise|undefined}
- Get the email provider.
+ Get an Auth0 client.
@@ -9538,7 +9326,7 @@ getEm
- Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Client parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ client_id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Application client ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.getEmailProvider(function (err, provider) {
- console.log(provider.length);
+ management.getClient({ client_id: CLIENT_ID }, function (err, client) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(client);
});
@@ -9675,14 +9552,14 @@ Example
- getGuardianEnrollment(data, cbopt) → {Promise|undefined}
+ getClientGrants(paramsopt, cbopt) → {Promise|undefined}
- Get a single Guardian enrollment.
+ Get all Auth0 Client Grants.
@@ -9718,7 +9595,7 @@
- Source:
Parameters:
- dataparams
@@ -9779,6 +9656,8 @@ Parameters:
+ <optional>
+
@@ -9789,7 +9668,7 @@ Parameters:
- The Guardian enrollment data object.
+ Client Grants parameters.
@@ -9803,6 +9682,8 @@ Parameters:
Type
+ Attributes
+
@@ -9815,32 +9696,34 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
-
+
-
- The Guardian enrollment id.
-
-
+
+
-
-
-
+
+
+ Number of results per page.
@@ -9849,13 +9732,13 @@ Parameters:
- cbpage
-function
+Number
@@ -9876,7 +9759,7 @@ Parameters:
- Callback function.
+ Page number, zero indexed.
@@ -9885,6 +9768,53 @@ Parameters:
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
@@ -9895,9 +9825,6 @@ Parameters:
-
-
-
Returns:
@@ -9927,8 +9854,20 @@ Returns:
Example
- management.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
- console.log(enrollment);
+
+ 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.getClientGrants(params, function (err, grants) {
+ console.log(grants.length);
});
@@ -9940,14 +9879,14 @@ Example
- getGuardianEnrollments(data, cbopt) → {Promise|undefined}
+ getClientInfo() → {Object}
- Get a list of a user's Guardian enrollments.
+ Return an object with information about the current client,
@@ -9983,7 +9922,115 @@ Source:
Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Object
+
+
+
+
+
+
+
+ Object containing client information.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ getClients(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all Auth0 clients.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ Parameters:
- dataparams
@@ -10044,6 +10091,8 @@ Parameters:
+ <optional>
+
@@ -10054,7 +10103,7 @@ Parameters:
- The user data object.
+ Clients parameters.
@@ -10068,6 +10117,8 @@ Parameters:
Type
+ Attributes
+
@@ -10080,24 +10131,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- The user id.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -10192,8 +10289,20 @@ Returns:
Example
- management.getGuardianEnrollments({ id: USER_ID }, function (err, enrollments) {
- console.log(enrollments);
+
+ 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.getClients(params, function (err, clients) {
+ console.log(clients.length);
});
@@ -10205,14 +10314,14 @@ Example
- getJob(params, cbopt) → {Promise|undefined}
+ getConnection(params, cbopt) → {Promise|undefined}
- Get a job by its ID.
+ Get an Auth0 connection.
@@ -10248,7 +10357,7 @@ getJobSource:
Parameters:
- Job parameters.
+ Connection parameters.
@@ -10362,7 +10471,7 @@ Parameters:
- Job ID.
+ Connection ID.
@@ -10457,17 +10566,12 @@ Returns:
Example
- var params = {
- id: '{JOB_ID}'
-};
-
-management.getJob(params, function (err, job) {
+ management.getConnection({ id: CONNECTION_ID }, function (err, connection) {
if (err) {
// Handle error.
}
- // Retrieved job.
- console.log(job);
+ console.log(connection);
});
@@ -10479,14 +10583,14 @@ Example
- getLog(params, cbopt) → {Promise|undefined}
+ getConnections(paramsopt, cbopt) → {Promise|undefined}
- Get an Auth0 log.
+ Get all connections.
@@ -10522,7 +10626,7 @@ getLogSource:
Parameters:
+ <optional>
+
@@ -10593,7 +10699,7 @@ Parameters:
- Log parameters.
+ Connections params.
@@ -10607,6 +10713,8 @@ Parameters:
Type
+ Attributes
+
@@ -10619,24 +10727,70 @@ Parameters:
- idper_page
-String
+Number
+
+
+ <optional>
+
+
+
+
+
+
+
- Event ID.
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
@@ -10731,12 +10885,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.getConnections(params, function (err, connections) {
+ console.log(connections.length);
});
@@ -10748,14 +10910,14 @@ Example
- getLogs(paramsopt, cbopt) → {Promise|undefined}
+ getCustomDomain(params, cbopt) → {Promise|undefined}
- Get all logs.
+ Get a Custom Domain.
@@ -10791,7 +10953,7 @@ getLogsSource:
Parameters:
- <optional>
-
@@ -10864,7 +11024,7 @@ Parameters:
- Logs params.
+ Custom Domain parameters.
@@ -10878,8 +11038,6 @@ Parameters:
Type
- Attributes
-
@@ -10892,7 +11050,7 @@ Parameters:
- qid
@@ -10905,21 +11063,19 @@ Parameters:
-
-
- <optional>
-
-
+
+
+ Custom Domain ID.
-
-
+
+
-
+
+
+
-
- Search Criteria using Query String Syntax
@@ -10928,13 +11084,13 @@ Parameters:
- pagecb
-Number
+function
@@ -10955,238 +11111,134 @@ Parameters:
- Page number. Zero based
+ Callback function.
+
+
-
-
- per_page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- The amount of entries per page
-
-
-
-
-
-
- sort
-
-
-String
-
-
+
+Returns:
-
-
-
- <optional>
-
+
-
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
-
-
-
+undefined
-
-
- The field to use for sorting.
-
-
-
+
+
+
+
-
-
- fields
-
-
-String
+
+Example
-
-
+ management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ if (err) {
+ // Handle error.
+ }
-
-
-
- <optional>
-
+ console.log(customDomain);
+});
-
+
-
-
+
+
+
-
+
-
- A comma separated list of fields to include or exclude
-
-
-
+ getCustomDomains() → {Promise|undefined}
-
-
- include_fields
-
-
-Boolean
+
+ Get all Auth0 CustomDomains.
+
-
-
-
-
-
- <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
-
-
-
+
-
-
-
-
-
+
+
+ Source:
+
-
- cb
-
-
-function
+
+
+
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- Callback function.
-
-
-
-
-
-
@@ -11230,20 +11282,8 @@ 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
-};
-
-management.getLogs(params, function (err, logs) {
- console.log(logs.length);
+ management.getCustomDomains(function (err, customDomains) {
+ console.log(customDomains.length);
});
@@ -11255,14 +11295,14 @@ Example
- getResourceServer(params, cbopt) → {Promise|undefined}
+ getDailyStats(params, cbopt) → {Promise|undefined}
- Get a Resource Server.
+ Get the daily stats.
@@ -11298,7 +11338,7 @@ getR
Source:
Parameters:
- Resource Server parameters.
+ Stats parameters.
@@ -11395,7 +11435,7 @@ Parameters:
- idfrom
@@ -11412,7 +11452,33 @@ Parameters:
- Resource Server ID.
+ The first day in YYYYMMDD format.
+
+
+
+
+
+
+
+
+ to
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The last day in YYYYMMDD format.
@@ -11507,12 +11573,17 @@ Returns:
Example
- management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+ var params = {
+ from: '{YYYYMMDD}', // First day included in the stats.
+ to: '{YYYYMMDD}' // Last day included in the stats.
+};
+
+management.getDaily(params, function (err, stats) {
if (err) {
// Handle error.
}
- console.log(resourceServer);
+ console.log(stats);
});
@@ -11524,14 +11595,14 @@ Example
- getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+ getDeviceCredentials(cbopt) → {Promise|undefined}
- Get all resource servers.
+ Get all Auth0 credentials.
@@ -11567,7 +11638,7 @@ get
Source:
Parameters:
- paramscb
-Object
+function
@@ -11640,226 +11711,79 @@ Parameters:
- Resource Servers parameters.
+ Callback function.
-
+
+
-
-
-
-
- Name
-
+
+
+
- Type
-
- Attributes
-
-
- Description
-
-
-
-
-
-
- per_page
-
-
-Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
+
+Returns:
-
+
-
-
- page
+ -
+ Type:
+
+ -
+
+
Promise
+|
-
-
-
-Number
+undefined
-
-
+
+
-
-
-
- <optional>
-
-
+
+
-
-
-
-
-
- Page number, zero indexed.
-
-
-
+
+Example
+
+ management.getDeviceCredentials(function (err, credentials) {
+ console.log(credentials.length);
+});
+
+
+
+
+
+
+
-
-
-
-
-
+ getEmailProvider(cbopt, paramsopt) → {Promise|undefined}
-
-
- 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);
-});
-
-
-
-
-
-
-
-
-
-
- getRule(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get an Auth0 rule.
-
+
+ Get the email provider.
+
@@ -11894,7 +11818,7 @@ getRuleSource:
Parameters:
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
paramsParameters:
+ <optional>
+
@@ -11965,7 +11927,7 @@ Parameters:
- Rule parameters.
+ Clients parameters.
@@ -11979,6 +11941,8 @@ Parameters:
Type
+ Attributes
+
@@ -11991,32 +11955,34 @@ Parameters:
- idfields
-String
+Number
+
+
+ <optional>
+
-
+
-
- Rule ID.
-
-
+
+
-
-
-
+
+
+ A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
@@ -12025,13 +11991,13 @@ Parameters:
- cbinclude_fields
-function
+Number
@@ -12052,7 +12018,15 @@ Parameters:
- Callback function.
+ true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
+
+
+
+
+
+
+
@@ -12103,12 +12077,8 @@ Returns:
Example
- management.getRule({ id: RULE_ID }, function (err, rule) {
- if (err) {
- // Handle error.
- }
-
- console.log(rule);
+ management.getEmailProvider(function (err, provider) {
+ console.log(provider.length);
});
@@ -12120,14 +12090,14 @@ Example
- getRules(paramsopt, cbopt) → {Promise|undefined}
+ getGuardianEnrollment(data, cbopt) → {Promise|undefined}
- Get all rules.
+ Get a single Guardian enrollment.
@@ -12163,7 +12133,7 @@ getRulesSource:
Parameters:
- paramsdata
@@ -12224,8 +12194,6 @@ Parameters:
- <optional>
-
@@ -12236,7 +12204,7 @@ Parameters:
- Rules parameters.
+ The Guardian enrollment data object.
@@ -12250,8 +12218,6 @@ Parameters:
Type
- Attributes
-
@@ -12264,70 +12230,24 @@ Parameters:
- per_page
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
-
-
-
-
-
-
-
-
- pageid
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ The Guardian enrollment id.
@@ -12422,20 +12342,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 = {
- per_page: 10,
- page: 0
-};
-
-management.getRules(params, function (err, rules) {
- console.log(rules.length);
+ management.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ console.log(enrollment);
});
@@ -12447,14 +12355,14 @@ Example
- getRulesConfigs() → {Promise|undefined}
+ getGuardianEnrollments(data, cbopt) → {Promise|undefined}
- Get rules config.
+ Get a list of a user's Guardian enrollments.
@@ -12490,7 +12398,7 @@ getRul
Source:
getRul
+ Parameters:
+
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
+
+
+
-
-
- -
- Type:
-
- -
+
Name
-Promise
-|
-
-undefined
-
-
-
-
-
-
-
-
-
-
-
-
-Example
-
- management.getRulesConfigs(function (err, rulesConfigs) {
- if (err) {
- // Handle error.
- }
-
- // Get Rules Configs.
-});
-
+ Type
-
-
-
-
-
-
- getTenantSettings(cbopt) → {Promise|undefined}
-
-
-
-
-
-
- Get the tenant settings..
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
- Attributes
+
-
+
-
+ Description
+
+
+
-
+
+
+ data
+
+
+Object
+
+
+
+
+
+
+
+
+
+
- Parameters:
-
+
+ The user data object.
+
+
@@ -12642,8 +12483,6 @@ Parameters:
Type
- Attributes
-
@@ -12654,6 +12493,40 @@ Parameters:
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cbReturns:
Example
- management.getSettings(function (err, settings) {
- if (err) {
- // Handle error.
- }
-
- console.log(settings);
+ management.getGuardianEnrollments({ id: USER_ID }, function (err, enrollments) {
+ console.log(enrollments);
});
@@ -12751,14 +12620,14 @@ Example
- getUser(data, cbopt) → {Promise|undefined}
+ getJob(params, cbopt) → {Promise|undefined}
- Get a user by its id.
+ Get a job by its ID.
@@ -12794,7 +12663,7 @@ getUserSource:
Parameters:
- dataparams
@@ -12865,7 +12734,7 @@ Parameters:
- The user data object.
+ Job parameters.
@@ -12908,7 +12777,7 @@ Parameters:
- The user id.
+ Job ID.
@@ -13003,8 +12872,17 @@ Returns:
Example
- management.getUser({ id: USER_ID }, function (err, user) {
- console.log(user);
+ var params = {
+ id: '{JOB_ID}'
+};
+
+management.getJob(params, function (err, job) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Retrieved job.
+ console.log(job);
});
@@ -13016,14 +12894,14 @@ Example
- getUserLogs(params, cbopt) → {Promise|undefined}
+ getLog(params, cbopt) → {Promise|undefined}
- Get user's log events.
+ Get an Auth0 log.
@@ -13059,7 +12937,7 @@ getUserLog
Source:
Parameters:
- Get logs data.
+ Log parameters.
@@ -13173,7 +13051,15 @@ Parameters:
- User id.
+ Event ID.
+
+
+
+
+
+
+
+
@@ -13182,24 +13068,2952 @@ Parameters:
- per_pagecb
-Number
+function
+
+
+ <optional>
+
+
+
+
+
+
+
- Number of results per page.
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getLog({ id: EVENT_ID }, function (err, log) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(log);
+});
+
+
+
+
+
+
+
+
+
+
+ getLogs(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all logs.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Logs params.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ q
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Search Criteria using Query String Syntax
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Page number. Zero based
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The amount of entries per page
+
+
+
+
+
+
+
+
+ sort
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The field to use for sorting.
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 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);
+});
+
+
+
+
+
+
+
+
+
+
+ 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);
+});
+
+
+
+
+
+
+
+
+
+
+ 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() → {Promise|undefined}
+
+
+
+
+
+
+ Get rules config.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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..
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.getSettings(function (err, settings) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(settings);
+});
+
+
+
+
+
+
+
+
+
+
+ getUser(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a user by its id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - 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.getUser({ id: USER_ID }, function (err, user) {
+ console.log(user);
+});
+
+
+
+
+
+
+
+
+
+
+ getUserLogs(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get user's log events.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Get logs data.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ User id.
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
+
+
+
+
+
+
+
+
+ page
+
+
+Number
+
+
+
+
+
+
+
+
+
+
+ Page number, zero indexed.
+
+
+
+
+
+
+
+
+ sort
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+
+
+
+
+
+
+
+
+ include_totals
+
+
+Boolean
+
+
+
+
+
+
+
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ cb
+
+
+function
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Callback function.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+
+management.getUserLogs(params, function (err, logs) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logs);
+});
+
+
+
+
+
+
+
+
+
+
+ getUsers(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get all users.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Users params.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ search_engine
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The version of the search engine to use.
+
+
+
+
+
+
+
+
+ per_page
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Number of results per page.
@@ -13217,24 +16031,235 @@ Parameters:
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 = {
+ search_engine: 'v3',
+ per_page: 10,
+ page: 0
+};
+
+auth0.getUsers(params, function (err, users) {
+ console.log(users.length);
+});
+
+
+
+
+
+
+
+
+
+
+ getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get users for a given email address
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
-
+
+ Attributes
+
-
+
-
- Page number, zero indexed.
-
-
-
+ Description
+
+
+
- sortemail
@@ -13247,45 +16272,21 @@ Parameters:
-
-
-
-
- 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
-
+ <optional>
-Boolean
+
-
-
-
+
+
- true if a query summary must be included in the result, false otherwise. Default false;
-
-
-
-
-
-
-
-
+ Email Address of users to locate
@@ -13372,14 +16373,13 @@ Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-
-management.getUserLogs(params, function (err, logs) {
- if (err) {
- // Handle error.
- }
-
- console.log(logs);
+
+ 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);
});
@@ -13391,14 +16391,15 @@ Example
- getUsers(paramsopt, cbopt) → {Promise|undefined}
+ importUsers(data, cbopt) → {Promise|undefined}
- Get all users.
+ Given a path to a file and a connection id, create a new job that imports the
+users contained in the file and associate them with the given connection.
@@ -13434,7 +16435,7 @@ getUsersSource:
Parameters:
- paramsdata
@@ -13495,8 +16496,6 @@ Parameters:
- <optional>
-
@@ -13507,7 +16506,7 @@ Parameters:
- Users params.
+ Users import data.
@@ -13521,8 +16520,6 @@ Parameters:
Type
- Attributes
-
@@ -13535,70 +16532,24 @@ Parameters:
- search_engine
-
-
-Number
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The version of the search engine to use.
-
-
-
-
-
-
-
-
- per_pageconnectionId
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Number of results per page.
+ Connection for the users insertion.
@@ -13607,34 +16558,24 @@ Parameters:
- pageusers
-Number
+String
-
-
- <optional>
-
-
-
-
-
-
-
- Page number, zero indexed.
+ Path to the users data file.
@@ -13729,21 +16670,15 @@ 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',
- per_page: 10,
- page: 0
+ var params = {
+ connection_id: '{CONNECTION_ID}',
+ users: '{PATH_TO_USERS_FILE}'
};
-auth0.getUsers(params, function (err, users) {
- console.log(users.length);
+management.get(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
});
@@ -13755,14 +16690,14 @@ Example
- getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+ linkUsers(userId, params, cbopt) → {Promise|undefined}
- Get users for a given email address
+ Link the user with another account.
@@ -13798,7 +16733,7 @@ getUse
Source:
getUse
- Parameters:
-
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ userId
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ID of the primary user.
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Secondary user data.
+
+
@@ -13830,8 +16852,6 @@ Parameters:
Type
- Attributes
-
@@ -13844,7 +16864,7 @@ Parameters:
- emailuser_id
@@ -13857,21 +16877,45 @@ Parameters:
-
-
- <optional>
-
+
+
+
+ ID of the user to be linked.
+
+
+
+
+
+
+
+ connection_id
+
-
+String
+
+
+
+
+
- Email Address of users to locate
+ ID of the connection to be used.
+
+
+
+
+
+
+
+
@@ -13958,13 +17002,18 @@ 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 userId = 'USER_ID';
+var params = {
+ user_id: 'OTHER_USER_ID',
+ connection_id: 'CONNECTION_ID'
+};
+
+management.linkUsers(userId, params, function (err, user) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Users linked.
});
@@ -13976,15 +17025,14 @@ Example
- importUsers(data, cbopt) → {Promise|undefined}
+ regenerateRecoveryCode(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 and associate them with the given connection.
+ Generate new Guardian recovery code.
@@ -14020,7 +17068,7 @@ importUser
Source:
Parameters:
- Users import data.
+ The user data object.
@@ -14117,33 +17165,7 @@ Parameters:
- connectionId
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Connection for the users insertion.
-
-
-
-
-
-
-
-
- usersid
@@ -14160,7 +17182,7 @@ Parameters:
- Path to the users data file.
+ The user id.
@@ -14255,15 +17277,8 @@ Returns:
Example
- var params = {
- connection_id: '{CONNECTION_ID}',
- users: '{PATH_TO_USERS_FILE}'
-};
-
-management.get(params, function (err) {
- if (err) {
- // Handle error.
- }
+ management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
+ console.log(newRecoveryCode);
});
@@ -14275,14 +17290,14 @@ Example
- linkUsers(userId, params, cbopt) → {Promise|undefined}
+ sendEmailVerification(data, cbopt) → {Promise|undefined}
- Link the user with another account.
+ Send a verification email to a user.
@@ -14318,7 +17333,7 @@ linkUsersSource:
Parameters:
- userId
-
-
-String
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ID of the primary user.
-
-
-
-
-
-
-
-
- paramsdata
@@ -14423,7 +17404,7 @@ Parameters:
- Secondary user data.
+ User data object.
@@ -14466,33 +17447,7 @@ Parameters:
- ID of the user to be linked.
-
-
-
-
-
-
-
-
- connection_id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- ID of the connection to be used.
+ ID of the user to be verified.
@@ -14587,18 +17542,14 @@ Returns:
Example
- var userId = 'USER_ID';
-var params = {
- user_id: 'OTHER_USER_ID',
- connection_id: 'CONNECTION_ID'
+ var params = {
+ user_id: '{USER_ID}'
};
-management.linkUsers(userId, params, function (err, user) {
+management.sendEmailVerification(function (err) {
if (err) {
// Handle error.
}
-
- // Users linked.
});
@@ -14610,14 +17561,14 @@ Example
- regenerateRecoveryCode(data, cbopt) → {Promise|undefined}
+ setRulesConfig(params, data, cbopt) → {Promise|undefined}
- Generate new Guardian recovery code.
+ Set a new rules config.
@@ -14653,7 +17604,7 @@ Source:
Parameters:
-
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rule Config parameters.
+
+
@@ -14685,8 +17689,6 @@ Parameters:
Type
- Attributes
-
@@ -14697,6 +17699,40 @@ Parameters:
+
+
+ key
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Rule Config key.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
dataParameters:
- The user data object.
+ Rule Config Data parameters.
@@ -14750,7 +17786,7 @@ Parameters:
- idvalue
@@ -14767,7 +17803,7 @@ Parameters:
- The user id.
+ Rule Config Data value.
@@ -14862,8 +17898,15 @@ Returns:
Example
- management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
- console.log(newRecoveryCode);
+ var params = { key: RULE_CONFIG_KEY };
+var data = { value: RULES_CONFIG_VALUE };
+
+management.setRulesConfig(params, data, function (err, rulesConfig) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Rules Config set.
});
@@ -14875,14 +17918,14 @@ Example
- sendEmailVerification(data, cbopt) → {Promise|undefined}
+ unlinkUsers(params, cbopt) → {Promise|undefined}
- Send a verification email to a user.
+ Unlink the given accounts.
@@ -14918,7 +17961,7 @@
Source:
Parameters:
- dataparams
@@ -14989,7 +18032,7 @@ Parameters:
- User data object.
+ Linked users data.
@@ -15013,6 +18056,58 @@ Parameters:
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Primary user ID.
+
+
+
+
+
+
+
+
+ provider
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Identity provider in use.
+
+
+
+
+
+
user_idParameters:
- ID of the user to be verified.
+ Secondary user ID.
@@ -15127,14 +18222,14 @@ Returns:
Example
- var params = {
- user_id: '{USER_ID}'
-};
+ var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
-management.sendEmailVerification(function (err) {
+management.unlinkUsers(params, function (err, user) {
if (err) {
// Handle error.
}
+
+ // Users accounts unlinked.
});
@@ -15146,14 +18241,14 @@ Example
- setRulesConfig(params, data, cbopt) → {Promise|undefined}
+ updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
- Set a new rules config.
+ Update the app metadata for a user.
@@ -15189,7 +18284,7 @@ setRule
Source:
Parameters:
- Rule Config parameters.
+ The user data object..
@@ -15286,7 +18381,7 @@ Parameters:
- keyid
@@ -15303,7 +18398,7 @@ Parameters:
- Rule Config key.
+ The user id.
@@ -15320,7 +18415,7 @@ Parameters:
- datametadata
@@ -15345,58 +18440,7 @@ Parameters:
- Rule Config Data parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- value
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Rule Config Data value.
-
-
-
-
-
-
-
-
+ New app metadata.
@@ -15432,7 +18476,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -15483,15 +18527,18 @@ Returns:
Example
- var params = { key: RULE_CONFIG_KEY };
-var data = { value: RULES_CONFIG_VALUE };
+ var params = { id: USER_ID };
+var metadata = {
+ foo: 'bar'
+};
-management.setRulesConfig(params, data, function (err, rulesConfig) {
+management.updateAppMetadata(params, metadata, function (err, user) {
if (err) {
// Handle error.
}
- // Rules Config set.
+ // Updated user.
+ console.log(user);
});
@@ -15503,14 +18550,14 @@ Example
- unlinkUsers(params, cbopt) → {Promise|undefined}
+ updateClient(params, data, cbopt) → {Promise|undefined}
- Unlink the given accounts.
+ Update an Auth0 client.
@@ -15546,7 +18593,7 @@ unlinkUser
Source:
Parameters:
- Linked users data.
+ Client parameters.
@@ -15643,7 +18690,7 @@ Parameters:
- idclient_id
@@ -15660,33 +18707,15 @@ Parameters:
- Primary user ID.
+ Application client ID.
+
+
-
-
- provider
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Identity provider in use.
@@ -15695,32 +18724,32 @@ Parameters:
- user_iddata
-String
+Object
+
+
+
+
+
+
+
+
- Secondary user ID.
-
-
-
-
-
-
-
-
+ Updated client data.
@@ -15807,14 +18836,15 @@ Returns:
Example
- var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
+ var data = { name: 'newClientName' };
+var params = { client_id: CLIENT_ID };
-management.unlinkUsers(params, function (err, user) {
+management.updateClient(params, data, function (err, client) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ console.log(client.name); // 'newClientName'
});
@@ -15826,14 +18856,14 @@ Example
- updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
+ updateClientGrant(params, data, cbopt) → {Promise|undefined}
- Update the app metadata for a user.
+ Update an Auth0 client grant.
@@ -15869,7 +18899,7 @@ upda
Source:
Parameters:
- The user data object..
+ Client parameters.
@@ -15983,7 +19013,7 @@ Parameters:
- The user id.
+ Client grant ID.
@@ -16000,7 +19030,7 @@ Parameters:
- metadatadata
@@ -16025,7 +19055,7 @@ Parameters:
- New app metadata.
+ Updated client data.
@@ -16061,7 +19091,7 @@ Parameters:
- Callback function
+ Callback function.
@@ -16112,18 +19142,19 @@ Returns:
Example
- var params = { id: USER_ID };
-var metadata = {
- foo: 'bar'
+ var data = {
+ client_id: CLIENT_ID,
+ audience: AUDIENCE,
+ scope: []
};
+var params = { id: CLIENT_GRANT_ID };
-management.updateAppMetadata(params, metadata, function (err, user) {
+management.clientGrants.update(params, data, function (err, grant) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+ console.log(grant.id);
});
@@ -16135,14 +19166,14 @@ Example
- updateClient(params, data, cbopt) → {Promise|undefined}
+ updateConnection(params, data, cbopt) → {Promise|undefined}
- Update an Auth0 client.
+ Update an existing connection.
@@ -16178,7 +19209,7 @@ updateCli
Source:
Parameters:
- Client parameters.
+ Connection parameters.
@@ -16275,7 +19306,7 @@ Parameters:
- client_idid
@@ -16292,7 +19323,7 @@ Parameters:
- Application client ID.
+ Connection ID.
@@ -16334,7 +19365,7 @@ Parameters:
- Updated client data.
+ Updated connection data.
@@ -16421,15 +19452,15 @@ Returns:
Example
- var data = { name: 'newClientName' };
-var params = { client_id: CLIENT_ID };
+ var data = { name: 'newConnectionName' };
+var params = { id: CONNECTION_ID };
-management.updateClient(params, data, function (err, client) {
+management.updateConnection(params, data, function (err, connection) {
if (err) {
// Handle error.
}
- console.log(client.name); // 'newClientName'
+ console.log(connection.name); // 'newConnectionName'
});
@@ -16441,14 +19472,14 @@ Example
- updateConnection(params, data, cbopt) → {Promise|undefined}
+ updateEmailProvider(params, data, cbopt) → {Promise|undefined}
- Update an existing connection.
+ Update the email provider.
@@ -16484,7 +19515,7 @@ updat
Source:
Parameters:
- Connection parameters.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Connection ID.
-
-
-
-
-
-
-
-
+ Email provider parameters.
@@ -16640,7 +19620,7 @@ Parameters:
- Updated connection data.
+ Updated email provider data.
@@ -16727,15 +19707,13 @@ Returns:
Example
- var data = { name: 'newConnectionName' };
-var params = { id: CONNECTION_ID };
-
-management.updateConnection(params, data, function (err, connection) {
+ management.updateEmailProvider(params, data, function (err, provider) {
if (err) {
// Handle error.
}
- console.log(connection.name); // 'newConnectionName'
+ // Updated email provider.
+ console.log(provider);
});
@@ -16747,14 +19725,14 @@ Example
- updateEmailProvider(params, data, cbopt) → {Promise|undefined}
+ updateResourceServer(params, data, cbopt) → {Promise|undefined}
- Update the email provider.
+ Update an existing resource server.
@@ -16790,7 +19768,7 @@ up
Source:
Parameters:
- Email provider parameters.
+ Resource Server parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Resource Server ID.
+
+
+
+
+
+
+
+
@@ -16895,7 +19924,7 @@ Parameters:
- Updated email provider data.
+ Updated Resource Server data.
@@ -16982,13 +20011,15 @@ Returns:
Example
- management.updateEmailProvider(params, data, function (err, provider) {
+ var data = { name: 'newResourceServerName' };
+var params = { id: RESOURCE_SERVER_ID };
+
+management.updateResourceServer(params, data, function (err, resourceServer) {
if (err) {
// Handle error.
}
- // Updated email provider.
- console.log(provider);
+ console.log(resourceServer.name); // 'newResourceServerName'
});
@@ -17000,14 +20031,14 @@ Example
- updateResourceServer(params, data, cbopt) → {Promise|undefined}
+ updateRule(params, data, cbopt) → {Promise|undefined}
- Update an existing resource server.
+ Update an existing rule.
@@ -17043,7 +20074,7 @@ u
Source:
Parameters:
- Resource Server parameters.
+ Rule parameters.
@@ -17157,7 +20188,7 @@ Parameters:
- Resource Server ID.
+ Rule ID.
@@ -17199,7 +20230,7 @@ Parameters:
- Updated Resource Server data.
+ Updated rule data.
@@ -17286,15 +20317,14 @@ Returns:
Example
- var data = { name: 'newResourceServerName' };
-var params = { id: RESOURCE_SERVER_ID };
-
-management.updateResourceServer(params, data, function (err, resourceServer) {
+ var params = { id: RULE_ID };
+var data = { name: 'my-rule'};
+management.updateRule(params, data, function (err, rule) {
if (err) {
// Handle error.
}
- console.log(resourceServer.name); // 'newResourceServerName'
+ console.log(rule.name); // 'my-rule'.
});
@@ -17306,14 +20336,14 @@ Example
- updateRule(params, data, cbopt) → {Promise|undefined}
+ updateTenantSettings(data, cbopt) → {Promise|undefined}
- Update an existing rule.
+ Update the tenant settings.
@@ -17340,89 +20370,36 @@ updateRule<
-
-
-
-
-
-
-
- Source:
- Parameters:
-
-
-
-
-
-
- Name
-
+
- Type
+
-
- Attributes
-
+
-
+
+ Source:
+ Description
-
-
+
-
-
-
- params
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
- Rule parameters.
-
-
+
+ Parameters:
+
@@ -17434,6 +20411,8 @@ Parameters:
Type
+ Attributes
+
@@ -17444,40 +20423,6 @@ Parameters:
-
-
- id
-
-
-String
-
-
-
-
-
-
-
-
-
-
- Rule ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
dataParameters:
- Updated rule data.
+ The new tenant settings.
@@ -17592,14 +20537,10 @@ Returns:
Example
- var params = { id: RULE_ID };
-var data = { name: 'my-rule'};
-management.updateRule(params, data, function (err, rule) {
+ management.updateTenantSettings(data, function (err) {
if (err) {
// Handle error.
}
-
- console.log(rule.name); // 'my-rule'.
});
@@ -17611,14 +20552,14 @@ Example
- updateTenantSettings(data, cbopt) → {Promise|undefined}
+ updateUser(params, data, cbopt) → {Promise|undefined}
- Update the tenant settings.
+ Update a user by its id.
@@ -17654,7 +20595,7 @@ u
Source:
Parameters:
+
+
+ params
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The user parameters.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ id
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ The user id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
dataParameters:
- The new tenant settings.
+ New user data.
@@ -17761,7 +20787,7 @@ Parameters:
- Callback function.
+ Callback function
@@ -17812,10 +20838,15 @@ Returns:
Example
- management.updateTenantSettings(data, function (err) {
+ var params = { id: USER_ID };
+
+management.updateUser(params, data, function (err, user) {
if (err) {
// Handle error.
}
+
+ // Updated user.
+ console.log(user);
});
@@ -17827,14 +20858,14 @@ Example
- updateUser(params, data, cbopt) → {Promise|undefined}
+ updateUserMetadata(params, metadata, cbopt) → {Promise|undefined}
- Update a user by its id.
+ Update the user metadata for a user.
@@ -17870,7 +20901,7 @@ updateUser<
Source:
Parameters:
- The user parameters.
+ The user data object..
@@ -18001,7 +21032,7 @@ Parameters:
- datametadata
@@ -18026,7 +21057,7 @@ Parameters:
- New user data.
+ New user metadata.
@@ -18114,8 +21145,11 @@ Returns:
Example
var params = { id: USER_ID };
+var metadata = {
+ address: '123th Node.js Street'
+};
-management.updateUser(params, data, function (err, user) {
+management.updateUserMetadata(params, metadata, function (err, user) {
if (err) {
// Handle error.
}
@@ -18133,14 +21167,14 @@ Example
- updateUserMetadata(params, metadata, cbopt) → {Promise|undefined}
+ verifyCustomDomain(params, cbopt) → {Promise|undefined}
- Update the user metadata for a user.
+ Verify a Custom Domain.
@@ -18176,7 +21210,7 @@ upd
Source:
Parameters:
- The user data object..
+ Custom Domain parameters.
@@ -18290,7 +21324,7 @@ Parameters:
- The user id.
+ Custom Domain ID.
@@ -18305,40 +21339,6 @@ Parameters:
-
-
- metadata
-
-
-Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- New user metadata.
-
-
-
-
-
-
cbParameters:
- Callback function
+ Callback function.
@@ -18419,18 +21419,12 @@ Returns:
Example
- var params = { id: USER_ID };
-var metadata = {
- address: '123th Node.js Street'
-};
-
-management.updateUserMetadata(params, metadata, function (err, user) {
+ management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+ console.log(customDomain);
});
@@ -18454,7 +21448,7 @@ Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 98a360c74..ff9ee87b1 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.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 0c021904e..506dcf254 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 482cb0539..7088c566b 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.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 4a371256c..502ae2f83 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 c81f2d396..b7640c53a 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 d73bbea41..ce9e4385a 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 527516334..c659e73ae 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
@@ -835,7 +835,7 @@ Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6cc15b131..ccc194f35 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.UsersManager.html b/docs/module-management.UsersManager.html
index 4a29c2bcb..33658deef 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -5075,7 +5075,7 @@ Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 24524f386..138034ca4 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -150,7 +150,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index c703086b0..0a882f6e8 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
@@ -339,7 +339,7 @@ (static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index e1092abfd..c1d593455 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
@@ -124,7 +124,7 @@ utils.js
diff --git a/package.json b/package.json
index da7529028..80138069b 100644
--- a/package.json
+++ b/package.json
@@ -1,16 +1,16 @@
{
"name": "auth0",
- "version": "2.14.0",
+ "version": "2.15.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
- "files": [
- "src"
- ],
+ "files": ["src"],
"scripts": {
"test": "mocha -R spec ./test/**/*.tests.js ./test/*.tests.js",
- "test:ci": "istanbul cover _mocha --report lcovonly -R $(find ./test -name *.tests.js) -- -R mocha-multi --reporter-options spec=-,mocha-junit-reporter=-",
+ "test:ci":
+ "istanbul cover _mocha --report lcovonly -R $(find ./test -name *.tests.js) -- -R mocha-multi --reporter-options spec=-,mocha-junit-reporter=-",
"test:coverage": "codecov",
- "test:watch": "cross-env NODE_ENV=test mocha --timeout 5000 ./test/**/*.tests.js ./test/*.tests.js --watch",
+ "test:watch":
+ "cross-env NODE_ENV=test mocha --timeout 5000 ./test/**/*.tests.js ./test/*.tests.js --watch",
"jsdoc:generate": "jsdoc --configure .jsdoc.json --verbose",
"release:clean": "node scripts/cleanup.js",
"preversion": "node scripts/prepare.js",
@@ -22,10 +22,7 @@
"type": "git",
"url": "https://github.com/auth0/node-auth0"
},
- "keywords": [
- "auth0",
- "api"
- ],
+ "keywords": ["auth0", "api"],
"author": "Auth0",
"license": "MIT",
"bugs": {
License
This project is licensed under the MIT license. See the
diff --git a/docs/index.js.html b/docs/index.js.html
index 1c8d473a0..9e941863c 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -24,7 +24,7 @@
Create an Auth0 client grant. The client data object. Callback function. Delete an Auth0 client grant. Client parameters. Client grant ID. Callback function. Delete an Auth0 client grant. Client parameters. Client grant ID. Callback function. Get all Auth0 Client Grants. Client Grants parameters. Number of results per page. Page number, zero indexed. Callback function.
- 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.
- Get all Auth0 Client Grants. Delete an Auth0 client grant. Client Grants parameters. Client parameters. Number of results per page. Page number, zero indexed. Client grant ID.
- This method takes an optional object as first argument that may be used to
- specify pagination settings. If pagination options are not present,
- the first page of a limited number of results will be returned.
- Update an Auth0 client grant. Get all Auth0 Client Grants. Client parameters. Client Grants parameters. Client grant ID. Number of results per page. Updated client data. Page number, zero indexed.
+ 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.
+ Create an Auth0 Custom Domain. The custom domain data object. Callback function. Delete a Custom Domain. Get a Custom Domain. Get a Custom Domain. Get all Auth0 CustomDomains. Custom Domain parameters. Custom Domain ID. Callback function. Get a Custom Domain. Custom Domain parameters. Custom Domain ID. Callback function. Get all Auth0 CustomDomains. Get all Auth0 CustomDomains. Verify a Custom Domain. Custom Domain parameters. Custom Domain ID. Callback function. Clients parameters. A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields. true if the fields specified are to be excluded from the result, false otherwise (defaults to true) Create a Guardian enrollment ticket. Callback function. Provides an abstraction layer for consuming the
+Create job to export users endpoint Export all users to a file using a long running job. Users export data. The connection id of the connection from which users will be exported The format of the file. Valid values are: "json" and "csv". Limit the number of records. A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported. Callback function. Create a new connection. Create an Auth0 client grant. Connection data object. The client data object. Create an Auth0 credential. Create a new connection. The device credential data object. Connection data object. Create an email verification ticket. Create an Auth0 Custom Domain. The custom domain data object. Create a new password change ticket. Create an Auth0 credential. The device credential data object. Create a new resource server. Create an email verification ticket. Resource Server data object. Create a new rule. Create a Guardian enrollment ticket. Rule data object. Create a new user. Create a new password change ticket. User data. Delete all users. Create a new resource server. Resource Server data object. Callback function Callback function. Delete an Auth0 client. Create a new rule. Client parameters. Application client ID. Rule data object. Delete an existing connection. Create a new user. Connection parameters. Connection ID. User data. Delete an Auth0 device credential. Delete all users. Credential parameters. Callback function Device credential ID. Callback function. Delete email provider. Delete an Auth0 client. Client parameters. Application client ID. Delete a user's Guardian enrollment. Delete an Auth0 client grant. The Guardian enrollment data object. Client parameters. The Guardian enrollment id. Client grant ID. Delete an existing resource server. Delete an existing connection. Resource Server parameters. Connection parameters. Resource Server ID. Connection ID. Delete an existing rule. Delete a Custom Domain. Rule parameters. Custom Domain parameters. Rule ID. Custom Domain ID. Delete rules config. Delete an Auth0 device credential. Rule Configs parameters. Credential parameters. Rule Configs key. Device credential ID. Delete a user by its id. Delete email provider. The user data object.. Callback function. The user id. Callback function Delete a multifactor provider for a user. Delete a user's Guardian enrollment. Data object. The Guardian enrollment data object. The user id. Multifactor provider. The Guardian enrollment id. Callback function Callback function. Delete a multifactor provider for a user. Delete an existing resource server. Data object. Resource Server parameters. The user id. Multifactor provider. Resource Server ID. Callback function Callback function. Get a the active users count. Delete an existing rule. Rule parameters. Rule ID. Get all blacklisted tokens. Delete rules config. Callback function. Rule Configs parameters. Rule Configs key. Callback function. Get an Auth0 client. Delete a user by its id. Client parameters. The user data object.. Application client ID. The user id. Callback function. Callback function Return an object with information about the current client, Object containing client information. Get all Auth0 clients. Delete a multifactor provider for a user. Clients parameters. Data object. Number of results per page. The user id. Page number, zero indexed. Multifactor provider. Callback function. Callback function
- 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.
- Get an Auth0 connection. Delete a multifactor provider for a user. Connection parameters. Data object. Connection ID. The user id. Multifactor provider. Callback function. Callback function Get all connections. Export all users to a file using a long running job. Connections params. Users export data. Number of results per page. The connection id of the connection from which users will be exported The format of the file. Valid values are: "json" and "csv". Page number, zero indexed. Limit the number of records. A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
- 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.
- Get the daily stats. Get a the active users count. Stats parameters. Callback function. The first day in YYYYMMDD format. The last day in YYYYMMDD format. Callback function. Get all Auth0 credentials. Get all blacklisted tokens. Get the email provider. Get an Auth0 client. Client parameters. Application client ID. Get a single Guardian enrollment. Get all Auth0 Client Grants. The Guardian enrollment data object. Client Grants parameters. The Guardian enrollment id. Number of results per page. Callback function. Page number, zero indexed. Callback function.
+ 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.
+ Get a list of a user's Guardian enrollments. Return an object with information about the current client, Object containing client information. Get all Auth0 clients. The user data object. Clients parameters. The user id. Number of results per page. Page number, zero indexed.
+ 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.
+ Get a job by its ID. Get an Auth0 connection. Job parameters. Connection parameters. Job ID. Connection ID. Get an Auth0 log. Get all connections. Log parameters. Connections params. Event ID. Number of results per page. Page number, zero indexed.
+ 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.
+ Get all logs. Get a Custom Domain. Logs params. Custom Domain parameters. Custom Domain ID. Search Criteria using Query String Syntax Page number. Zero based Callback function. The amount of entries per page The field to use for sorting. A comma separated list of fields to include or exclude Get all Auth0 CustomDomains. true if the fields specified are to be included in the result, false otherwise. true if a query summary must be included in the result, false otherwise. Default false Callback function.
- 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.
- Get a Resource Server. Get the daily stats. Resource Server parameters. Stats parameters. Resource Server ID. The first day in YYYYMMDD format. The last day in YYYYMMDD format. Get all resource servers. Get all Auth0 credentials. Resource Servers parameters. Callback function. Number of results per page. Page number, zero indexed. Callback function.
- 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.
- Get an Auth0 rule. Get the email provider. Callback function. Rule parameters. Clients parameters. Rule ID. A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields. Callback function. true if the fields specified are to be excluded from the result, false otherwise (defaults to true) Get all rules. Get a single Guardian enrollment. Rules parameters. The Guardian enrollment data object. Number of results per page. Page number, zero indexed. The Guardian enrollment id.
- This method takes an optional object as first argument that may be used to
- specify pagination settings. If pagination options are not present,
- the first page of a limited number of results will be returned.
- Get rules config. Get a list of a user's Guardian enrollments. Get the tenant settings.. The user data object. The user id. Get a user by its id. Get a job by its ID. The user data object. Job parameters. The user id. Job ID. Get user's log events. Get an Auth0 log. Get logs data. Log parameters. User id. Event ID. Number of results per page. Callback function. Get all logs. Logs params. Search Criteria using Query String Syntax Page number. Zero based The amount of entries per page The field to use for sorting. A comma separated list of fields to include or exclude true if the fields specified are to be included in the result, false otherwise. true if a query summary must be included in the result, false otherwise. Default false Callback function.
+ 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.
+ Get a Resource Server. Resource Server parameters. Resource Server ID. Callback function. Get all resource servers. Resource Servers parameters. Number of results per page. Page number, zero indexed. Callback function.
+ 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.
+ Get an Auth0 rule. Rule parameters. Rule ID. Callback function. Get all rules. Rules parameters. Number of results per page. Page number, zero indexed. Callback function.
+ 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.
+ Get rules config. Get the tenant settings.. Callback function. Get a user by its id. The user data object. The user id. Callback function. Get user's log events. Get logs data. User id. Number of results per page. Page number, zero indexed. The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1. true if a query summary must be included in the result, false otherwise. Default false; Callback function. Get all users. Users params. The version of the search engine to use. Number of results per page. Page number, zero indexed. Callback function.
+ 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.
+ Get users for a given email address Page number, zero indexed. The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1. true if a query summary must be included in the result, false otherwise. Default false; Email Address of users to locate
+ This method takes an email address as the first argument,
+ and returns all users with that email address
+ Get all users. Given a path to a file and a connection id, create a new job that imports the
+users contained in the file and associate them with the given connection. Users params. Users import data. The version of the search engine to use. Number of results per page. Connection for the users insertion. Page number, zero indexed. Path to the users data file.
- 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.
- Get users for a given email address Link the user with another account. ID of the primary user. Secondary user data. ID of the user to be linked. Email Address of users to locate ID of the connection to be used.
- This method takes an email address as the first argument,
- and returns all users with that email address
- Given a path to a file and a connection id, create a new job that imports the
-users contained in the file and associate them with the given connection. Generate new Guardian recovery code. Users import data. The user data object. Connection for the users insertion. Path to the users data file. The user id. Link the user with another account. Send a verification email to a user. ID of the primary user. Secondary user data. User data object. ID of the user to be linked. ID of the connection to be used. ID of the user to be verified. Generate new Guardian recovery code. Set a new rules config. Rule Config parameters. Rule Config key. The user data object. Rule Config Data parameters. The user id. Rule Config Data value. Send a verification email to a user. Unlink the given accounts. User data object. Linked users data. Primary user ID. Identity provider in use. ID of the user to be verified. Secondary user ID. Set a new rules config. Update the app metadata for a user. Rule Config parameters. The user data object.. Rule Config key. The user id. Rule Config Data parameters. Rule Config Data value. New app metadata. Callback function. Callback function Unlink the given accounts. Update an Auth0 client. Linked users data. Client parameters. Primary user ID. Application client ID. Identity provider in use. Secondary user ID. Updated client data. Update the app metadata for a user. Update an Auth0 client grant. The user data object.. Client parameters. The user id. Client grant ID. New app metadata. Updated client data. Callback function Callback function. Update an Auth0 client. Update an existing connection. Client parameters. Connection parameters. Application client ID. Connection ID. Updated client data. Updated connection data. Update an existing connection. Update the email provider. Connection parameters. Connection ID. Email provider parameters. Updated connection data. Updated email provider data. Update the email provider. Update an existing resource server. Email provider parameters. Resource Server parameters. Resource Server ID. Updated email provider data. Updated Resource Server data. Update an existing resource server. Update an existing rule. Resource Server parameters. Rule parameters. Resource Server ID. Rule ID. Updated Resource Server data. Updated rule data. Update an existing rule. Update the tenant settings. Rule parameters. Rule ID. Updated rule data. The new tenant settings. Update the tenant settings. Update a user by its id. The user parameters. The user id. The new tenant settings. New user data. Callback function. Callback function Update a user by its id. Update the user metadata for a user. The user parameters. The user data object.. New user data. New user metadata. Update the user metadata for a user. Verify a Custom Domain. The user data object.. Custom Domain parameters. The user id. Custom Domain ID. New user metadata. Callback function Callback function.index.js
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html
index 48fdcb021..57186a500 100644
--- a/docs/management_BlacklistedTokensManager.js.html
+++ b/docs/management_BlacklistedTokensManager.js.html
@@ -24,7 +24,7 @@
management/BlacklistedTokensManager.js
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
index 02d124357..090f03820 100644
--- a/docs/management_ClientGrantsManager.js.html
+++ b/docs/management_ClientGrantsManager.js.html
@@ -24,7 +24,7 @@
management/ClientGrantsManager.js
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html
index ee848a5a2..c8a415528 100644
--- a/docs/management_ClientsManager.js.html
+++ b/docs/management_ClientsManager.js.html
@@ -24,7 +24,7 @@
management/ClientsManager.js
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html
index 15c95b0b1..70edd7e7a 100644
--- a/docs/management_ConnectionsManager.js.html
+++ b/docs/management_ConnectionsManager.js.html
@@ -24,7 +24,7 @@
management/ConnectionsManager.js
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
index 09e419d59..8940d287b 100644
--- a/docs/management_CustomDomainsManager.js.html
+++ b/docs/management_CustomDomainsManager.js.html
@@ -24,7 +24,7 @@
management/CustomDomainsManager.js
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
index f5dc2e012..9f64551f5 100644
--- a/docs/management_DeviceCredentialsManager.js.html
+++ b/docs/management_DeviceCredentialsManager.js.html
@@ -24,7 +24,7 @@
management/DeviceCredentialsManager.js
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
index 38f961049..276f60672 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
management/EmailProviderManager.js
* });
*
* @param {Function} [cb] Callback function.
- *
+ * @param {Object} [params] Clients parameters.
+ * @param {Number} [params.fields] A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
+ * @param {Number} [params.include_fields] true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(EmailProviderManager, 'get', 'resource.getAll');
@@ -195,7 +198,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index b926f4b92..1d5725300 100644
--- a/docs/management_EmailTemplatesManager.js.html
+++ b/docs/management_EmailTemplatesManager.js.html
@@ -24,7 +24,7 @@
management/EmailTemplatesManager.js
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html
index fd969d25b..3afa11710 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 0b1a0388d..409665611 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
management/JobsManager.js
options.tokenProvider
);
this.jobs = new RetryRestClient(auth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for consuming the
+ * {@link https://auth0.com/docs/api/v2#!/Jobs/post_users_exports Create job to export users endpoint}
+ *
+ * @type {external:RestClient}
+ */
+ const usersExportsRestClient = new Auth0RestClient(
+ options.baseUrl + '/jobs/users-exports',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.usersExports = new RetryRestClient(usersExportsRestClient, options.retry);
};
/**
@@ -155,7 +168,7 @@ management/JobsManager.js
* send_completion_email: false //optional
* };
*
- * management.jobs.get(params, function (err) {
+ * management.jobs.importUsers(params, function (err) {
* if (err) {
* // Handle error.
* }
@@ -235,6 +248,63 @@ management/JobsManager.js
return promise;
};
+/**
+ * Export all users to a file using a long running job.
+ *
+ * @method exportUsers
+ * @memberOf module:management.JobsManager.prototype
+ *
+ * @example
+ * var data = {
+ * connection_id: 'con_0000000000000001',
+ * format: 'csv',
+ * limit: 5,
+ * fields: [
+ * {
+ * "name": "user_id"
+ * },
+ * {
+ * "name": "name"
+ * },
+ * {
+ * "name": "email"
+ * },
+ * {
+ * "name": "identities[0].connection",
+ * "export_as": "provider"
+ * },
+ * {
+ * "name": "user_metadata.some_field"
+ * }
+ * ]
+ * }
+ *
+ * management.jobs.exportUsers(data, function (err, results) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Retrieved job.
+ * console.log(results);
+ * });
+ *
+ * @param {Object} data Users export data.
+ * @param {String} [data.connection_id] The connection id of the connection from which users will be exported
+ * @param {String} [data.format] The format of the file. Valid values are: "json" and "csv".
+ * @param {Number} [data.limit] Limit the number of records.
+ * @param {Object[]} [data.fields] A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+JobsManager.prototype.exportUsers = function(data, cb) {
+ if (cb && cb instanceof Function) {
+ return this.usersExports.create(data, cb);
+ }
+
+ return this.usersExports.create(data);
+};
+
/**
* Send a verification email to a user.
*
@@ -284,7 +354,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index 6c9f5b9ea..02b71be8d 100644
--- a/docs/management_LogsManager.js.html
+++ b/docs/management_LogsManager.js.html
@@ -24,7 +24,7 @@
management/LogsManager.js
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html
index 2b5b18db8..61a6fa94b 100644
--- a/docs/management_ManagementTokenProvider.js.html
+++ b/docs/management_ManagementTokenProvider.js.html
@@ -24,7 +24,7 @@
management/ManagementTokenProvider.js
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
index 3cfaa5da4..fafbb3aca 100644
--- a/docs/management_ResourceServersManager.js.html
+++ b/docs/management_ResourceServersManager.js.html
@@ -24,7 +24,7 @@
management/ResourceServersManager.js
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
index 18de21ac5..439658b62 100644
--- a/docs/management_RulesConfigsManager.js.html
+++ b/docs/management_RulesConfigsManager.js.html
@@ -24,7 +24,7 @@
management/RulesConfigsManager.js
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
index 8f51c048f..93eae695b 100644
--- a/docs/management_RulesManager.js.html
+++ b/docs/management_RulesManager.js.html
@@ -24,7 +24,7 @@
management/RulesManager.js
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html
index aff6e68c8..6ef638d33 100644
--- a/docs/management_StatsManager.js.html
+++ b/docs/management_StatsManager.js.html
@@ -24,7 +24,7 @@
management/StatsManager.js
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html
index 2a14fe60a..25f65f66b 100644
--- a/docs/management_TenantManager.js.html
+++ b/docs/management_TenantManager.js.html
@@ -24,7 +24,7 @@
management/TenantManager.js
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
index ce0b83bb6..03451ef26 100644
--- a/docs/management_TicketsManager.js.html
+++ b/docs/management_TicketsManager.js.html
@@ -24,7 +24,7 @@
management/TicketsManager.js
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html
index 76adaeaa4..e09e07ad9 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index 9e4daa584..a94ca9567 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
management/index.js
/**
* Get all Auth0 Client Grants.
*
- * @method getAll
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method getClientGrants
+ * @memberOf module:management.ManagementClient.prototype
*
* @example <caption>
* This method takes an optional object as first argument that may be used to
@@ -630,8 +630,8 @@ management/index.js
/**
* Create an Auth0 client grant.
*
- * @method create
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method createClientGrant
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.clientGrants.create(data, function (err) {
@@ -652,8 +652,8 @@ management/index.js
/**
* Update an Auth0 client grant.
*
- * @method update
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method updateClientGrant
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* var data = {
@@ -683,8 +683,8 @@ management/index.js
/**
* Delete an Auth0 client grant.
*
- * @method delete
- * @memberOf module:management.ClientGrantsManager.prototype
+ * @method deleteClientGrant
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.clientGrants.delete({ id: GRANT_ID }, function (err) {
@@ -1430,7 +1430,10 @@ management/index.js
* });
*
* @param {Function} [cb] Callback function.
- *
+ * @param {Object} [params] Clients parameters.
+ * @param {Number} [params.fields] A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
+ * @param {Number} [params.include_fields] true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(ManagementClient, 'getEmailProvider', 'emailProvider.get');
@@ -1649,6 +1652,57 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'importUsers', 'jobs.importUsers');
+/**
+ * Export all users to a file using a long running job.
+ *
+ * @method exportUsers
+ * @memberOf module:management.ManagementClient.prototype
+ *
+ * @example
+ * var data = {
+ * connection_id: 'con_0000000000000001',
+ * format: 'csv',
+ * limit: 5,
+ * fields: [
+ * {
+ * "name": "user_id"
+ * },
+ * {
+ * "name": "name"
+ * },
+ * {
+ * "name": "email"
+ * },
+ * {
+ * "name": "identities[0].connection",
+ * "export_as": "provider"
+ * },
+ * {
+ * "name": "user_metadata.some_field"
+ * }
+ * ]
+ * }
+ *
+ * management.exportUsers(data, function (err, results) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // Retrieved job.
+ * console.log(results);
+ * });
+ *
+ * @param {Object} data Users export data.
+ * @param {String} [data.connection_id] The connection id of the connection from which users will be exported
+ * @param {String} [data.format] The format of the file. Valid values are: "json" and "csv".
+ * @param {Number} [data.limit] Limit the number of records.
+ * @param {Object[]} [data.fields] A list of fields to be included in the CSV. If omitted, a set of predefined fields will be exported.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'exportUsers', 'jobs.exportUsers');
+
/**
* Send a verification email to a user.
*
@@ -1982,8 +2036,8 @@ management/index.js
/**
* Create an Auth0 Custom Domain.
*
- * @method create
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method createCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.createCustomDomain(data, function (err) {
@@ -2004,8 +2058,8 @@ management/index.js
/**
* Get all Auth0 CustomDomains.
*
- * @method getAll
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method getCustomDomains
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.getCustomDomains(function (err, customDomains) {
@@ -2019,8 +2073,8 @@ management/index.js
/**
* Get a Custom Domain.
*
- * @method get
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method getCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
@@ -2042,8 +2096,8 @@ management/index.js
/**
* Verify a Custom Domain.
*
- * @method verify
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method verifyCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
@@ -2065,8 +2119,8 @@ management/index.js
/**
* Delete a Custom Domain.
*
- * @method delete
- * @memberOf module:management.CustomDomainsManager.prototype
+ * @method deleteCustomDomain
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
@@ -2089,7 +2143,7 @@ management/index.js
* Create a Guardian enrollment ticket.
*
* @method createGuardianEnrollmentTicket
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* @example
* management.createGuardianEnrollmentTicket(function (err, ticket) {
@@ -2110,7 +2164,7 @@ management/index.js
* Get a list of Guardian factors and statuses.
*
* @method getGuardianFactors
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.getGuardianFactors(function (err, factors) {
* console.log(factors.length);
@@ -2126,7 +2180,7 @@ management/index.js
* Get Guardian factor provider configuration
*
* @method getGuardianFactorProvider
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
* console.log(provider);
@@ -2147,7 +2201,7 @@ management/index.js
* Update Guardian's factor provider
*
* @method updateFactorProvider
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
* messaging_service_sid: 'XXXXXXXXXXXXXX',
@@ -2173,7 +2227,7 @@ management/index.js
* Get Guardian enrollment and verification factor templates
*
* @method getGuardianFactorTemplates
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
* console.log(templates);
@@ -2194,7 +2248,7 @@ management/index.js
* Update Guardian enrollment and verification factor templates
*
* @method updateGuardianFactorTemplates
- * @memberOf module:management.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.updateGuardianFactorTemplates({ name: 'sms' }, {
* enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
@@ -2219,7 +2273,7 @@ management/index.js
* Update Guardian Factor
*
* @method updateGuardianFactor
- * @memberOf module.GuardianManager.prototype
+ * @memberOf module:management.ManagementClient.prototype
*
* management.updateGuardianFactor({ name: 'sms' }, {
* enabled: true
@@ -2248,7 +2302,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index fb612176b..3759ff8a2 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index b7b29e7b2..64f95eedb 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
Parameters:
-
+
-
-
-
+
+ Stinrg
+String
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
index 8697b3777..f161a65ee 100644
--- a/docs/module-auth.OAUthWithIDTokenValidation.html
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -24,7 +24,7 @@
Source:
Parameters:
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 1a653544b..9aec2c527 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index e81cdc6c4..e20079a2c 100644
--- a/docs/module-auth.PasswordlessAuthenticator.html
+++ b/docs/module-auth.PasswordlessAuthenticator.html
@@ -24,7 +24,7 @@
Examples
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
index 97a1daf27..c01be4808 100644
--- a/docs/module-auth.TokensManager.html
+++ b/docs/module-auth.TokensManager.html
@@ -24,7 +24,7 @@
Parameters:
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html
index 1b625dd20..f35ae1e47 100644
--- a/docs/module-auth.UsersManager.html
+++ b/docs/module-auth.UsersManager.html
@@ -24,7 +24,7 @@
Example
diff --git a/docs/module-auth.html b/docs/module-auth.html
index 249e89209..cc295c8ec 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
Classes
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 0451d5674..094d54110 100644
--- a/docs/module-management.BlacklistedTokensManager.html
+++ b/docs/module-management.BlacklistedTokensManager.html
@@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
index dee679a9a..a14a07f8c 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
Example
- create(data, cbopt) → {Promise|undefined}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
- data
-
-
-
-
-
- Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-cb
-
-
-
-
-
- function
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
-
- Returns:
-
-
-
-
-
-
-
-
-Promise
-|
-
-undefined
-
-
- Example
-
-
-
-management.clientGrants.create(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Client grant created.
-});delete(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
- params
-
-
-
-
-
- Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-id
-
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
-
-
-cb
-
-
-
-
-
- function
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
-
- Returns:
-
-
-
-
-
-
-
-
-Promise
-|
-
-undefined
-
-
- Example
-
-
-
-management.clientGrants.delete({ id: GRANT_ID }, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Grant deleted.
-});delete(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
- params
-
-
-
-
-
- Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-id
-
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
-
-
-cb
-
-
-
-
-
- function
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
-
- Returns:
-
-
-
-
-
-
-
-
-Promise
-|
-
-undefined
-
-
- Example
-
-
-
-management.clientGrants.delete({ id: GRANT_ID }, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Grant deleted.
-});getAll(paramsopt, cbopt) → {Promise|undefined}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
- params
-
-
-
-
-
- Object
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
- per_page
-
-
-
-
-
- Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-page
-
-
-
-
-
- Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-cb
-
-
-
-
-
- function
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
-
- Returns:
-
-
-
-
-
-
-
-
-Promise
-|
-
-undefined
-
-
- Example
-
-
-
-// Pagination settings.
-var params = {
- per_page: 10,
- page: 0
-};
-
-management.getClientGrants(params, function (err, grants) {
- console.log(grants.length);
-});getAll(paramsopt, cbopt) → {Promise|undefined}
+ delete(params, cbopt) → {Promise|undefined}
getAllSource:
Parameters:
- <optional>
-
@@ -1916,7 +831,7 @@ Parameters:
- Parameters:
Type
- Attributes
-
@@ -1944,70 +857,24 @@ Parameters:
-
-
-
-
- per_page
-
-
-
-
-
- Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -2102,21 +969,12 @@ pageid
-
- Number
+String
-
- <optional>
-
-
-
-
-
-
-
-
Returns:
Example
- // Pagination settings.
-var params = {
- per_page: 10,
- page: 0
-};
-
+ management.clientGrants.delete({ id: GRANT_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
-management.clientGrants.getAll(params, function (err, grants) {
- console.log(grants.length);
+ // Grant deleted.
});Example
- update(params, data, cbopt) → {Promise|undefined}
+ getAll(paramsopt, cbopt) → {Promise|undefined}
updateSource:
Parameters:
+ <optional>
+
@@ -2242,7 +1102,7 @@ Parameters:
- Parameters:
Type
+ Attributes
+
@@ -2268,32 +1130,34 @@ Parameters:
-
+ idper_page
-
+ String
+Number
+
+ <optional>
+
-
+
-
-
-
+
@@ -2302,13 +1166,13 @@ Parameters:
-
+
+
+
+
+
@@ -2414,19 +1288,21 @@ datapage
- Object
+Number
@@ -2317,6 +1181,8 @@ Parameters:
+ <optional>
+
@@ -2327,7 +1193,15 @@ Parameters:
-
+ Returns:
Example
- var data = {
- client_id: CLIENT_ID,
- audience: AUDIENCE,
- scope: []
+ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
};
-var params = { id: CLIENT_GRANT_ID };
-management.clientGrants.update(params, data, function (err, grant) {
- if (err) {
- // Handle error.
- }
- console.log(grant.id);
+management.clientGrants.getAll(params, function (err, grants) {
+ console.log(grants.length);
});Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 02612947b..0b77f92d1 100644
--- a/docs/module-management.ClientsManager.html
+++ b/docs/module-management.ClientsManager.html
@@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
index 7ebfbcc77..c6a8da76d 100644
--- a/docs/module-management.ConnectionsManager.html
+++ b/docs/module-management.ConnectionsManager.html
@@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
index 6c4def656..c61671616 100644
--- a/docs/module-management.CustomDomainsManager.html
+++ b/docs/module-management.CustomDomainsManager.html
@@ -24,7 +24,7 @@
Example
create(data, cbopt) → {Promise|undefined}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
- data
-
-
-
-
-
- Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-cb
-
-
-
-
-
- function
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
-
- Returns:
-
-
-
-
-
-
-
-
-Promise
-|
-
-undefined
-
-
- Example
-
-
-
-management.createCustomDomain(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // CustomDomain created.
-});deleteSource:
Returns:
Example
- management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ management.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
if (err) {
// Handle error.
}
@@ -1283,14 +1065,14 @@ Example
- delete(params, cbopt) → {Promise|undefined}
+ get(params, cbopt) → {Promise|undefined}
deleteSource:
Returns:
Example
- management.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ management.customDomains.get({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
if (err) {
// Handle error.
}
- // CustomDomain deleted.
+ console.log(customDomain);
});Example
- get(params, cbopt) → {Promise|undefined}
+ getAll() → {Promise|undefined}
getSource:
get
-
-
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
- params
-
-
-
-
-
- Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-id
-
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-cb
-
-
-
-
-
- function
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
-
- Returns:
-
-
-
-
-
-
-
-
-Promise
-|
-
-undefined
-
-
- Example
-
-
-
-management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
- if (err) {
- // Handle error.
- }
-
- console.log(customDomain);
-});get(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
- params
-
-
-
-
-
- Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-id
-
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
-
-
-cb
-
-
-
-
-
- function
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
-
- Returns:
-
-
-
-
-
-
-
-
-Promise
-|
-
-undefined
-
-
- Example
-
-
-
-management.customDomains.get({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
- if (err) {
- // Handle error.
- }
-
- console.log(customDomain);
-});getAll() → {Promise|undefined}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
-
-
-
-
-Promise
-|
-
-undefined
-
-
- Example
-
-
-
-management.getCustomDomains(function (err, customDomains) {
- console.log(customDomains.length);
-});getAll() → {Promise|undefined}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
-
-
-
-
-Promise
-|
-
-undefined
-
-
- Example
-
-
-
-management.customDomains.getAll(function (err, customDomains) {
- console.log(customDomains.length);
-});verify(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
-
@@ -2574,12 +1437,8 @@
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
- params
-
-
-
-
-
- Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-id
-
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
-
-
-cb
-
-
-
-
-
- function
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
-
- Returns:
Example
- management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
- if (err) {
- // Handle error.
- }
-
- console.log(customDomain);
+ management.customDomains.getAll(function (err, customDomains) {
+ console.log(customDomains.length);
});Example
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index 01d6666b7..c87bb56fc 100644
--- a/docs/module-management.DeviceCredentialsManager.html
+++ b/docs/module-management.DeviceCredentialsManager.html
@@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
index 52441ed0a..530ab5dcb 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
deleteSource:
Example
- get(cbopt) → {Promise|undefined}
+ get(cbopt, paramsopt) → {Promise|undefined}
@@ -1022,6 +1022,141 @@ Parameters:
+
+
+
+
+
+
@@ -1123,7 +1258,7 @@ params
+
+
+
+
+
+ Object
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ fields
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+include_fields
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ updateSource:
Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index 2495916b4..ecaea5ef5 100644
--- a/docs/module-management.EmailTemplatesManager.html
+++ b/docs/module-management.EmailTemplatesManager.html
@@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
index eff768fda..59e6fb9d8 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
Example
createGuardianEnrollmentTicket(cbopt) → {Promise|undefined}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-cb
-
-
-
-
-
- function
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
-
- Returns:
-
-
-
-
-
-
-
-
-Promise
-|
-
-undefined
-
-
- Example
-
-
-
-management.createGuardianEnrollmentTicket(function (err, ticket) {
- console.log(ticket);
-});Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index a17cf8ff0..a8d359bf4 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
(inner)
+
+
+
+
Type:
+
+
+
+
+
+
+
+external:RestClient
+
+
+ (inner, constant) usersExportsRestClient :external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -419,6 +494,420 @@ Methods
+exportUsers(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ data
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ connection_id
+
+
+
+
+
+ String
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ format
+
+
+
+
+
+ String
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ limit
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+fields
+
+
+
+
+
+ Array.<Object>
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+
+
+
+
+
+
+
+
+Promise
+|
+
+undefined
+
+
+ Example
+
+
+
+var data = {
+ connection_id: 'con_0000000000000001',
+ format: 'csv',
+ limit: 5,
+ fields: [
+ {
+ "name": "user_id"
+ },
+ {
+ "name": "name"
+ },
+ {
+ "name": "email"
+ },
+ {
+ "name": "identities[0].connection",
+ "export_as": "provider"
+ },
+ {
+ "name": "user_metadata.some_field"
+ }
+ ]
+}
+
+management.jobs.exportUsers(data, function (err, results) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Retrieved job.
+ console.log(results);
+});getSource:
importUser
Example
send_completion_email: false //optional
};
-management.jobs.get(params, function (err) {
+management.jobs.importUsers(params, function (err) {
if (err) {
// Handle error.
}
@@ -1120,7 +1609,7 @@ verifyEmai
Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index a476b9d52..c022c6e50 100644
--- a/docs/module-management.LogsManager.html
+++ b/docs/module-management.LogsManager.html
@@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
index bc804d928..843cb3828 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
Source:
Example
- createConnection(data, cbopt) → {Promise|undefined}
+ createClientGrant(data, cbopt) → {Promise|undefined}
creat
Parameters:
-
@@ -2970,12 +2970,12 @@ Returns:
Example
- management.createConnection(data, function (err) {
+ management.clientGrants.create(data, function (err) {
if (err) {
// Handle error.
}
- // Conection created.
+ // Client grant created.
});Example
- createDevicePublicKey(data, cbopt) → {Promise|undefined}
+ createConnection(data, cbopt) → {Promise|undefined}
Parameters:
-
@@ -3193,7 +3193,7 @@ Example
// Handle error.
}
- // Credential created.
+ // Conection created.
});
Example
- createEmailVerificationTicket(cbopt) → {Promise}
+ createCustomDomain(data, cbopt) → {Promise|undefined}
Source:
Parameters:
+
+
+
+
+
+
data
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -10928,13 +11084,13 @@ cbReturns:
Promise
+|
+
+undefined
Returns:
Example
- var data = {
- user_id: '{USER_ID}',
- result_url: '{REDIRECT_URL}' // Optional redirect after the ticket is used.
-};
-
-auth0.createEmailVerificationTicket(data, function (err) {
+ management.createCustomDomain(data, function (err) {
if (err) {
// Handle error.
}
+
+ // CustomDomain created.
});Example
- createPasswordChangeTicket(cbopt) → {Promise}
+ createDevicePublicKey(data, cbopt) → {Promise|undefined}
Source:
Parameters:
+
+
+
+
+
+
data
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -10457,17 +10566,12 @@ cbReturns:
Promise
+|
+
+undefined
Returns:
Example
- var params = {
- result_url: '{REDIRECT_URL}', // Redirect after using the ticket.
- user_id: '{USER_ID}', // Optional.
- email: '{USER_EMAIL}', // Optional.
- new_password: '{PASSWORD}'
-};
-
-auth0.createPasswordChangeTicket(params, function (err) {
+ management.createConnection(data, function (err) {
if (err) {
// Handle error.
}
+
+ // Credential created.
});Example
- createResourceServer(data, cbopt) → {Promise|undefined}
+ createEmailVerificationTicket(cbopt) → {Promise}
c
Parameters:
-
-
-
-
-
-
data
-
-
-
-
-
- Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+ cbReturns:
Promise
-|
-
-undefined
Returns:
Example
- management.createResourceServer(data, function (err) {
+ var data = {
+ user_id: '{USER_ID}',
+ result_url: '{REDIRECT_URL}' // Optional redirect after the ticket is used.
+};
+
+auth0.createEmailVerificationTicket(data, function (err) {
if (err) {
// Handle error.
}
-
- // Resource Server created.
});Example
- createRule(data, cbopt) → {Promise|undefined}
+ createGuardianEnrollmentTicket(cbopt) → {Promise|undefined}
createRule<
Parameters:
-
-
-
-
-
-
data
-
-
-
-
-
- Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -7031,14 +6814,12 @@ cbReturns:
Example
- management.createRule(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // Rule created.
+ management.createGuardianEnrollmentTicket(function (err, ticket) {
+ console.log(ticket);
});Example
- createUser(data, cbopt) → {Promise|undefined}
+ createPasswordChangeTicket(cbopt) → {Promise}
createUser<
Parameters:
-
-
-
-
-
-
data
-
-
-
-
-
- Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -6736,12 +6545,12 @@ cbReturns:
Promise
-|
-
-undefined
Returns:
Example
- management.createUser(data, function (err) {
- if (err) {
- // Handle error.
- }
-
- // User created.
+ var params = {
+ result_url: '{REDIRECT_URL}', // Redirect after using the ticket.
+ user_id: '{USER_ID}', // Optional.
+ email: '{USER_EMAIL}', // Optional.
+ new_password: '{PASSWORD}'
+};
+
+auth0.createPasswordChangeTicket(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
});Example
- deleteAllUsers(cbopt) → {Promise|undefined}
+ createResourceServer(data, cbopt) → {Promise|undefined}
deleteA
-
deleteA
Parameters:
+
+
+
+
+
+
data
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -4398,12 +4392,12 @@ cbParameters:
-
Returns:
Example
- management.deleteAllUsers(function (err) {
+ management.createResourceServer(data, function (err) {
if (err) {
// Handle error.
}
- // Users deleted
+ // Resource Server created.
});Example
- deleteClient(params, cbopt) → {Promise|undefined}
+ createRule(data, cbopt) → {Promise|undefined}
deleteCli
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Parameters:
-
@@ -4667,12 +4610,12 @@ paramsdata
@@ -4529,58 +4523,7 @@ Parameters:
-
-
-
-
+
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-client_id
-
-
-
-
-
-
-
-
- String
-
-
-
-
-
- Returns:
Example
- management.deleteClient({ client_id: CLIENT_ID }, function (err) {
+ management.createRule(data, function (err) {
if (err) {
// Handle error.
}
- // Client deleted.
+ // Rule created.
});Example
- deleteConnection(params, cbopt) → {Promise|undefined}
+ createUser(data, cbopt) → {Promise|undefined}
delet
Parameters:
-
@@ -4936,12 +4828,12 @@ paramsdata
@@ -4798,58 +4741,7 @@ Parameters:
-
-
-
-
+
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-id
-
-
-
-
-
-
-
-
- String
-
-
-
-
-
- Returns:
Example
- management.deleteConnection({ id: CONNECTION_ID }, function (err) {
+ management.createUser(data, function (err) {
if (err) {
// Handle error.
}
- // Conection deleted.
+ // User created.
});Example
- deleteDeviceCredential(params, cbopt) → {Promise|undefined}
+ deleteAllUsers(cbopt) → {Promise|undefined}
Deprecated:
Source:
Parameters:
-
-
-
-
- paramscb
- Object
+function
@@ -5057,6 +4951,8 @@ Parameters:
+ <optional>
+
@@ -5067,119 +4963,32 @@ Parameters:
-
-
-
-
-
-
-
-
- Name
-
+
+ Type
+
+
+Description
-
-
-
-
-
-
-
-
-
-
+id
-
-
-
-
-
- String
-
-
-
- Returns:
-
-
-
-
-
- cb
-
-
-
-
-
- function
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
-
- Returns:
-
-
+
Returns:
Example
- var params = { id: CREDENTIAL_ID };
-
-management.deleteDeviceCredential(params, function (err) {
+ management.deleteAllUsers(function (err) {
if (err) {
// Handle error.
}
- // Credential deleted.
+ // Users deleted
});Example
- deleteEmailProvider(cbopt) → {Promise|undefined}
+ deleteClient(params, cbopt) → {Promise|undefined}
de
Parameters:
+
+
+
+
+
+
params
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+client_id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
@@ -5929,12 +5821,12 @@ cbReturns:
Example
- management.deleteEmailProvider(function (err) {
+ management.deleteClient({ client_id: CLIENT_ID }, function (err) {
if (err) {
// Handle error.
}
- // Email provider deleted.
+ // Client deleted.
});Example
- deleteGuardianEnrollment(data, cbopt) → {Promise|undefined}
+ deleteClientGrant(params, cbopt) → {Promise|undefined}
Source:
Parameters:
-
@@ -5660,12 +5552,12 @@ dataparams
@@ -5522,7 +5414,7 @@ Parameters:
- Parameters:
-
Returns:
Example
- management.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err) {
+ management.clientGrants.delete({ id: GRANT_ID }, function (err) {
if (err) {
// Handle error.
}
- // Email provider deleted.
+ // Grant deleted.
});Example
- deleteResourceServer(params, cbopt) → {Promise|undefined}
+ deleteConnection(params, cbopt) → {Promise|undefined}
d
Parameters:
- Parameters:
-
Returns:
Example
- management.deleteResourceServer({ id: RESOURCE_SERVER_ID }, function (err) {
+ management.deleteConnection({ id: CONNECTION_ID }, function (err) {
if (err) {
// Handle error.
}
- // Resource Server deleted.
+ // Conection deleted.
});Example
- deleteRule(params, cbopt) → {Promise|undefined}
+ deleteCustomDomain(params, cbopt) → {Promise|undefined}
deleteRule<
-
+
+ Parameters:
- Parameters:
-
@@ -6198,12 +6090,12 @@ Returns:
Example
- auth0.deleteRule({ id: RULE_ID }, function (err) {
+ management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
if (err) {
// Handle error.
}
- // Rule deleted.
+ // CustomDomain deleted.
});Example
- deleteRulesConfig(params, cbopt) → {Promise|undefined}
+ deleteDeviceCredential(params, cbopt) → {Promise|undefined}
dele
Parameters:
- Parameters:
-
@@ -6467,12 +6359,14 @@ keyid
@@ -6372,7 +6264,7 @@ Parameters:
-
Returns:
Example
- management.deleteRulesConfig({ key: RULE_CONFIG_KEY }, function (err) {
+ var params = { id: CREDENTIAL_ID };
+
+management.deleteDeviceCredential(params, function (err) {
if (err) {
// Handle error.
}
- // Rules Config deleted.
+ // Credential deleted.
});Example
- deleteUser(params, cbopt) → {Promise|undefined}
+ deleteEmailProvider(cbopt) → {Promise|undefined}
deleteUser<
Parameters:
-
-
-
-
- paramscb
- Object
+function
@@ -6588,6 +6482,8 @@ Parameters:
+ <optional>
+
@@ -6598,101 +6494,14 @@ Parameters:
-
-
-
-
-
-
-
-
-
- Name
-
+
+ Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
-
-
-
-
-id
-
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-
-
-
- function
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
-
- Returns:
Example
- management.deleteUser({ id: USER_ID }, function (err) {
+ management.deleteEmailProvider(function (err) {
if (err) {
// Handle error.
}
- // User deleted.
+ // Email provider deleted.
});Example
- deleteUserMultifactor(params, cbopt) → {Promise|undefined}
+ deleteGuardianEnrollment(data, cbopt) → {Promise|undefined}
Parameters:
-
-
-
-
- paramsdata
@@ -6867,7 +6676,7 @@ Parameters:
- Parameters:
-
-
-
-
@@ -6980,7 +6763,7 @@ provider
-
-
-
-
-
-
-
-
- String
-
-
-
-
-
Parameters:
-
Returns:
Example
- var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-
-management.deleteUserMultifactor(params, function (err, user) {
+ management.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // Email provider deleted.
});Example
- deleteUserMultifcator(params, cbopt) → {Promise|undefined}
+ deleteResourceServer(params, cbopt) → {Promise|undefined}
-
+
+
+ deleteUserMultifactor instead.
Parameters:
- Parameters:
-
-
-
-
-
-
-
-
@@ -7281,7 +7032,7 @@ provider
-
-
-
-
-
-
-
-
- String
-
-
-
-
-
Parameters:
-
@@ -7332,14 +7083,12 @@ Returns:
Example
- var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-
-management.deleteUserMultifcator(params, function (err, user) {
+ management.deleteResourceServer({ id: RESOURCE_SERVER_ID }, function (err) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // Resource Server deleted.
});Example
- getActiveUsersCount(cbopt) → {Promise|undefined}
+ deleteRule(params, cbopt) → {Promise|undefined}
ge
Parameters:
+
+
+
+
+
+
params
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
@@ -7967,12 +7890,12 @@ cbReturns:
Example
- management.getActiveUsersCount(function (err, usersCount) {
+ auth0.deleteRule({ id: RULE_ID }, function (err) {
if (err) {
// Handle error.
}
- console.log(usersCount);
+ // Rule deleted.
});Example
- getBlacklistedTokens(cbopt) → {Promise|undefined}
+ deleteRulesConfig(params, cbopt) → {Promise|undefined}
g
Parameters:
-
+
+
+
+ cbparams
- function
+Object
@@ -7639,8 +7473,6 @@ Parameters:
- <optional>
-
@@ -7651,7 +7483,94 @@ Parameters:
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+key
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
@@ -7702,8 +7621,12 @@ cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
Example
- management.getBlacklistedTokens(function (err, tokens) {
- console.log(tokens.length);
+ management.deleteRulesConfig({ key: RULE_CONFIG_KEY }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Rules Config deleted.
});Example
- getClient(params, cbopt) → {Promise|undefined}
+ deleteUser(params, cbopt) → {Promise|undefined}
getClient
Parameters:
- Parameters:
-
@@ -7916,7 +7839,7 @@ client_idid
@@ -7872,7 +7795,7 @@ Parameters:
-
Parameters:
-
Returns:
Example
- management.getClient({ client_id: CLIENT_ID }, function (err, client) {
+ management.deleteUser({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
- console.log(client);
+ // User deleted.
});Example
- getClientInfo() → {Object}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
-
-
-
-Object
-
-
- getClients(paramsopt, cbopt) → {Promise|undefined}
+ deleteUserMultifactor(params, cbopt) → {Promise|undefined}
getClients<
Parameters:
- <optional>
-
@@ -8208,7 +8021,7 @@ Parameters:
- Parameters:
Type
- Attributes
-
@@ -8236,34 +8047,24 @@ Parameters:
-
@@ -8272,34 +8073,24 @@ per_pageid
-
- Number
+String
-
- <optional>
-
-
-
-
-
-
-
-
Parameters:
-
@@ -8343,7 +8134,7 @@ pageprovider
-
- Number
+String
-
- <optional>
-
-
-
-
-
-
-
-
Parameters:
-
@@ -8394,20 +8185,14 @@ Returns:
Example
- // Pagination settings.
-var params = {
- per_page: 10,
- page: 0
-};
+ var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-management.getClients(params, function (err, clients) {
- console.log(clients.length);
+management.deleteUserMultifactor(params, function (err, user) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Users accounts unlinked.
});Example
- getConnection(params, cbopt) → {Promise|undefined}
+ deleteUserMultifcator(params, cbopt) → {Promise|undefined}
getConne
+
deleteUserMultifactor instead.getConne
Parameters:
- Parameters:
-
+
+
+
+
+
+
+
@@ -8620,7 +8435,7 @@ provider
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
Parameters:
-
@@ -8671,12 +8486,14 @@ Returns:
Example
- management.getConnection({ id: CONNECTION_ID }, function (err, connection) {
+ var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
+
+management.deleteUserMultifcator(params, function (err, user) {
if (err) {
// Handle error.
}
- console.log(connection);
+ // Users accounts unlinked.
});Example
- getConnections(paramsopt, cbopt) → {Promise|undefined}
+ exportUsers(data, cbopt) → {Promise|undefined}
getConn
Parameters:
- paramsdata
@@ -8792,8 +8609,6 @@ Parameters:
- <optional>
-
@@ -8804,7 +8619,7 @@ Parameters:
- Parameters:
-
@@ -8868,7 +8683,43 @@ per_pageconnection_id
- Number
+String
@@ -8859,7 +8674,7 @@ Parameters:
-
Parameters:
-
+
+
+
+ pageformat
+
+
+
+
+
+ String
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ limit
@@ -8895,7 +8746,43 @@ Parameters:
-
+
+
+
@@ -8990,20 +8877,37 @@ fields
+
+
+
+
+
+ Array.<Object>
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
Example
- // Pagination settings.
-var params = {
- per_page: 10,
- page: 0
-};
+ var data = {
+ connection_id: 'con_0000000000000001',
+ format: 'csv',
+ limit: 5,
+ fields: [
+ {
+ "name": "user_id"
+ },
+ {
+ "name": "name"
+ },
+ {
+ "name": "email"
+ },
+ {
+ "name": "identities[0].connection",
+ "export_as": "provider"
+ },
+ {
+ "name": "user_metadata.some_field"
+ }
+ ]
+}
+
+management.exportUsers(data, function (err, results) {
+ if (err) {
+ // Handle error.
+ }
-management.getConnections(params, function (err, connections) {
- console.log(connections.length);
+ // Retrieved job.
+ console.log(results);
});Example
- getDailyStats(params, cbopt) → {Promise|undefined}
+ getActiveUsersCount(cbopt) → {Promise|undefined}
getDaily
Parameters:
-
-
-
-
- paramscb
- Object
+function
@@ -9119,6 +9023,8 @@ Parameters:
+ <optional>
+
@@ -9129,156 +9035,43 @@ Parameters:
-
-
-
-
-
-
-
-
- Name
-
+
+ Type
+
+
+Description
-
-
-
-
- from
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- to
-
-
-
+String
+Returns:
+
-
-
+
Promise
+|
-
-
-
-
-
-
-
-
-
-
-
- cb
-
-
-
-
-
- function
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
-
- Returns:
-
-
-
-
-
Promise
-|
-
-undefined
+undefined
Returns:
Example
- var params = {
- from: '{YYYYMMDD}', // First day included in the stats.
- to: '{YYYYMMDD}' // Last day included in the stats.
-};
-
-management.getDaily(params, function (err, stats) {
+ management.getActiveUsersCount(function (err, usersCount) {
if (err) {
// Handle error.
}
- console.log(stats);
+ console.log(usersCount);
});Example
- getDeviceCredentials(cbopt) → {Promise|undefined}
+ getBlacklistedTokens(cbopt) → {Promise|undefined}
g
Returns:
Example
- management.getDeviceCredentials(function (err, credentials) {
- console.log(credentials.length);
+ management.getBlacklistedTokens(function (err, tokens) {
+ console.log(tokens.length);
});Example
- getEmailProvider(cbopt) → {Promise|undefined}
+ getClient(params, cbopt) → {Promise|undefined}
getEm
Parameters:
+
+
+
+
+
+
params
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+client_id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
-
+
+ cbReturns:
Example
- management.getEmailProvider(function (err, provider) {
- console.log(provider.length);
+ management.getClient({ client_id: CLIENT_ID }, function (err, client) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(client);
});Example
- getGuardianEnrollment(data, cbopt) → {Promise|undefined}
+ getClientGrants(paramsopt, cbopt) → {Promise|undefined}
Parameters:
- dataparams
@@ -9779,6 +9656,8 @@ Parameters:
+ <optional>
+
@@ -9789,7 +9668,7 @@ Parameters:
- Parameters:
Type
+ Attributes
+
@@ -9815,32 +9696,34 @@ Parameters:
-
+
+
-
- idper_page
-
+ String
+Number
+
+ <optional>
+
-
+
-
-
-
+
@@ -9849,13 +9732,13 @@ Parameters:
-
@@ -9885,6 +9768,53 @@ cbpage
- function
+Number
@@ -9876,7 +9759,7 @@ Parameters:
-
Parameters:
+
+
+
+
+
+
+
+
+
+
@@ -9895,9 +9825,6 @@ cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
-
-
-
Returns:
@@ -9927,8 +9854,20 @@ Returns:
Example
- management.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
- console.log(enrollment);
+ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
+};
+
+management.getClientGrants(params, function (err, grants) {
+ console.log(grants.length);
});Example
- getGuardianEnrollments(data, cbopt) → {Promise|undefined}
+ getClientInfo() → {Object}
Source:
Returns:
+
+
+
+
+
+
+
+Object
+
+
+ getClients(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameters:
- dataparams
@@ -10044,6 +10091,8 @@ Parameters:
+ <optional>
+
@@ -10054,7 +10103,7 @@ Parameters:
- Parameters:
Type
+ Attributes
+
@@ -10080,24 +10131,70 @@ Parameters:
-
+
+
+
+ idper_page
-
+ String
+Number
+
+ <optional>
+
+
+
+
+
+
+
-
+
+
+
@@ -10192,8 +10289,20 @@ page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
Example
- management.getGuardianEnrollments({ id: USER_ID }, function (err, enrollments) {
- console.log(enrollments);
+ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
+};
+
+management.getClients(params, function (err, clients) {
+ console.log(clients.length);
});Example
- getJob(params, cbopt) → {Promise|undefined}
+ getConnection(params, cbopt) → {Promise|undefined}
getJobSource:
Parameters:
- Parameters:
-
Returns:
Example
- var params = {
- id: '{JOB_ID}'
-};
-
-management.getJob(params, function (err, job) {
+ management.getConnection({ id: CONNECTION_ID }, function (err, connection) {
if (err) {
// Handle error.
}
- // Retrieved job.
- console.log(job);
+ console.log(connection);
});Example
- getLog(params, cbopt) → {Promise|undefined}
+ getConnections(paramsopt, cbopt) → {Promise|undefined}
getLogSource:
+
- Parameters:
+ <optional>
+
@@ -10593,7 +10699,7 @@ Parameters:
- Parameters:
Type
+ Attributes
+
@@ -10619,24 +10727,70 @@ Parameters:
-
+
+
+
+ idper_page
-
+ String
+Number
+
+ <optional>
+
+
+
+
+
+
+
-
+
+
+
@@ -10731,12 +10885,20 @@ page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
Example
- management.getLog({ id: EVENT_ID }, function (err, log) {
- if (err) {
- // Handle error.
- }
+ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
+};
- console.log(log);
+management.getConnections(params, function (err, connections) {
+ console.log(connections.length);
});Example
- getLogs(paramsopt, cbopt) → {Promise|undefined}
+ getCustomDomain(params, cbopt) → {Promise|undefined}
getLogsSource:
Parameters:
- <optional>
-
@@ -10864,7 +11024,7 @@ Parameters:
- Parameters:
Type
- Attributes
-
@@ -10892,7 +11050,7 @@ Parameters:
-
-
+
+ qid
@@ -10905,21 +11063,19 @@
- Parameters:
-
- <optional>
-
-
+
+
+
-
+
+
-
Parameters:
-
+
+
- pagecb
- Number
+function
@@ -10955,238 +11111,134 @@ Parameters:
-
-
-
-
- per_page
-
-
-
-
- Number
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+sort
-
-
-
+String
-
- Returns:
-
-
-
- <optional>
-
+
-
+
-
+
+
Promise
+|
-
- undefined
-
-
-
-
-
-
+ fields
-
-
-
+ String
+Example
-
- management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ if (err) {
+ // Handle error.
+ }
-
-
-
- <optional>
+
+
+
-
+ console.log(customDomain);
+});
-
+
-
-
-
- getCustomDomains() → {Promise|undefined}
-
-
-
+
- include_fields
-
-
-
-
- Boolean
+
-
- <optional>
-
-
+
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
+
+
+ include_totals
-
-
-
-
-
- Boolean
+
+
-
-
-
- <optional>
-
+
-
+
-
-
+
-
+
-
-
-
-
-
-
-
-
-
@@ -11230,20 +11282,8 @@ cb
-
-
-
-
- function
+
+
+
-
-
-
- <optional>
-
-
-
-
-
-
-
-
- Returns:
Example
- // Pagination settings.
-var params = {
- per_page: 10,
- page: 2
-};
-
-management.getLogs(params, function (err, logs) {
- console.log(logs.length);
+ management.getCustomDomains(function (err, customDomains) {
+ console.log(customDomains.length);
});Example
- getResourceServer(params, cbopt) → {Promise|undefined}
+ getDailyStats(params, cbopt) → {Promise|undefined}
getR
Parameters:
- Parameters:
-
+
+
+
+ idfrom
@@ -11412,7 +11452,33 @@ Parameters:
-
+
+
+
@@ -11507,12 +11573,17 @@ to
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
Returns:
Example
- management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+ var params = {
+ from: '{YYYYMMDD}', // First day included in the stats.
+ to: '{YYYYMMDD}' // Last day included in the stats.
+};
+
+management.getDaily(params, function (err, stats) {
if (err) {
// Handle error.
}
- console.log(resourceServer);
+ console.log(stats);
});Example
- getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+ getDeviceCredentials(cbopt) → {Promise|undefined}
get
Parameters:
-
-paramscb
- Object
+function
@@ -11640,226 +11711,79 @@ Parameters:
-
+
-
-
-
-
- Name
-
+
+
+Type
-
- Attributes
-
-
- Description
-
-
-
-
-
-
-
+per_page
-
-
-
-
- Number
-
-
-
- <optional>
-
-
-
-
-
-
-
-
- Returns:
-
+
-
-
-
+page
+
-
- Promise
+|
-
-
-
-
+ Number
+undefined
-
-
-
- <optional>
-
-
-
-
-
+
+
-
-
-
- Example
+
+
+
+management.getDeviceCredentials(function (err, credentials) {
+ console.log(credentials.length);
+});getEmailProvider(cbopt, paramsopt) → {Promise|undefined}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-cb
-
-
-
-
-
- function
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
-
- Returns:
-
-
-
-
-
-
-
-
-Promise
-|
-
-undefined
-
-
- Example
-
-
-
-// Pagination settings.
-var params = {
- per_page: 10,
- page: 0
-};
-
-management.getResourceServers(params, function (err, resourceServers) {
- console.log(resourceServers.length);
-});getRule(params, cbopt) → {Promise|undefined}
-
-
-
-
-
-getRuleSource:
Parameters:
+
+
+
+
+
+
cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
paramsParameters:
+ <optional>
+
@@ -11965,7 +11927,7 @@ Parameters:
- Parameters:
Type
+ Attributes
+
@@ -11991,32 +11955,34 @@ Parameters:
-
+
+
-
-
-
+
+ idfields
-
+ String
+Number
+
+ <optional>
+
-
+
-
-
-
+
@@ -12025,13 +11991,13 @@ Parameters:
-
+
+
+
+
+
@@ -12103,12 +12077,8 @@ cbinclude_fields
- function
+Number
@@ -12052,7 +12018,15 @@ Parameters:
-
+ Returns:
Example
- management.getRule({ id: RULE_ID }, function (err, rule) {
- if (err) {
- // Handle error.
- }
-
- console.log(rule);
+ management.getEmailProvider(function (err, provider) {
+ console.log(provider.length);
});Example
- getRules(paramsopt, cbopt) → {Promise|undefined}
+ getGuardianEnrollment(data, cbopt) → {Promise|undefined}
getRulesSource:
Parameters:
- paramsdata
@@ -12224,8 +12194,6 @@ Parameters:
- <optional>
-
@@ -12236,7 +12204,7 @@ Parameters:
- Parameters:
Type
- Attributes
-
@@ -12264,70 +12230,24 @@ Parameters:
-
-
-
-
- per_page
-
-
-
-
-
- Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -12422,20 +12342,8 @@ pageid
-
- Number
+String
-
- <optional>
-
-
-
-
-
-
-
-
Returns:
Example
- // Pagination settings.
-var params = {
- per_page: 10,
- page: 0
-};
-
-management.getRules(params, function (err, rules) {
- console.log(rules.length);
+ management.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ console.log(enrollment);
});Example
- getRulesConfigs() → {Promise|undefined}
+ getGuardianEnrollments(data, cbopt) → {Promise|undefined}
getRul
getRul
+
Parameters:
+
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
+
+
+
+
@@ -13182,24 +13068,2952 @@
-
-
+
+
-
+
-
-
-
-
-
-
-
-
-Name
-Promise
-|
-
-undefined
-
-
- Example
-
-
-management.getRulesConfigs(function (err, rulesConfigs) {
- if (err) {
- // Handle error.
- }
-
- // Get Rules Configs.
-});Type
-
-
-getTenantSettings(cbopt) → {Promise|undefined}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Attributes
+
-
+
-
+ Description
+
+
+
+
+
+
data
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
- Parameters:
-
+
+
+
@@ -12642,8 +12483,6 @@
+
+
+ Parameters:
Type
- Attributes
-
@@ -12654,6 +12493,40 @@ Parameters:
+
+
+
+
+
+
+id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+cbReturns:
Example
- management.getSettings(function (err, settings) {
- if (err) {
- // Handle error.
- }
-
- console.log(settings);
+ management.getGuardianEnrollments({ id: USER_ID }, function (err, enrollments) {
+ console.log(enrollments);
});Example
- getUser(data, cbopt) → {Promise|undefined}
+ getJob(params, cbopt) → {Promise|undefined}
getUserSource:
Parameters:
-
@@ -13003,8 +12872,17 @@ dataparams
@@ -12865,7 +12734,7 @@ Parameters:
- Parameters:
-
Returns:
Example
- management.getUser({ id: USER_ID }, function (err, user) {
- console.log(user);
+ var params = {
+ id: '{JOB_ID}'
+};
+
+management.getJob(params, function (err, job) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Retrieved job.
+ console.log(job);
});Example
- getUserLogs(params, cbopt) → {Promise|undefined}
+ getLog(params, cbopt) → {Promise|undefined}
getUserLog
Parameters:
- Parameters:
-
+ Parameters:
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+per_pagecb
-
+ Number
+function
+
+ <optional>
+
+
+
+
+
+
+
-
+ Returns:
+
+
+
+
+
+
+
+
+Promise
+|
+
+undefined
+
+
+ Example
+
+
+
+management.getLog({ id: EVENT_ID }, function (err, log) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(log);
+});getLogs(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ params
+
+
+
+
+
+ Object
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ q
+
+
+
+
+
+ String
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ per_page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ sort
+
+
+
+
+
+ String
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ fields
+
+
+
+
+
+ String
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ include_fields
+
+
+
+
+
+ Boolean
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+include_totals
+
+
+
+
+
+ Boolean
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+
+
+
+
+
+
+
+
+Promise
+|
+
+undefined
+
+
+ Example
+
+
+
+// Pagination settings.
+var params = {
+ per_page: 10,
+ page: 2
+};
+
+management.getLogs(params, function (err, logs) {
+ console.log(logs.length);
+});getResourceServer(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ params
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+
+
+
+
+
+
+
+
+Promise
+|
+
+undefined
+
+
+ Example
+
+
+
+management.getResourceServer({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(resourceServer);
+});getResourceServers(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ params
+
+
+
+
+
+ Object
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ per_page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+
+
+
+
+
+
+
+
+Promise
+|
+
+undefined
+
+
+ Example
+
+
+
+// Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
+};
+
+management.getResourceServers(params, function (err, resourceServers) {
+ console.log(resourceServers.length);
+});getRule(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ params
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+
+
+
+
+
+
+
+
+Promise
+|
+
+undefined
+
+
+ Example
+
+
+
+management.getRule({ id: RULE_ID }, function (err, rule) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(rule);
+});getRules(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ params
+
+
+
+
+
+ Object
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ per_page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+
+
+
+
+
+
+
+
+Promise
+|
+
+undefined
+
+
+ Example
+
+
+
+// Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
+};
+
+management.getRules(params, function (err, rules) {
+ console.log(rules.length);
+});getRulesConfigs() → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+Promise
+|
+
+undefined
+
+
+ Example
+
+
+
+management.getRulesConfigs(function (err, rulesConfigs) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Get Rules Configs.
+});getTenantSettings(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+
+
+
+
+
+
+
+
+Promise
+|
+
+undefined
+
+
+ Example
+
+
+
+management.getSettings(function (err, settings) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(settings);
+});getUser(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ data
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+
+
+
+
+
+
+
+
+Promise
+|
+
+undefined
+
+
+ Example
+
+
+
+management.getUser({ id: USER_ID }, function (err, user) {
+ console.log(user);
+});getUserLogs(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ params
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+ id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+ per_page
+
+
+
+
+
+
+
+
+ Number
+
+
+
+
+
+
+
+
+
+
+
+ page
+
+
+
+
+
+
+
+
+ Number
+
+
+
+
+
+
+
+
+
+
+
+ sort
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+include_totals
+
+
+
+
+
+
+
+
+ Boolean
+
+
+
+
+
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+
+
+
+
+
+
+
+
+Promise
+|
+
+undefined
+
+
+ Example
+
+
+
+var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+
+management.getUserLogs(params, function (err, logs) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(logs);
+});getUsers(paramsopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ params
+
+
+
+
+
+ Object
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ search_engine
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -13217,24 +16031,235 @@ per_page
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
Parameters:
Number
-
-
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+
+
+
+
+
+
+
+
+Promise
+|
+
+undefined
+
+
+ Example
+
+
+
+// Pagination settings.
+var params = {
+ search_engine: 'v3',
+ per_page: 10,
+ page: 0
+};
+
+auth0.getUsers(params, function (err, users) {
+ console.log(users.length);
+});getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
-
+
+
+
+ Name
+
+
+ Type
-
+
+ Attributes
+
-
+
-
-
- Description
+
+
+
-
-
-
-
- sortemail
@@ -13247,45 +16272,21 @@
-
-
-
- Parameters:
-
-
-
-
-
-
-
-
-include_totals
-
+ <optional>
-
+
+
-Boolean
+
-
-
-
- Returns:
Example
- var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-
-management.getUserLogs(params, function (err, logs) {
- if (err) {
- // Handle error.
- }
-
- console.log(logs);
+ auth0.getUsersByEmail(email, function (err, users) {
+ console.log(users);
});Example
- getUsers(paramsopt, cbopt) → {Promise|undefined}
+ importUsers(data, cbopt) → {Promise|undefined}
getUsersSource:
Parameters:
- paramsdata
@@ -13495,8 +16496,6 @@ Parameters:
- <optional>
-
@@ -13507,7 +16506,7 @@ Parameters:
- Parameters:
Type
- Attributes
-
@@ -13535,70 +16532,24 @@ Parameters:
-
-
-
-
- search_engine
-
-
-
-
-
- Number
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -13607,34 +16558,24 @@ per_pageconnectionId
-
- Number
+String
-
- <optional>
-
-
-
-
-
-
-
-
Parameters:
-
@@ -13729,21 +16670,15 @@ pageusers
-
- Number
+String
-
- <optional>
-
-
-
-
-
-
-
-
Returns:
Example
- // Pagination settings.
-var params = {
- search_engine: 'v3',
- per_page: 10,
- page: 0
+ var params = {
+ connection_id: '{CONNECTION_ID}',
+ users: '{PATH_TO_USERS_FILE}'
};
-auth0.getUsers(params, function (err, users) {
- console.log(users.length);
+management.get(params, function (err) {
+ if (err) {
+ // Handle error.
+ }
});Example
- getUsersByEmail(emailopt, cbopt) → {Promise|undefined}
+ linkUsers(userId, params, cbopt) → {Promise|undefined}
getUse
getUse
-
Parameters:
-
+ Parameters:
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ userId
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -13958,13 +17002,18 @@ params
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -13830,8 +16852,6 @@
+
Parameters:
Type
- Attributes
-
@@ -13844,7 +16864,7 @@ Parameters:
-
+
+
+
+ emailuser_id
@@ -13857,21 +16877,45 @@
- Parameters:
-
- <optional>
-
+
+
+
+
+
+
+
+
+
+
+connection_id
+
-
+String
+
+
+
+
+
-
+ Returns:
Example
- auth0.getUsersByEmail(email, function (err, users) {
- console.log(users);
+ var userId = 'USER_ID';
+var params = {
+ user_id: 'OTHER_USER_ID',
+ connection_id: 'CONNECTION_ID'
+};
+
+management.linkUsers(userId, params, function (err, user) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Users linked.
});Example
- importUsers(data, cbopt) → {Promise|undefined}
+ regenerateRecoveryCode(data, cbopt) → {Promise|undefined}
importUser
-Parameters:
- Parameters:
-
-
-
-
- connectionId
-
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
@@ -14255,15 +17277,8 @@ usersid
@@ -14160,7 +17182,7 @@ Parameters:
-
Returns:
Example
- var params = {
- connection_id: '{CONNECTION_ID}',
- users: '{PATH_TO_USERS_FILE}'
-};
-
-management.get(params, function (err) {
- if (err) {
- // Handle error.
- }
+ management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
+ console.log(newRecoveryCode);
});Example
- linkUsers(userId, params, cbopt) → {Promise|undefined}
+ sendEmailVerification(data, cbopt) → {Promise|undefined}
linkUsers
Parameters:
-
-
-
-
- userId
-
-
-
-
-
- String
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- paramsdata
@@ -14423,7 +17404,7 @@ Parameters:
- Parameters:
-
-
-
-
@@ -14587,18 +17542,14 @@ connection_id
-
-
-
-
-
-
-
-
- String
-
-
-
-
-
Returns:
Example
- var userId = 'USER_ID';
-var params = {
- user_id: 'OTHER_USER_ID',
- connection_id: 'CONNECTION_ID'
+ var params = {
+ user_id: '{USER_ID}'
};
-management.linkUsers(userId, params, function (err, user) {
+management.sendEmailVerification(function (err) {
if (err) {
// Handle error.
}
-
- // Users linked.
});Example
- regenerateRecoveryCode(data, cbopt) → {Promise|undefined}
+ setRulesConfig(params, data, cbopt) → {Promise|undefined}
Source:
Parameters:
-
+
Parameters:
+
+
+
+
+
-
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
params
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -14685,8 +17689,6 @@
+
+
+ Parameters:
Type
- Attributes
-
@@ -14697,6 +17699,40 @@ Parameters:
+
+
+
+
+
+
+key
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
dataParameters:
- Parameters:
-
@@ -14862,8 +17898,15 @@ idvalue
@@ -14767,7 +17803,7 @@ Parameters:
-
Returns:
Example
- management.regenerateRecoveryCode({ id: USER_ID }, function (err, newRecoveryCode) {
- console.log(newRecoveryCode);
+ var params = { key: RULE_CONFIG_KEY };
+var data = { value: RULES_CONFIG_VALUE };
+
+management.setRulesConfig(params, data, function (err, rulesConfig) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Rules Config set.
});Example
- sendEmailVerification(data, cbopt) → {Promise|undefined}
+ unlinkUsers(params, cbopt) → {Promise|undefined}
Parameters:
-
+ dataparams
@@ -14989,7 +18032,7 @@ Parameters:
- Parameters:
+
+
+
+
+
+ id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
provider
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
@@ -15127,14 +18222,14 @@ user_idParameters:
-
Returns:
Example
- var params = {
- user_id: '{USER_ID}'
-};
+ var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
-management.sendEmailVerification(function (err) {
+management.unlinkUsers(params, function (err, user) {
if (err) {
// Handle error.
}
+
+ // Users accounts unlinked.
});Example
- setRulesConfig(params, data, cbopt) → {Promise|undefined}
+ updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
setRule
+Parameters:
- Parameters:
-
@@ -15320,7 +18415,7 @@ keyid
@@ -15303,7 +18398,7 @@ Parameters:
-
Parameters:
-
@@ -15432,7 +18476,7 @@ datametadata
@@ -15345,58 +18440,7 @@ Parameters:
-
-
-
-
+
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-value
-
-
-
-
-
-
-
-
- String
-
-
-
-
-
- Parameters:
-
@@ -15483,15 +18527,18 @@ Returns:
Example
- var params = { key: RULE_CONFIG_KEY };
-var data = { value: RULES_CONFIG_VALUE };
+ var params = { id: USER_ID };
+var metadata = {
+ foo: 'bar'
+};
-management.setRulesConfig(params, data, function (err, rulesConfig) {
+management.updateAppMetadata(params, metadata, function (err, user) {
if (err) {
// Handle error.
}
- // Rules Config set.
+ // Updated user.
+ console.log(user);
});Example
- unlinkUsers(params, cbopt) → {Promise|undefined}
+ updateClient(params, data, cbopt) → {Promise|undefined}
unlinkUser
Parameters:
- Parameters:
-
+ idclient_id
@@ -15660,33 +18707,15 @@ Parameters:
-
-
-
@@ -15695,32 +18724,32 @@ provider
-
-
-
-
-
-
-
-
- String
-
-
-
-
-
Parameters:
-
-
-
- user_iddata
-
+ String
+Object
+
+
+
+
+
+
+
-
- Returns:
Example
- var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
+ var data = { name: 'newClientName' };
+var params = { client_id: CLIENT_ID };
-management.unlinkUsers(params, function (err, user) {
+management.updateClient(params, data, function (err, client) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ console.log(client.name); // 'newClientName'
});Example
- updateAppMetadata(params, metadata, cbopt) → {Promise|undefined}
+ updateClientGrant(params, data, cbopt) → {Promise|undefined}
upda
Parameters:
- Parameters:
-
@@ -16000,7 +19030,7 @@ Parameters:
-
@@ -16061,7 +19091,7 @@ metadatadata
@@ -16025,7 +19055,7 @@ Parameters:
-
Parameters:
-
@@ -16112,18 +19142,19 @@ Returns:
Example
- var params = { id: USER_ID };
-var metadata = {
- foo: 'bar'
+ var data = {
+ client_id: CLIENT_ID,
+ audience: AUDIENCE,
+ scope: []
};
+var params = { id: CLIENT_GRANT_ID };
-management.updateAppMetadata(params, metadata, function (err, user) {
+management.clientGrants.update(params, data, function (err, grant) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+ console.log(grant.id);
});Example
- updateClient(params, data, cbopt) → {Promise|undefined}
+ updateConnection(params, data, cbopt) → {Promise|undefined}
updateCli
Parameters:
- Parameters:
-
@@ -16334,7 +19365,7 @@ client_idid
@@ -16292,7 +19323,7 @@ Parameters:
-
Parameters:
-
@@ -16421,15 +19452,15 @@ Returns:
Example
- var data = { name: 'newClientName' };
-var params = { client_id: CLIENT_ID };
+ var data = { name: 'newConnectionName' };
+var params = { id: CONNECTION_ID };
-management.updateClient(params, data, function (err, client) {
+management.updateConnection(params, data, function (err, connection) {
if (err) {
// Handle error.
}
- console.log(client.name); // 'newClientName'
+ console.log(connection.name); // 'newConnectionName'
});Example
- updateConnection(params, data, cbopt) → {Promise|undefined}
+ updateEmailProvider(params, data, cbopt) → {Promise|undefined}
updat
Parameters:
-
@@ -16640,7 +19620,7 @@
-
-
-
+
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-id
-
-
-
-
-
-
-
-
- String
-
-
-
-
-
- Parameters:
-
@@ -16727,15 +19707,13 @@ Returns:
Example
- var data = { name: 'newConnectionName' };
-var params = { id: CONNECTION_ID };
-
-management.updateConnection(params, data, function (err, connection) {
+ management.updateEmailProvider(params, data, function (err, provider) {
if (err) {
// Handle error.
}
- console.log(connection.name); // 'newConnectionName'
+ // Updated email provider.
+ console.log(provider);
});Example
- updateEmailProvider(params, data, cbopt) → {Promise|undefined}
+ updateResourceServer(params, data, cbopt) → {Promise|undefined}
up
Parameters:
-
@@ -16895,7 +19924,7 @@
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+ Parameters:
-
@@ -16982,13 +20011,15 @@ Returns:
Example
- management.updateEmailProvider(params, data, function (err, provider) {
+ var data = { name: 'newResourceServerName' };
+var params = { id: RESOURCE_SERVER_ID };
+
+management.updateResourceServer(params, data, function (err, resourceServer) {
if (err) {
// Handle error.
}
- // Updated email provider.
- console.log(provider);
+ console.log(resourceServer.name); // 'newResourceServerName'
});Example
- updateResourceServer(params, data, cbopt) → {Promise|undefined}
+ updateRule(params, data, cbopt) → {Promise|undefined}
u
Parameters:
- Parameters:
-
@@ -17199,7 +20230,7 @@ Parameters:
-
@@ -17286,15 +20317,14 @@ Returns:
Example
- var data = { name: 'newResourceServerName' };
-var params = { id: RESOURCE_SERVER_ID };
-
-management.updateResourceServer(params, data, function (err, resourceServer) {
+ var params = { id: RULE_ID };
+var data = { name: 'my-rule'};
+management.updateRule(params, data, function (err, rule) {
if (err) {
// Handle error.
}
- console.log(resourceServer.name); // 'newResourceServerName'
+ console.log(rule.name); // 'my-rule'.
});Example
- updateRule(params, data, cbopt) → {Promise|undefined}
+ updateTenantSettings(data, cbopt) → {Promise|undefined}
updateRule<
-
-
-
-
-
-
-
-
Parameters:
-
-
-
-
-
-
-
-
+
-
- Name
-
+
- Type
+
-
- Attributes
-
+
-
+
+ Description
-
-
-
-
-
-
params
-
-
-
-
- Object
-
-
-
-
-
-
-
-
-
-
- Parameters:
+
@@ -17434,6 +20411,8 @@
-
-
- Parameters:
Type
+ Attributes
+
@@ -17444,40 +20423,6 @@ Parameters:
-
-
-
-
-
-
-id
-
-
-
-
-
-
-
-
- String
-
-
-
-
-
-
@@ -17592,14 +20537,10 @@ dataParameters:
-
Returns:
Example
- var params = { id: RULE_ID };
-var data = { name: 'my-rule'};
-management.updateRule(params, data, function (err, rule) {
+ management.updateTenantSettings(data, function (err) {
if (err) {
// Handle error.
}
-
- console.log(rule.name); // 'my-rule'.
});Example
- updateTenantSettings(data, cbopt) → {Promise|undefined}
+ updateUser(params, data, cbopt) → {Promise|undefined}
u
Parameters:
+
+
+
+
+
+
params
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
@@ -17761,7 +20787,7 @@ dataParameters:
-
Parameters:
-
@@ -17812,10 +20838,15 @@ Returns:
Example
- management.updateTenantSettings(data, function (err) {
+ var params = { id: USER_ID };
+
+management.updateUser(params, data, function (err, user) {
if (err) {
// Handle error.
}
+
+ // Updated user.
+ console.log(user);
});Example
- updateUser(params, data, cbopt) → {Promise|undefined}
+ updateUserMetadata(params, metadata, cbopt) → {Promise|undefined}
updateUser<
Parameters:
- Parameters:
-
@@ -18114,8 +21145,11 @@ datametadata
@@ -18026,7 +21057,7 @@ Parameters:
-
Returns:
Example
var params = { id: USER_ID };
+var metadata = {
+ address: '123th Node.js Street'
+};
-management.updateUser(params, data, function (err, user) {
+management.updateUserMetadata(params, metadata, function (err, user) {
if (err) {
// Handle error.
}
@@ -18133,14 +21167,14 @@ Example
- updateUserMetadata(params, metadata, cbopt) → {Promise|undefined}
+ verifyCustomDomain(params, cbopt) → {Promise|undefined}
upd
Parameters:
- Parameters:
-
@@ -18305,40 +21339,6 @@ Parameters:
-
-
-
-
-
-
metadata
-
-
-
-
-
- Object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -18419,18 +21419,12 @@ cbParameters:
-
Returns:
Example
- var params = { id: USER_ID };
-var metadata = {
- address: '123th Node.js Street'
-};
-
-management.updateUserMetadata(params, metadata, function (err, user) {
+ management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+ console.log(customDomain);
});Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 98a360c74..ff9ee87b1 100644
--- a/docs/module-management.ManagementTokenProvider.html
+++ b/docs/module-management.ManagementTokenProvider.html
@@ -24,7 +24,7 @@
Returns:
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
index 0c021904e..506dcf254 100644
--- a/docs/module-management.ResourceServersManager.html
+++ b/docs/module-management.ResourceServersManager.html
@@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
index 482cb0539..7088c566b 100644
--- a/docs/module-management.RetryRestClient.html
+++ b/docs/module-management.RetryRestClient.html
@@ -24,7 +24,7 @@
Parameters:
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 4a371256c..502ae2f83 100644
--- a/docs/module-management.RulesConfigsManager.html
+++ b/docs/module-management.RulesConfigsManager.html
@@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index c81f2d396..b7640c53a 100644
--- a/docs/module-management.RulesManager.html
+++ b/docs/module-management.RulesManager.html
@@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index d73bbea41..ce9e4385a 100644
--- a/docs/module-management.StatsManager.html
+++ b/docs/module-management.StatsManager.html
@@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index 527516334..c659e73ae 100644
--- a/docs/module-management.TenantManager.html
+++ b/docs/module-management.TenantManager.html
@@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 6cc15b131..ccc194f35 100644
--- a/docs/module-management.TicketsManager.html
+++ b/docs/module-management.TicketsManager.html
@@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 4a29c2bcb..33658deef 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
Example
diff --git a/docs/module-management.html b/docs/module-management.html
index 24524f386..138034ca4 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index c703086b0..0a882f6e8 100644
--- a/docs/module-utils.html
+++ b/docs/module-utils.html
@@ -24,7 +24,7 @@
(static)
diff --git a/docs/utils.js.html b/docs/utils.js.html
index e1092abfd..c1d593455 100644
--- a/docs/utils.js.html
+++ b/docs/utils.js.html
@@ -24,7 +24,7 @@
utils.js
diff --git a/package.json b/package.json
index da7529028..80138069b 100644
--- a/package.json
+++ b/package.json
@@ -1,16 +1,16 @@
{
"name": "auth0",
- "version": "2.14.0",
+ "version": "2.15.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
- "files": [
- "src"
- ],
+ "files": ["src"],
"scripts": {
"test": "mocha -R spec ./test/**/*.tests.js ./test/*.tests.js",
- "test:ci": "istanbul cover _mocha --report lcovonly -R $(find ./test -name *.tests.js) -- -R mocha-multi --reporter-options spec=-,mocha-junit-reporter=-",
+ "test:ci":
+ "istanbul cover _mocha --report lcovonly -R $(find ./test -name *.tests.js) -- -R mocha-multi --reporter-options spec=-,mocha-junit-reporter=-",
"test:coverage": "codecov",
- "test:watch": "cross-env NODE_ENV=test mocha --timeout 5000 ./test/**/*.tests.js ./test/*.tests.js --watch",
+ "test:watch":
+ "cross-env NODE_ENV=test mocha --timeout 5000 ./test/**/*.tests.js ./test/*.tests.js --watch",
"jsdoc:generate": "jsdoc --configure .jsdoc.json --verbose",
"release:clean": "node scripts/cleanup.js",
"preversion": "node scripts/prepare.js",
@@ -22,10 +22,7 @@
"type": "git",
"url": "https://github.com/auth0/node-auth0"
},
- "keywords": [
- "auth0",
- "api"
- ],
+ "keywords": ["auth0", "api"],
"author": "Auth0",
"license": "MIT",
"bugs": {