var jwt = require('jsonwebtoken');
+var jwksClient = require('jwks-rsa');
+var Promise = require('bluebird');
+
+var ArgumentError = require('rest-facade').ArgumentError;
+
+/**
+ * @class
+ * Abstracts the `oauth.create` method with additional id_token validation
+ * @constructor
+ * @memberOf module:auth
+ *
+ * @param {Object} oauth An instance of @type {OAuthAuthenticator}
+ * @param {Object} options Authenticator options.
+ * @param {String} options.domain AuthenticationClient server domain
+ * @param {String} [options.clientId] Default client ID.
+ * @param {String} [options.clientSecret] Default client Secret.
+ * @param {String} [options.supportedAlgorithms] Algorithms that your application expects to receive
+ */
+var OAUthWithIDTokenValidation = function(oauth, options) {
+ if (!oauth) {
+ throw new ArgumentError('Missing OAuthAuthenticator param');
+ }
+
+ if (!options) {
+ throw new ArgumentError('Missing authenticator options');
+ }
+
+ if (typeof options !== 'object') {
+ throw new ArgumentError('The authenticator options must be an object');
+ }
+
+ this.oauth = oauth;
+ this.clientId = options.clientId;
+ this.clientSecret = options.clientSecret;
+ this.domain = options.domain;
+ this.supportedAlgorithms = options.supportedAlgorithms || ['HS256', 'RS256'];
+ this._jwksClient = jwksClient({
+ jwksUri: 'https://' + options.domain + '/.well-known/jwks.json'
+ });
+};
+
+/**
+ * Creates an oauth request and validates the id_token (if any)
+ *
+ * @method create
+ * @memberOf module:auth.OAuthWithIDTokenValidation.prototype
+ *
+ * @param {Object} params OAuth parameters that are passed through
+ * @param {Object} data Custom parameters sent to the OAuth endpoint
+ * @param {Function} [callback] Callback function
+ *
+ * @return {Promise|undefined}
+ */
+OAUthWithIDTokenValidation.prototype.create = function(params, data, cb) {
+ const createAndValidate = this.oauth.create(params, data).then(r => {
+ var _this = this;
+ if (r.id_token) {
+ function getKey(header, callback) {
+ if (header.alg === 'HS256') {
+ return callback(null, Buffer.from(_this.clientSecret, 'base64'));
+ }
+ _this._jwksClient.getSigningKey(header.kid, function(err, key) {
+ if (err) {
+ return callback(err);
+ }
+ var signingKey = key.publicKey || key.rsaPublicKey;
+ return callback(null, signingKey);
+ });
+ }
+ return new Promise((res, rej) => {
+ jwt.verify(
+ r.id_token,
+ getKey,
+ {
+ algorithms: this.supportedAlgorithms,
+ audience: this.clientId,
+ issuer: 'https://' + this.domain + '/'
+ },
+ function(err, payload) {
+ if (err) {
+ return rej(err);
+ }
+ return res(r);
+ }
+ );
+ });
+ }
+ return r;
+ });
+ if (!cb) {
+ return createAndValidate;
+ }
+ createAndValidate.then(r => cb(null, r)).catch(e => cb(e));
+};
+
+module.exports = OAUthWithIDTokenValidation;
+RetryRestClient.js
diff --git a/docs/auth_DatabaseAuthenticator.js.html b/docs/auth_DatabaseAuthenticator.js.html index c8c049ed6..9cfabf416 100644 --- a/docs/auth_DatabaseAuthenticator.js.html +++ b/docs/auth_DatabaseAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -345,7 +345,7 @@
diff --git a/docs/auth_OAUthWithIDTokenValidation.js.html b/docs/auth_OAUthWithIDTokenValidation.js.html new file mode 100644 index 000000000..c8d5b0180 --- /dev/null +++ b/docs/auth_OAUthWithIDTokenValidation.js.html @@ -0,0 +1,157 @@ + + + + + +auth/OAUthWithIDTokenValidation.js - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + + + + + + diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html index c1a8ba2db..31055ed63 100644 --- a/docs/auth_OAuthAuthenticator.js.html +++ b/docs/auth_OAuthAuthenticator.js.html @@ -24,7 +24,7 @@
auth/DatabaseAuthenticator.js
diff --git a/docs/auth_OAUthWithIDTokenValidation.js.html b/docs/auth_OAUthWithIDTokenValidation.js.html new file mode 100644 index 000000000..c8d5b0180 --- /dev/null +++ b/docs/auth_OAUthWithIDTokenValidation.js.html @@ -0,0 +1,157 @@ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+auth/OAUthWithIDTokenValidation.js
+ + + + + + + ++ + + + + + + diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html index c1a8ba2db..31055ed63 100644 --- a/docs/auth_OAuthAuthenticator.js.html +++ b/docs/auth_OAuthAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -44,6 +44,8 @@
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html index aad81fcea..49e45b1be 100644 --- a/docs/auth_PasswordlessAuthenticator.js.html +++ b/docs/auth_PasswordlessAuthenticator.js.html @@ -24,7 +24,7 @@
auth/OAuthAuthenticator.js
var ArgumentError = require('rest-facade').ArgumentError; var RestClient = require('rest-facade').Client; +var OAUthWithIDTokenValidation = require('./OAUthWithIDTokenValidation'); + /** * @class * Abstracts the sign-in, sign-up and change-password processes for Database & @@ -52,7 +54,8 @@auth/OAuthAuthenticator.js
* @memberOf module:auth * * @param {Object} options Authenticator options. - * @param {String} options.baseUrl The auth0 account URL. + * @param {String} options.baseUrl The Auth0 account URL. + * @param {String} options.domain AuthenticationClient server domain * @param {String} [options.clientId] Default client ID. * @param {String} [options.clientSecret] Default client Secret. */ @@ -75,6 +78,7 @@auth/OAuthAuthenticator.js
}; this.oauth = new RestClient(options.baseUrl + '/oauth/:type', clientOptions); + this.oauthWithIDTokenValidation = new OAUthWithIDTokenValidation(this.oauth, options); this.clientId = options.clientId; this.clientSecret = options.clientSecret; }; @@ -137,10 +141,10 @@auth/OAuthAuthenticator.js
} if (cb && cb instanceof Function) { - return this.oauth.create(params, data, cb); + return this.oauthWithIDTokenValidation.create(params, data, cb); } - return this.oauth.create(params, data); + return this.oauthWithIDTokenValidation.create(params, data); }; /** @@ -210,10 +214,64 @@auth/OAuthAuthenticator.js
} if (cb && cb instanceof Function) { - return this.oauth.create(params, data, cb); + return this.oauthWithIDTokenValidation.create(params, data, cb); } - return this.oauth.create(params, data); + return this.oauthWithIDTokenValidation.create(params, data); +}; + +/** + * Sign in using a refresh token + * + * @method refreshToken + * @memberOf module:auth.OAuthAuthenticator.prototype + * + * @example <caption> + * Given a refresh token from a previous authentication request + * it will return a JSON with the access_token and id_token. + * More information in the + * <a href="https://auth0.com/docs/api/authentication#refresh-token"> + * API Docs + * </a>. + * </caption> + * + * var data = { + * client_id: '{CLIENT_ID}', // Optional field. + * refresh_token: '{REFRESH_TOKEN}', + * }; + * + * auth0.oauth.refreshToken(data, function (err, userData) { + * if (err) { + * // Handle error. + * } + * + * console.log(userData); + * }); + * + * @param {Object} userData User credentials object. + * @param {String} userData.refresh_token Refresh token. + * + * @return {Promise|undefined} + */ +OAuthAuthenticator.prototype.refreshToken = function(userData, cb) { + var params = { + type: 'token' + }; + var defaultFields = { + client_id: this.clientId, + grant_type: 'refresh_token' + }; + var data = extend(defaultFields, userData); + if (!userData || typeof userData !== 'object') { + throw new ArgumentError('Missing user data object'); + } + if (typeof data.refresh_token !== 'string' || data.refresh_token.split().length === 0) { + throw new ArgumentError('refresh_token is required'); + } + if (cb && cb instanceof Function) { + return this.oauthWithIDTokenValidation.create(params, data, cb); + } + return this.oauthWithIDTokenValidation.create(params, data); }; /** @@ -347,10 +405,10 @@auth/OAuthAuthenticator.js
} if (cb && cb instanceof Function) { - return this.oauth.create(params, data, cb); + return this.oauthWithIDTokenValidation.create(params, data, cb); } - return this.oauth.create(params, data); + return this.oauthWithIDTokenValidation.create(params, data); }; module.exports = OAuthAuthenticator; @@ -366,7 +424,7 @@auth/OAuthAuthenticator.js
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html index aad81fcea..49e45b1be 100644 --- a/docs/auth_PasswordlessAuthenticator.js.html +++ b/docs/auth_PasswordlessAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -286,7 +286,7 @@
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html index 77b8a8476..dab714d38 100644 --- a/docs/auth_TokensManager.js.html +++ b/docs/auth_TokensManager.js.html @@ -24,7 +24,7 @@
auth/PasswordlessAuthenticator.js
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html index 77b8a8476..dab714d38 100644 --- a/docs/auth_TokensManager.js.html +++ b/docs/auth_TokensManager.js.html @@ -24,7 +24,7 @@
@@ -226,7 +226,7 @@
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html index 1633f0793..49fa17592 100644 --- a/docs/auth_UsersManager.js.html +++ b/docs/auth_UsersManager.js.html @@ -24,7 +24,7 @@
auth/TokensManager.js
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html index 1633f0793..49fa17592 100644 --- a/docs/auth_UsersManager.js.html +++ b/docs/auth_UsersManager.js.html @@ -24,7 +24,7 @@
@@ -224,7 +224,7 @@
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html index 21c528f6a..09545aa68 100644 --- a/docs/auth_index.js.html +++ b/docs/auth_index.js.html @@ -24,7 +24,7 @@
auth/UsersManager.js
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html index 21c528f6a..09545aa68 100644 --- a/docs/auth_index.js.html +++ b/docs/auth_index.js.html @@ -24,7 +24,7 @@
@@ -80,11 +80,11 @@
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html index a3b5100f2..65462a15f 100644 --- a/docs/external-RestClient.html +++ b/docs/external-RestClient.html @@ -24,7 +24,7 @@
auth/index.js
* clientId: '{OPTIONAL_CLIENT_ID}' * }); * - * @param {Object} options Options for the Authentication Client - * SDK. - * @param {String} options.domain AuthenticationClient server domain. - * @param {String} [options.clientId] Default client ID. - * @param {String} [options.clientSecret] Default client Secret. + * @param {Object} options Options for the Authentication Client SDK. + * @param {String} options.domain AuthenticationClient server domain. + * @param {String} [options.clientId] Default client ID. + * @param {String} [options.clientSecret] Default client Secret. + * @param {String} [options.supportedAlgorithms] Algorithms that your application expects to receive */ var AuthenticationClient = function(options) { if (!options || typeof options !== 'object') { @@ -103,7 +103,8 @@auth/index.js
'User-agent': 'node.js/' + process.version.replace('v', ''), 'Content-Type': 'application/json' }, - baseUrl: util.format(BASE_URL_FORMAT, options.domain) + baseUrl: util.format(BASE_URL_FORMAT, options.domain), + supportedAlgorithms: options.supportedAlgorithms }; if (options.telemetry !== false) { @@ -583,6 +584,41 @@auth/index.js
*/ utils.wrapPropertyMethod(AuthenticationClient, 'passwordGrant', 'oauth.passwordGrant'); +/** + * Sign in using a refresh token + * + * @method refreshToken + * @memberOf module:auth.AuthenticationClient.prototype + * + * @example <caption> + * Given a refresh token from a previous authentication request, + * it will return a JSON with the access_token and id_token. + * More information in the + * <a href="https://auth0.com/docs/api/authentication#refresh-token"> + * API Docs + * </a>. + * </caption> + * + * var data = { + * client_id: '{CLIENT_ID}', // Optional field. + * refresh_token: '{REFRESH_TOKEN}', + * }; + * + * auth0.refreshToken(data, function (err, userData) { + * if (err) { + * // Handle error. + * } + * + * console.log(userData); + * }); + * + * @param {Object} userData User credentials object. + * @param {String} userData.refresh_token Refresh token. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod(AuthenticationClient, 'refreshToken', 'oauth.refreshToken'); + module.exports = AuthenticationClient; @@ -596,7 +632,7 @@auth/index.js
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html index a3b5100f2..65462a15f 100644 --- a/docs/external-RestClient.html +++ b/docs/external-RestClient.html @@ -24,7 +24,7 @@
@@ -87,7 +87,7 @@
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
diff --git a/docs/index.html b/docs/index.html
index b31885fe4..284900d46 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 afb9fd421..1c8d473a0 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 1af25e4de..48fdcb021 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 635bbd2c2..02d124357 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 36d5e9f99..ee848a5a2 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 e72316139..15c95b0b1 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
new file mode 100644
index 000000000..09e419d59
--- /dev/null
+++ b/docs/management_CustomDomainsManager.js.html
@@ -0,0 +1,250 @@
+
+
+
+
+
+ management/CustomDomainsManager.js - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ management/CustomDomainsManager.js
+
+
+
+
+
+
+
+
+
+ var ArgumentError = require('rest-facade').ArgumentError;
+var utils = require('../utils');
+var Auth0RestClient = require('../Auth0RestClient');
+var RetryRestClient = require('../RetryRestClient');
+
+/**
+ * @class CustomDomainsManager
+ * Auth0 Custom Domains Manager.
+ *
+ * {@link https://auth0.com/docs/api/management/v2#!/Custom_Domains/get_custom_domains CustomDomains} represent
+ * custom domain names.
+ * You can learn more about this in the
+ * {@link https://auth0.com/docs/custom-domains CustomDomains} section of the
+ * documentation.
+ * @constructor
+ * @memberOf module:management
+ *
+ * @param {Object} options The client options.
+ * @param {String} options.baseUrl The URL of the API.
+ * @param {Object} [options.headers] Headers to be included in all requests.
+ * @param {Object} [options.retry] Retry Policy Config
+ */
+var CustomDomainsManager = function(options) {
+ if (options === null || typeof options !== 'object') {
+ throw new ArgumentError('Must provide manager options');
+ }
+
+ if (options.baseUrl === null || options.baseUrl === undefined) {
+ throw new ArgumentError('Must provide a base URL for the API');
+ }
+
+ if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
+ throw new ArgumentError('The provided base URL is invalid');
+ }
+
+ /**
+ * Options object for the Rest Client instance.
+ *
+ * @type {Object}
+ */
+ var clientOptions = {
+ errorFormatter: { message: 'message', name: 'error' },
+ headers: options.headers,
+ query: { repeatParams: false }
+ };
+
+ /**
+ * Provides an abstraction layer for consuming the
+ * {@link https://auth0.com/docs/api/v2#!/Custom_Domains Auth0 Custom Domains endpoint}.
+ *
+ * @type {external:RestClient}
+ */
+ var auth0CustomDomainsRestClient = new Auth0RestClient(
+ options.baseUrl + '/custom-domains/:id',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.resource = new RetryRestClient(auth0CustomDomainsRestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for consuming the
+ * {@link https://auth0.com/docs/api/v2#!/Custom_Domains Auth0 Custom Domains Verify endpoint}.
+ *
+ * @type {external:RestClient}
+ */
+ var auth0VerifyRestClient = new Auth0RestClient(
+ options.baseUrl + '/custom-domains/:id/verify',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.vefifyResource = new RetryRestClient(auth0VerifyRestClient, options.retry);
+};
+
+/**
+ * Create an Auth0 Custom Domain.
+ *
+ * @method create
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.create(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain created.
+ * });
+ *
+ * @param {Object} data The custom domain data object.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'create', 'resource.create');
+
+/**
+ * Get all Auth0 CustomDomains.
+ *
+ * @method getAll
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.getAll(function (err, customDomains) {
+ * console.log(customDomains.length);
+ * });
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'getAll', 'resource.getAll');
+
+/**
+ * Get a Custom Domain.
+ *
+ * @method get
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.get({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'get', 'resource.get');
+
+/**
+ * Verify a Custom Domain.
+ *
+ * @method verify
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.verify({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+CustomDomainsManager.prototype.verify = function(params, cb) {
+ if (!params || !params.id) {
+ throw new ArgumentError('The custom domain id cannot be null or undefined');
+ }
+
+ if (cb && cb instanceof Function) {
+ return this.vefifyResource.create(params, {}, cb);
+ }
+
+ return this.vefifyResource.create(params, {});
+};
+
+/**
+ * Delete a Custom Domain.
+ *
+ * @method delete
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain deleted.
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'delete', 'resource.delete');
+
+module.exports = CustomDomainsManager;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
index bcec857b3..f5dc2e012 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 0cde21107..38f961049 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -195,7 +195,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index 2a33027bc..b926f4b92 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 63848b8cc..fd969d25b 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -40,6 +40,7 @@ management/GuardianManager.js
var ArgumentError = require('rest-facade').ArgumentError;
+var utils = require('../utils');
var Auth0RestClient = require('../Auth0RestClient');
var RetryRestClient = require('../RetryRestClient');
@@ -90,6 +91,60 @@ management/GuardianManager.js
options.tokenProvider
);
this.enrollments = new RetryRestClient(guardianEnrollmentsAuth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian tickets.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianTicketsAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/enrollments/ticket',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.tickets = new RetryRestClient(guardianTicketsAuth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian factors.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorsAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/:name',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factors = new RetryRestClient(guardianFactorsAuth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian factors.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorsTemplatesAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/:name/templates',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factorsTemplates = new RetryRestClient(
+ guardianFactorsTemplatesAuth0RestClient,
+ options.retry
+ );
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian factor providers.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorsProvidersAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/:name/providers/:provider',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factorsProviders = new RetryRestClient(
+ guardianFactorsProvidersAuth0RestClient,
+ options.retry
+ );
};
/**
@@ -99,7 +154,7 @@ management/GuardianManager.js
* @memberOf module:management.GuardianManager.prototype
*
* @example
- * management.users.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ * management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
* console.log(enrollment);
* });
*
@@ -109,9 +164,7 @@ management/GuardianManager.js
*
* @return {Promise|undefined}
*/
-GuardianManager.prototype.getGuardianEnrollment = function(params, cb) {
- return this.enrollments.get(params, cb);
-};
+utils.wrapPropertyMethod(GuardianManager, 'getGuardianEnrollment', 'enrollments.get');
/**
* Delete a Guardian enrollment.
@@ -120,7 +173,7 @@ management/GuardianManager.js
* @memberOf module:management.GuardianManager.prototype
*
* @example
- * management.users.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
+ * management.guardian.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
* console.log(enrollments);
* });
*
@@ -130,9 +183,137 @@ management/GuardianManager.js
*
* @return {Promise|undefined}
*/
-GuardianManager.prototype.deleteGuardianEnrollment = function(params, cb) {
- return this.enrollments.delete(params, cb);
-};
+utils.wrapPropertyMethod(GuardianManager, 'deleteGuardianEnrollment', 'enrollments.delete');
+
+/**
+ * Create a Guardian enrollment ticket.
+ *
+ * @method createEnrollmentTicket
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.guardian.createEnrollmentTicket(function (err, ticket) {
+ * console.log(ticket);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'createEnrollmentTicket', 'tickets.create');
+
+/**
+ * Get a list of factors and statuses.
+ *
+ * @method getFactors
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.getFactors(function (err, factors) {
+ * console.log(factors.length);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'getFactors', 'factors.getAll');
+
+/**
+ * Get Guardian factor provider configuration
+ *
+ * @method getFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'getFactorProvider', 'factorsProviders.get');
+
+/**
+ * Update Guardian's factor provider
+ *
+ * @method updateFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.updateFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ * messaging_service_sid: 'XXXXXXXXXXXXXX',
+ * auth_token: 'XXXXXXXXXXXXXX',
+ * sid: 'XXXXXXXXXXXXXX'
+ * }, function(err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Object} data Updated Factor provider data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'updateFactorProvider', 'factorsProviders.update');
+
+/**
+ * Get Guardian enrollment and verification factor templates
+ *
+ * @method getFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.getFactorTemplates({ name: 'sms' }, function (err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'getFactorTemplates', 'factorsTemplates.get');
+
+/**
+ * Update Guardian enrollment and verification factor templates
+ *
+ * @method updateFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.updateFactorProvider({ name: 'sms' }, {
+ * enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ * verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+ * }, function(err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor templates data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'updateFactorTemplates', 'factorsTemplates.update');
+
+/**
+ * Update Guardian Factor
+ *
+ * @method updateFactor
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.updateFactor({ name: 'sms' }, {
+ * enabled: true
+ * }, function(err, factor) {
+ * console.log(factor);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'updateFactor', 'factors.update');
module.exports = GuardianManager;
@@ -147,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 7bb900673..0b1a0388d 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -150,7 +150,9 @@ management/JobsManager.js
* @example
* var params = {
* connection_id: '{CONNECTION_ID}',
- * users: '{PATH_TO_USERS_FILE}'
+ * users: '{PATH_TO_USERS_FILE}',
+ * upsert: true, //optional
+ * send_completion_email: false //optional
* };
*
* management.jobs.get(params, function (err) {
@@ -159,11 +161,13 @@ management/JobsManager.js
* }
* });
*
- * @param {Object} data Users import data.
- * @param {String} data.connectionId Connection for the users insertion.
- * @param {String} data.users Path to the users data file.
- * @param {String} data.users_json JSON data for the users.
- * @param {Function} [cb] Callback function.
+ * @param {Object} data Users import data.
+ * @param {String} data.connectionId Connection for the users insertion.
+ * @param {String} data.users Path to the users data file.
+ * @param {String} data.users_json JSON data for the users.
+ * @param {String} data.upsert OPTIONAL: set to true to upsert users, defaults to false
+ * @param {String} data.send_completion_email OPTIONAL: defaults to true
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -175,6 +179,8 @@ management/JobsManager.js
var url = options.baseUrl + '/jobs/users-imports';
var method = 'POST';
+ var upsert = data.upsert === true ? 'true' : 'false';
+ var send_completion_email = data.send_completion_email === false ? 'false' : 'true';
var promise = options.tokenProvider.getAccessToken().then(function(access_token) {
return new Promise(function(resolve, reject) {
@@ -192,7 +198,9 @@ management/JobsManager.js
filename: data.users_json ? 'users.json' : data.users
}
},
- connection_id: data.connection_id
+ connection_id: data.connection_id,
+ upsert: upsert,
+ send_completion_email: send_completion_email
}
},
function(err, res) {
@@ -235,8 +243,7 @@ management/JobsManager.js
*
* @example
* var params = {
- * user_id: '{USER_ID}',
- * client_id: '{CLIENT_ID}'
+ * user_id: '{USER_ID}'
* };
*
* management.jobs.verifyEmail(function (err) {
@@ -247,7 +254,6 @@ management/JobsManager.js
*
* @param {Object} data User data object.
* @param {String} data.user_id ID of the user to be verified.
- * @param {String} data.client_id ID of the client for which the verification email will be sent.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
@@ -278,7 +284,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index acd346b4a..6c9f5b9ea 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 86d417de4..2b5b18db8 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 033845b8d..3cfaa5da4 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 0f35dfe3a..18de21ac5 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 9147e75af..8f51c048f 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 cf104f111..aff6e68c8 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 13431f806..2a14fe60a 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 26757c795..ce0b83bb6 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 21432f9f9..76adaeaa4 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -427,6 +427,8 @@ management/UsersManager.js
* @param {Function} [cb] Callback function
*
* @return {Promise|undefined}
+ *
+ * @deprecated This method will be removed in the next major release.
*/
UsersManager.prototype.deleteAll = function(cb) {
if (typeof cb !== 'function') {
@@ -675,7 +677,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index c447dff70..9e4daa584 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -68,6 +68,7 @@ management/index.js
var RulesConfigsManager = require('./RulesConfigsManager');
var EmailTemplatesManager = require('./EmailTemplatesManager');
var GuardianManager = require('./GuardianManager');
+var CustomDomainsManager = require('./CustomDomainsManager');
var BASE_URL_FORMAT = 'https://%s/api/v2';
var MANAGEMENT_API_AUD_FORMAT = 'https://%s/api/v2/';
@@ -205,6 +206,14 @@ management/index.js
*/
this.guardian = new GuardianManager(managerOptions);
+ /**
+ * Simple abstraction for performing CRUD operations on the
+ * custom domains endpoint.
+ *
+ * @type {CustomDomainsManager}
+ */
+ this.customDomains = new CustomDomainsManager(managerOptions);
+
/**
* Simple abstraction for performing CRUD operations on the
* connections endpoint.
@@ -901,6 +910,7 @@ management/index.js
*
* // Pagination settings.
* var params = {
+ * search_engine: 'v3',
* per_page: 10,
* page: 0
* };
@@ -909,10 +919,11 @@ management/index.js
* console.log(users.length);
* });
*
- * @param {Object} [params] Users params.
- * @param {Number} [params.per_page] Number of results per page.
- * @param {Number} [params.page] Page number, zero indexed.
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Users params.
+ * @param {Number} [params.search_engine] The version of the search engine to use.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -977,6 +988,8 @@ management/index.js
* @param {Function} [cb] Callback function
*
* @return {Promise|undefined}
+ *
+ * @deprecated This method will be removed in the next major release.
*/
utils.wrapPropertyMethod(ManagementClient, 'deleteAllUsers', 'users.deleteAll');
@@ -1966,6 +1979,261 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'deleteRulesConfig', 'rulesConfigs.delete');
+/**
+ * Create an Auth0 Custom Domain.
+ *
+ * @method create
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.createCustomDomain(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain created.
+ * });
+ *
+ * @param {Object} data The custom domain data object.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'createCustomDomain', 'customDomains.create');
+
+/**
+ * Get all Auth0 CustomDomains.
+ *
+ * @method getAll
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.getCustomDomains(function (err, customDomains) {
+ * console.log(customDomains.length);
+ * });
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getCustomDomains', 'customDomains.getAll');
+
+/**
+ * Get a Custom Domain.
+ *
+ * @method get
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getCustomDomain', 'customDomains.get');
+
+/**
+ * Verify a Custom Domain.
+ *
+ * @method verify
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'verifyCustomDomain', 'customDomains.verify');
+
+/**
+ * Delete a Custom Domain.
+ *
+ * @method delete
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain deleted.
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'deleteCustomDomain', 'customDomains.delete');
+
+/**
+ * Create a Guardian enrollment ticket.
+ *
+ * @method createGuardianEnrollmentTicket
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.createGuardianEnrollmentTicket(function (err, ticket) {
+ * console.log(ticket);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'createGuardianEnrollmentTicket',
+ 'guardian.tickets.create'
+);
+
+/**
+ * Get a list of Guardian factors and statuses.
+ *
+ * @method getGuardianFactors
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.getGuardianFactors(function (err, factors) {
+ * console.log(factors.length);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getGuardianFactors', 'guardian.factors.getAll');
+
+/**
+ * Get Guardian factor provider configuration
+ *
+ * @method getGuardianFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'getGuardianFactorProvider',
+ 'guardian.factorsProviders.get'
+);
+
+/**
+ * Update Guardian's factor provider
+ *
+ * @method updateFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ * messaging_service_sid: 'XXXXXXXXXXXXXX',
+ * auth_token: 'XXXXXXXXXXXXXX',
+ * sid: 'XXXXXXXXXXXXXX'
+ * }, function(err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Object} data Updated Factor provider data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'updateGuardianFactorProvider',
+ 'guardian.factorsProviders.update'
+);
+
+/**
+ * Get Guardian enrollment and verification factor templates
+ *
+ * @method getGuardianFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'getGuardianFactorTemplates',
+ 'guardian.factorsTemplates.get'
+);
+
+/**
+ * Update Guardian enrollment and verification factor templates
+ *
+ * @method updateGuardianFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.updateGuardianFactorTemplates({ name: 'sms' }, {
+ * enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ * verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+ * }, function(err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor templates data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'updateGuardianFactorTemplates',
+ 'guardian.factorsTemplates.update'
+);
+
+/**
+ * Update Guardian Factor
+ *
+ * @method updateGuardianFactor
+ * @memberOf module.GuardianManager.prototype
+ *
+ * management.updateGuardianFactor({ name: 'sms' }, {
+ * enabled: true
+ * }, function(err, factor) {
+ * console.log(factor);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'updateGuardianFactor', 'guardian.factors.update');
module.exports = ManagementClient;
@@ -1980,7 +2248,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 014ddfaf8..fb612176b 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -164,8 +164,7 @@ Parameters:
- Options for the Authentication Client
- SDK.
+ Options for the Authentication Client SDK.
@@ -296,6 +295,42 @@ Parameters:
+
+
+
+ supportedAlgorithms
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Algorithms that your application expects to receive
+
+
+
+
+
@@ -401,7 +436,7 @@ databaseSource:
oauthSource:
passwordl
Source:
tokensSource:
usersSource:
changeP
Source:
Source:
getClien
Source:
get
Source:
getProfile<
Source:
password
Source:
Example
+
+
+
+
+ refreshToken(userData) → {Promise|undefined}
+
+
+
+
+
+
+ Sign in using a refresh token
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ auth/index.js, line 546
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ userData
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ User credentials object.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ refresh_token
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Refresh token.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+
+ Given a refresh token from a previous authentication request,
+ it will return a JSON with the access_token and id_token.
+ More information in the
+
+ API Docs
+ .
+
+
+ var data = {
+ client_id: '{CLIENT_ID}', // Optional field.
+ refresh_token: '{REFRESH_TOKEN}',
+};
+
+auth0.refreshToken(data, function (err, userData) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(userData);
+});
+
+
+
+
+
+
@@ -2274,7 +2546,7 @@ Source:
reque
Source:
reque
Source:
request
Source:
verifySM
Source:
Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index e6e64005d..b7b29e7b2 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
new file mode 100644
index 000000000..8697b3777
--- /dev/null
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -0,0 +1,423 @@
+
+
+
+
+
+ OAUthWithIDTokenValidation - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ OAUthWithIDTokenValidation
+
+
+
+
+
+
+
+
+
+
+
+
+ auth.
+
+ OAUthWithIDTokenValidation
+
+
+ Abstracts the oauth.create method with additional id_token validation
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new OAUthWithIDTokenValidation(oauth, options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ oauth
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ An instance of @type {OAuthAuthenticator}
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Authenticator options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ domain
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ AuthenticationClient server domain
+
+
+
+
+
+
+
+
+ clientId
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Default client ID.
+
+
+
+
+
+
+
+
+ clientSecret
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Default client Secret.
+
+
+
+
+
+
+
+
+ supportedAlgorithms
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Algorithms that your application expects to receive
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 03d92e15c..1a653544b 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -102,7 +102,7 @@ new
Source:
Parameters:
- The auth0 account URL.
+ The Auth0 account URL.
+
+
+
+
+
+
+
+
+ domain
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ AuthenticationClient server domain
@@ -382,7 +416,7 @@ (inner) Source:
Source:
password
Source:
Example
+
+
+
+
+ refreshToken(userData) → {Promise|undefined}
+
+
+
+
+
+
+ Sign in using a refresh token
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ userData
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ User credentials object.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ refresh_token
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Refresh token.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+
+ Given a refresh token from a previous authentication request
+ it will return a JSON with the access_token and id_token.
+ More information in the
+
+ API Docs
+ .
+
+
+ var data = {
+ client_id: '{CLIENT_ID}', // Optional field.
+ refresh_token: '{REFRESH_TOKEN}',
+};
+
+auth0.oauth.refreshToken(data, function (err, userData) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(userData);
+});
+
+
+
+
+
+
@@ -1028,7 +1299,7 @@ signInSource:
socialSig
Source:
Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 155cb2a41..e81cdc6c4 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 1e0e59400..97a1daf27 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 f5980491e..1b625dd20 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 787e4940d..249e89209 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -71,6 +71,9 @@ Classes
OAuthAuthenticator
+ OAUthWithIDTokenValidation
+
+
PasswordlessAuthenticator
@@ -105,7 +108,7 @@ Classes
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 2b1f79ecf..0451d5674 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 15b7dbdb0..dee679a9a 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -542,7 +542,7 @@ createSource:
createSource:
deleteSource:
deleteSource:
getAllSource:
updateSource:
updateSource:
Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 4231ee760..02612947b 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 25998797b..7ebfbcc77 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
new file mode 100644
index 000000000..6c4def656
--- /dev/null
+++ b/docs/module-management.CustomDomainsManager.html
@@ -0,0 +1,2881 @@
+
+
+
+
+
+ CustomDomainsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CustomDomainsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ CustomDomainsManager
+
+
+ CustomDomainsManager
+Auth0 Custom Domains Manager.
+CustomDomains represent
+custom domain names.
+You can learn more about this in the
+CustomDomains section of the
+documentation.
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new CustomDomainsManager(options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The client options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ baseUrl
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The URL of the API.
+
+
+
+
+
+
+
+
+ headers
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Headers to be included in all requests.
+
+
+
+
+
+
+
+
+ retry
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Retry Policy Config
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+
+(inner) auth0CustomDomainsRestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the
+Auth0 Custom Domains endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) auth0VerifyRestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the
+Auth0 Custom Domains Verify endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) clientOptions :Object
+
+
+
+
+
+ Options object for the Rest Client instance.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ 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.customDomains.create(data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // CustomDomain created.
+});
+
+
+
+
+
+
+
+
+
+
+ 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.
+});
+
+
+
+
+
+
+
+
+
+
+ delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete 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.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // CustomDomain deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete 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.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // CustomDomain deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ 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.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.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(customDomain);
+});
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.customDomains.verify({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(customDomain);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index 2f00bdd12..01d6666b7 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 e442cb9b8..52441ed0a 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1345,7 +1345,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index 79da62aec..2495916b4 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 9b8b1f648..eff768fda 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -101,7 +101,7 @@ new Gu
Source:
Source:
Type:
+
+
+(inner) guardianFactorsAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian factors.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorsProvidersAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian factor providers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorsTemplatesAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian factors.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianTicketsAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian tickets.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ createEnrollmentTicket(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.guardian.createEnrollmentTicket(function (err, ticket) {
+ console.log(ticket);
+});
+
+
+
+
+
+
+
+
+ createGuardianEnrollmentTicket(cbopt) → {Promise|undefined}
+
- Methods
+
+
+
+ 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);
+});
+
+
+
+
@@ -465,7 +1121,7 @@ Source:
Returns:
Example
- management.users.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
+ management.guardian.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
console.log(enrollments);
});
@@ -730,7 +1386,7 @@
Source:
Returns:
Example
- management.users.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
console.log(enrollment);
});
@@ -964,7 +1620,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 873b2b1e7..a17cf8ff0 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -914,6 +914,58 @@ Parameters:
+
+
+
+ upsert
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ OPTIONAL: set to true to upsert users, defaults to false
+
+
+
+
+
+
+
+
+ send_completion_email
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ OPTIONAL: defaults to true
+
+
+
+
+
@@ -1005,7 +1057,9 @@ Example
var params = {
connection_id: '{CONNECTION_ID}',
- users: '{PATH_TO_USERS_FILE}'
+ users: '{PATH_TO_USERS_FILE}',
+ upsert: true, //optional
+ send_completion_email: false //optional
};
management.jobs.get(params, function (err) {
@@ -1066,7 +1120,7 @@ verifyEmai
Source:
Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index e7910f961..a476b9d52 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 96222b15e..bc804d928 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -106,7 +106,7 @@ new M
Source:
blac
Source:
clientGra
Source:
clientsSource:
connection
Source:
Type:
+
+
+
+
+
+customDomains :CustomDomainsManager
+
+
+
+
+
+ Simple abstraction for performing CRUD operations on the
+custom domains endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
CustomDomainsManager
+
+
+
+
+
+
+
+
+
@@ -1023,7 +1098,7 @@ devi
Source:
emailPro
Source:
emailTe
Source:
guardianSource:
jobsSource:
logsSource:
resour
Source:
rulesSource:
rulesConf
Source:
statsSource:
tenantSource:
ticketsSource:
usersSource:
blackli
Source:
Source:
createCli
Source:
creat
Source:
Source:
Source:
Source:
c
Source:
createRule<
Source:
createUser<
Source:
deleteA
+ Deprecated: - This method will be removed in the next major release.
deleteA
Source:
deleteCli
Source:
delet
Source:
Source:
de
Source:
Source:
d
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
ge
Source:
g
Source:
getClientSource:
getClien
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getDaily
Source:
g
Source:
getEm
Source:
Source:
Source:
getJobSource:
getLogSource:
getLogsSource:
getR
Source:
get
Source:
getRuleSource:
getRulesSource:
getRul
Source:
getT
Source:
getUserSource:
getUserLog
Source:
getUsersSource:
Parameters:
+
+
+ search_engine
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The version of the search engine to use.
+
+
+
+
+
+
per_pageExample
// Pagination settings.
var params = {
+ search_engine: 'v3',
per_page: 10,
page: 0
};
@@ -13684,7 +13798,7 @@ getUse
Source:
importUser
Source:
linkUsersSource:
Source:
Source:
setRule
Source:
unlinkUser
Source:
upda
Source:
updateCli
Source:
updat
Source:
up
Source:
u
Source:
updateRule<
Source:
u
Source:
updateUser<
Source:
upd
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 1a7af1fa7..98a360c74 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 653f75118..0c021904e 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 7881b3014..482cb0539 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 e91728514..4a371256c 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 5f007b36b..c81f2d396 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 b9d45cecb..d73bbea41 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 f0decde8e..527516334 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 ea4aecf75..6cc15b131 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 d8f02b7a6..4a29c2bcb 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -1311,6 +1311,8 @@ deleteAllDeprecated:- This method will be removed in the next major release.
Source:
Source:
linkSource:
logsSource:
Source:
unlinkSource:
Example
diff --git a/docs/module-management.html b/docs/module-management.html
index ef43ed70b..24524f386 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -74,6 +74,9 @@ Classes
ConnectionsManager
+ CustomDomainsManager
+
+
DeviceCredentialsManager
@@ -147,7 +150,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 806e78741..c703086b0 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 e91aaff38..e1092abfd 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 620c47daa..b91a85153 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.13.0",
+ "version": "2.14.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": ["src"],
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
diff --git a/docs/index.html b/docs/index.html
index b31885fe4..284900d46 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 afb9fd421..1c8d473a0 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 1af25e4de..48fdcb021 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 635bbd2c2..02d124357 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 36d5e9f99..ee848a5a2 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 e72316139..15c95b0b1 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
new file mode 100644
index 000000000..09e419d59
--- /dev/null
+++ b/docs/management_CustomDomainsManager.js.html
@@ -0,0 +1,250 @@
+
+
+
+
+
+ management/CustomDomainsManager.js - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ management/CustomDomainsManager.js
+
+
+
+
+
+
+
+
+
+ var ArgumentError = require('rest-facade').ArgumentError;
+var utils = require('../utils');
+var Auth0RestClient = require('../Auth0RestClient');
+var RetryRestClient = require('../RetryRestClient');
+
+/**
+ * @class CustomDomainsManager
+ * Auth0 Custom Domains Manager.
+ *
+ * {@link https://auth0.com/docs/api/management/v2#!/Custom_Domains/get_custom_domains CustomDomains} represent
+ * custom domain names.
+ * You can learn more about this in the
+ * {@link https://auth0.com/docs/custom-domains CustomDomains} section of the
+ * documentation.
+ * @constructor
+ * @memberOf module:management
+ *
+ * @param {Object} options The client options.
+ * @param {String} options.baseUrl The URL of the API.
+ * @param {Object} [options.headers] Headers to be included in all requests.
+ * @param {Object} [options.retry] Retry Policy Config
+ */
+var CustomDomainsManager = function(options) {
+ if (options === null || typeof options !== 'object') {
+ throw new ArgumentError('Must provide manager options');
+ }
+
+ if (options.baseUrl === null || options.baseUrl === undefined) {
+ throw new ArgumentError('Must provide a base URL for the API');
+ }
+
+ if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
+ throw new ArgumentError('The provided base URL is invalid');
+ }
+
+ /**
+ * Options object for the Rest Client instance.
+ *
+ * @type {Object}
+ */
+ var clientOptions = {
+ errorFormatter: { message: 'message', name: 'error' },
+ headers: options.headers,
+ query: { repeatParams: false }
+ };
+
+ /**
+ * Provides an abstraction layer for consuming the
+ * {@link https://auth0.com/docs/api/v2#!/Custom_Domains Auth0 Custom Domains endpoint}.
+ *
+ * @type {external:RestClient}
+ */
+ var auth0CustomDomainsRestClient = new Auth0RestClient(
+ options.baseUrl + '/custom-domains/:id',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.resource = new RetryRestClient(auth0CustomDomainsRestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for consuming the
+ * {@link https://auth0.com/docs/api/v2#!/Custom_Domains Auth0 Custom Domains Verify endpoint}.
+ *
+ * @type {external:RestClient}
+ */
+ var auth0VerifyRestClient = new Auth0RestClient(
+ options.baseUrl + '/custom-domains/:id/verify',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.vefifyResource = new RetryRestClient(auth0VerifyRestClient, options.retry);
+};
+
+/**
+ * Create an Auth0 Custom Domain.
+ *
+ * @method create
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.create(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain created.
+ * });
+ *
+ * @param {Object} data The custom domain data object.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'create', 'resource.create');
+
+/**
+ * Get all Auth0 CustomDomains.
+ *
+ * @method getAll
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.getAll(function (err, customDomains) {
+ * console.log(customDomains.length);
+ * });
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'getAll', 'resource.getAll');
+
+/**
+ * Get a Custom Domain.
+ *
+ * @method get
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.get({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'get', 'resource.get');
+
+/**
+ * Verify a Custom Domain.
+ *
+ * @method verify
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.verify({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+CustomDomainsManager.prototype.verify = function(params, cb) {
+ if (!params || !params.id) {
+ throw new ArgumentError('The custom domain id cannot be null or undefined');
+ }
+
+ if (cb && cb instanceof Function) {
+ return this.vefifyResource.create(params, {}, cb);
+ }
+
+ return this.vefifyResource.create(params, {});
+};
+
+/**
+ * Delete a Custom Domain.
+ *
+ * @method delete
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain deleted.
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'delete', 'resource.delete');
+
+module.exports = CustomDomainsManager;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
index bcec857b3..f5dc2e012 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 0cde21107..38f961049 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -195,7 +195,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index 2a33027bc..b926f4b92 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 63848b8cc..fd969d25b 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -40,6 +40,7 @@ management/GuardianManager.js
var ArgumentError = require('rest-facade').ArgumentError;
+var utils = require('../utils');
var Auth0RestClient = require('../Auth0RestClient');
var RetryRestClient = require('../RetryRestClient');
@@ -90,6 +91,60 @@ management/GuardianManager.js
options.tokenProvider
);
this.enrollments = new RetryRestClient(guardianEnrollmentsAuth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian tickets.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianTicketsAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/enrollments/ticket',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.tickets = new RetryRestClient(guardianTicketsAuth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian factors.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorsAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/:name',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factors = new RetryRestClient(guardianFactorsAuth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian factors.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorsTemplatesAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/:name/templates',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factorsTemplates = new RetryRestClient(
+ guardianFactorsTemplatesAuth0RestClient,
+ options.retry
+ );
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian factor providers.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorsProvidersAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/:name/providers/:provider',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factorsProviders = new RetryRestClient(
+ guardianFactorsProvidersAuth0RestClient,
+ options.retry
+ );
};
/**
@@ -99,7 +154,7 @@ management/GuardianManager.js
* @memberOf module:management.GuardianManager.prototype
*
* @example
- * management.users.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ * management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
* console.log(enrollment);
* });
*
@@ -109,9 +164,7 @@ management/GuardianManager.js
*
* @return {Promise|undefined}
*/
-GuardianManager.prototype.getGuardianEnrollment = function(params, cb) {
- return this.enrollments.get(params, cb);
-};
+utils.wrapPropertyMethod(GuardianManager, 'getGuardianEnrollment', 'enrollments.get');
/**
* Delete a Guardian enrollment.
@@ -120,7 +173,7 @@ management/GuardianManager.js
* @memberOf module:management.GuardianManager.prototype
*
* @example
- * management.users.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
+ * management.guardian.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
* console.log(enrollments);
* });
*
@@ -130,9 +183,137 @@ management/GuardianManager.js
*
* @return {Promise|undefined}
*/
-GuardianManager.prototype.deleteGuardianEnrollment = function(params, cb) {
- return this.enrollments.delete(params, cb);
-};
+utils.wrapPropertyMethod(GuardianManager, 'deleteGuardianEnrollment', 'enrollments.delete');
+
+/**
+ * Create a Guardian enrollment ticket.
+ *
+ * @method createEnrollmentTicket
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.guardian.createEnrollmentTicket(function (err, ticket) {
+ * console.log(ticket);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'createEnrollmentTicket', 'tickets.create');
+
+/**
+ * Get a list of factors and statuses.
+ *
+ * @method getFactors
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.getFactors(function (err, factors) {
+ * console.log(factors.length);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'getFactors', 'factors.getAll');
+
+/**
+ * Get Guardian factor provider configuration
+ *
+ * @method getFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'getFactorProvider', 'factorsProviders.get');
+
+/**
+ * Update Guardian's factor provider
+ *
+ * @method updateFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.updateFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ * messaging_service_sid: 'XXXXXXXXXXXXXX',
+ * auth_token: 'XXXXXXXXXXXXXX',
+ * sid: 'XXXXXXXXXXXXXX'
+ * }, function(err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Object} data Updated Factor provider data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'updateFactorProvider', 'factorsProviders.update');
+
+/**
+ * Get Guardian enrollment and verification factor templates
+ *
+ * @method getFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.getFactorTemplates({ name: 'sms' }, function (err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'getFactorTemplates', 'factorsTemplates.get');
+
+/**
+ * Update Guardian enrollment and verification factor templates
+ *
+ * @method updateFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.updateFactorProvider({ name: 'sms' }, {
+ * enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ * verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+ * }, function(err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor templates data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'updateFactorTemplates', 'factorsTemplates.update');
+
+/**
+ * Update Guardian Factor
+ *
+ * @method updateFactor
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.updateFactor({ name: 'sms' }, {
+ * enabled: true
+ * }, function(err, factor) {
+ * console.log(factor);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'updateFactor', 'factors.update');
module.exports = GuardianManager;
@@ -147,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 7bb900673..0b1a0388d 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -150,7 +150,9 @@ management/JobsManager.js
* @example
* var params = {
* connection_id: '{CONNECTION_ID}',
- * users: '{PATH_TO_USERS_FILE}'
+ * users: '{PATH_TO_USERS_FILE}',
+ * upsert: true, //optional
+ * send_completion_email: false //optional
* };
*
* management.jobs.get(params, function (err) {
@@ -159,11 +161,13 @@ management/JobsManager.js
* }
* });
*
- * @param {Object} data Users import data.
- * @param {String} data.connectionId Connection for the users insertion.
- * @param {String} data.users Path to the users data file.
- * @param {String} data.users_json JSON data for the users.
- * @param {Function} [cb] Callback function.
+ * @param {Object} data Users import data.
+ * @param {String} data.connectionId Connection for the users insertion.
+ * @param {String} data.users Path to the users data file.
+ * @param {String} data.users_json JSON data for the users.
+ * @param {String} data.upsert OPTIONAL: set to true to upsert users, defaults to false
+ * @param {String} data.send_completion_email OPTIONAL: defaults to true
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -175,6 +179,8 @@ management/JobsManager.js
var url = options.baseUrl + '/jobs/users-imports';
var method = 'POST';
+ var upsert = data.upsert === true ? 'true' : 'false';
+ var send_completion_email = data.send_completion_email === false ? 'false' : 'true';
var promise = options.tokenProvider.getAccessToken().then(function(access_token) {
return new Promise(function(resolve, reject) {
@@ -192,7 +198,9 @@ management/JobsManager.js
filename: data.users_json ? 'users.json' : data.users
}
},
- connection_id: data.connection_id
+ connection_id: data.connection_id,
+ upsert: upsert,
+ send_completion_email: send_completion_email
}
},
function(err, res) {
@@ -235,8 +243,7 @@ management/JobsManager.js
*
* @example
* var params = {
- * user_id: '{USER_ID}',
- * client_id: '{CLIENT_ID}'
+ * user_id: '{USER_ID}'
* };
*
* management.jobs.verifyEmail(function (err) {
@@ -247,7 +254,6 @@ management/JobsManager.js
*
* @param {Object} data User data object.
* @param {String} data.user_id ID of the user to be verified.
- * @param {String} data.client_id ID of the client for which the verification email will be sent.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
@@ -278,7 +284,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index acd346b4a..6c9f5b9ea 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 86d417de4..2b5b18db8 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 033845b8d..3cfaa5da4 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 0f35dfe3a..18de21ac5 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 9147e75af..8f51c048f 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 cf104f111..aff6e68c8 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 13431f806..2a14fe60a 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 26757c795..ce0b83bb6 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 21432f9f9..76adaeaa4 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -427,6 +427,8 @@ management/UsersManager.js
* @param {Function} [cb] Callback function
*
* @return {Promise|undefined}
+ *
+ * @deprecated This method will be removed in the next major release.
*/
UsersManager.prototype.deleteAll = function(cb) {
if (typeof cb !== 'function') {
@@ -675,7 +677,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index c447dff70..9e4daa584 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -68,6 +68,7 @@ management/index.js
var RulesConfigsManager = require('./RulesConfigsManager');
var EmailTemplatesManager = require('./EmailTemplatesManager');
var GuardianManager = require('./GuardianManager');
+var CustomDomainsManager = require('./CustomDomainsManager');
var BASE_URL_FORMAT = 'https://%s/api/v2';
var MANAGEMENT_API_AUD_FORMAT = 'https://%s/api/v2/';
@@ -205,6 +206,14 @@ management/index.js
*/
this.guardian = new GuardianManager(managerOptions);
+ /**
+ * Simple abstraction for performing CRUD operations on the
+ * custom domains endpoint.
+ *
+ * @type {CustomDomainsManager}
+ */
+ this.customDomains = new CustomDomainsManager(managerOptions);
+
/**
* Simple abstraction for performing CRUD operations on the
* connections endpoint.
@@ -901,6 +910,7 @@ management/index.js
*
* // Pagination settings.
* var params = {
+ * search_engine: 'v3',
* per_page: 10,
* page: 0
* };
@@ -909,10 +919,11 @@ management/index.js
* console.log(users.length);
* });
*
- * @param {Object} [params] Users params.
- * @param {Number} [params.per_page] Number of results per page.
- * @param {Number} [params.page] Page number, zero indexed.
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Users params.
+ * @param {Number} [params.search_engine] The version of the search engine to use.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -977,6 +988,8 @@ management/index.js
* @param {Function} [cb] Callback function
*
* @return {Promise|undefined}
+ *
+ * @deprecated This method will be removed in the next major release.
*/
utils.wrapPropertyMethod(ManagementClient, 'deleteAllUsers', 'users.deleteAll');
@@ -1966,6 +1979,261 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'deleteRulesConfig', 'rulesConfigs.delete');
+/**
+ * Create an Auth0 Custom Domain.
+ *
+ * @method create
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.createCustomDomain(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain created.
+ * });
+ *
+ * @param {Object} data The custom domain data object.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'createCustomDomain', 'customDomains.create');
+
+/**
+ * Get all Auth0 CustomDomains.
+ *
+ * @method getAll
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.getCustomDomains(function (err, customDomains) {
+ * console.log(customDomains.length);
+ * });
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getCustomDomains', 'customDomains.getAll');
+
+/**
+ * Get a Custom Domain.
+ *
+ * @method get
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getCustomDomain', 'customDomains.get');
+
+/**
+ * Verify a Custom Domain.
+ *
+ * @method verify
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'verifyCustomDomain', 'customDomains.verify');
+
+/**
+ * Delete a Custom Domain.
+ *
+ * @method delete
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain deleted.
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'deleteCustomDomain', 'customDomains.delete');
+
+/**
+ * Create a Guardian enrollment ticket.
+ *
+ * @method createGuardianEnrollmentTicket
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.createGuardianEnrollmentTicket(function (err, ticket) {
+ * console.log(ticket);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'createGuardianEnrollmentTicket',
+ 'guardian.tickets.create'
+);
+
+/**
+ * Get a list of Guardian factors and statuses.
+ *
+ * @method getGuardianFactors
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.getGuardianFactors(function (err, factors) {
+ * console.log(factors.length);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getGuardianFactors', 'guardian.factors.getAll');
+
+/**
+ * Get Guardian factor provider configuration
+ *
+ * @method getGuardianFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'getGuardianFactorProvider',
+ 'guardian.factorsProviders.get'
+);
+
+/**
+ * Update Guardian's factor provider
+ *
+ * @method updateFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ * messaging_service_sid: 'XXXXXXXXXXXXXX',
+ * auth_token: 'XXXXXXXXXXXXXX',
+ * sid: 'XXXXXXXXXXXXXX'
+ * }, function(err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Object} data Updated Factor provider data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'updateGuardianFactorProvider',
+ 'guardian.factorsProviders.update'
+);
+
+/**
+ * Get Guardian enrollment and verification factor templates
+ *
+ * @method getGuardianFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'getGuardianFactorTemplates',
+ 'guardian.factorsTemplates.get'
+);
+
+/**
+ * Update Guardian enrollment and verification factor templates
+ *
+ * @method updateGuardianFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.updateGuardianFactorTemplates({ name: 'sms' }, {
+ * enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ * verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+ * }, function(err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor templates data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'updateGuardianFactorTemplates',
+ 'guardian.factorsTemplates.update'
+);
+
+/**
+ * Update Guardian Factor
+ *
+ * @method updateGuardianFactor
+ * @memberOf module.GuardianManager.prototype
+ *
+ * management.updateGuardianFactor({ name: 'sms' }, {
+ * enabled: true
+ * }, function(err, factor) {
+ * console.log(factor);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'updateGuardianFactor', 'guardian.factors.update');
module.exports = ManagementClient;
@@ -1980,7 +2248,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 014ddfaf8..fb612176b 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -164,8 +164,7 @@ Parameters:
- Options for the Authentication Client
- SDK.
+ Options for the Authentication Client SDK.
@@ -296,6 +295,42 @@ Parameters:
+
+
+
+ supportedAlgorithms
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Algorithms that your application expects to receive
+
+
+
+
+
@@ -401,7 +436,7 @@ databaseSource:
oauthSource:
passwordl
Source:
tokensSource:
usersSource:
changeP
Source:
Source:
getClien
Source:
get
Source:
getProfile<
Source:
password
Source:
Example
+
+
+
+
+ refreshToken(userData) → {Promise|undefined}
+
+
+
+
+
+
+ Sign in using a refresh token
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ auth/index.js, line 546
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ userData
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ User credentials object.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ refresh_token
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Refresh token.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+
+ Given a refresh token from a previous authentication request,
+ it will return a JSON with the access_token and id_token.
+ More information in the
+
+ API Docs
+ .
+
+
+ var data = {
+ client_id: '{CLIENT_ID}', // Optional field.
+ refresh_token: '{REFRESH_TOKEN}',
+};
+
+auth0.refreshToken(data, function (err, userData) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(userData);
+});
+
+
+
+
+
+
@@ -2274,7 +2546,7 @@ Source:
reque
Source:
reque
Source:
request
Source:
verifySM
Source:
Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index e6e64005d..b7b29e7b2 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
new file mode 100644
index 000000000..8697b3777
--- /dev/null
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -0,0 +1,423 @@
+
+
+
+
+
+ OAUthWithIDTokenValidation - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ OAUthWithIDTokenValidation
+
+
+
+
+
+
+
+
+
+
+
+
+ auth.
+
+ OAUthWithIDTokenValidation
+
+
+ Abstracts the oauth.create method with additional id_token validation
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new OAUthWithIDTokenValidation(oauth, options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ oauth
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ An instance of @type {OAuthAuthenticator}
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Authenticator options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ domain
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ AuthenticationClient server domain
+
+
+
+
+
+
+
+
+ clientId
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Default client ID.
+
+
+
+
+
+
+
+
+ clientSecret
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Default client Secret.
+
+
+
+
+
+
+
+
+ supportedAlgorithms
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Algorithms that your application expects to receive
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 03d92e15c..1a653544b 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -102,7 +102,7 @@ new
Source:
Parameters:
- The auth0 account URL.
+ The Auth0 account URL.
+
+
+
+
+
+
+
+
+ domain
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ AuthenticationClient server domain
@@ -382,7 +416,7 @@ (inner) Source:
Source:
password
Source:
Example
+
+
+
+
+ refreshToken(userData) → {Promise|undefined}
+
+
+
+
+
+
+ Sign in using a refresh token
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ userData
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ User credentials object.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ refresh_token
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Refresh token.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+
+ Given a refresh token from a previous authentication request
+ it will return a JSON with the access_token and id_token.
+ More information in the
+
+ API Docs
+ .
+
+
+ var data = {
+ client_id: '{CLIENT_ID}', // Optional field.
+ refresh_token: '{REFRESH_TOKEN}',
+};
+
+auth0.oauth.refreshToken(data, function (err, userData) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(userData);
+});
+
+
+
+
+
+
@@ -1028,7 +1299,7 @@ signInSource:
socialSig
Source:
Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 155cb2a41..e81cdc6c4 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 1e0e59400..97a1daf27 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 f5980491e..1b625dd20 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 787e4940d..249e89209 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -71,6 +71,9 @@ Classes
OAuthAuthenticator
+ OAUthWithIDTokenValidation
+
+
PasswordlessAuthenticator
@@ -105,7 +108,7 @@ Classes
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 2b1f79ecf..0451d5674 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 15b7dbdb0..dee679a9a 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -542,7 +542,7 @@ createSource:
createSource:
deleteSource:
deleteSource:
getAllSource:
updateSource:
updateSource:
Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 4231ee760..02612947b 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 25998797b..7ebfbcc77 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
new file mode 100644
index 000000000..6c4def656
--- /dev/null
+++ b/docs/module-management.CustomDomainsManager.html
@@ -0,0 +1,2881 @@
+
+
+
+
+
+ CustomDomainsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CustomDomainsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ CustomDomainsManager
+
+
+ CustomDomainsManager
+Auth0 Custom Domains Manager.
+CustomDomains represent
+custom domain names.
+You can learn more about this in the
+CustomDomains section of the
+documentation.
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new CustomDomainsManager(options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The client options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ baseUrl
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The URL of the API.
+
+
+
+
+
+
+
+
+ headers
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Headers to be included in all requests.
+
+
+
+
+
+
+
+
+ retry
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Retry Policy Config
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+
+(inner) auth0CustomDomainsRestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the
+Auth0 Custom Domains endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) auth0VerifyRestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the
+Auth0 Custom Domains Verify endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) clientOptions :Object
+
+
+
+
+
+ Options object for the Rest Client instance.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ 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.customDomains.create(data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // CustomDomain created.
+});
+
+
+
+
+
+
+
+
+
+
+ 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.
+});
+
+
+
+
+
+
+
+
+
+
+ delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete 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.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // CustomDomain deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete 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.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // CustomDomain deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ 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.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.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(customDomain);
+});
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.customDomains.verify({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(customDomain);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index 2f00bdd12..01d6666b7 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 e442cb9b8..52441ed0a 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1345,7 +1345,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index 79da62aec..2495916b4 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 9b8b1f648..eff768fda 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -101,7 +101,7 @@ new Gu
Source:
Source:
Type:
+
+
+(inner) guardianFactorsAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian factors.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorsProvidersAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian factor providers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorsTemplatesAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian factors.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianTicketsAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian tickets.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ createEnrollmentTicket(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.guardian.createEnrollmentTicket(function (err, ticket) {
+ console.log(ticket);
+});
+
+
+
+
+
+
+
+
+ createGuardianEnrollmentTicket(cbopt) → {Promise|undefined}
+
- Methods
+
+
+
+ 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);
+});
+
+
+
+
@@ -465,7 +1121,7 @@ Source:
Returns:
Example
- management.users.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
+ management.guardian.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
console.log(enrollments);
});
@@ -730,7 +1386,7 @@
Source:
Returns:
Example
- management.users.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
console.log(enrollment);
});
@@ -964,7 +1620,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 873b2b1e7..a17cf8ff0 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -914,6 +914,58 @@ Parameters:
+
+
+
+ upsert
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ OPTIONAL: set to true to upsert users, defaults to false
+
+
+
+
+
+
+
+
+ send_completion_email
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ OPTIONAL: defaults to true
+
+
+
+
+
@@ -1005,7 +1057,9 @@ Example
var params = {
connection_id: '{CONNECTION_ID}',
- users: '{PATH_TO_USERS_FILE}'
+ users: '{PATH_TO_USERS_FILE}',
+ upsert: true, //optional
+ send_completion_email: false //optional
};
management.jobs.get(params, function (err) {
@@ -1066,7 +1120,7 @@ verifyEmai
Source:
Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index e7910f961..a476b9d52 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 96222b15e..bc804d928 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -106,7 +106,7 @@ new M
Source:
blac
Source:
clientGra
Source:
clientsSource:
connection
Source:
Type:
+
+
+
+
+
+customDomains :CustomDomainsManager
+
+
+
+
+
+ Simple abstraction for performing CRUD operations on the
+custom domains endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
CustomDomainsManager
+
+
+
+
+
+
+
+
+
@@ -1023,7 +1098,7 @@ devi
Source:
emailPro
Source:
emailTe
Source:
guardianSource:
jobsSource:
logsSource:
resour
Source:
rulesSource:
rulesConf
Source:
statsSource:
tenantSource:
ticketsSource:
usersSource:
blackli
Source:
Source:
createCli
Source:
creat
Source:
Source:
Source:
Source:
c
Source:
createRule<
Source:
createUser<
Source:
deleteA
+ Deprecated: - This method will be removed in the next major release.
deleteA
Source:
deleteCli
Source:
delet
Source:
Source:
de
Source:
Source:
d
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
ge
Source:
g
Source:
getClientSource:
getClien
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getDaily
Source:
g
Source:
getEm
Source:
Source:
Source:
getJobSource:
getLogSource:
getLogsSource:
getR
Source:
get
Source:
getRuleSource:
getRulesSource:
getRul
Source:
getT
Source:
getUserSource:
getUserLog
Source:
getUsersSource:
Parameters:
+
+
+ search_engine
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The version of the search engine to use.
+
+
+
+
+
+
per_pageExample
// Pagination settings.
var params = {
+ search_engine: 'v3',
per_page: 10,
page: 0
};
@@ -13684,7 +13798,7 @@ getUse
Source:
importUser
Source:
linkUsersSource:
Source:
Source:
setRule
Source:
unlinkUser
Source:
upda
Source:
updateCli
Source:
updat
Source:
up
Source:
u
Source:
updateRule<
Source:
u
Source:
updateUser<
Source:
upd
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 1a7af1fa7..98a360c74 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 653f75118..0c021904e 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 7881b3014..482cb0539 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 e91728514..4a371256c 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 5f007b36b..c81f2d396 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 b9d45cecb..d73bbea41 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 f0decde8e..527516334 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 ea4aecf75..6cc15b131 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 d8f02b7a6..4a29c2bcb 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -1311,6 +1311,8 @@ deleteAllDeprecated:- This method will be removed in the next major release.
Source:
Source:
linkSource:
logsSource:
Source:
unlinkSource:
Example
diff --git a/docs/module-management.html b/docs/module-management.html
index ef43ed70b..24524f386 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -74,6 +74,9 @@ Classes
ConnectionsManager
+ CustomDomainsManager
+
+
DeviceCredentialsManager
@@ -147,7 +150,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 806e78741..c703086b0 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 e91aaff38..e1092abfd 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 620c47daa..b91a85153 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.13.0",
+ "version": "2.14.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": ["src"],
Source:
Source:
Source:
Source:
Source:
Source:
diff --git a/docs/index.html b/docs/index.html
index b31885fe4..284900d46 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 afb9fd421..1c8d473a0 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 1af25e4de..48fdcb021 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 635bbd2c2..02d124357 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 36d5e9f99..ee848a5a2 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 e72316139..15c95b0b1 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
new file mode 100644
index 000000000..09e419d59
--- /dev/null
+++ b/docs/management_CustomDomainsManager.js.html
@@ -0,0 +1,250 @@
+
+
+
+
+
+ management/CustomDomainsManager.js - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ management/CustomDomainsManager.js
+
+
+
+
+
+
+
+
+
+ var ArgumentError = require('rest-facade').ArgumentError;
+var utils = require('../utils');
+var Auth0RestClient = require('../Auth0RestClient');
+var RetryRestClient = require('../RetryRestClient');
+
+/**
+ * @class CustomDomainsManager
+ * Auth0 Custom Domains Manager.
+ *
+ * {@link https://auth0.com/docs/api/management/v2#!/Custom_Domains/get_custom_domains CustomDomains} represent
+ * custom domain names.
+ * You can learn more about this in the
+ * {@link https://auth0.com/docs/custom-domains CustomDomains} section of the
+ * documentation.
+ * @constructor
+ * @memberOf module:management
+ *
+ * @param {Object} options The client options.
+ * @param {String} options.baseUrl The URL of the API.
+ * @param {Object} [options.headers] Headers to be included in all requests.
+ * @param {Object} [options.retry] Retry Policy Config
+ */
+var CustomDomainsManager = function(options) {
+ if (options === null || typeof options !== 'object') {
+ throw new ArgumentError('Must provide manager options');
+ }
+
+ if (options.baseUrl === null || options.baseUrl === undefined) {
+ throw new ArgumentError('Must provide a base URL for the API');
+ }
+
+ if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
+ throw new ArgumentError('The provided base URL is invalid');
+ }
+
+ /**
+ * Options object for the Rest Client instance.
+ *
+ * @type {Object}
+ */
+ var clientOptions = {
+ errorFormatter: { message: 'message', name: 'error' },
+ headers: options.headers,
+ query: { repeatParams: false }
+ };
+
+ /**
+ * Provides an abstraction layer for consuming the
+ * {@link https://auth0.com/docs/api/v2#!/Custom_Domains Auth0 Custom Domains endpoint}.
+ *
+ * @type {external:RestClient}
+ */
+ var auth0CustomDomainsRestClient = new Auth0RestClient(
+ options.baseUrl + '/custom-domains/:id',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.resource = new RetryRestClient(auth0CustomDomainsRestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for consuming the
+ * {@link https://auth0.com/docs/api/v2#!/Custom_Domains Auth0 Custom Domains Verify endpoint}.
+ *
+ * @type {external:RestClient}
+ */
+ var auth0VerifyRestClient = new Auth0RestClient(
+ options.baseUrl + '/custom-domains/:id/verify',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.vefifyResource = new RetryRestClient(auth0VerifyRestClient, options.retry);
+};
+
+/**
+ * Create an Auth0 Custom Domain.
+ *
+ * @method create
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.create(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain created.
+ * });
+ *
+ * @param {Object} data The custom domain data object.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'create', 'resource.create');
+
+/**
+ * Get all Auth0 CustomDomains.
+ *
+ * @method getAll
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.getAll(function (err, customDomains) {
+ * console.log(customDomains.length);
+ * });
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'getAll', 'resource.getAll');
+
+/**
+ * Get a Custom Domain.
+ *
+ * @method get
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.get({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'get', 'resource.get');
+
+/**
+ * Verify a Custom Domain.
+ *
+ * @method verify
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.verify({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+CustomDomainsManager.prototype.verify = function(params, cb) {
+ if (!params || !params.id) {
+ throw new ArgumentError('The custom domain id cannot be null or undefined');
+ }
+
+ if (cb && cb instanceof Function) {
+ return this.vefifyResource.create(params, {}, cb);
+ }
+
+ return this.vefifyResource.create(params, {});
+};
+
+/**
+ * Delete a Custom Domain.
+ *
+ * @method delete
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain deleted.
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'delete', 'resource.delete');
+
+module.exports = CustomDomainsManager;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
index bcec857b3..f5dc2e012 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 0cde21107..38f961049 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -195,7 +195,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index 2a33027bc..b926f4b92 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 63848b8cc..fd969d25b 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -40,6 +40,7 @@ management/GuardianManager.js
var ArgumentError = require('rest-facade').ArgumentError;
+var utils = require('../utils');
var Auth0RestClient = require('../Auth0RestClient');
var RetryRestClient = require('../RetryRestClient');
@@ -90,6 +91,60 @@ management/GuardianManager.js
options.tokenProvider
);
this.enrollments = new RetryRestClient(guardianEnrollmentsAuth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian tickets.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianTicketsAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/enrollments/ticket',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.tickets = new RetryRestClient(guardianTicketsAuth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian factors.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorsAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/:name',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factors = new RetryRestClient(guardianFactorsAuth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian factors.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorsTemplatesAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/:name/templates',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factorsTemplates = new RetryRestClient(
+ guardianFactorsTemplatesAuth0RestClient,
+ options.retry
+ );
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian factor providers.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorsProvidersAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/:name/providers/:provider',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factorsProviders = new RetryRestClient(
+ guardianFactorsProvidersAuth0RestClient,
+ options.retry
+ );
};
/**
@@ -99,7 +154,7 @@ management/GuardianManager.js
* @memberOf module:management.GuardianManager.prototype
*
* @example
- * management.users.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ * management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
* console.log(enrollment);
* });
*
@@ -109,9 +164,7 @@ management/GuardianManager.js
*
* @return {Promise|undefined}
*/
-GuardianManager.prototype.getGuardianEnrollment = function(params, cb) {
- return this.enrollments.get(params, cb);
-};
+utils.wrapPropertyMethod(GuardianManager, 'getGuardianEnrollment', 'enrollments.get');
/**
* Delete a Guardian enrollment.
@@ -120,7 +173,7 @@ management/GuardianManager.js
* @memberOf module:management.GuardianManager.prototype
*
* @example
- * management.users.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
+ * management.guardian.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
* console.log(enrollments);
* });
*
@@ -130,9 +183,137 @@ management/GuardianManager.js
*
* @return {Promise|undefined}
*/
-GuardianManager.prototype.deleteGuardianEnrollment = function(params, cb) {
- return this.enrollments.delete(params, cb);
-};
+utils.wrapPropertyMethod(GuardianManager, 'deleteGuardianEnrollment', 'enrollments.delete');
+
+/**
+ * Create a Guardian enrollment ticket.
+ *
+ * @method createEnrollmentTicket
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.guardian.createEnrollmentTicket(function (err, ticket) {
+ * console.log(ticket);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'createEnrollmentTicket', 'tickets.create');
+
+/**
+ * Get a list of factors and statuses.
+ *
+ * @method getFactors
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.getFactors(function (err, factors) {
+ * console.log(factors.length);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'getFactors', 'factors.getAll');
+
+/**
+ * Get Guardian factor provider configuration
+ *
+ * @method getFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'getFactorProvider', 'factorsProviders.get');
+
+/**
+ * Update Guardian's factor provider
+ *
+ * @method updateFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.updateFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ * messaging_service_sid: 'XXXXXXXXXXXXXX',
+ * auth_token: 'XXXXXXXXXXXXXX',
+ * sid: 'XXXXXXXXXXXXXX'
+ * }, function(err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Object} data Updated Factor provider data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'updateFactorProvider', 'factorsProviders.update');
+
+/**
+ * Get Guardian enrollment and verification factor templates
+ *
+ * @method getFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.getFactorTemplates({ name: 'sms' }, function (err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'getFactorTemplates', 'factorsTemplates.get');
+
+/**
+ * Update Guardian enrollment and verification factor templates
+ *
+ * @method updateFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.updateFactorProvider({ name: 'sms' }, {
+ * enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ * verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+ * }, function(err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor templates data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'updateFactorTemplates', 'factorsTemplates.update');
+
+/**
+ * Update Guardian Factor
+ *
+ * @method updateFactor
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.updateFactor({ name: 'sms' }, {
+ * enabled: true
+ * }, function(err, factor) {
+ * console.log(factor);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'updateFactor', 'factors.update');
module.exports = GuardianManager;
@@ -147,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 7bb900673..0b1a0388d 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -150,7 +150,9 @@ management/JobsManager.js
* @example
* var params = {
* connection_id: '{CONNECTION_ID}',
- * users: '{PATH_TO_USERS_FILE}'
+ * users: '{PATH_TO_USERS_FILE}',
+ * upsert: true, //optional
+ * send_completion_email: false //optional
* };
*
* management.jobs.get(params, function (err) {
@@ -159,11 +161,13 @@ management/JobsManager.js
* }
* });
*
- * @param {Object} data Users import data.
- * @param {String} data.connectionId Connection for the users insertion.
- * @param {String} data.users Path to the users data file.
- * @param {String} data.users_json JSON data for the users.
- * @param {Function} [cb] Callback function.
+ * @param {Object} data Users import data.
+ * @param {String} data.connectionId Connection for the users insertion.
+ * @param {String} data.users Path to the users data file.
+ * @param {String} data.users_json JSON data for the users.
+ * @param {String} data.upsert OPTIONAL: set to true to upsert users, defaults to false
+ * @param {String} data.send_completion_email OPTIONAL: defaults to true
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -175,6 +179,8 @@ management/JobsManager.js
var url = options.baseUrl + '/jobs/users-imports';
var method = 'POST';
+ var upsert = data.upsert === true ? 'true' : 'false';
+ var send_completion_email = data.send_completion_email === false ? 'false' : 'true';
var promise = options.tokenProvider.getAccessToken().then(function(access_token) {
return new Promise(function(resolve, reject) {
@@ -192,7 +198,9 @@ management/JobsManager.js
filename: data.users_json ? 'users.json' : data.users
}
},
- connection_id: data.connection_id
+ connection_id: data.connection_id,
+ upsert: upsert,
+ send_completion_email: send_completion_email
}
},
function(err, res) {
@@ -235,8 +243,7 @@ management/JobsManager.js
*
* @example
* var params = {
- * user_id: '{USER_ID}',
- * client_id: '{CLIENT_ID}'
+ * user_id: '{USER_ID}'
* };
*
* management.jobs.verifyEmail(function (err) {
@@ -247,7 +254,6 @@ management/JobsManager.js
*
* @param {Object} data User data object.
* @param {String} data.user_id ID of the user to be verified.
- * @param {String} data.client_id ID of the client for which the verification email will be sent.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
@@ -278,7 +284,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index acd346b4a..6c9f5b9ea 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 86d417de4..2b5b18db8 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 033845b8d..3cfaa5da4 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 0f35dfe3a..18de21ac5 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 9147e75af..8f51c048f 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 cf104f111..aff6e68c8 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 13431f806..2a14fe60a 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 26757c795..ce0b83bb6 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 21432f9f9..76adaeaa4 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -427,6 +427,8 @@ management/UsersManager.js
* @param {Function} [cb] Callback function
*
* @return {Promise|undefined}
+ *
+ * @deprecated This method will be removed in the next major release.
*/
UsersManager.prototype.deleteAll = function(cb) {
if (typeof cb !== 'function') {
@@ -675,7 +677,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index c447dff70..9e4daa584 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -68,6 +68,7 @@ management/index.js
var RulesConfigsManager = require('./RulesConfigsManager');
var EmailTemplatesManager = require('./EmailTemplatesManager');
var GuardianManager = require('./GuardianManager');
+var CustomDomainsManager = require('./CustomDomainsManager');
var BASE_URL_FORMAT = 'https://%s/api/v2';
var MANAGEMENT_API_AUD_FORMAT = 'https://%s/api/v2/';
@@ -205,6 +206,14 @@ management/index.js
*/
this.guardian = new GuardianManager(managerOptions);
+ /**
+ * Simple abstraction for performing CRUD operations on the
+ * custom domains endpoint.
+ *
+ * @type {CustomDomainsManager}
+ */
+ this.customDomains = new CustomDomainsManager(managerOptions);
+
/**
* Simple abstraction for performing CRUD operations on the
* connections endpoint.
@@ -901,6 +910,7 @@ management/index.js
*
* // Pagination settings.
* var params = {
+ * search_engine: 'v3',
* per_page: 10,
* page: 0
* };
@@ -909,10 +919,11 @@ management/index.js
* console.log(users.length);
* });
*
- * @param {Object} [params] Users params.
- * @param {Number} [params.per_page] Number of results per page.
- * @param {Number} [params.page] Page number, zero indexed.
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Users params.
+ * @param {Number} [params.search_engine] The version of the search engine to use.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -977,6 +988,8 @@ management/index.js
* @param {Function} [cb] Callback function
*
* @return {Promise|undefined}
+ *
+ * @deprecated This method will be removed in the next major release.
*/
utils.wrapPropertyMethod(ManagementClient, 'deleteAllUsers', 'users.deleteAll');
@@ -1966,6 +1979,261 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'deleteRulesConfig', 'rulesConfigs.delete');
+/**
+ * Create an Auth0 Custom Domain.
+ *
+ * @method create
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.createCustomDomain(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain created.
+ * });
+ *
+ * @param {Object} data The custom domain data object.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'createCustomDomain', 'customDomains.create');
+
+/**
+ * Get all Auth0 CustomDomains.
+ *
+ * @method getAll
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.getCustomDomains(function (err, customDomains) {
+ * console.log(customDomains.length);
+ * });
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getCustomDomains', 'customDomains.getAll');
+
+/**
+ * Get a Custom Domain.
+ *
+ * @method get
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getCustomDomain', 'customDomains.get');
+
+/**
+ * Verify a Custom Domain.
+ *
+ * @method verify
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'verifyCustomDomain', 'customDomains.verify');
+
+/**
+ * Delete a Custom Domain.
+ *
+ * @method delete
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain deleted.
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'deleteCustomDomain', 'customDomains.delete');
+
+/**
+ * Create a Guardian enrollment ticket.
+ *
+ * @method createGuardianEnrollmentTicket
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.createGuardianEnrollmentTicket(function (err, ticket) {
+ * console.log(ticket);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'createGuardianEnrollmentTicket',
+ 'guardian.tickets.create'
+);
+
+/**
+ * Get a list of Guardian factors and statuses.
+ *
+ * @method getGuardianFactors
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.getGuardianFactors(function (err, factors) {
+ * console.log(factors.length);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getGuardianFactors', 'guardian.factors.getAll');
+
+/**
+ * Get Guardian factor provider configuration
+ *
+ * @method getGuardianFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'getGuardianFactorProvider',
+ 'guardian.factorsProviders.get'
+);
+
+/**
+ * Update Guardian's factor provider
+ *
+ * @method updateFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ * messaging_service_sid: 'XXXXXXXXXXXXXX',
+ * auth_token: 'XXXXXXXXXXXXXX',
+ * sid: 'XXXXXXXXXXXXXX'
+ * }, function(err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Object} data Updated Factor provider data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'updateGuardianFactorProvider',
+ 'guardian.factorsProviders.update'
+);
+
+/**
+ * Get Guardian enrollment and verification factor templates
+ *
+ * @method getGuardianFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'getGuardianFactorTemplates',
+ 'guardian.factorsTemplates.get'
+);
+
+/**
+ * Update Guardian enrollment and verification factor templates
+ *
+ * @method updateGuardianFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.updateGuardianFactorTemplates({ name: 'sms' }, {
+ * enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ * verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+ * }, function(err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor templates data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'updateGuardianFactorTemplates',
+ 'guardian.factorsTemplates.update'
+);
+
+/**
+ * Update Guardian Factor
+ *
+ * @method updateGuardianFactor
+ * @memberOf module.GuardianManager.prototype
+ *
+ * management.updateGuardianFactor({ name: 'sms' }, {
+ * enabled: true
+ * }, function(err, factor) {
+ * console.log(factor);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'updateGuardianFactor', 'guardian.factors.update');
module.exports = ManagementClient;
@@ -1980,7 +2248,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 014ddfaf8..fb612176b 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -164,8 +164,7 @@ Parameters:
- Options for the Authentication Client
- SDK.
+ Options for the Authentication Client SDK.
@@ -296,6 +295,42 @@ Parameters:
+
+
+
+ supportedAlgorithms
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Algorithms that your application expects to receive
+
+
+
+
+
@@ -401,7 +436,7 @@ databaseSource:
oauthSource:
passwordl
Source:
tokensSource:
usersSource:
changeP
Source:
Source:
getClien
Source:
get
Source:
getProfile<
Source:
password
Source:
Example
+
+
+
+
+ refreshToken(userData) → {Promise|undefined}
+
+
+
+
+
+
+ Sign in using a refresh token
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ auth/index.js, line 546
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ userData
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ User credentials object.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ refresh_token
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Refresh token.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+
+ Given a refresh token from a previous authentication request,
+ it will return a JSON with the access_token and id_token.
+ More information in the
+
+ API Docs
+ .
+
+
+ var data = {
+ client_id: '{CLIENT_ID}', // Optional field.
+ refresh_token: '{REFRESH_TOKEN}',
+};
+
+auth0.refreshToken(data, function (err, userData) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(userData);
+});
+
+
+
+
+
+
@@ -2274,7 +2546,7 @@ Source:
reque
Source:
reque
Source:
request
Source:
verifySM
Source:
Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index e6e64005d..b7b29e7b2 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
new file mode 100644
index 000000000..8697b3777
--- /dev/null
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -0,0 +1,423 @@
+
+
+
+
+
+ OAUthWithIDTokenValidation - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ OAUthWithIDTokenValidation
+
+
+
+
+
+
+
+
+
+
+
+
+ auth.
+
+ OAUthWithIDTokenValidation
+
+
+ Abstracts the oauth.create method with additional id_token validation
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new OAUthWithIDTokenValidation(oauth, options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ oauth
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ An instance of @type {OAuthAuthenticator}
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Authenticator options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ domain
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ AuthenticationClient server domain
+
+
+
+
+
+
+
+
+ clientId
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Default client ID.
+
+
+
+
+
+
+
+
+ clientSecret
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Default client Secret.
+
+
+
+
+
+
+
+
+ supportedAlgorithms
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Algorithms that your application expects to receive
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 03d92e15c..1a653544b 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -102,7 +102,7 @@ new
Source:
Parameters:
- The auth0 account URL.
+ The Auth0 account URL.
+
+
+
+
+
+
+
+
+ domain
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ AuthenticationClient server domain
@@ -382,7 +416,7 @@ (inner) Source:
Source:
password
Source:
Example
+
+
+
+
+ refreshToken(userData) → {Promise|undefined}
+
+
+
+
+
+
+ Sign in using a refresh token
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ userData
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ User credentials object.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ refresh_token
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Refresh token.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+
+ Given a refresh token from a previous authentication request
+ it will return a JSON with the access_token and id_token.
+ More information in the
+
+ API Docs
+ .
+
+
+ var data = {
+ client_id: '{CLIENT_ID}', // Optional field.
+ refresh_token: '{REFRESH_TOKEN}',
+};
+
+auth0.oauth.refreshToken(data, function (err, userData) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(userData);
+});
+
+
+
+
+
+
@@ -1028,7 +1299,7 @@ signInSource:
socialSig
Source:
Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 155cb2a41..e81cdc6c4 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 1e0e59400..97a1daf27 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 f5980491e..1b625dd20 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 787e4940d..249e89209 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -71,6 +71,9 @@ Classes
OAuthAuthenticator
+ OAUthWithIDTokenValidation
+
+
PasswordlessAuthenticator
@@ -105,7 +108,7 @@ Classes
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 2b1f79ecf..0451d5674 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 15b7dbdb0..dee679a9a 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -542,7 +542,7 @@ createSource:
createSource:
deleteSource:
deleteSource:
getAllSource:
updateSource:
updateSource:
Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 4231ee760..02612947b 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 25998797b..7ebfbcc77 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
new file mode 100644
index 000000000..6c4def656
--- /dev/null
+++ b/docs/module-management.CustomDomainsManager.html
@@ -0,0 +1,2881 @@
+
+
+
+
+
+ CustomDomainsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CustomDomainsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ CustomDomainsManager
+
+
+ CustomDomainsManager
+Auth0 Custom Domains Manager.
+CustomDomains represent
+custom domain names.
+You can learn more about this in the
+CustomDomains section of the
+documentation.
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new CustomDomainsManager(options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The client options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ baseUrl
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The URL of the API.
+
+
+
+
+
+
+
+
+ headers
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Headers to be included in all requests.
+
+
+
+
+
+
+
+
+ retry
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Retry Policy Config
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+
+(inner) auth0CustomDomainsRestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the
+Auth0 Custom Domains endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) auth0VerifyRestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the
+Auth0 Custom Domains Verify endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) clientOptions :Object
+
+
+
+
+
+ Options object for the Rest Client instance.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ 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.customDomains.create(data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // CustomDomain created.
+});
+
+
+
+
+
+
+
+
+
+
+ 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.
+});
+
+
+
+
+
+
+
+
+
+
+ delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete 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.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // CustomDomain deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete 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.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // CustomDomain deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ 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.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.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(customDomain);
+});
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.customDomains.verify({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(customDomain);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index 2f00bdd12..01d6666b7 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 e442cb9b8..52441ed0a 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1345,7 +1345,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index 79da62aec..2495916b4 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 9b8b1f648..eff768fda 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -101,7 +101,7 @@ new Gu
Source:
Source:
Type:
+
+
+(inner) guardianFactorsAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian factors.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorsProvidersAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian factor providers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorsTemplatesAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian factors.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianTicketsAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian tickets.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ createEnrollmentTicket(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.guardian.createEnrollmentTicket(function (err, ticket) {
+ console.log(ticket);
+});
+
+
+
+
+
+
+
+
+ createGuardianEnrollmentTicket(cbopt) → {Promise|undefined}
+
- Methods
+
+
+
+ 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);
+});
+
+
+
+
@@ -465,7 +1121,7 @@ Source:
Returns:
Example
- management.users.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
+ management.guardian.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
console.log(enrollments);
});
@@ -730,7 +1386,7 @@
Source:
Returns:
Example
- management.users.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
console.log(enrollment);
});
@@ -964,7 +1620,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 873b2b1e7..a17cf8ff0 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -914,6 +914,58 @@ Parameters:
+
+
+
+ upsert
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ OPTIONAL: set to true to upsert users, defaults to false
+
+
+
+
+
+
+
+
+ send_completion_email
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ OPTIONAL: defaults to true
+
+
+
+
+
@@ -1005,7 +1057,9 @@ Example
var params = {
connection_id: '{CONNECTION_ID}',
- users: '{PATH_TO_USERS_FILE}'
+ users: '{PATH_TO_USERS_FILE}',
+ upsert: true, //optional
+ send_completion_email: false //optional
};
management.jobs.get(params, function (err) {
@@ -1066,7 +1120,7 @@ verifyEmai
Source:
Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index e7910f961..a476b9d52 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 96222b15e..bc804d928 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -106,7 +106,7 @@ new M
Source:
blac
Source:
clientGra
Source:
clientsSource:
connection
Source:
Type:
+
+
+
+
+
+customDomains :CustomDomainsManager
+
+
+
+
+
+ Simple abstraction for performing CRUD operations on the
+custom domains endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
CustomDomainsManager
+
+
+
+
+
+
+
+
+
@@ -1023,7 +1098,7 @@ devi
Source:
emailPro
Source:
emailTe
Source:
guardianSource:
jobsSource:
logsSource:
resour
Source:
rulesSource:
rulesConf
Source:
statsSource:
tenantSource:
ticketsSource:
usersSource:
blackli
Source:
Source:
createCli
Source:
creat
Source:
Source:
Source:
Source:
c
Source:
createRule<
Source:
createUser<
Source:
deleteA
+ Deprecated: - This method will be removed in the next major release.
deleteA
Source:
deleteCli
Source:
delet
Source:
Source:
de
Source:
Source:
d
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
ge
Source:
g
Source:
getClientSource:
getClien
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getDaily
Source:
g
Source:
getEm
Source:
Source:
Source:
getJobSource:
getLogSource:
getLogsSource:
getR
Source:
get
Source:
getRuleSource:
getRulesSource:
getRul
Source:
getT
Source:
getUserSource:
getUserLog
Source:
getUsersSource:
Parameters:
+
+
+ search_engine
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The version of the search engine to use.
+
+
+
+
+
+
per_pageExample
// Pagination settings.
var params = {
+ search_engine: 'v3',
per_page: 10,
page: 0
};
@@ -13684,7 +13798,7 @@ getUse
Source:
importUser
Source:
linkUsersSource:
Source:
Source:
setRule
Source:
unlinkUser
Source:
upda
Source:
updateCli
Source:
updat
Source:
up
Source:
u
Source:
updateRule<
Source:
u
Source:
updateUser<
Source:
upd
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 1a7af1fa7..98a360c74 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 653f75118..0c021904e 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 7881b3014..482cb0539 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 e91728514..4a371256c 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 5f007b36b..c81f2d396 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 b9d45cecb..d73bbea41 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 f0decde8e..527516334 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 ea4aecf75..6cc15b131 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 d8f02b7a6..4a29c2bcb 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -1311,6 +1311,8 @@ deleteAllDeprecated:- This method will be removed in the next major release.
Source:
Source:
linkSource:
logsSource:
Source:
unlinkSource:
Example
diff --git a/docs/module-management.html b/docs/module-management.html
index ef43ed70b..24524f386 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -74,6 +74,9 @@ Classes
ConnectionsManager
+ CustomDomainsManager
+
+
DeviceCredentialsManager
@@ -147,7 +150,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 806e78741..c703086b0 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 e91aaff38..e1092abfd 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 620c47daa..b91a85153 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.13.0",
+ "version": "2.14.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": ["src"],
Source:
Source:
Source:
Source:
diff --git a/docs/index.html b/docs/index.html
index b31885fe4..284900d46 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 afb9fd421..1c8d473a0 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 1af25e4de..48fdcb021 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 635bbd2c2..02d124357 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 36d5e9f99..ee848a5a2 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 e72316139..15c95b0b1 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
new file mode 100644
index 000000000..09e419d59
--- /dev/null
+++ b/docs/management_CustomDomainsManager.js.html
@@ -0,0 +1,250 @@
+
+
+
+
+
+ management/CustomDomainsManager.js - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ management/CustomDomainsManager.js
+
+
+
+
+
+
+
+
+
+ var ArgumentError = require('rest-facade').ArgumentError;
+var utils = require('../utils');
+var Auth0RestClient = require('../Auth0RestClient');
+var RetryRestClient = require('../RetryRestClient');
+
+/**
+ * @class CustomDomainsManager
+ * Auth0 Custom Domains Manager.
+ *
+ * {@link https://auth0.com/docs/api/management/v2#!/Custom_Domains/get_custom_domains CustomDomains} represent
+ * custom domain names.
+ * You can learn more about this in the
+ * {@link https://auth0.com/docs/custom-domains CustomDomains} section of the
+ * documentation.
+ * @constructor
+ * @memberOf module:management
+ *
+ * @param {Object} options The client options.
+ * @param {String} options.baseUrl The URL of the API.
+ * @param {Object} [options.headers] Headers to be included in all requests.
+ * @param {Object} [options.retry] Retry Policy Config
+ */
+var CustomDomainsManager = function(options) {
+ if (options === null || typeof options !== 'object') {
+ throw new ArgumentError('Must provide manager options');
+ }
+
+ if (options.baseUrl === null || options.baseUrl === undefined) {
+ throw new ArgumentError('Must provide a base URL for the API');
+ }
+
+ if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
+ throw new ArgumentError('The provided base URL is invalid');
+ }
+
+ /**
+ * Options object for the Rest Client instance.
+ *
+ * @type {Object}
+ */
+ var clientOptions = {
+ errorFormatter: { message: 'message', name: 'error' },
+ headers: options.headers,
+ query: { repeatParams: false }
+ };
+
+ /**
+ * Provides an abstraction layer for consuming the
+ * {@link https://auth0.com/docs/api/v2#!/Custom_Domains Auth0 Custom Domains endpoint}.
+ *
+ * @type {external:RestClient}
+ */
+ var auth0CustomDomainsRestClient = new Auth0RestClient(
+ options.baseUrl + '/custom-domains/:id',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.resource = new RetryRestClient(auth0CustomDomainsRestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for consuming the
+ * {@link https://auth0.com/docs/api/v2#!/Custom_Domains Auth0 Custom Domains Verify endpoint}.
+ *
+ * @type {external:RestClient}
+ */
+ var auth0VerifyRestClient = new Auth0RestClient(
+ options.baseUrl + '/custom-domains/:id/verify',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.vefifyResource = new RetryRestClient(auth0VerifyRestClient, options.retry);
+};
+
+/**
+ * Create an Auth0 Custom Domain.
+ *
+ * @method create
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.create(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain created.
+ * });
+ *
+ * @param {Object} data The custom domain data object.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'create', 'resource.create');
+
+/**
+ * Get all Auth0 CustomDomains.
+ *
+ * @method getAll
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.getAll(function (err, customDomains) {
+ * console.log(customDomains.length);
+ * });
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'getAll', 'resource.getAll');
+
+/**
+ * Get a Custom Domain.
+ *
+ * @method get
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.get({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'get', 'resource.get');
+
+/**
+ * Verify a Custom Domain.
+ *
+ * @method verify
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.verify({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+CustomDomainsManager.prototype.verify = function(params, cb) {
+ if (!params || !params.id) {
+ throw new ArgumentError('The custom domain id cannot be null or undefined');
+ }
+
+ if (cb && cb instanceof Function) {
+ return this.vefifyResource.create(params, {}, cb);
+ }
+
+ return this.vefifyResource.create(params, {});
+};
+
+/**
+ * Delete a Custom Domain.
+ *
+ * @method delete
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain deleted.
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'delete', 'resource.delete');
+
+module.exports = CustomDomainsManager;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
index bcec857b3..f5dc2e012 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 0cde21107..38f961049 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -195,7 +195,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index 2a33027bc..b926f4b92 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 63848b8cc..fd969d25b 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -40,6 +40,7 @@ management/GuardianManager.js
var ArgumentError = require('rest-facade').ArgumentError;
+var utils = require('../utils');
var Auth0RestClient = require('../Auth0RestClient');
var RetryRestClient = require('../RetryRestClient');
@@ -90,6 +91,60 @@ management/GuardianManager.js
options.tokenProvider
);
this.enrollments = new RetryRestClient(guardianEnrollmentsAuth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian tickets.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianTicketsAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/enrollments/ticket',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.tickets = new RetryRestClient(guardianTicketsAuth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian factors.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorsAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/:name',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factors = new RetryRestClient(guardianFactorsAuth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian factors.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorsTemplatesAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/:name/templates',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factorsTemplates = new RetryRestClient(
+ guardianFactorsTemplatesAuth0RestClient,
+ options.retry
+ );
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian factor providers.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorsProvidersAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/:name/providers/:provider',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factorsProviders = new RetryRestClient(
+ guardianFactorsProvidersAuth0RestClient,
+ options.retry
+ );
};
/**
@@ -99,7 +154,7 @@ management/GuardianManager.js
* @memberOf module:management.GuardianManager.prototype
*
* @example
- * management.users.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ * management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
* console.log(enrollment);
* });
*
@@ -109,9 +164,7 @@ management/GuardianManager.js
*
* @return {Promise|undefined}
*/
-GuardianManager.prototype.getGuardianEnrollment = function(params, cb) {
- return this.enrollments.get(params, cb);
-};
+utils.wrapPropertyMethod(GuardianManager, 'getGuardianEnrollment', 'enrollments.get');
/**
* Delete a Guardian enrollment.
@@ -120,7 +173,7 @@ management/GuardianManager.js
* @memberOf module:management.GuardianManager.prototype
*
* @example
- * management.users.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
+ * management.guardian.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
* console.log(enrollments);
* });
*
@@ -130,9 +183,137 @@ management/GuardianManager.js
*
* @return {Promise|undefined}
*/
-GuardianManager.prototype.deleteGuardianEnrollment = function(params, cb) {
- return this.enrollments.delete(params, cb);
-};
+utils.wrapPropertyMethod(GuardianManager, 'deleteGuardianEnrollment', 'enrollments.delete');
+
+/**
+ * Create a Guardian enrollment ticket.
+ *
+ * @method createEnrollmentTicket
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.guardian.createEnrollmentTicket(function (err, ticket) {
+ * console.log(ticket);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'createEnrollmentTicket', 'tickets.create');
+
+/**
+ * Get a list of factors and statuses.
+ *
+ * @method getFactors
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.getFactors(function (err, factors) {
+ * console.log(factors.length);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'getFactors', 'factors.getAll');
+
+/**
+ * Get Guardian factor provider configuration
+ *
+ * @method getFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'getFactorProvider', 'factorsProviders.get');
+
+/**
+ * Update Guardian's factor provider
+ *
+ * @method updateFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.updateFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ * messaging_service_sid: 'XXXXXXXXXXXXXX',
+ * auth_token: 'XXXXXXXXXXXXXX',
+ * sid: 'XXXXXXXXXXXXXX'
+ * }, function(err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Object} data Updated Factor provider data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'updateFactorProvider', 'factorsProviders.update');
+
+/**
+ * Get Guardian enrollment and verification factor templates
+ *
+ * @method getFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.getFactorTemplates({ name: 'sms' }, function (err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'getFactorTemplates', 'factorsTemplates.get');
+
+/**
+ * Update Guardian enrollment and verification factor templates
+ *
+ * @method updateFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.updateFactorProvider({ name: 'sms' }, {
+ * enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ * verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+ * }, function(err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor templates data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'updateFactorTemplates', 'factorsTemplates.update');
+
+/**
+ * Update Guardian Factor
+ *
+ * @method updateFactor
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.updateFactor({ name: 'sms' }, {
+ * enabled: true
+ * }, function(err, factor) {
+ * console.log(factor);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'updateFactor', 'factors.update');
module.exports = GuardianManager;
@@ -147,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 7bb900673..0b1a0388d 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -150,7 +150,9 @@ management/JobsManager.js
* @example
* var params = {
* connection_id: '{CONNECTION_ID}',
- * users: '{PATH_TO_USERS_FILE}'
+ * users: '{PATH_TO_USERS_FILE}',
+ * upsert: true, //optional
+ * send_completion_email: false //optional
* };
*
* management.jobs.get(params, function (err) {
@@ -159,11 +161,13 @@ management/JobsManager.js
* }
* });
*
- * @param {Object} data Users import data.
- * @param {String} data.connectionId Connection for the users insertion.
- * @param {String} data.users Path to the users data file.
- * @param {String} data.users_json JSON data for the users.
- * @param {Function} [cb] Callback function.
+ * @param {Object} data Users import data.
+ * @param {String} data.connectionId Connection for the users insertion.
+ * @param {String} data.users Path to the users data file.
+ * @param {String} data.users_json JSON data for the users.
+ * @param {String} data.upsert OPTIONAL: set to true to upsert users, defaults to false
+ * @param {String} data.send_completion_email OPTIONAL: defaults to true
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -175,6 +179,8 @@ management/JobsManager.js
var url = options.baseUrl + '/jobs/users-imports';
var method = 'POST';
+ var upsert = data.upsert === true ? 'true' : 'false';
+ var send_completion_email = data.send_completion_email === false ? 'false' : 'true';
var promise = options.tokenProvider.getAccessToken().then(function(access_token) {
return new Promise(function(resolve, reject) {
@@ -192,7 +198,9 @@ management/JobsManager.js
filename: data.users_json ? 'users.json' : data.users
}
},
- connection_id: data.connection_id
+ connection_id: data.connection_id,
+ upsert: upsert,
+ send_completion_email: send_completion_email
}
},
function(err, res) {
@@ -235,8 +243,7 @@ management/JobsManager.js
*
* @example
* var params = {
- * user_id: '{USER_ID}',
- * client_id: '{CLIENT_ID}'
+ * user_id: '{USER_ID}'
* };
*
* management.jobs.verifyEmail(function (err) {
@@ -247,7 +254,6 @@ management/JobsManager.js
*
* @param {Object} data User data object.
* @param {String} data.user_id ID of the user to be verified.
- * @param {String} data.client_id ID of the client for which the verification email will be sent.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
@@ -278,7 +284,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index acd346b4a..6c9f5b9ea 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 86d417de4..2b5b18db8 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 033845b8d..3cfaa5da4 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 0f35dfe3a..18de21ac5 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 9147e75af..8f51c048f 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 cf104f111..aff6e68c8 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 13431f806..2a14fe60a 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 26757c795..ce0b83bb6 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 21432f9f9..76adaeaa4 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -427,6 +427,8 @@ management/UsersManager.js
* @param {Function} [cb] Callback function
*
* @return {Promise|undefined}
+ *
+ * @deprecated This method will be removed in the next major release.
*/
UsersManager.prototype.deleteAll = function(cb) {
if (typeof cb !== 'function') {
@@ -675,7 +677,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index c447dff70..9e4daa584 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -68,6 +68,7 @@ management/index.js
var RulesConfigsManager = require('./RulesConfigsManager');
var EmailTemplatesManager = require('./EmailTemplatesManager');
var GuardianManager = require('./GuardianManager');
+var CustomDomainsManager = require('./CustomDomainsManager');
var BASE_URL_FORMAT = 'https://%s/api/v2';
var MANAGEMENT_API_AUD_FORMAT = 'https://%s/api/v2/';
@@ -205,6 +206,14 @@ management/index.js
*/
this.guardian = new GuardianManager(managerOptions);
+ /**
+ * Simple abstraction for performing CRUD operations on the
+ * custom domains endpoint.
+ *
+ * @type {CustomDomainsManager}
+ */
+ this.customDomains = new CustomDomainsManager(managerOptions);
+
/**
* Simple abstraction for performing CRUD operations on the
* connections endpoint.
@@ -901,6 +910,7 @@ management/index.js
*
* // Pagination settings.
* var params = {
+ * search_engine: 'v3',
* per_page: 10,
* page: 0
* };
@@ -909,10 +919,11 @@ management/index.js
* console.log(users.length);
* });
*
- * @param {Object} [params] Users params.
- * @param {Number} [params.per_page] Number of results per page.
- * @param {Number} [params.page] Page number, zero indexed.
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Users params.
+ * @param {Number} [params.search_engine] The version of the search engine to use.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -977,6 +988,8 @@ management/index.js
* @param {Function} [cb] Callback function
*
* @return {Promise|undefined}
+ *
+ * @deprecated This method will be removed in the next major release.
*/
utils.wrapPropertyMethod(ManagementClient, 'deleteAllUsers', 'users.deleteAll');
@@ -1966,6 +1979,261 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'deleteRulesConfig', 'rulesConfigs.delete');
+/**
+ * Create an Auth0 Custom Domain.
+ *
+ * @method create
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.createCustomDomain(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain created.
+ * });
+ *
+ * @param {Object} data The custom domain data object.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'createCustomDomain', 'customDomains.create');
+
+/**
+ * Get all Auth0 CustomDomains.
+ *
+ * @method getAll
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.getCustomDomains(function (err, customDomains) {
+ * console.log(customDomains.length);
+ * });
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getCustomDomains', 'customDomains.getAll');
+
+/**
+ * Get a Custom Domain.
+ *
+ * @method get
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getCustomDomain', 'customDomains.get');
+
+/**
+ * Verify a Custom Domain.
+ *
+ * @method verify
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'verifyCustomDomain', 'customDomains.verify');
+
+/**
+ * Delete a Custom Domain.
+ *
+ * @method delete
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain deleted.
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'deleteCustomDomain', 'customDomains.delete');
+
+/**
+ * Create a Guardian enrollment ticket.
+ *
+ * @method createGuardianEnrollmentTicket
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.createGuardianEnrollmentTicket(function (err, ticket) {
+ * console.log(ticket);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'createGuardianEnrollmentTicket',
+ 'guardian.tickets.create'
+);
+
+/**
+ * Get a list of Guardian factors and statuses.
+ *
+ * @method getGuardianFactors
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.getGuardianFactors(function (err, factors) {
+ * console.log(factors.length);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getGuardianFactors', 'guardian.factors.getAll');
+
+/**
+ * Get Guardian factor provider configuration
+ *
+ * @method getGuardianFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'getGuardianFactorProvider',
+ 'guardian.factorsProviders.get'
+);
+
+/**
+ * Update Guardian's factor provider
+ *
+ * @method updateFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ * messaging_service_sid: 'XXXXXXXXXXXXXX',
+ * auth_token: 'XXXXXXXXXXXXXX',
+ * sid: 'XXXXXXXXXXXXXX'
+ * }, function(err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Object} data Updated Factor provider data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'updateGuardianFactorProvider',
+ 'guardian.factorsProviders.update'
+);
+
+/**
+ * Get Guardian enrollment and verification factor templates
+ *
+ * @method getGuardianFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'getGuardianFactorTemplates',
+ 'guardian.factorsTemplates.get'
+);
+
+/**
+ * Update Guardian enrollment and verification factor templates
+ *
+ * @method updateGuardianFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.updateGuardianFactorTemplates({ name: 'sms' }, {
+ * enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ * verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+ * }, function(err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor templates data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'updateGuardianFactorTemplates',
+ 'guardian.factorsTemplates.update'
+);
+
+/**
+ * Update Guardian Factor
+ *
+ * @method updateGuardianFactor
+ * @memberOf module.GuardianManager.prototype
+ *
+ * management.updateGuardianFactor({ name: 'sms' }, {
+ * enabled: true
+ * }, function(err, factor) {
+ * console.log(factor);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'updateGuardianFactor', 'guardian.factors.update');
module.exports = ManagementClient;
@@ -1980,7 +2248,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 014ddfaf8..fb612176b 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -164,8 +164,7 @@ Parameters:
- Options for the Authentication Client
- SDK.
+ Options for the Authentication Client SDK.
@@ -296,6 +295,42 @@ Parameters:
+
+
+
+ supportedAlgorithms
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Algorithms that your application expects to receive
+
+
+
+
+
@@ -401,7 +436,7 @@ databaseSource:
oauthSource:
passwordl
Source:
tokensSource:
usersSource:
changeP
Source:
Source:
getClien
Source:
get
Source:
getProfile<
Source:
password
Source:
Example
+
+
+
+
+ refreshToken(userData) → {Promise|undefined}
+
+
+
+
+
+
+ Sign in using a refresh token
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ auth/index.js, line 546
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ userData
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ User credentials object.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ refresh_token
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Refresh token.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+
+ Given a refresh token from a previous authentication request,
+ it will return a JSON with the access_token and id_token.
+ More information in the
+
+ API Docs
+ .
+
+
+ var data = {
+ client_id: '{CLIENT_ID}', // Optional field.
+ refresh_token: '{REFRESH_TOKEN}',
+};
+
+auth0.refreshToken(data, function (err, userData) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(userData);
+});
+
+
+
+
+
+
@@ -2274,7 +2546,7 @@ Source:
reque
Source:
reque
Source:
request
Source:
verifySM
Source:
Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index e6e64005d..b7b29e7b2 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
new file mode 100644
index 000000000..8697b3777
--- /dev/null
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -0,0 +1,423 @@
+
+
+
+
+
+ OAUthWithIDTokenValidation - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ OAUthWithIDTokenValidation
+
+
+
+
+
+
+
+
+
+
+
+
+ auth.
+
+ OAUthWithIDTokenValidation
+
+
+ Abstracts the oauth.create method with additional id_token validation
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new OAUthWithIDTokenValidation(oauth, options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ oauth
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ An instance of @type {OAuthAuthenticator}
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Authenticator options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ domain
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ AuthenticationClient server domain
+
+
+
+
+
+
+
+
+ clientId
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Default client ID.
+
+
+
+
+
+
+
+
+ clientSecret
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Default client Secret.
+
+
+
+
+
+
+
+
+ supportedAlgorithms
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Algorithms that your application expects to receive
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 03d92e15c..1a653544b 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -102,7 +102,7 @@ new
Source:
Parameters:
- The auth0 account URL.
+ The Auth0 account URL.
+
+
+
+
+
+
+
+
+ domain
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ AuthenticationClient server domain
@@ -382,7 +416,7 @@ (inner) Source:
Source:
password
Source:
Example
+
+
+
+
+ refreshToken(userData) → {Promise|undefined}
+
+
+
+
+
+
+ Sign in using a refresh token
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ userData
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ User credentials object.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ refresh_token
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Refresh token.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+
+ Given a refresh token from a previous authentication request
+ it will return a JSON with the access_token and id_token.
+ More information in the
+
+ API Docs
+ .
+
+
+ var data = {
+ client_id: '{CLIENT_ID}', // Optional field.
+ refresh_token: '{REFRESH_TOKEN}',
+};
+
+auth0.oauth.refreshToken(data, function (err, userData) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(userData);
+});
+
+
+
+
+
+
@@ -1028,7 +1299,7 @@ signInSource:
socialSig
Source:
Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 155cb2a41..e81cdc6c4 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 1e0e59400..97a1daf27 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 f5980491e..1b625dd20 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 787e4940d..249e89209 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -71,6 +71,9 @@ Classes
OAuthAuthenticator
+ OAUthWithIDTokenValidation
+
+
PasswordlessAuthenticator
@@ -105,7 +108,7 @@ Classes
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 2b1f79ecf..0451d5674 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 15b7dbdb0..dee679a9a 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -542,7 +542,7 @@ createSource:
createSource:
deleteSource:
deleteSource:
getAllSource:
updateSource:
updateSource:
Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 4231ee760..02612947b 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 25998797b..7ebfbcc77 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
new file mode 100644
index 000000000..6c4def656
--- /dev/null
+++ b/docs/module-management.CustomDomainsManager.html
@@ -0,0 +1,2881 @@
+
+
+
+
+
+ CustomDomainsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CustomDomainsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ CustomDomainsManager
+
+
+ CustomDomainsManager
+Auth0 Custom Domains Manager.
+CustomDomains represent
+custom domain names.
+You can learn more about this in the
+CustomDomains section of the
+documentation.
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new CustomDomainsManager(options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The client options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ baseUrl
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The URL of the API.
+
+
+
+
+
+
+
+
+ headers
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Headers to be included in all requests.
+
+
+
+
+
+
+
+
+ retry
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Retry Policy Config
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+
+(inner) auth0CustomDomainsRestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the
+Auth0 Custom Domains endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) auth0VerifyRestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the
+Auth0 Custom Domains Verify endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) clientOptions :Object
+
+
+
+
+
+ Options object for the Rest Client instance.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ 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.customDomains.create(data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // CustomDomain created.
+});
+
+
+
+
+
+
+
+
+
+
+ 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.
+});
+
+
+
+
+
+
+
+
+
+
+ delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete 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.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // CustomDomain deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete 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.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // CustomDomain deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ 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.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.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(customDomain);
+});
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.customDomains.verify({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(customDomain);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index 2f00bdd12..01d6666b7 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 e442cb9b8..52441ed0a 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1345,7 +1345,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index 79da62aec..2495916b4 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 9b8b1f648..eff768fda 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -101,7 +101,7 @@ new Gu
Source:
Source:
Type:
+
+
+(inner) guardianFactorsAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian factors.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorsProvidersAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian factor providers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorsTemplatesAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian factors.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianTicketsAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian tickets.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ createEnrollmentTicket(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.guardian.createEnrollmentTicket(function (err, ticket) {
+ console.log(ticket);
+});
+
+
+
+
+
+
+
+
+ createGuardianEnrollmentTicket(cbopt) → {Promise|undefined}
+
- Methods
+
+
+
+ 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);
+});
+
+
+
+
@@ -465,7 +1121,7 @@ Source:
Returns:
Example
- management.users.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
+ management.guardian.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
console.log(enrollments);
});
@@ -730,7 +1386,7 @@
Source:
Returns:
Example
- management.users.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
console.log(enrollment);
});
@@ -964,7 +1620,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 873b2b1e7..a17cf8ff0 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -914,6 +914,58 @@ Parameters:
+
+
+
+ upsert
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ OPTIONAL: set to true to upsert users, defaults to false
+
+
+
+
+
+
+
+
+ send_completion_email
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ OPTIONAL: defaults to true
+
+
+
+
+
@@ -1005,7 +1057,9 @@ Example
var params = {
connection_id: '{CONNECTION_ID}',
- users: '{PATH_TO_USERS_FILE}'
+ users: '{PATH_TO_USERS_FILE}',
+ upsert: true, //optional
+ send_completion_email: false //optional
};
management.jobs.get(params, function (err) {
@@ -1066,7 +1120,7 @@ verifyEmai
Source:
Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index e7910f961..a476b9d52 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 96222b15e..bc804d928 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -106,7 +106,7 @@ new M
Source:
blac
Source:
clientGra
Source:
clientsSource:
connection
Source:
Type:
+
+
+
+
+
+customDomains :CustomDomainsManager
+
+
+
+
+
+ Simple abstraction for performing CRUD operations on the
+custom domains endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
CustomDomainsManager
+
+
+
+
+
+
+
+
+
@@ -1023,7 +1098,7 @@ devi
Source:
emailPro
Source:
emailTe
Source:
guardianSource:
jobsSource:
logsSource:
resour
Source:
rulesSource:
rulesConf
Source:
statsSource:
tenantSource:
ticketsSource:
usersSource:
blackli
Source:
Source:
createCli
Source:
creat
Source:
Source:
Source:
Source:
c
Source:
createRule<
Source:
createUser<
Source:
deleteA
+ Deprecated: - This method will be removed in the next major release.
deleteA
Source:
deleteCli
Source:
delet
Source:
Source:
de
Source:
Source:
d
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
ge
Source:
g
Source:
getClientSource:
getClien
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getDaily
Source:
g
Source:
getEm
Source:
Source:
Source:
getJobSource:
getLogSource:
getLogsSource:
getR
Source:
get
Source:
getRuleSource:
getRulesSource:
getRul
Source:
getT
Source:
getUserSource:
getUserLog
Source:
getUsersSource:
Parameters:
+
+
+ search_engine
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The version of the search engine to use.
+
+
+
+
+
+
per_pageExample
// Pagination settings.
var params = {
+ search_engine: 'v3',
per_page: 10,
page: 0
};
@@ -13684,7 +13798,7 @@ getUse
Source:
importUser
Source:
linkUsersSource:
Source:
Source:
setRule
Source:
unlinkUser
Source:
upda
Source:
updateCli
Source:
updat
Source:
up
Source:
u
Source:
updateRule<
Source:
u
Source:
updateUser<
Source:
upd
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 1a7af1fa7..98a360c74 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 653f75118..0c021904e 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 7881b3014..482cb0539 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 e91728514..4a371256c 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 5f007b36b..c81f2d396 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 b9d45cecb..d73bbea41 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 f0decde8e..527516334 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 ea4aecf75..6cc15b131 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 d8f02b7a6..4a29c2bcb 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -1311,6 +1311,8 @@ deleteAllDeprecated:- This method will be removed in the next major release.
Source:
Source:
linkSource:
logsSource:
Source:
unlinkSource:
Example
diff --git a/docs/module-management.html b/docs/module-management.html
index ef43ed70b..24524f386 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -74,6 +74,9 @@ Classes
ConnectionsManager
+ CustomDomainsManager
+
+
DeviceCredentialsManager
@@ -147,7 +150,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 806e78741..c703086b0 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 e91aaff38..e1092abfd 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 620c47daa..b91a85153 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.13.0",
+ "version": "2.14.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": ["src"],
Source:
Source:
diff --git a/docs/index.html b/docs/index.html
index b31885fe4..284900d46 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 afb9fd421..1c8d473a0 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 1af25e4de..48fdcb021 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 635bbd2c2..02d124357 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 36d5e9f99..ee848a5a2 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 e72316139..15c95b0b1 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
new file mode 100644
index 000000000..09e419d59
--- /dev/null
+++ b/docs/management_CustomDomainsManager.js.html
@@ -0,0 +1,250 @@
+
+
+
+
+
+ management/CustomDomainsManager.js - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ management/CustomDomainsManager.js
+
+
+
+
+
+
+
+
+
+ var ArgumentError = require('rest-facade').ArgumentError;
+var utils = require('../utils');
+var Auth0RestClient = require('../Auth0RestClient');
+var RetryRestClient = require('../RetryRestClient');
+
+/**
+ * @class CustomDomainsManager
+ * Auth0 Custom Domains Manager.
+ *
+ * {@link https://auth0.com/docs/api/management/v2#!/Custom_Domains/get_custom_domains CustomDomains} represent
+ * custom domain names.
+ * You can learn more about this in the
+ * {@link https://auth0.com/docs/custom-domains CustomDomains} section of the
+ * documentation.
+ * @constructor
+ * @memberOf module:management
+ *
+ * @param {Object} options The client options.
+ * @param {String} options.baseUrl The URL of the API.
+ * @param {Object} [options.headers] Headers to be included in all requests.
+ * @param {Object} [options.retry] Retry Policy Config
+ */
+var CustomDomainsManager = function(options) {
+ if (options === null || typeof options !== 'object') {
+ throw new ArgumentError('Must provide manager options');
+ }
+
+ if (options.baseUrl === null || options.baseUrl === undefined) {
+ throw new ArgumentError('Must provide a base URL for the API');
+ }
+
+ if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
+ throw new ArgumentError('The provided base URL is invalid');
+ }
+
+ /**
+ * Options object for the Rest Client instance.
+ *
+ * @type {Object}
+ */
+ var clientOptions = {
+ errorFormatter: { message: 'message', name: 'error' },
+ headers: options.headers,
+ query: { repeatParams: false }
+ };
+
+ /**
+ * Provides an abstraction layer for consuming the
+ * {@link https://auth0.com/docs/api/v2#!/Custom_Domains Auth0 Custom Domains endpoint}.
+ *
+ * @type {external:RestClient}
+ */
+ var auth0CustomDomainsRestClient = new Auth0RestClient(
+ options.baseUrl + '/custom-domains/:id',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.resource = new RetryRestClient(auth0CustomDomainsRestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for consuming the
+ * {@link https://auth0.com/docs/api/v2#!/Custom_Domains Auth0 Custom Domains Verify endpoint}.
+ *
+ * @type {external:RestClient}
+ */
+ var auth0VerifyRestClient = new Auth0RestClient(
+ options.baseUrl + '/custom-domains/:id/verify',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.vefifyResource = new RetryRestClient(auth0VerifyRestClient, options.retry);
+};
+
+/**
+ * Create an Auth0 Custom Domain.
+ *
+ * @method create
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.create(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain created.
+ * });
+ *
+ * @param {Object} data The custom domain data object.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'create', 'resource.create');
+
+/**
+ * Get all Auth0 CustomDomains.
+ *
+ * @method getAll
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.getAll(function (err, customDomains) {
+ * console.log(customDomains.length);
+ * });
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'getAll', 'resource.getAll');
+
+/**
+ * Get a Custom Domain.
+ *
+ * @method get
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.get({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'get', 'resource.get');
+
+/**
+ * Verify a Custom Domain.
+ *
+ * @method verify
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.verify({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+CustomDomainsManager.prototype.verify = function(params, cb) {
+ if (!params || !params.id) {
+ throw new ArgumentError('The custom domain id cannot be null or undefined');
+ }
+
+ if (cb && cb instanceof Function) {
+ return this.vefifyResource.create(params, {}, cb);
+ }
+
+ return this.vefifyResource.create(params, {});
+};
+
+/**
+ * Delete a Custom Domain.
+ *
+ * @method delete
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain deleted.
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'delete', 'resource.delete');
+
+module.exports = CustomDomainsManager;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
index bcec857b3..f5dc2e012 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 0cde21107..38f961049 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -195,7 +195,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index 2a33027bc..b926f4b92 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 63848b8cc..fd969d25b 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -40,6 +40,7 @@ management/GuardianManager.js
var ArgumentError = require('rest-facade').ArgumentError;
+var utils = require('../utils');
var Auth0RestClient = require('../Auth0RestClient');
var RetryRestClient = require('../RetryRestClient');
@@ -90,6 +91,60 @@ management/GuardianManager.js
options.tokenProvider
);
this.enrollments = new RetryRestClient(guardianEnrollmentsAuth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian tickets.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianTicketsAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/enrollments/ticket',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.tickets = new RetryRestClient(guardianTicketsAuth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian factors.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorsAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/:name',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factors = new RetryRestClient(guardianFactorsAuth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian factors.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorsTemplatesAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/:name/templates',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factorsTemplates = new RetryRestClient(
+ guardianFactorsTemplatesAuth0RestClient,
+ options.retry
+ );
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian factor providers.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorsProvidersAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/:name/providers/:provider',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factorsProviders = new RetryRestClient(
+ guardianFactorsProvidersAuth0RestClient,
+ options.retry
+ );
};
/**
@@ -99,7 +154,7 @@ management/GuardianManager.js
* @memberOf module:management.GuardianManager.prototype
*
* @example
- * management.users.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ * management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
* console.log(enrollment);
* });
*
@@ -109,9 +164,7 @@ management/GuardianManager.js
*
* @return {Promise|undefined}
*/
-GuardianManager.prototype.getGuardianEnrollment = function(params, cb) {
- return this.enrollments.get(params, cb);
-};
+utils.wrapPropertyMethod(GuardianManager, 'getGuardianEnrollment', 'enrollments.get');
/**
* Delete a Guardian enrollment.
@@ -120,7 +173,7 @@ management/GuardianManager.js
* @memberOf module:management.GuardianManager.prototype
*
* @example
- * management.users.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
+ * management.guardian.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
* console.log(enrollments);
* });
*
@@ -130,9 +183,137 @@ management/GuardianManager.js
*
* @return {Promise|undefined}
*/
-GuardianManager.prototype.deleteGuardianEnrollment = function(params, cb) {
- return this.enrollments.delete(params, cb);
-};
+utils.wrapPropertyMethod(GuardianManager, 'deleteGuardianEnrollment', 'enrollments.delete');
+
+/**
+ * Create a Guardian enrollment ticket.
+ *
+ * @method createEnrollmentTicket
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.guardian.createEnrollmentTicket(function (err, ticket) {
+ * console.log(ticket);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'createEnrollmentTicket', 'tickets.create');
+
+/**
+ * Get a list of factors and statuses.
+ *
+ * @method getFactors
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.getFactors(function (err, factors) {
+ * console.log(factors.length);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'getFactors', 'factors.getAll');
+
+/**
+ * Get Guardian factor provider configuration
+ *
+ * @method getFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'getFactorProvider', 'factorsProviders.get');
+
+/**
+ * Update Guardian's factor provider
+ *
+ * @method updateFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.updateFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ * messaging_service_sid: 'XXXXXXXXXXXXXX',
+ * auth_token: 'XXXXXXXXXXXXXX',
+ * sid: 'XXXXXXXXXXXXXX'
+ * }, function(err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Object} data Updated Factor provider data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'updateFactorProvider', 'factorsProviders.update');
+
+/**
+ * Get Guardian enrollment and verification factor templates
+ *
+ * @method getFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.getFactorTemplates({ name: 'sms' }, function (err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'getFactorTemplates', 'factorsTemplates.get');
+
+/**
+ * Update Guardian enrollment and verification factor templates
+ *
+ * @method updateFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.updateFactorProvider({ name: 'sms' }, {
+ * enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ * verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+ * }, function(err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor templates data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'updateFactorTemplates', 'factorsTemplates.update');
+
+/**
+ * Update Guardian Factor
+ *
+ * @method updateFactor
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.updateFactor({ name: 'sms' }, {
+ * enabled: true
+ * }, function(err, factor) {
+ * console.log(factor);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'updateFactor', 'factors.update');
module.exports = GuardianManager;
@@ -147,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 7bb900673..0b1a0388d 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -150,7 +150,9 @@ management/JobsManager.js
* @example
* var params = {
* connection_id: '{CONNECTION_ID}',
- * users: '{PATH_TO_USERS_FILE}'
+ * users: '{PATH_TO_USERS_FILE}',
+ * upsert: true, //optional
+ * send_completion_email: false //optional
* };
*
* management.jobs.get(params, function (err) {
@@ -159,11 +161,13 @@ management/JobsManager.js
* }
* });
*
- * @param {Object} data Users import data.
- * @param {String} data.connectionId Connection for the users insertion.
- * @param {String} data.users Path to the users data file.
- * @param {String} data.users_json JSON data for the users.
- * @param {Function} [cb] Callback function.
+ * @param {Object} data Users import data.
+ * @param {String} data.connectionId Connection for the users insertion.
+ * @param {String} data.users Path to the users data file.
+ * @param {String} data.users_json JSON data for the users.
+ * @param {String} data.upsert OPTIONAL: set to true to upsert users, defaults to false
+ * @param {String} data.send_completion_email OPTIONAL: defaults to true
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -175,6 +179,8 @@ management/JobsManager.js
var url = options.baseUrl + '/jobs/users-imports';
var method = 'POST';
+ var upsert = data.upsert === true ? 'true' : 'false';
+ var send_completion_email = data.send_completion_email === false ? 'false' : 'true';
var promise = options.tokenProvider.getAccessToken().then(function(access_token) {
return new Promise(function(resolve, reject) {
@@ -192,7 +198,9 @@ management/JobsManager.js
filename: data.users_json ? 'users.json' : data.users
}
},
- connection_id: data.connection_id
+ connection_id: data.connection_id,
+ upsert: upsert,
+ send_completion_email: send_completion_email
}
},
function(err, res) {
@@ -235,8 +243,7 @@ management/JobsManager.js
*
* @example
* var params = {
- * user_id: '{USER_ID}',
- * client_id: '{CLIENT_ID}'
+ * user_id: '{USER_ID}'
* };
*
* management.jobs.verifyEmail(function (err) {
@@ -247,7 +254,6 @@ management/JobsManager.js
*
* @param {Object} data User data object.
* @param {String} data.user_id ID of the user to be verified.
- * @param {String} data.client_id ID of the client for which the verification email will be sent.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
@@ -278,7 +284,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index acd346b4a..6c9f5b9ea 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 86d417de4..2b5b18db8 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 033845b8d..3cfaa5da4 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 0f35dfe3a..18de21ac5 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 9147e75af..8f51c048f 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 cf104f111..aff6e68c8 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 13431f806..2a14fe60a 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 26757c795..ce0b83bb6 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 21432f9f9..76adaeaa4 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -427,6 +427,8 @@ management/UsersManager.js
* @param {Function} [cb] Callback function
*
* @return {Promise|undefined}
+ *
+ * @deprecated This method will be removed in the next major release.
*/
UsersManager.prototype.deleteAll = function(cb) {
if (typeof cb !== 'function') {
@@ -675,7 +677,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index c447dff70..9e4daa584 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -68,6 +68,7 @@ management/index.js
var RulesConfigsManager = require('./RulesConfigsManager');
var EmailTemplatesManager = require('./EmailTemplatesManager');
var GuardianManager = require('./GuardianManager');
+var CustomDomainsManager = require('./CustomDomainsManager');
var BASE_URL_FORMAT = 'https://%s/api/v2';
var MANAGEMENT_API_AUD_FORMAT = 'https://%s/api/v2/';
@@ -205,6 +206,14 @@ management/index.js
*/
this.guardian = new GuardianManager(managerOptions);
+ /**
+ * Simple abstraction for performing CRUD operations on the
+ * custom domains endpoint.
+ *
+ * @type {CustomDomainsManager}
+ */
+ this.customDomains = new CustomDomainsManager(managerOptions);
+
/**
* Simple abstraction for performing CRUD operations on the
* connections endpoint.
@@ -901,6 +910,7 @@ management/index.js
*
* // Pagination settings.
* var params = {
+ * search_engine: 'v3',
* per_page: 10,
* page: 0
* };
@@ -909,10 +919,11 @@ management/index.js
* console.log(users.length);
* });
*
- * @param {Object} [params] Users params.
- * @param {Number} [params.per_page] Number of results per page.
- * @param {Number} [params.page] Page number, zero indexed.
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Users params.
+ * @param {Number} [params.search_engine] The version of the search engine to use.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -977,6 +988,8 @@ management/index.js
* @param {Function} [cb] Callback function
*
* @return {Promise|undefined}
+ *
+ * @deprecated This method will be removed in the next major release.
*/
utils.wrapPropertyMethod(ManagementClient, 'deleteAllUsers', 'users.deleteAll');
@@ -1966,6 +1979,261 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'deleteRulesConfig', 'rulesConfigs.delete');
+/**
+ * Create an Auth0 Custom Domain.
+ *
+ * @method create
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.createCustomDomain(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain created.
+ * });
+ *
+ * @param {Object} data The custom domain data object.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'createCustomDomain', 'customDomains.create');
+
+/**
+ * Get all Auth0 CustomDomains.
+ *
+ * @method getAll
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.getCustomDomains(function (err, customDomains) {
+ * console.log(customDomains.length);
+ * });
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getCustomDomains', 'customDomains.getAll');
+
+/**
+ * Get a Custom Domain.
+ *
+ * @method get
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getCustomDomain', 'customDomains.get');
+
+/**
+ * Verify a Custom Domain.
+ *
+ * @method verify
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'verifyCustomDomain', 'customDomains.verify');
+
+/**
+ * Delete a Custom Domain.
+ *
+ * @method delete
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain deleted.
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'deleteCustomDomain', 'customDomains.delete');
+
+/**
+ * Create a Guardian enrollment ticket.
+ *
+ * @method createGuardianEnrollmentTicket
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.createGuardianEnrollmentTicket(function (err, ticket) {
+ * console.log(ticket);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'createGuardianEnrollmentTicket',
+ 'guardian.tickets.create'
+);
+
+/**
+ * Get a list of Guardian factors and statuses.
+ *
+ * @method getGuardianFactors
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.getGuardianFactors(function (err, factors) {
+ * console.log(factors.length);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getGuardianFactors', 'guardian.factors.getAll');
+
+/**
+ * Get Guardian factor provider configuration
+ *
+ * @method getGuardianFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'getGuardianFactorProvider',
+ 'guardian.factorsProviders.get'
+);
+
+/**
+ * Update Guardian's factor provider
+ *
+ * @method updateFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ * messaging_service_sid: 'XXXXXXXXXXXXXX',
+ * auth_token: 'XXXXXXXXXXXXXX',
+ * sid: 'XXXXXXXXXXXXXX'
+ * }, function(err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Object} data Updated Factor provider data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'updateGuardianFactorProvider',
+ 'guardian.factorsProviders.update'
+);
+
+/**
+ * Get Guardian enrollment and verification factor templates
+ *
+ * @method getGuardianFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'getGuardianFactorTemplates',
+ 'guardian.factorsTemplates.get'
+);
+
+/**
+ * Update Guardian enrollment and verification factor templates
+ *
+ * @method updateGuardianFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.updateGuardianFactorTemplates({ name: 'sms' }, {
+ * enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ * verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+ * }, function(err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor templates data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'updateGuardianFactorTemplates',
+ 'guardian.factorsTemplates.update'
+);
+
+/**
+ * Update Guardian Factor
+ *
+ * @method updateGuardianFactor
+ * @memberOf module.GuardianManager.prototype
+ *
+ * management.updateGuardianFactor({ name: 'sms' }, {
+ * enabled: true
+ * }, function(err, factor) {
+ * console.log(factor);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'updateGuardianFactor', 'guardian.factors.update');
module.exports = ManagementClient;
@@ -1980,7 +2248,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 014ddfaf8..fb612176b 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -164,8 +164,7 @@ Parameters:
- Options for the Authentication Client
- SDK.
+ Options for the Authentication Client SDK.
@@ -296,6 +295,42 @@ Parameters:
+
+
+
+ supportedAlgorithms
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Algorithms that your application expects to receive
+
+
+
+
+
@@ -401,7 +436,7 @@ databaseSource:
oauthSource:
passwordl
Source:
tokensSource:
usersSource:
changeP
Source:
Source:
getClien
Source:
get
Source:
getProfile<
Source:
password
Source:
Example
+
+
+
+
+ refreshToken(userData) → {Promise|undefined}
+
+
+
+
+
+
+ Sign in using a refresh token
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ auth/index.js, line 546
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ userData
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ User credentials object.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ refresh_token
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Refresh token.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+
+ Given a refresh token from a previous authentication request,
+ it will return a JSON with the access_token and id_token.
+ More information in the
+
+ API Docs
+ .
+
+
+ var data = {
+ client_id: '{CLIENT_ID}', // Optional field.
+ refresh_token: '{REFRESH_TOKEN}',
+};
+
+auth0.refreshToken(data, function (err, userData) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(userData);
+});
+
+
+
+
+
+
@@ -2274,7 +2546,7 @@ Source:
reque
Source:
reque
Source:
request
Source:
verifySM
Source:
Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index e6e64005d..b7b29e7b2 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
new file mode 100644
index 000000000..8697b3777
--- /dev/null
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -0,0 +1,423 @@
+
+
+
+
+
+ OAUthWithIDTokenValidation - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ OAUthWithIDTokenValidation
+
+
+
+
+
+
+
+
+
+
+
+
+ auth.
+
+ OAUthWithIDTokenValidation
+
+
+ Abstracts the oauth.create method with additional id_token validation
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new OAUthWithIDTokenValidation(oauth, options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ oauth
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ An instance of @type {OAuthAuthenticator}
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Authenticator options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ domain
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ AuthenticationClient server domain
+
+
+
+
+
+
+
+
+ clientId
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Default client ID.
+
+
+
+
+
+
+
+
+ clientSecret
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Default client Secret.
+
+
+
+
+
+
+
+
+ supportedAlgorithms
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Algorithms that your application expects to receive
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 03d92e15c..1a653544b 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -102,7 +102,7 @@ new
Source:
Parameters:
- The auth0 account URL.
+ The Auth0 account URL.
+
+
+
+
+
+
+
+
+ domain
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ AuthenticationClient server domain
@@ -382,7 +416,7 @@ (inner) Source:
Source:
password
Source:
Example
+
+
+
+
+ refreshToken(userData) → {Promise|undefined}
+
+
+
+
+
+
+ Sign in using a refresh token
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ userData
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ User credentials object.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ refresh_token
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Refresh token.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+
+ Given a refresh token from a previous authentication request
+ it will return a JSON with the access_token and id_token.
+ More information in the
+
+ API Docs
+ .
+
+
+ var data = {
+ client_id: '{CLIENT_ID}', // Optional field.
+ refresh_token: '{REFRESH_TOKEN}',
+};
+
+auth0.oauth.refreshToken(data, function (err, userData) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(userData);
+});
+
+
+
+
+
+
@@ -1028,7 +1299,7 @@ signInSource:
socialSig
Source:
Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 155cb2a41..e81cdc6c4 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 1e0e59400..97a1daf27 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 f5980491e..1b625dd20 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 787e4940d..249e89209 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -71,6 +71,9 @@ Classes
OAuthAuthenticator
+ OAUthWithIDTokenValidation
+
+
PasswordlessAuthenticator
@@ -105,7 +108,7 @@ Classes
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 2b1f79ecf..0451d5674 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 15b7dbdb0..dee679a9a 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -542,7 +542,7 @@ createSource:
createSource:
deleteSource:
deleteSource:
getAllSource:
updateSource:
updateSource:
Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 4231ee760..02612947b 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 25998797b..7ebfbcc77 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
new file mode 100644
index 000000000..6c4def656
--- /dev/null
+++ b/docs/module-management.CustomDomainsManager.html
@@ -0,0 +1,2881 @@
+
+
+
+
+
+ CustomDomainsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CustomDomainsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ CustomDomainsManager
+
+
+ CustomDomainsManager
+Auth0 Custom Domains Manager.
+CustomDomains represent
+custom domain names.
+You can learn more about this in the
+CustomDomains section of the
+documentation.
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new CustomDomainsManager(options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The client options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ baseUrl
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The URL of the API.
+
+
+
+
+
+
+
+
+ headers
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Headers to be included in all requests.
+
+
+
+
+
+
+
+
+ retry
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Retry Policy Config
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+
+(inner) auth0CustomDomainsRestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the
+Auth0 Custom Domains endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) auth0VerifyRestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the
+Auth0 Custom Domains Verify endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) clientOptions :Object
+
+
+
+
+
+ Options object for the Rest Client instance.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ 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.customDomains.create(data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // CustomDomain created.
+});
+
+
+
+
+
+
+
+
+
+
+ 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.
+});
+
+
+
+
+
+
+
+
+
+
+ delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete 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.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // CustomDomain deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete 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.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // CustomDomain deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ 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.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.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(customDomain);
+});
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.customDomains.verify({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(customDomain);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index 2f00bdd12..01d6666b7 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 e442cb9b8..52441ed0a 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1345,7 +1345,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index 79da62aec..2495916b4 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 9b8b1f648..eff768fda 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -101,7 +101,7 @@ new Gu
Source:
Source:
Type:
+
+
+(inner) guardianFactorsAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian factors.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorsProvidersAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian factor providers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorsTemplatesAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian factors.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianTicketsAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian tickets.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ createEnrollmentTicket(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.guardian.createEnrollmentTicket(function (err, ticket) {
+ console.log(ticket);
+});
+
+
+
+
+
+
+
+
+ createGuardianEnrollmentTicket(cbopt) → {Promise|undefined}
+
- Methods
+
+
+
+ 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);
+});
+
+
+
+
@@ -465,7 +1121,7 @@ Source:
Returns:
Example
- management.users.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
+ management.guardian.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
console.log(enrollments);
});
@@ -730,7 +1386,7 @@
Source:
Returns:
Example
- management.users.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
console.log(enrollment);
});
@@ -964,7 +1620,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 873b2b1e7..a17cf8ff0 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -914,6 +914,58 @@ Parameters:
+
+
+
+ upsert
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ OPTIONAL: set to true to upsert users, defaults to false
+
+
+
+
+
+
+
+
+ send_completion_email
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ OPTIONAL: defaults to true
+
+
+
+
+
@@ -1005,7 +1057,9 @@ Example
var params = {
connection_id: '{CONNECTION_ID}',
- users: '{PATH_TO_USERS_FILE}'
+ users: '{PATH_TO_USERS_FILE}',
+ upsert: true, //optional
+ send_completion_email: false //optional
};
management.jobs.get(params, function (err) {
@@ -1066,7 +1120,7 @@ verifyEmai
Source:
Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index e7910f961..a476b9d52 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 96222b15e..bc804d928 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -106,7 +106,7 @@ new M
Source:
blac
Source:
clientGra
Source:
clientsSource:
connection
Source:
Type:
+
+
+
+
+
+customDomains :CustomDomainsManager
+
+
+
+
+
+ Simple abstraction for performing CRUD operations on the
+custom domains endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
CustomDomainsManager
+
+
+
+
+
+
+
+
+
@@ -1023,7 +1098,7 @@ devi
Source:
emailPro
Source:
emailTe
Source:
guardianSource:
jobsSource:
logsSource:
resour
Source:
rulesSource:
rulesConf
Source:
statsSource:
tenantSource:
ticketsSource:
usersSource:
blackli
Source:
Source:
createCli
Source:
creat
Source:
Source:
Source:
Source:
c
Source:
createRule<
Source:
createUser<
Source:
deleteA
+ Deprecated: - This method will be removed in the next major release.
deleteA
Source:
deleteCli
Source:
delet
Source:
Source:
de
Source:
Source:
d
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
ge
Source:
g
Source:
getClientSource:
getClien
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getDaily
Source:
g
Source:
getEm
Source:
Source:
Source:
getJobSource:
getLogSource:
getLogsSource:
getR
Source:
get
Source:
getRuleSource:
getRulesSource:
getRul
Source:
getT
Source:
getUserSource:
getUserLog
Source:
getUsersSource:
Parameters:
+
+
+ search_engine
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The version of the search engine to use.
+
+
+
+
+
+
per_pageExample
// Pagination settings.
var params = {
+ search_engine: 'v3',
per_page: 10,
page: 0
};
@@ -13684,7 +13798,7 @@ getUse
Source:
importUser
Source:
linkUsersSource:
Source:
Source:
setRule
Source:
unlinkUser
Source:
upda
Source:
updateCli
Source:
updat
Source:
up
Source:
u
Source:
updateRule<
Source:
u
Source:
updateUser<
Source:
upd
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 1a7af1fa7..98a360c74 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 653f75118..0c021904e 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 7881b3014..482cb0539 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 e91728514..4a371256c 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 5f007b36b..c81f2d396 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 b9d45cecb..d73bbea41 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 f0decde8e..527516334 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 ea4aecf75..6cc15b131 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 d8f02b7a6..4a29c2bcb 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -1311,6 +1311,8 @@ deleteAllDeprecated:- This method will be removed in the next major release.
Source:
Source:
linkSource:
logsSource:
Source:
unlinkSource:
Example
diff --git a/docs/module-management.html b/docs/module-management.html
index ef43ed70b..24524f386 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -74,6 +74,9 @@ Classes
ConnectionsManager
+ CustomDomainsManager
+
+
DeviceCredentialsManager
@@ -147,7 +150,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 806e78741..c703086b0 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 e91aaff38..e1092abfd 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 620c47daa..b91a85153 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.13.0",
+ "version": "2.14.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": ["src"],
diff --git a/docs/index.html b/docs/index.html
index b31885fe4..284900d46 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 afb9fd421..1c8d473a0 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 1af25e4de..48fdcb021 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 635bbd2c2..02d124357 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 36d5e9f99..ee848a5a2 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 e72316139..15c95b0b1 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
new file mode 100644
index 000000000..09e419d59
--- /dev/null
+++ b/docs/management_CustomDomainsManager.js.html
@@ -0,0 +1,250 @@
+
+
+
+
+
+ management/CustomDomainsManager.js - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ management/CustomDomainsManager.js
+
+
+
+
+
+
+
+
+
+ var ArgumentError = require('rest-facade').ArgumentError;
+var utils = require('../utils');
+var Auth0RestClient = require('../Auth0RestClient');
+var RetryRestClient = require('../RetryRestClient');
+
+/**
+ * @class CustomDomainsManager
+ * Auth0 Custom Domains Manager.
+ *
+ * {@link https://auth0.com/docs/api/management/v2#!/Custom_Domains/get_custom_domains CustomDomains} represent
+ * custom domain names.
+ * You can learn more about this in the
+ * {@link https://auth0.com/docs/custom-domains CustomDomains} section of the
+ * documentation.
+ * @constructor
+ * @memberOf module:management
+ *
+ * @param {Object} options The client options.
+ * @param {String} options.baseUrl The URL of the API.
+ * @param {Object} [options.headers] Headers to be included in all requests.
+ * @param {Object} [options.retry] Retry Policy Config
+ */
+var CustomDomainsManager = function(options) {
+ if (options === null || typeof options !== 'object') {
+ throw new ArgumentError('Must provide manager options');
+ }
+
+ if (options.baseUrl === null || options.baseUrl === undefined) {
+ throw new ArgumentError('Must provide a base URL for the API');
+ }
+
+ if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
+ throw new ArgumentError('The provided base URL is invalid');
+ }
+
+ /**
+ * Options object for the Rest Client instance.
+ *
+ * @type {Object}
+ */
+ var clientOptions = {
+ errorFormatter: { message: 'message', name: 'error' },
+ headers: options.headers,
+ query: { repeatParams: false }
+ };
+
+ /**
+ * Provides an abstraction layer for consuming the
+ * {@link https://auth0.com/docs/api/v2#!/Custom_Domains Auth0 Custom Domains endpoint}.
+ *
+ * @type {external:RestClient}
+ */
+ var auth0CustomDomainsRestClient = new Auth0RestClient(
+ options.baseUrl + '/custom-domains/:id',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.resource = new RetryRestClient(auth0CustomDomainsRestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for consuming the
+ * {@link https://auth0.com/docs/api/v2#!/Custom_Domains Auth0 Custom Domains Verify endpoint}.
+ *
+ * @type {external:RestClient}
+ */
+ var auth0VerifyRestClient = new Auth0RestClient(
+ options.baseUrl + '/custom-domains/:id/verify',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.vefifyResource = new RetryRestClient(auth0VerifyRestClient, options.retry);
+};
+
+/**
+ * Create an Auth0 Custom Domain.
+ *
+ * @method create
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.create(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain created.
+ * });
+ *
+ * @param {Object} data The custom domain data object.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'create', 'resource.create');
+
+/**
+ * Get all Auth0 CustomDomains.
+ *
+ * @method getAll
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.getAll(function (err, customDomains) {
+ * console.log(customDomains.length);
+ * });
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'getAll', 'resource.getAll');
+
+/**
+ * Get a Custom Domain.
+ *
+ * @method get
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.get({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'get', 'resource.get');
+
+/**
+ * Verify a Custom Domain.
+ *
+ * @method verify
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.verify({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+CustomDomainsManager.prototype.verify = function(params, cb) {
+ if (!params || !params.id) {
+ throw new ArgumentError('The custom domain id cannot be null or undefined');
+ }
+
+ if (cb && cb instanceof Function) {
+ return this.vefifyResource.create(params, {}, cb);
+ }
+
+ return this.vefifyResource.create(params, {});
+};
+
+/**
+ * Delete a Custom Domain.
+ *
+ * @method delete
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain deleted.
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'delete', 'resource.delete');
+
+module.exports = CustomDomainsManager;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
index bcec857b3..f5dc2e012 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 0cde21107..38f961049 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -195,7 +195,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index 2a33027bc..b926f4b92 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 63848b8cc..fd969d25b 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -40,6 +40,7 @@ management/GuardianManager.js
var ArgumentError = require('rest-facade').ArgumentError;
+var utils = require('../utils');
var Auth0RestClient = require('../Auth0RestClient');
var RetryRestClient = require('../RetryRestClient');
@@ -90,6 +91,60 @@ management/GuardianManager.js
options.tokenProvider
);
this.enrollments = new RetryRestClient(guardianEnrollmentsAuth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian tickets.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianTicketsAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/enrollments/ticket',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.tickets = new RetryRestClient(guardianTicketsAuth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian factors.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorsAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/:name',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factors = new RetryRestClient(guardianFactorsAuth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian factors.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorsTemplatesAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/:name/templates',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factorsTemplates = new RetryRestClient(
+ guardianFactorsTemplatesAuth0RestClient,
+ options.retry
+ );
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian factor providers.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorsProvidersAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/:name/providers/:provider',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factorsProviders = new RetryRestClient(
+ guardianFactorsProvidersAuth0RestClient,
+ options.retry
+ );
};
/**
@@ -99,7 +154,7 @@ management/GuardianManager.js
* @memberOf module:management.GuardianManager.prototype
*
* @example
- * management.users.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ * management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
* console.log(enrollment);
* });
*
@@ -109,9 +164,7 @@ management/GuardianManager.js
*
* @return {Promise|undefined}
*/
-GuardianManager.prototype.getGuardianEnrollment = function(params, cb) {
- return this.enrollments.get(params, cb);
-};
+utils.wrapPropertyMethod(GuardianManager, 'getGuardianEnrollment', 'enrollments.get');
/**
* Delete a Guardian enrollment.
@@ -120,7 +173,7 @@ management/GuardianManager.js
* @memberOf module:management.GuardianManager.prototype
*
* @example
- * management.users.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
+ * management.guardian.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
* console.log(enrollments);
* });
*
@@ -130,9 +183,137 @@ management/GuardianManager.js
*
* @return {Promise|undefined}
*/
-GuardianManager.prototype.deleteGuardianEnrollment = function(params, cb) {
- return this.enrollments.delete(params, cb);
-};
+utils.wrapPropertyMethod(GuardianManager, 'deleteGuardianEnrollment', 'enrollments.delete');
+
+/**
+ * Create a Guardian enrollment ticket.
+ *
+ * @method createEnrollmentTicket
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.guardian.createEnrollmentTicket(function (err, ticket) {
+ * console.log(ticket);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'createEnrollmentTicket', 'tickets.create');
+
+/**
+ * Get a list of factors and statuses.
+ *
+ * @method getFactors
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.getFactors(function (err, factors) {
+ * console.log(factors.length);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'getFactors', 'factors.getAll');
+
+/**
+ * Get Guardian factor provider configuration
+ *
+ * @method getFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'getFactorProvider', 'factorsProviders.get');
+
+/**
+ * Update Guardian's factor provider
+ *
+ * @method updateFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.updateFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ * messaging_service_sid: 'XXXXXXXXXXXXXX',
+ * auth_token: 'XXXXXXXXXXXXXX',
+ * sid: 'XXXXXXXXXXXXXX'
+ * }, function(err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Object} data Updated Factor provider data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'updateFactorProvider', 'factorsProviders.update');
+
+/**
+ * Get Guardian enrollment and verification factor templates
+ *
+ * @method getFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.getFactorTemplates({ name: 'sms' }, function (err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'getFactorTemplates', 'factorsTemplates.get');
+
+/**
+ * Update Guardian enrollment and verification factor templates
+ *
+ * @method updateFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.updateFactorProvider({ name: 'sms' }, {
+ * enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ * verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+ * }, function(err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor templates data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'updateFactorTemplates', 'factorsTemplates.update');
+
+/**
+ * Update Guardian Factor
+ *
+ * @method updateFactor
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.updateFactor({ name: 'sms' }, {
+ * enabled: true
+ * }, function(err, factor) {
+ * console.log(factor);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'updateFactor', 'factors.update');
module.exports = GuardianManager;
@@ -147,7 +328,7 @@ management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 7bb900673..0b1a0388d 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -150,7 +150,9 @@ management/JobsManager.js
* @example
* var params = {
* connection_id: '{CONNECTION_ID}',
- * users: '{PATH_TO_USERS_FILE}'
+ * users: '{PATH_TO_USERS_FILE}',
+ * upsert: true, //optional
+ * send_completion_email: false //optional
* };
*
* management.jobs.get(params, function (err) {
@@ -159,11 +161,13 @@ management/JobsManager.js
* }
* });
*
- * @param {Object} data Users import data.
- * @param {String} data.connectionId Connection for the users insertion.
- * @param {String} data.users Path to the users data file.
- * @param {String} data.users_json JSON data for the users.
- * @param {Function} [cb] Callback function.
+ * @param {Object} data Users import data.
+ * @param {String} data.connectionId Connection for the users insertion.
+ * @param {String} data.users Path to the users data file.
+ * @param {String} data.users_json JSON data for the users.
+ * @param {String} data.upsert OPTIONAL: set to true to upsert users, defaults to false
+ * @param {String} data.send_completion_email OPTIONAL: defaults to true
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -175,6 +179,8 @@ management/JobsManager.js
var url = options.baseUrl + '/jobs/users-imports';
var method = 'POST';
+ var upsert = data.upsert === true ? 'true' : 'false';
+ var send_completion_email = data.send_completion_email === false ? 'false' : 'true';
var promise = options.tokenProvider.getAccessToken().then(function(access_token) {
return new Promise(function(resolve, reject) {
@@ -192,7 +198,9 @@ management/JobsManager.js
filename: data.users_json ? 'users.json' : data.users
}
},
- connection_id: data.connection_id
+ connection_id: data.connection_id,
+ upsert: upsert,
+ send_completion_email: send_completion_email
}
},
function(err, res) {
@@ -235,8 +243,7 @@ management/JobsManager.js
*
* @example
* var params = {
- * user_id: '{USER_ID}',
- * client_id: '{CLIENT_ID}'
+ * user_id: '{USER_ID}'
* };
*
* management.jobs.verifyEmail(function (err) {
@@ -247,7 +254,6 @@ management/JobsManager.js
*
* @param {Object} data User data object.
* @param {String} data.user_id ID of the user to be verified.
- * @param {String} data.client_id ID of the client for which the verification email will be sent.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
@@ -278,7 +284,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index acd346b4a..6c9f5b9ea 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 86d417de4..2b5b18db8 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 033845b8d..3cfaa5da4 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 0f35dfe3a..18de21ac5 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 9147e75af..8f51c048f 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 cf104f111..aff6e68c8 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 13431f806..2a14fe60a 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 26757c795..ce0b83bb6 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 21432f9f9..76adaeaa4 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -427,6 +427,8 @@ management/UsersManager.js
* @param {Function} [cb] Callback function
*
* @return {Promise|undefined}
+ *
+ * @deprecated This method will be removed in the next major release.
*/
UsersManager.prototype.deleteAll = function(cb) {
if (typeof cb !== 'function') {
@@ -675,7 +677,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index c447dff70..9e4daa584 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -68,6 +68,7 @@ management/index.js
var RulesConfigsManager = require('./RulesConfigsManager');
var EmailTemplatesManager = require('./EmailTemplatesManager');
var GuardianManager = require('./GuardianManager');
+var CustomDomainsManager = require('./CustomDomainsManager');
var BASE_URL_FORMAT = 'https://%s/api/v2';
var MANAGEMENT_API_AUD_FORMAT = 'https://%s/api/v2/';
@@ -205,6 +206,14 @@ management/index.js
*/
this.guardian = new GuardianManager(managerOptions);
+ /**
+ * Simple abstraction for performing CRUD operations on the
+ * custom domains endpoint.
+ *
+ * @type {CustomDomainsManager}
+ */
+ this.customDomains = new CustomDomainsManager(managerOptions);
+
/**
* Simple abstraction for performing CRUD operations on the
* connections endpoint.
@@ -901,6 +910,7 @@ management/index.js
*
* // Pagination settings.
* var params = {
+ * search_engine: 'v3',
* per_page: 10,
* page: 0
* };
@@ -909,10 +919,11 @@ management/index.js
* console.log(users.length);
* });
*
- * @param {Object} [params] Users params.
- * @param {Number} [params.per_page] Number of results per page.
- * @param {Number} [params.page] Page number, zero indexed.
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Users params.
+ * @param {Number} [params.search_engine] The version of the search engine to use.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -977,6 +988,8 @@ management/index.js
* @param {Function} [cb] Callback function
*
* @return {Promise|undefined}
+ *
+ * @deprecated This method will be removed in the next major release.
*/
utils.wrapPropertyMethod(ManagementClient, 'deleteAllUsers', 'users.deleteAll');
@@ -1966,6 +1979,261 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'deleteRulesConfig', 'rulesConfigs.delete');
+/**
+ * Create an Auth0 Custom Domain.
+ *
+ * @method create
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.createCustomDomain(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain created.
+ * });
+ *
+ * @param {Object} data The custom domain data object.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'createCustomDomain', 'customDomains.create');
+
+/**
+ * Get all Auth0 CustomDomains.
+ *
+ * @method getAll
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.getCustomDomains(function (err, customDomains) {
+ * console.log(customDomains.length);
+ * });
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getCustomDomains', 'customDomains.getAll');
+
+/**
+ * Get a Custom Domain.
+ *
+ * @method get
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getCustomDomain', 'customDomains.get');
+
+/**
+ * Verify a Custom Domain.
+ *
+ * @method verify
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'verifyCustomDomain', 'customDomains.verify');
+
+/**
+ * Delete a Custom Domain.
+ *
+ * @method delete
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain deleted.
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'deleteCustomDomain', 'customDomains.delete');
+
+/**
+ * Create a Guardian enrollment ticket.
+ *
+ * @method createGuardianEnrollmentTicket
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.createGuardianEnrollmentTicket(function (err, ticket) {
+ * console.log(ticket);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'createGuardianEnrollmentTicket',
+ 'guardian.tickets.create'
+);
+
+/**
+ * Get a list of Guardian factors and statuses.
+ *
+ * @method getGuardianFactors
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.getGuardianFactors(function (err, factors) {
+ * console.log(factors.length);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getGuardianFactors', 'guardian.factors.getAll');
+
+/**
+ * Get Guardian factor provider configuration
+ *
+ * @method getGuardianFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'getGuardianFactorProvider',
+ 'guardian.factorsProviders.get'
+);
+
+/**
+ * Update Guardian's factor provider
+ *
+ * @method updateFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ * messaging_service_sid: 'XXXXXXXXXXXXXX',
+ * auth_token: 'XXXXXXXXXXXXXX',
+ * sid: 'XXXXXXXXXXXXXX'
+ * }, function(err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Object} data Updated Factor provider data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'updateGuardianFactorProvider',
+ 'guardian.factorsProviders.update'
+);
+
+/**
+ * Get Guardian enrollment and verification factor templates
+ *
+ * @method getGuardianFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'getGuardianFactorTemplates',
+ 'guardian.factorsTemplates.get'
+);
+
+/**
+ * Update Guardian enrollment and verification factor templates
+ *
+ * @method updateGuardianFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.updateGuardianFactorTemplates({ name: 'sms' }, {
+ * enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ * verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+ * }, function(err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor templates data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'updateGuardianFactorTemplates',
+ 'guardian.factorsTemplates.update'
+);
+
+/**
+ * Update Guardian Factor
+ *
+ * @method updateGuardianFactor
+ * @memberOf module.GuardianManager.prototype
+ *
+ * management.updateGuardianFactor({ name: 'sms' }, {
+ * enabled: true
+ * }, function(err, factor) {
+ * console.log(factor);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'updateGuardianFactor', 'guardian.factors.update');
module.exports = ManagementClient;
@@ -1980,7 +2248,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 014ddfaf8..fb612176b 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -164,8 +164,7 @@ Parameters:
- Options for the Authentication Client
- SDK.
+ Options for the Authentication Client SDK.
@@ -296,6 +295,42 @@ Parameters:
+
+
+
+ supportedAlgorithms
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Algorithms that your application expects to receive
+
+
+
+
+
@@ -401,7 +436,7 @@ databaseSource:
oauthSource:
passwordl
Source:
tokensSource:
usersSource:
changeP
Source:
Source:
getClien
Source:
get
Source:
getProfile<
Source:
password
Source:
Example
+
+
+
+
+ refreshToken(userData) → {Promise|undefined}
+
+
+
+
+
+
+ Sign in using a refresh token
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ auth/index.js, line 546
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ userData
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ User credentials object.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ refresh_token
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Refresh token.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+
+ Given a refresh token from a previous authentication request,
+ it will return a JSON with the access_token and id_token.
+ More information in the
+
+ API Docs
+ .
+
+
+ var data = {
+ client_id: '{CLIENT_ID}', // Optional field.
+ refresh_token: '{REFRESH_TOKEN}',
+};
+
+auth0.refreshToken(data, function (err, userData) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(userData);
+});
+
+
+
+
+
+
@@ -2274,7 +2546,7 @@ Source:
reque
Source:
reque
Source:
request
Source:
verifySM
Source:
Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index e6e64005d..b7b29e7b2 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
new file mode 100644
index 000000000..8697b3777
--- /dev/null
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -0,0 +1,423 @@
+
+
+
+
+
+ OAUthWithIDTokenValidation - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ OAUthWithIDTokenValidation
+
+
+
+
+
+
+
+
+
+
+
+
+ auth.
+
+ OAUthWithIDTokenValidation
+
+
+ Abstracts the oauth.create method with additional id_token validation
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new OAUthWithIDTokenValidation(oauth, options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ oauth
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ An instance of @type {OAuthAuthenticator}
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ Authenticator options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ domain
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ AuthenticationClient server domain
+
+
+
+
+
+
+
+
+ clientId
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Default client ID.
+
+
+
+
+
+
+
+
+ clientSecret
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Default client Secret.
+
+
+
+
+
+
+
+
+ supportedAlgorithms
+
+
+String
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Algorithms that your application expects to receive
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 03d92e15c..1a653544b 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -102,7 +102,7 @@ new
Source:
Parameters:
- The auth0 account URL.
+ The Auth0 account URL.
+
+
+
+
+
+
+
+
+ domain
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ AuthenticationClient server domain
@@ -382,7 +416,7 @@ (inner) Source:
Source:
password
Source:
Example
+
+
+
+
+ refreshToken(userData) → {Promise|undefined}
+
+
+
+
+
+
+ Sign in using a refresh token
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ userData
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ User credentials object.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ refresh_token
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ Refresh token.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+
+ Given a refresh token from a previous authentication request
+ it will return a JSON with the access_token and id_token.
+ More information in the
+
+ API Docs
+ .
+
+
+ var data = {
+ client_id: '{CLIENT_ID}', // Optional field.
+ refresh_token: '{REFRESH_TOKEN}',
+};
+
+auth0.oauth.refreshToken(data, function (err, userData) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(userData);
+});
+
+
+
+
+
+
@@ -1028,7 +1299,7 @@ signInSource:
socialSig
Source:
Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 155cb2a41..e81cdc6c4 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 1e0e59400..97a1daf27 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 f5980491e..1b625dd20 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 787e4940d..249e89209 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -71,6 +71,9 @@ Classes
OAuthAuthenticator
+ OAUthWithIDTokenValidation
+
+
PasswordlessAuthenticator
@@ -105,7 +108,7 @@ Classes
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 2b1f79ecf..0451d5674 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 15b7dbdb0..dee679a9a 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -542,7 +542,7 @@ createSource:
createSource:
deleteSource:
deleteSource:
getAllSource:
updateSource:
updateSource:
Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 4231ee760..02612947b 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 25998797b..7ebfbcc77 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
new file mode 100644
index 000000000..6c4def656
--- /dev/null
+++ b/docs/module-management.CustomDomainsManager.html
@@ -0,0 +1,2881 @@
+
+
+
+
+
+ CustomDomainsManager - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CustomDomainsManager
+
+
+
+
+
+
+
+
+
+
+
+
+ management.
+
+ CustomDomainsManager
+
+
+ CustomDomainsManager
+Auth0 Custom Domains Manager.
+CustomDomains represent
+custom domain names.
+You can learn more about this in the
+CustomDomains section of the
+documentation.
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new CustomDomainsManager(options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ options
+
+
+Object
+
+
+
+
+
+
+
+
+
+
+ The client options.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ baseUrl
+
+
+String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The URL of the API.
+
+
+
+
+
+
+
+
+ headers
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Headers to be included in all requests.
+
+
+
+
+
+
+
+
+ retry
+
+
+Object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Retry Policy Config
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+
+(inner) auth0CustomDomainsRestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the
+Auth0 Custom Domains endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) auth0VerifyRestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for consuming the
+Auth0 Custom Domains Verify endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) clientOptions :Object
+
+
+
+
+
+ Options object for the Rest Client instance.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ 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.customDomains.create(data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // CustomDomain created.
+});
+
+
+
+
+
+
+
+
+
+
+ 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.
+});
+
+
+
+
+
+
+
+
+
+
+ delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete 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.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // CustomDomain deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ delete(params, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Delete 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.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // CustomDomain deleted.
+});
+
+
+
+
+
+
+
+
+
+
+ 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.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.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(customDomain);
+});
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
+
+undefined
+
+
+
+
+
+
+
+
+
+
+
+
+Example
+
+ management.customDomains.verify({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(customDomain);
+});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index 2f00bdd12..01d6666b7 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 e442cb9b8..52441ed0a 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1345,7 +1345,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index 79da62aec..2495916b4 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 9b8b1f648..eff768fda 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -101,7 +101,7 @@ new Gu
Source:
Source:
Type:
+
+
+(inner) guardianFactorsAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian factors.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorsProvidersAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian factor providers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianFactorsTemplatesAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian factors.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(inner) guardianTicketsAuth0RestClient :external:RestClient
+
+
+
+
+
+ Provides an abstraction layer for retrieving Guardian tickets.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ createEnrollmentTicket(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.guardian.createEnrollmentTicket(function (err, ticket) {
+ console.log(ticket);
+});
+
+
+
+
+
+
+
+
+ createGuardianEnrollmentTicket(cbopt) → {Promise|undefined}
+
- Methods
+
+
+
+ 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);
+});
+
+
+
+
@@ -465,7 +1121,7 @@ Source:
Returns:
Example
- management.users.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
+ management.guardian.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
console.log(enrollments);
});
@@ -730,7 +1386,7 @@
Source:
Returns:
Example
- management.users.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
console.log(enrollment);
});
@@ -964,7 +1620,7 @@ Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 873b2b1e7..a17cf8ff0 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -914,6 +914,58 @@ Parameters:
+
+
+
+ upsert
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ OPTIONAL: set to true to upsert users, defaults to false
+
+
+
+
+
+
+
+
+ send_completion_email
+
+
+String
+
+
+
+
+
+
+
+
+
+
+ OPTIONAL: defaults to true
+
+
+
+
+
@@ -1005,7 +1057,9 @@ Example
var params = {
connection_id: '{CONNECTION_ID}',
- users: '{PATH_TO_USERS_FILE}'
+ users: '{PATH_TO_USERS_FILE}',
+ upsert: true, //optional
+ send_completion_email: false //optional
};
management.jobs.get(params, function (err) {
@@ -1066,7 +1120,7 @@ verifyEmai
Source:
Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index e7910f961..a476b9d52 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 96222b15e..bc804d928 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -106,7 +106,7 @@ new M
Source:
blac
Source:
clientGra
Source:
clientsSource:
connection
Source:
Type:
+
+
+
+
+
+customDomains :CustomDomainsManager
+
+
+
+
+
+ Simple abstraction for performing CRUD operations on the
+custom domains endpoint.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+ Type:
+
+ -
+
+
CustomDomainsManager
+
+
+
+
+
+
+
+
+
@@ -1023,7 +1098,7 @@ devi
Source:
emailPro
Source:
emailTe
Source:
guardianSource:
jobsSource:
logsSource:
resour
Source:
rulesSource:
rulesConf
Source:
statsSource:
tenantSource:
ticketsSource:
usersSource:
blackli
Source:
Source:
createCli
Source:
creat
Source:
Source:
Source:
Source:
c
Source:
createRule<
Source:
createUser<
Source:
deleteA
+ Deprecated: - This method will be removed in the next major release.
deleteA
Source:
deleteCli
Source:
delet
Source:
Source:
de
Source:
Source:
d
Source:
deleteRule<
Source:
dele
Source:
deleteUser<
Source:
Source:
Source:
ge
Source:
g
Source:
getClientSource:
getClien
Source:
getClients<
Source:
getConne
Source:
getConn
Source:
getDaily
Source:
g
Source:
getEm
Source:
Source:
Source:
getJobSource:
getLogSource:
getLogsSource:
getR
Source:
get
Source:
getRuleSource:
getRulesSource:
getRul
Source:
getT
Source:
getUserSource:
getUserLog
Source:
getUsersSource:
Parameters:
+
+
+ search_engine
+
+
+Number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The version of the search engine to use.
+
+
+
+
+
+
per_pageExample
// Pagination settings.
var params = {
+ search_engine: 'v3',
per_page: 10,
page: 0
};
@@ -13684,7 +13798,7 @@ getUse
Source:
importUser
Source:
linkUsersSource:
Source:
Source:
setRule
Source:
unlinkUser
Source:
upda
Source:
updateCli
Source:
updat
Source:
up
Source:
u
Source:
updateRule<
Source:
u
Source:
updateUser<
Source:
upd
Source:
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 1a7af1fa7..98a360c74 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 653f75118..0c021904e 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 7881b3014..482cb0539 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 e91728514..4a371256c 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 5f007b36b..c81f2d396 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 b9d45cecb..d73bbea41 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 f0decde8e..527516334 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 ea4aecf75..6cc15b131 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 d8f02b7a6..4a29c2bcb 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -1311,6 +1311,8 @@ deleteAllDeprecated:- This method will be removed in the next major release.
Source:
Source:
linkSource:
logsSource:
Source:
unlinkSource:
Example
diff --git a/docs/module-management.html b/docs/module-management.html
index ef43ed70b..24524f386 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -74,6 +74,9 @@ Classes
ConnectionsManager
+ CustomDomainsManager
+
+
DeviceCredentialsManager
@@ -147,7 +150,7 @@ Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 806e78741..c703086b0 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 e91aaff38..e1092abfd 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 620c47daa..b91a85153 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.13.0",
+ "version": "2.14.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": ["src"],
License
This project is licensed under the MIT license. See the
diff --git a/docs/index.js.html b/docs/index.js.html
index afb9fd421..1c8d473a0 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -24,7 +24,7 @@
Options for the Authentication Client
- SDK. Options for the Authentication Client SDK. Algorithms that your application expects to receive Sign in using a refresh token User credentials object. Refresh token.
+ Given a refresh token from a previous authentication request,
+ it will return a JSON with the access_token and id_token.
+ More information in the
+
+ API Docs
+ .
+ Abstracts the An instance of @type {OAuthAuthenticator} Authenticator options. AuthenticationClient server domain Default client ID. Default client Secret. Algorithms that your application expects to receive The auth0 account URL. The Auth0 account URL. AuthenticationClient server domain Sign in using a refresh token User credentials object. Refresh token.
+ Given a refresh token from a previous authentication request
+ it will return a JSON with the access_token and id_token.
+ More information in the
+
+ API Docs
+ .
+ CustomDomainsManager
+Auth0 Custom Domains Manager. CustomDomains represent
+custom domain names.
+You can learn more about this in the
+CustomDomains section of the
+documentation. The client options. The URL of the API. Headers to be included in all requests. Retry Policy Config Provides an abstraction layer for consuming the
+Auth0 Custom Domains endpoint. Provides an abstraction layer for consuming the
+Auth0 Custom Domains Verify endpoint. Options object for the Rest Client instance. Create an Auth0 Custom Domain. The custom domain data object. Callback function. Create an Auth0 Custom Domain. The custom domain data object. Callback function. Delete a Custom Domain. Custom Domain parameters. Custom Domain ID. Callback function. Delete a Custom Domain. Custom Domain parameters. Custom Domain ID. Callback function. Get a Custom Domain. 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. Verify a Custom Domain. Custom Domain parameters. Custom Domain ID. Callback function. Provides an abstraction layer for retrieving Guardian factors. Provides an abstraction layer for retrieving Guardian factor providers. Provides an abstraction layer for retrieving Guardian factors. Provides an abstraction layer for retrieving Guardian tickets. Create a Guardian enrollment ticket. Callback function. Create a Guardian enrollment ticket. Callback function. OPTIONAL: set to true to upsert users, defaults to false OPTIONAL: defaults to true Simple abstraction for performing CRUD operations on the
+custom domains endpoint. The version of the search engine to use.
@@ -61,7 +61,7 @@ index.js
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html
index 1af25e4de..48fdcb021 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 635bbd2c2..02d124357 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 36d5e9f99..ee848a5a2 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 e72316139..15c95b0b1 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
new file mode 100644
index 000000000..09e419d59
--- /dev/null
+++ b/docs/management_CustomDomainsManager.js.html
@@ -0,0 +1,250 @@
+
+
+
+
+
+
+
+
+
+management/CustomDomainsManager.js
+
+
+
+
+
+
+
+
+ var ArgumentError = require('rest-facade').ArgumentError;
+var utils = require('../utils');
+var Auth0RestClient = require('../Auth0RestClient');
+var RetryRestClient = require('../RetryRestClient');
+
+/**
+ * @class CustomDomainsManager
+ * Auth0 Custom Domains Manager.
+ *
+ * {@link https://auth0.com/docs/api/management/v2#!/Custom_Domains/get_custom_domains CustomDomains} represent
+ * custom domain names.
+ * You can learn more about this in the
+ * {@link https://auth0.com/docs/custom-domains CustomDomains} section of the
+ * documentation.
+ * @constructor
+ * @memberOf module:management
+ *
+ * @param {Object} options The client options.
+ * @param {String} options.baseUrl The URL of the API.
+ * @param {Object} [options.headers] Headers to be included in all requests.
+ * @param {Object} [options.retry] Retry Policy Config
+ */
+var CustomDomainsManager = function(options) {
+ if (options === null || typeof options !== 'object') {
+ throw new ArgumentError('Must provide manager options');
+ }
+
+ if (options.baseUrl === null || options.baseUrl === undefined) {
+ throw new ArgumentError('Must provide a base URL for the API');
+ }
+
+ if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
+ throw new ArgumentError('The provided base URL is invalid');
+ }
+
+ /**
+ * Options object for the Rest Client instance.
+ *
+ * @type {Object}
+ */
+ var clientOptions = {
+ errorFormatter: { message: 'message', name: 'error' },
+ headers: options.headers,
+ query: { repeatParams: false }
+ };
+
+ /**
+ * Provides an abstraction layer for consuming the
+ * {@link https://auth0.com/docs/api/v2#!/Custom_Domains Auth0 Custom Domains endpoint}.
+ *
+ * @type {external:RestClient}
+ */
+ var auth0CustomDomainsRestClient = new Auth0RestClient(
+ options.baseUrl + '/custom-domains/:id',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.resource = new RetryRestClient(auth0CustomDomainsRestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for consuming the
+ * {@link https://auth0.com/docs/api/v2#!/Custom_Domains Auth0 Custom Domains Verify endpoint}.
+ *
+ * @type {external:RestClient}
+ */
+ var auth0VerifyRestClient = new Auth0RestClient(
+ options.baseUrl + '/custom-domains/:id/verify',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.vefifyResource = new RetryRestClient(auth0VerifyRestClient, options.retry);
+};
+
+/**
+ * Create an Auth0 Custom Domain.
+ *
+ * @method create
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.create(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain created.
+ * });
+ *
+ * @param {Object} data The custom domain data object.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'create', 'resource.create');
+
+/**
+ * Get all Auth0 CustomDomains.
+ *
+ * @method getAll
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.getAll(function (err, customDomains) {
+ * console.log(customDomains.length);
+ * });
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'getAll', 'resource.getAll');
+
+/**
+ * Get a Custom Domain.
+ *
+ * @method get
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.get({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'get', 'resource.get');
+
+/**
+ * Verify a Custom Domain.
+ *
+ * @method verify
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.verify({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+CustomDomainsManager.prototype.verify = function(params, cb) {
+ if (!params || !params.id) {
+ throw new ArgumentError('The custom domain id cannot be null or undefined');
+ }
+
+ if (cb && cb instanceof Function) {
+ return this.vefifyResource.create(params, {}, cb);
+ }
+
+ return this.vefifyResource.create(params, {});
+};
+
+/**
+ * Delete a Custom Domain.
+ *
+ * @method delete
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain deleted.
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(CustomDomainsManager, 'delete', 'resource.delete');
+
+module.exports = CustomDomainsManager;
+
+
+
+
+
+
+
+
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
index bcec857b3..f5dc2e012 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 0cde21107..38f961049 100644
--- a/docs/management_EmailProviderManager.js.html
+++ b/docs/management_EmailProviderManager.js.html
@@ -24,7 +24,7 @@
@@ -195,7 +195,7 @@ management/EmailProviderManager.js
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
index 2a33027bc..b926f4b92 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 63848b8cc..fd969d25b 100644
--- a/docs/management_GuardianManager.js.html
+++ b/docs/management_GuardianManager.js.html
@@ -24,7 +24,7 @@
@@ -40,6 +40,7 @@ management/GuardianManager.js
@@ -147,7 +328,7 @@ var ArgumentError = require('rest-facade').ArgumentError;
+var utils = require('../utils');
var Auth0RestClient = require('../Auth0RestClient');
var RetryRestClient = require('../RetryRestClient');
@@ -90,6 +91,60 @@ management/GuardianManager.js
options.tokenProvider
);
this.enrollments = new RetryRestClient(guardianEnrollmentsAuth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian tickets.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianTicketsAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/enrollments/ticket',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.tickets = new RetryRestClient(guardianTicketsAuth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian factors.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorsAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/:name',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factors = new RetryRestClient(guardianFactorsAuth0RestClient, options.retry);
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian factors.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorsTemplatesAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/:name/templates',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factorsTemplates = new RetryRestClient(
+ guardianFactorsTemplatesAuth0RestClient,
+ options.retry
+ );
+
+ /**
+ * Provides an abstraction layer for retrieving Guardian factor providers.
+ *
+ * @type {external:RestClient}
+ */
+ var guardianFactorsProvidersAuth0RestClient = new Auth0RestClient(
+ options.baseUrl + '/guardian/factors/:name/providers/:provider',
+ clientOptions,
+ options.tokenProvider
+ );
+ this.factorsProviders = new RetryRestClient(
+ guardianFactorsProvidersAuth0RestClient,
+ options.retry
+ );
};
/**
@@ -99,7 +154,7 @@ management/GuardianManager.js
* @memberOf module:management.GuardianManager.prototype
*
* @example
- * management.users.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ * management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
* console.log(enrollment);
* });
*
@@ -109,9 +164,7 @@ management/GuardianManager.js
*
* @return {Promise|undefined}
*/
-GuardianManager.prototype.getGuardianEnrollment = function(params, cb) {
- return this.enrollments.get(params, cb);
-};
+utils.wrapPropertyMethod(GuardianManager, 'getGuardianEnrollment', 'enrollments.get');
/**
* Delete a Guardian enrollment.
@@ -120,7 +173,7 @@ management/GuardianManager.js
* @memberOf module:management.GuardianManager.prototype
*
* @example
- * management.users.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
+ * management.guardian.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
* console.log(enrollments);
* });
*
@@ -130,9 +183,137 @@ management/GuardianManager.js
*
* @return {Promise|undefined}
*/
-GuardianManager.prototype.deleteGuardianEnrollment = function(params, cb) {
- return this.enrollments.delete(params, cb);
-};
+utils.wrapPropertyMethod(GuardianManager, 'deleteGuardianEnrollment', 'enrollments.delete');
+
+/**
+ * Create a Guardian enrollment ticket.
+ *
+ * @method createEnrollmentTicket
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.guardian.createEnrollmentTicket(function (err, ticket) {
+ * console.log(ticket);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'createEnrollmentTicket', 'tickets.create');
+
+/**
+ * Get a list of factors and statuses.
+ *
+ * @method getFactors
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.getFactors(function (err, factors) {
+ * console.log(factors.length);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'getFactors', 'factors.getAll');
+
+/**
+ * Get Guardian factor provider configuration
+ *
+ * @method getFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'getFactorProvider', 'factorsProviders.get');
+
+/**
+ * Update Guardian's factor provider
+ *
+ * @method updateFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.updateFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ * messaging_service_sid: 'XXXXXXXXXXXXXX',
+ * auth_token: 'XXXXXXXXXXXXXX',
+ * sid: 'XXXXXXXXXXXXXX'
+ * }, function(err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Object} data Updated Factor provider data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'updateFactorProvider', 'factorsProviders.update');
+
+/**
+ * Get Guardian enrollment and verification factor templates
+ *
+ * @method getFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.getFactorTemplates({ name: 'sms' }, function (err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'getFactorTemplates', 'factorsTemplates.get');
+
+/**
+ * Update Guardian enrollment and verification factor templates
+ *
+ * @method updateFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.updateFactorProvider({ name: 'sms' }, {
+ * enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ * verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+ * }, function(err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor templates data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'updateFactorTemplates', 'factorsTemplates.update');
+
+/**
+ * Update Guardian Factor
+ *
+ * @method updateFactor
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.guardian.updateFactor({ name: 'sms' }, {
+ * enabled: true
+ * }, function(err, factor) {
+ * console.log(factor);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GuardianManager, 'updateFactor', 'factors.update');
module.exports = GuardianManager;
management/GuardianManager.js
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
index 7bb900673..0b1a0388d 100644
--- a/docs/management_JobsManager.js.html
+++ b/docs/management_JobsManager.js.html
@@ -24,7 +24,7 @@
@@ -150,7 +150,9 @@ management/JobsManager.js
* @example
* var params = {
* connection_id: '{CONNECTION_ID}',
- * users: '{PATH_TO_USERS_FILE}'
+ * users: '{PATH_TO_USERS_FILE}',
+ * upsert: true, //optional
+ * send_completion_email: false //optional
* };
*
* management.jobs.get(params, function (err) {
@@ -159,11 +161,13 @@ management/JobsManager.js
* }
* });
*
- * @param {Object} data Users import data.
- * @param {String} data.connectionId Connection for the users insertion.
- * @param {String} data.users Path to the users data file.
- * @param {String} data.users_json JSON data for the users.
- * @param {Function} [cb] Callback function.
+ * @param {Object} data Users import data.
+ * @param {String} data.connectionId Connection for the users insertion.
+ * @param {String} data.users Path to the users data file.
+ * @param {String} data.users_json JSON data for the users.
+ * @param {String} data.upsert OPTIONAL: set to true to upsert users, defaults to false
+ * @param {String} data.send_completion_email OPTIONAL: defaults to true
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -175,6 +179,8 @@ management/JobsManager.js
var url = options.baseUrl + '/jobs/users-imports';
var method = 'POST';
+ var upsert = data.upsert === true ? 'true' : 'false';
+ var send_completion_email = data.send_completion_email === false ? 'false' : 'true';
var promise = options.tokenProvider.getAccessToken().then(function(access_token) {
return new Promise(function(resolve, reject) {
@@ -192,7 +198,9 @@ management/JobsManager.js
filename: data.users_json ? 'users.json' : data.users
}
},
- connection_id: data.connection_id
+ connection_id: data.connection_id,
+ upsert: upsert,
+ send_completion_email: send_completion_email
}
},
function(err, res) {
@@ -235,8 +243,7 @@ management/JobsManager.js
*
* @example
* var params = {
- * user_id: '{USER_ID}',
- * client_id: '{CLIENT_ID}'
+ * user_id: '{USER_ID}'
* };
*
* management.jobs.verifyEmail(function (err) {
@@ -247,7 +254,6 @@ management/JobsManager.js
*
* @param {Object} data User data object.
* @param {String} data.user_id ID of the user to be verified.
- * @param {String} data.client_id ID of the client for which the verification email will be sent.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
@@ -278,7 +284,7 @@ management/JobsManager.js
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
index acd346b4a..6c9f5b9ea 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 86d417de4..2b5b18db8 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 033845b8d..3cfaa5da4 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 0f35dfe3a..18de21ac5 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 9147e75af..8f51c048f 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 cf104f111..aff6e68c8 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 13431f806..2a14fe60a 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 26757c795..ce0b83bb6 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 21432f9f9..76adaeaa4 100644
--- a/docs/management_UsersManager.js.html
+++ b/docs/management_UsersManager.js.html
@@ -24,7 +24,7 @@
@@ -427,6 +427,8 @@ management/UsersManager.js
* @param {Function} [cb] Callback function
*
* @return {Promise|undefined}
+ *
+ * @deprecated This method will be removed in the next major release.
*/
UsersManager.prototype.deleteAll = function(cb) {
if (typeof cb !== 'function') {
@@ -675,7 +677,7 @@ management/UsersManager.js
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
index c447dff70..9e4daa584 100644
--- a/docs/management_index.js.html
+++ b/docs/management_index.js.html
@@ -24,7 +24,7 @@
@@ -68,6 +68,7 @@ management/index.js
var RulesConfigsManager = require('./RulesConfigsManager');
var EmailTemplatesManager = require('./EmailTemplatesManager');
var GuardianManager = require('./GuardianManager');
+var CustomDomainsManager = require('./CustomDomainsManager');
var BASE_URL_FORMAT = 'https://%s/api/v2';
var MANAGEMENT_API_AUD_FORMAT = 'https://%s/api/v2/';
@@ -205,6 +206,14 @@ management/index.js
*/
this.guardian = new GuardianManager(managerOptions);
+ /**
+ * Simple abstraction for performing CRUD operations on the
+ * custom domains endpoint.
+ *
+ * @type {CustomDomainsManager}
+ */
+ this.customDomains = new CustomDomainsManager(managerOptions);
+
/**
* Simple abstraction for performing CRUD operations on the
* connections endpoint.
@@ -901,6 +910,7 @@ management/index.js
*
* // Pagination settings.
* var params = {
+ * search_engine: 'v3',
* per_page: 10,
* page: 0
* };
@@ -909,10 +919,11 @@ management/index.js
* console.log(users.length);
* });
*
- * @param {Object} [params] Users params.
- * @param {Number} [params.per_page] Number of results per page.
- * @param {Number} [params.page] Page number, zero indexed.
- * @param {Function} [cb] Callback function.
+ * @param {Object} [params] Users params.
+ * @param {Number} [params.search_engine] The version of the search engine to use.
+ * @param {Number} [params.per_page] Number of results per page.
+ * @param {Number} [params.page] Page number, zero indexed.
+ * @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
@@ -977,6 +988,8 @@ management/index.js
* @param {Function} [cb] Callback function
*
* @return {Promise|undefined}
+ *
+ * @deprecated This method will be removed in the next major release.
*/
utils.wrapPropertyMethod(ManagementClient, 'deleteAllUsers', 'users.deleteAll');
@@ -1966,6 +1979,261 @@ management/index.js
*/
utils.wrapPropertyMethod(ManagementClient, 'deleteRulesConfig', 'rulesConfigs.delete');
+/**
+ * Create an Auth0 Custom Domain.
+ *
+ * @method create
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.createCustomDomain(data, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain created.
+ * });
+ *
+ * @param {Object} data The custom domain data object.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'createCustomDomain', 'customDomains.create');
+
+/**
+ * Get all Auth0 CustomDomains.
+ *
+ * @method getAll
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.getCustomDomains(function (err, customDomains) {
+ * console.log(customDomains.length);
+ * });
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getCustomDomains', 'customDomains.getAll');
+
+/**
+ * Get a Custom Domain.
+ *
+ * @method get
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.getCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getCustomDomain', 'customDomains.get');
+
+/**
+ * Verify a Custom Domain.
+ *
+ * @method verify
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * console.log(customDomain);
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'verifyCustomDomain', 'customDomains.verify');
+
+/**
+ * Delete a Custom Domain.
+ *
+ * @method delete
+ * @memberOf module:management.CustomDomainsManager.prototype
+ *
+ * @example
+ * management.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ * if (err) {
+ * // Handle error.
+ * }
+ *
+ * // CustomDomain deleted.
+ * });
+ *
+ * @param {Object} params Custom Domain parameters.
+ * @param {String} params.id Custom Domain ID.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'deleteCustomDomain', 'customDomains.delete');
+
+/**
+ * Create a Guardian enrollment ticket.
+ *
+ * @method createGuardianEnrollmentTicket
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.createGuardianEnrollmentTicket(function (err, ticket) {
+ * console.log(ticket);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'createGuardianEnrollmentTicket',
+ 'guardian.tickets.create'
+);
+
+/**
+ * Get a list of Guardian factors and statuses.
+ *
+ * @method getGuardianFactors
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.getGuardianFactors(function (err, factors) {
+ * console.log(factors.length);
+ * });
+ *
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getGuardianFactors', 'guardian.factors.getAll');
+
+/**
+ * Get Guardian factor provider configuration
+ *
+ * @method getGuardianFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.getFactorProvider({ name: 'sms', provider: 'twilio'}, function (err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'getGuardianFactorProvider',
+ 'guardian.factorsProviders.get'
+);
+
+/**
+ * Update Guardian's factor provider
+ *
+ * @method updateFactorProvider
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.updateGuardianFactorProvider({ name: 'sms', provider: 'twilio' }, {
+ * messaging_service_sid: 'XXXXXXXXXXXXXX',
+ * auth_token: 'XXXXXXXXXXXXXX',
+ * sid: 'XXXXXXXXXXXXXX'
+ * }, function(err, provider) {
+ * console.log(provider);
+ * });
+ *
+ * @param {Object} params Factor provider parameters.
+ * @param {Object} data Updated Factor provider data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'updateGuardianFactorProvider',
+ 'guardian.factorsProviders.update'
+);
+
+/**
+ * Get Guardian enrollment and verification factor templates
+ *
+ * @method getGuardianFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.getGuardianFactorTemplates({ name: 'sms' }, function (err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'getGuardianFactorTemplates',
+ 'guardian.factorsTemplates.get'
+);
+
+/**
+ * Update Guardian enrollment and verification factor templates
+ *
+ * @method updateGuardianFactorTemplates
+ * @memberOf module:management.GuardianManager.prototype
+ *
+ * management.updateGuardianFactorTemplates({ name: 'sms' }, {
+ * enrollment_message: "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
+ * verification_message: "{{code}} is your verification code for {{tenant.friendly_name}}"
+ * }, function(err, templates) {
+ * console.log(templates);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor templates data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(
+ ManagementClient,
+ 'updateGuardianFactorTemplates',
+ 'guardian.factorsTemplates.update'
+);
+
+/**
+ * Update Guardian Factor
+ *
+ * @method updateGuardianFactor
+ * @memberOf module.GuardianManager.prototype
+ *
+ * management.updateGuardianFactor({ name: 'sms' }, {
+ * enabled: true
+ * }, function(err, factor) {
+ * console.log(factor);
+ * });
+ *
+ * @param {Object} params Factor parameters.
+ * @param {Object} data Updated factor data.
+ * @param {Function} [cb] Callback function.
+ *
+ * @return {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'updateGuardianFactor', 'guardian.factors.update');
module.exports = ManagementClient;
@@ -1980,7 +2248,7 @@ management/index.js
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
index 014ddfaf8..fb612176b 100644
--- a/docs/module-auth.AuthenticationClient.html
+++ b/docs/module-auth.AuthenticationClient.html
@@ -24,7 +24,7 @@
@@ -164,8 +164,7 @@
+Parameters:
- Parameters:
+
+
+
+
+
+
@@ -401,7 +436,7 @@ supportedAlgorithms
+
+
+
+
+
+ String
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ databaseSource:
oauthSource:
passwordl
tokensSource:
usersSource:
changeP
Source:
getClien
get
getProfile<
password
Example
+
+
+
+
+
+
refreshToken(userData) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+userData
+
+
+
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+refresh_token
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+Promise
+|
+
+undefined
+
+
+
+
+
+Example
+
+
+
+var data = {
+ client_id: '{CLIENT_ID}', // Optional field.
+ refresh_token: '{REFRESH_TOKEN}',
+};
+
+auth0.refreshToken(data, function (err, userData) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(userData);
+});
@@ -2274,7 +2546,7 @@ Source:
reque
reque
request
verifySM
Examples
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
index e6e64005d..b7b29e7b2 100644
--- a/docs/module-auth.DatabaseAuthenticator.html
+++ b/docs/module-auth.DatabaseAuthenticator.html
@@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@ Example
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
new file mode 100644
index 000000000..8697b3777
--- /dev/null
+++ b/docs/module-auth.OAUthWithIDTokenValidation.html
@@ -0,0 +1,423 @@
+
+
+
+
+
+
+
+
+
+OAUthWithIDTokenValidation
+
+
+
+
+
+
+
+
+ auth.
+
+ OAUthWithIDTokenValidation
+
+
+
+
+
+oauth.create method with additional id_token validation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new OAUthWithIDTokenValidation(oauth, options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+ oauth
+
+
+
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+options
+
+
+
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ domain
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ clientId
+
+
+
+
+
+ String
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ clientSecret
+
+
+
+
+
+ String
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+supportedAlgorithms
+
+
+
+
+
+ String
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
index 03d92e15c..1a653544b 100644
--- a/docs/module-auth.OAuthAuthenticator.html
+++ b/docs/module-auth.OAuthAuthenticator.html
@@ -24,7 +24,7 @@
@@ -102,7 +102,7 @@
+new
Parameters:
-
+
+
+
+
+
+
+
@@ -382,7 +416,7 @@ domain
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
(inner) Source:
Source:
password
Example
+
+
+
+
+
+
refreshToken(userData) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+userData
+
+
+
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+refresh_token
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+Promise
+|
+
+undefined
+
+
+
+
+
+Example
+
+
+
+var data = {
+ client_id: '{CLIENT_ID}', // Optional field.
+ refresh_token: '{REFRESH_TOKEN}',
+};
+
+auth0.oauth.refreshToken(data, function (err, userData) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(userData);
+});
@@ -1028,7 +1299,7 @@ signInSource:
socialSig
Returns:
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
index 155cb2a41..e81cdc6c4 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 1e0e59400..97a1daf27 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 f5980491e..1b625dd20 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 787e4940d..249e89209 100644
--- a/docs/module-auth.html
+++ b/docs/module-auth.html
@@ -24,7 +24,7 @@
@@ -71,6 +71,9 @@ Classes
Classes
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
index 2b1f79ecf..0451d5674 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 15b7dbdb0..dee679a9a 100644
--- a/docs/module-management.ClientGrantsManager.html
+++ b/docs/module-management.ClientGrantsManager.html
@@ -24,7 +24,7 @@
@@ -542,7 +542,7 @@ createSource:
createSource:
deleteSource:
deleteSource:
getAllSource:
updateSource:
updateSource:
Example
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
index 4231ee760..02612947b 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 25998797b..7ebfbcc77 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
new file mode 100644
index 000000000..6c4def656
--- /dev/null
+++ b/docs/module-management.CustomDomainsManager.html
@@ -0,0 +1,2881 @@
+
+
+
+
+
+
+
+
+
+CustomDomainsManager
+
+
+
+
+
+
+
+
+ management.
+
+ CustomDomainsManager
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+
+
+ new CustomDomainsManager(options)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+options
+
+
+
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ baseUrl
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ headers
+
+
+
+
+
+ Object
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+retry
+
+
+
+
+
+ Object
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+
+
+
+
+
+(inner) auth0CustomDomainsRestClient :external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type:
+
+
+
+
+
+
+
+external:RestClient
+
+
+
+
+
+
+
+(inner) auth0VerifyRestClient :external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type:
+
+
+
+
+
+
+
+external:RestClient
+
+
+
+
+
+
+
+
+
+ (inner) clientOptions :Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type:
+
+
+
+
+
+
+
+Object
+
+
+ Methods
+
+
+
+
+
+
+
+
+
+
+create(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ data
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+Promise
+|
+
+undefined
+
+
+
+
+
+Example
+
+
+
+management.customDomains.create(data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // CustomDomain created.
+});
+
+
+
+
+
+
+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.
+});
+
+
+
+
+
+
+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.deleteCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // CustomDomain 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.customDomains.delete({ id: CUSTOM_DOMAIN_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // CustomDomain deleted.
+});
+
+
+
+
+
+
+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.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:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+ params
+
+
+
+
+
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+id
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+Promise
+|
+
+undefined
+
+
+
+
+
+Example
+
+
+
+management.verifyCustomDomain({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(customDomain);
+});
+
+
+
+
+
+
+
+
+
+
+verify(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.verify({ id: CUSTOM_DOMAIN_ID }, function (err, customDomain) {
+ if (err) {
+ // Handle error.
+ }
+
+ console.log(customDomain);
+});
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
index 2f00bdd12..01d6666b7 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 e442cb9b8..52441ed0a 100644
--- a/docs/module-management.EmailProviderManager.html
+++ b/docs/module-management.EmailProviderManager.html
@@ -24,7 +24,7 @@
@@ -1345,7 +1345,7 @@ Example
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
index 79da62aec..2495916b4 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 9b8b1f648..eff768fda 100644
--- a/docs/module-management.GuardianManager.html
+++ b/docs/module-management.GuardianManager.html
@@ -24,7 +24,7 @@
@@ -101,7 +101,7 @@
+
+new Gu
Source:
Type:
+
+
+
+
+(inner) guardianFactorsAuth0RestClient :external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type:
+
+
+
+
+
+
+
+external:RestClient
+
+
+
+
+
+
+
+(inner) guardianFactorsProvidersAuth0RestClient :external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type:
+
+
+
+
+
+
+
+external:RestClient
+
+
+
+
+
+
+
+(inner) guardianFactorsTemplatesAuth0RestClient :external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type:
+
+
+
+
+
+
+
+external:RestClient
+
+
+
+
+
+
+
+
+
+ (inner) guardianTicketsAuth0RestClient :external:RestClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type:
+
+
+
+
+
+
+
+external:RestClient
+
+
+ Methods
+
+
+
+
+
+
+
+
+
+
+createEnrollmentTicket(cbopt) → {Promise|undefined}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+Promise
+|
+
+undefined
+
+
+
+
+
+Example
+
+
+
+management.guardian.createEnrollmentTicket(function (err, ticket) {
+ console.log(ticket);
+});
+
+
createGuardianEnrollmentTicket(cbopt) → {Promise|undefined}
+
- Methods
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+cb
+
+
+
+
+
+ function
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+Promise
+|
+
+undefined
+
+
+
+
+
+Example
+
+
+
+management.createGuardianEnrollmentTicket(function (err, ticket) {
+ console.log(ticket);
+});
@@ -465,7 +1121,7 @@ Source:
Returns:
Example
- management.users.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
+
@@ -730,7 +1386,7 @@ management.guardian.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
console.log(enrollments);
});
Returns:
Example
- management.users.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+
@@ -964,7 +1620,7 @@ management.guardian.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
console.log(enrollment);
});Example
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
index 873b2b1e7..a17cf8ff0 100644
--- a/docs/module-management.JobsManager.html
+++ b/docs/module-management.JobsManager.html
@@ -24,7 +24,7 @@
@@ -914,6 +914,58 @@ Parameters:
+
+
+
+
+
+
+
+ upsert
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
@@ -1005,7 +1057,9 @@ send_completion_email
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+
+ Example
var params = {
connection_id: '{CONNECTION_ID}',
- users: '{PATH_TO_USERS_FILE}'
+ users: '{PATH_TO_USERS_FILE}',
+ upsert: true, //optional
+ send_completion_email: false //optional
};
management.jobs.get(params, function (err) {
@@ -1066,7 +1120,7 @@ verifyEmai
Example
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
index e7910f961..a476b9d52 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 96222b15e..bc804d928 100644
--- a/docs/module-management.ManagementClient.html
+++ b/docs/module-management.ManagementClient.html
@@ -24,7 +24,7 @@
@@ -106,7 +106,7 @@
+
+
+
+new M
blac
clientGra
clientsSource:
connection
Type:
+
+
@@ -1023,7 +1098,7 @@ customDomains :CustomDomainsManager
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type:
+
+
+
+
+
+
+
CustomDomainsManager
+
+
+ devi
emailPro
emailTe
guardianSource:
jobsSource:
logsSource:
resour
rulesSource:
rulesConf
statsSource:
tenantSource:
ticketsSource:
usersSource:
blackli
Source:
createCli
creat
Source:
Source:
c
createRule<
createUser<
deleteA
+
deleteA
deleteCli
delet
Source:
de
Source:
d
deleteRule<
dele
deleteUser<
ge
g
getClient
getClien
getClients<
getConne
getConn
getDaily
g
getEm
Source:
getJobSource:
getLogSource:
getLogsSource:
getR
get
getRuleSource:
getRulesSource:
getRul
getT
getUserSource:
getUserLog
getUsersSource:
Parameters:
+
+
+
+
+
+
search_engine
+
+
+
+
+
+ Number
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
per_pageExample
// Pagination settings.
var params = {
+ search_engine: 'v3',
per_page: 10,
page: 0
};
@@ -13684,7 +13798,7 @@ getUse
importUser
linkUsers
Source:
setRule
unlinkUser
upda
updateCli
updat
up
u
updateRule<
u
updateUser<
upd
Example
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
index 1a7af1fa7..98a360c74 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 653f75118..0c021904e 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 7881b3014..482cb0539 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 e91728514..4a371256c 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 5f007b36b..c81f2d396 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 b9d45cecb..d73bbea41 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 f0decde8e..527516334 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 ea4aecf75..6cc15b131 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 d8f02b7a6..4a29c2bcb 100644
--- a/docs/module-management.UsersManager.html
+++ b/docs/module-management.UsersManager.html
@@ -24,7 +24,7 @@
@@ -1311,6 +1311,8 @@ deleteAll
Source:
Source:
linkSource:
logsSource:
Source:
unlinkSource:
Example
diff --git a/docs/module-management.html b/docs/module-management.html
index ef43ed70b..24524f386 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
@@ -74,6 +74,9 @@ Classes
Classes
diff --git a/docs/module-utils.html b/docs/module-utils.html
index 806e78741..c703086b0 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 e91aaff38..e1092abfd 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 620c47daa..b91a85153 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "auth0",
- "version": "2.13.0",
+ "version": "2.14.0",
"description": "SDK for Auth0 API v2",
"main": "src/index.js",
"files": ["src"],