From e88f73ce1fb366c41950ff033e034c4753bf7aca Mon Sep 17 00:00:00 2001 From: davidpatrick Date: Wed, 15 Jan 2020 11:28:53 -0800 Subject: [PATCH] Release v2.21.0 --- CHANGELOG.md | 17 + docs/RetryRestClient.js.html | 4 +- docs/auth_DatabaseAuthenticator.js.html | 4 +- docs/auth_OAUthWithIDTokenValidation.js.html | 47 +- docs/auth_OAuthAuthenticator.js.html | 43 +- docs/auth_PasswordlessAuthenticator.js.html | 4 +- docs/auth_TokensManager.js.html | 4 +- docs/auth_UsersManager.js.html | 4 +- docs/auth_idToken.js.html | 211 +++++++++ docs/auth_index.js.html | 4 +- docs/errors.js.html | 4 +- docs/external-RestClient.html | 4 +- docs/global.html | 432 ++++++++++++++++++ docs/index.html | 6 +- docs/index.js.html | 4 +- ...anagement_BlacklistedTokensManager.js.html | 4 +- docs/management_BrandingManager.js.html | 4 +- docs/management_ClientGrantsManager.js.html | 4 +- docs/management_ClientsManager.js.html | 4 +- docs/management_ConnectionsManager.js.html | 4 +- docs/management_CustomDomainsManager.js.html | 4 +- ...anagement_DeviceCredentialsManager.js.html | 4 +- docs/management_EmailProviderManager.js.html | 4 +- docs/management_EmailTemplatesManager.js.html | 4 +- docs/management_GrantsManager.js.html | 4 +- docs/management_GuardianManager.js.html | 4 +- docs/management_JobsManager.js.html | 4 +- docs/management_LogsManager.js.html | 4 +- ...management_ManagementTokenProvider.js.html | 4 +- docs/management_PromptsManager.js.html | 4 +- .../management_ResourceServersManager.js.html | 4 +- docs/management_RolesManager.js.html | 4 +- docs/management_RulesConfigsManager.js.html | 4 +- docs/management_RulesManager.js.html | 4 +- docs/management_StatsManager.js.html | 4 +- docs/management_TenantManager.js.html | 4 +- docs/management_TicketsManager.js.html | 4 +- docs/management_UserBlocksManager.js.html | 4 +- docs/management_UsersManager.js.html | 4 +- docs/management_index.js.html | 8 +- docs/module-auth.AuthenticationClient.html | 4 +- docs/module-auth.DatabaseAuthenticator.html | 4 +- ...odule-auth.OAUthWithIDTokenValidation.html | 6 +- docs/module-auth.OAuthAuthenticator.html | 24 +- ...module-auth.PasswordlessAuthenticator.html | 4 +- docs/module-auth.TokensManager.html | 4 +- docs/module-auth.UsersManager.html | 4 +- docs/module-auth.html | 4 +- docs/module-errors.html | 4 +- ...e-management.BlacklistedTokensManager.html | 4 +- docs/module-management.BrandingManager.html | 4 +- ...module-management.ClientGrantsManager.html | 4 +- docs/module-management.ClientsManager.html | 4 +- .../module-management.ConnectionsManager.html | 4 +- ...odule-management.CustomDomainsManager.html | 4 +- ...e-management.DeviceCredentialsManager.html | 4 +- ...odule-management.EmailProviderManager.html | 4 +- ...dule-management.EmailTemplatesManager.html | 4 +- docs/module-management.GrantsManager.html | 4 +- docs/module-management.GuardianManager.html | 4 +- docs/module-management.JobsManager.html | 4 +- docs/module-management.LogsManager.html | 4 +- docs/module-management.ManagementClient.html | 187 +++++--- ...le-management.ManagementTokenProvider.html | 4 +- docs/module-management.PromptsManager.html | 4 +- ...ule-management.ResourceServersManager.html | 4 +- docs/module-management.RetryRestClient.html | 4 +- docs/module-management.RolesManager.html | 4 +- ...module-management.RulesConfigsManager.html | 4 +- docs/module-management.RulesManager.html | 4 +- docs/module-management.StatsManager.html | 4 +- docs/module-management.TenantManager.html | 4 +- docs/module-management.TicketsManager.html | 4 +- docs/module-management.UserBlocksManager.html | 4 +- docs/module-management.UsersManager.html | 4 +- docs/module-management.html | 4 +- docs/module-utils.html | 4 +- docs/utils.js.html | 4 +- package.json | 2 +- 79 files changed, 986 insertions(+), 269 deletions(-) create mode 100644 docs/auth_idToken.js.html create mode 100644 docs/global.html diff --git a/CHANGELOG.md b/CHANGELOG.md index 6bc947bc6..376f29eb5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,22 @@ # Change Log +## [v2.21.0](https://github.com/auth0/node-auth0/tree/v2.21.0) (2020-01-15) + +**Added** + +- Improved OIDC compliance [\#446](https://github.com/auth0/node-auth0/pull/446) ([davidpatrick](https://github.com/davidpatrick)) + +**Changed** + +- Add client secret to refreshToken and remove ID token validation [\#433](https://github.com/auth0/node-auth0/pull/433) ([joshcanhelp](https://github.com/joshcanhelp)) + +**Security** + +- [Security] Bump handlebars from 4.1.2 to 4.5.3 [\#441](https://github.com/auth0/node-auth0/pull/441) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) +- Update rest-facade dependency [\#436](https://github.com/auth0/node-auth0/pull/436) ([joshcanhelp](https://github.com/joshcanhelp)) + +[Full Changelog](https://github.com/auth0/node-auth0/compare/v2.20.0...v2.21.0) + ## [v2.20.0](https://github.com/auth0/node-auth0/tree/v2.20.0) (2019-09-17) **Added** diff --git a/docs/RetryRestClient.js.html b/docs/RetryRestClient.js.html index a9be84ae0..0c07c076c 100644 --- a/docs/RetryRestClient.js.html +++ b/docs/RetryRestClient.js.html @@ -24,7 +24,7 @@
@@ -207,7 +207,7 @@

RetryRestClient.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_DatabaseAuthenticator.js.html b/docs/auth_DatabaseAuthenticator.js.html index 5a832b92b..d66938a5b 100644 --- a/docs/auth_DatabaseAuthenticator.js.html +++ b/docs/auth_DatabaseAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -346,7 +346,7 @@

auth/DatabaseAuthenticator.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_OAUthWithIDTokenValidation.js.html b/docs/auth_OAUthWithIDTokenValidation.js.html index e853cea9d..570e9c3c5 100644 --- a/docs/auth_OAUthWithIDTokenValidation.js.html +++ b/docs/auth_OAUthWithIDTokenValidation.js.html @@ -24,7 +24,7 @@
@@ -44,6 +44,7 @@

auth/OAUthWithIDTokenValidation.js

var Promise = require('bluebird'); var ArgumentError = require('rest-facade').ArgumentError; +var validateIdToken = require('./idToken').validate; var HS256_IGNORE_VALIDATION_MESSAGE = 'Validation of `id_token` requires a `clientSecret` when using the HS256 algorithm. To ensure tokens are validated, please switch the signing algorithm to RS256 or provide a `clientSecret` in the constructor.'; @@ -121,25 +122,37 @@

auth/OAUthWithIDTokenValidation.js

}); } return new Promise((res, rej) => { - jwt.verify( - r.id_token, - getKey, - { - algorithms: this.supportedAlgorithms, - audience: this.clientId, - issuer: 'https://' + this.domain + '/' - }, - function(err) { - if (!err) { - return res(r); - } + var options = { + algorithms: this.supportedAlgorithms, + audience: this.clientId, + issuer: 'https://' + this.domain + '/' + }; + + if (data.nonce) { + options.nonce = data.nonce; + } + + if (data.maxAge) { + options.maxAge = data.maxAge; + } + + jwt.verify(r.id_token, getKey, options, function(err) { + if (err) { if (err.message && err.message.includes(HS256_IGNORE_VALIDATION_MESSAGE)) { console.warn(HS256_IGNORE_VALIDATION_MESSAGE); - return res(r); + } else { + return rej(err); } - return rej(err); } - ); + + try { + validateIdToken(r.id_token, options); + } catch (idTokenError) { + return rej(idTokenError); + } + + return res(r); + }); }); } return r; @@ -163,7 +176,7 @@

auth/OAUthWithIDTokenValidation.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html index f138f6f15..e5542265c 100644 --- a/docs/auth_OAuthAuthenticator.js.html +++ b/docs/auth_OAuthAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -247,14 +247,15 @@

auth/OAuthAuthenticator.js

}; /** - * Sign in using a refresh token + * Exchange 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. + * it will return a JSON with the access_token and id_token if + * the openid scope was originally included. * More information in the * <a href="https://auth0.com/docs/api/authentication#refresh-token"> * API Docs @@ -262,42 +263,46 @@

auth/OAuthAuthenticator.js

* </caption> * * var data = { - * client_id: '{CLIENT_ID}', // Optional field. * refresh_token: '{REFRESH_TOKEN}', * }; * - * auth0.oauth.refreshToken(data, function (err, userData) { + * auth0.oauth.refreshToken(data, function (err, data) { * if (err) { * // Handle error. * } * - * console.log(userData); + * console.log(data); * }); * - * @param {Object} userData User credentials object. - * @param {String} userData.refresh_token Refresh token. + * @param {Object} data Data object. + * @param {String} data.refresh_token Refresh token. * * @return {Promise|undefined} */ -OAuthAuthenticator.prototype.refreshToken = function(userData, cb) { - var params = { - type: 'token' - }; +OAuthAuthenticator.prototype.refreshToken = function(data, cb) { + if (!data || typeof data !== 'object') { + throw new ArgumentError('Missing data object'); + } + var defaultFields = { client_id: this.clientId, + client_secret: this.clientSecret, grant_type: 'refresh_token' }; - var data = extend(defaultFields, userData); - if (!userData || typeof userData !== 'object') { - throw new ArgumentError('Missing user data object'); - } + + var data = extend(defaultFields, data); if (typeof data.refresh_token !== 'string' || data.refresh_token.split().length === 0) { throw new ArgumentError('refresh_token is required'); } + + var params = { + type: 'token' + }; + if (cb && cb instanceof Function) { - return this.oauthWithIDTokenValidation.create(params, data, cb); + return this.oauth.create(params, data, cb); } - return this.oauthWithIDTokenValidation.create(params, data); + return this.oauth.create(params, data); }; /** @@ -450,7 +455,7 @@

auth/OAuthAuthenticator.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html index 1ba23d1ed..4a9734ae8 100644 --- a/docs/auth_PasswordlessAuthenticator.js.html +++ b/docs/auth_PasswordlessAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -287,7 +287,7 @@

auth/PasswordlessAuthenticator.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html index b59104adc..e18cec651 100644 --- a/docs/auth_TokensManager.js.html +++ b/docs/auth_TokensManager.js.html @@ -24,7 +24,7 @@
@@ -226,7 +226,7 @@

auth/TokensManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html index ce9171abb..72894d2f4 100644 --- a/docs/auth_UsersManager.js.html +++ b/docs/auth_UsersManager.js.html @@ -24,7 +24,7 @@
@@ -224,7 +224,7 @@

auth/UsersManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_idToken.js.html b/docs/auth_idToken.js.html new file mode 100644 index 000000000..2e6b6e7db --- /dev/null +++ b/docs/auth_idToken.js.html @@ -0,0 +1,211 @@ + + + + + + auth/idToken.js - Documentation + + + + + + + + + + + + + + + + + +
+ +

auth/idToken.js

+ + + + + + + +
+
+
var urlDecodeB64 = function(data) {
+  return Buffer.from(data, 'base64').toString('utf8');
+};
+
+/**
+ * Decodes a string token into the 3 parts, throws if the format is invalid
+ * @param token
+ */
+var decode = function(token) {
+  var parts = token.split('.');
+
+  if (parts.length !== 3) {
+    throw new Error('ID token could not be decoded');
+  }
+
+  return {
+    _raw: token,
+    header: JSON.parse(urlDecodeB64(parts[0])),
+    payload: JSON.parse(urlDecodeB64(parts[1])),
+    signature: parts[2]
+  };
+};
+
+var DEFAULT_LEEWAY = 60; //default clock-skew, in seconds
+
+/**
+ * Validator for ID Tokens following OIDC spec.
+ * @param token the string token to verify
+ * @param options the options required to run this verification
+ * @returns A promise containing the decoded token payload, or throws an exception if validation failed
+ */
+var validate = function(token, options) {
+  if (!token) {
+    throw new Error('ID token is required but missing');
+  }
+
+  var decodedToken = decode(token);
+
+  // Check algorithm
+  var header = decodedToken.header;
+  if (header.alg !== 'RS256' && header.alg !== 'HS256') {
+    throw new Error(
+      `Signature algorithm of "${header.alg}" is not supported. Expected the ID token to be signed with "RS256" or "HS256".`
+    );
+  }
+
+  var payload = decodedToken.payload;
+
+  // Issuer
+  if (!payload.iss || typeof payload.iss !== 'string') {
+    throw new Error('Issuer (iss) claim must be a string present in the ID token');
+  }
+  if (payload.iss !== options.issuer) {
+    throw new Error(
+      `Issuer (iss) claim mismatch in the ID token; expected "${options.issuer}", found "${payload.iss}"`
+    );
+  }
+
+  // Subject
+  if (!payload.sub || typeof payload.sub !== 'string') {
+    throw new Error('Subject (sub) claim must be a string present in the ID token');
+  }
+
+  // Audience
+  if (!payload.aud || !(typeof payload.aud === 'string' || Array.isArray(payload.aud))) {
+    throw new Error(
+      'Audience (aud) claim must be a string or array of strings present in the ID token'
+    );
+  }
+  if (Array.isArray(payload.aud) && !payload.aud.includes(options.audience)) {
+    throw new Error(
+      `Audience (aud) claim mismatch in the ID token; expected "${
+        options.audience
+      }" but was not one of "${payload.aud.join(', ')}"`
+    );
+  } else if (typeof payload.aud === 'string' && payload.aud !== options.audience) {
+    throw new Error(
+      `Audience (aud) claim mismatch in the ID token; expected "${options.audience}" but found "${payload.aud}"`
+    );
+  }
+
+  // --Time validation (epoch)--
+  var now = Math.floor(Date.now() / 1000);
+  var leeway = options.leeway || DEFAULT_LEEWAY;
+
+  // Expires at
+  if (!payload.exp || typeof payload.exp !== 'number') {
+    throw new Error('Expiration Time (exp) claim must be a number present in the ID token');
+  }
+  var expTime = payload.exp + leeway;
+
+  if (now > expTime) {
+    throw new Error(
+      `Expiration Time (exp) claim error in the ID token; current time (${now}) is after expiration time (${expTime})`
+    );
+  }
+
+  // Issued at
+  if (!payload.iat || typeof payload.iat !== 'number') {
+    throw new Error('Issued At (iat) claim must be a number present in the ID token');
+  }
+
+  // Nonce
+  if (options.nonce) {
+    if (!payload.nonce || typeof payload.nonce !== 'string') {
+      throw new Error('Nonce (nonce) claim must be a string present in the ID token');
+    }
+    if (payload.nonce !== options.nonce) {
+      throw new Error(
+        `Nonce (nonce) claim mismatch in the ID token; expected "${options.nonce}", found "${payload.nonce}"`
+      );
+    }
+  }
+
+  // Authorized party
+  if (Array.isArray(payload.aud) && payload.aud.length > 1) {
+    if (!payload.azp || typeof payload.azp !== 'string') {
+      throw new Error(
+        'Authorized Party (azp) claim must be a string present in the ID token when Audience (aud) claim has multiple values'
+      );
+    }
+    if (payload.azp !== options.audience) {
+      throw new Error(
+        `Authorized Party (azp) claim mismatch in the ID token; expected "${options.audience}", found "${payload.azp}"`
+      );
+    }
+  }
+
+  // Authentication time
+  if (options.maxAge) {
+    if (!payload.auth_time || typeof payload.auth_time !== 'number') {
+      throw new Error(
+        'Authentication Time (auth_time) claim must be a number present in the ID token when Max Age (max_age) is specified'
+      );
+    }
+
+    var authValidUntil = payload.auth_time + options.maxAge + leeway;
+    if (now > authValidUntil) {
+      throw new Error(
+        `Authentication Time (auth_time) claim in the ID token indicates that too much time has passed since the last end-user authentication. Currrent time (${now}) is after last auth at ${authValidUntil}`
+      );
+    }
+  }
+
+  return decodedToken;
+};
+
+module.exports = {
+  decode: decode,
+  validate: validate
+};
+
+
+
+ + + + +
+ +
+ +
+ Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme. +
+ + + + + diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html index 8ca635db6..891a8b8f2 100644 --- a/docs/auth_index.js.html +++ b/docs/auth_index.js.html @@ -24,7 +24,7 @@
@@ -603,7 +603,7 @@

auth/index.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/errors.js.html b/docs/errors.js.html index a5a20120d..47899ada6 100644 --- a/docs/errors.js.html +++ b/docs/errors.js.html @@ -24,7 +24,7 @@
@@ -98,7 +98,7 @@

errors.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html index be3536675..60a41b2d9 100644 --- a/docs/external-RestClient.html +++ b/docs/external-RestClient.html @@ -24,7 +24,7 @@
@@ -1539,7 +1539,7 @@


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/global.html b/docs/global.html new file mode 100644 index 000000000..c7a216ae1 --- /dev/null +++ b/docs/global.html @@ -0,0 +1,432 @@ + + + + + + Global - Documentation + + + + + + + + + + + + + + + + + +
+ +

Global

+ + + + + + + +
+ +
+ +

+ +

+ + +
+ +
+
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + + +

Methods

+ + + +
+ + + +

decode(token)

+ + + + + +
+

Decodes a string token into the 3 parts, throws if the format is invalid

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
token + + + + +
+ + + + + + + + + + + + + + + + +
+ + +
+ + + +

validate(token, options)

+ + + + + +
+

Validator for ID Tokens following OIDC spec.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
token + + +

the string token to verify

+ +
options + + +

the options required to run this verification

+ +
+ + + + + + + + + + + + + + +
+
Returns:
+ + + + +
+

A promise containing the decoded token payload, or throws an exception if validation failed

+
+ + +
+ + + +
+ + + + + + +
+ +
+ + + + +
+ +
+ +
+ Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme. +
+ + + + + \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 3a4f8c030..33447e31d 100644 --- a/docs/index.html +++ b/docs/index.html @@ -24,7 +24,7 @@
@@ -56,7 +56,7 @@ Downloads

Node.js client library for the Auth0 platform.

Installation

-
  npm install auth0
+
npm install auth0
 

Documentation

You can find this library documentation in this page.

@@ -174,7 +174,7 @@

License


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/index.js.html b/docs/index.js.html index b985f7bb8..30d6c4708 100644 --- a/docs/index.js.html +++ b/docs/index.js.html @@ -24,7 +24,7 @@
@@ -61,7 +61,7 @@

index.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html index e7bc25fea..b2b5c82c6 100644 --- a/docs/management_BlacklistedTokensManager.js.html +++ b/docs/management_BlacklistedTokensManager.js.html @@ -24,7 +24,7 @@
@@ -153,7 +153,7 @@

management/BlacklistedTokensManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_BrandingManager.js.html b/docs/management_BrandingManager.js.html index bf1dc88a4..5079b1ccb 100644 --- a/docs/management_BrandingManager.js.html +++ b/docs/management_BrandingManager.js.html @@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@

management/BrandingManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html index f930bb76d..879359551 100644 --- a/docs/management_ClientGrantsManager.js.html +++ b/docs/management_ClientGrantsManager.js.html @@ -24,7 +24,7 @@
@@ -216,7 +216,7 @@

management/ClientGrantsManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html index 8d95cb7b6..7b6eeeefe 100644 --- a/docs/management_ClientsManager.js.html +++ b/docs/management_ClientsManager.js.html @@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@

management/ClientsManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html index 765102488..ba5ff6584 100644 --- a/docs/management_ConnectionsManager.js.html +++ b/docs/management_ConnectionsManager.js.html @@ -24,7 +24,7 @@
@@ -232,7 +232,7 @@

management/ConnectionsManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html index 09c194bff..ed169d4cd 100644 --- a/docs/management_CustomDomainsManager.js.html +++ b/docs/management_CustomDomainsManager.js.html @@ -24,7 +24,7 @@
@@ -241,7 +241,7 @@

management/CustomDomainsManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html index 1744f73d1..c016a1aa1 100644 --- a/docs/management_DeviceCredentialsManager.js.html +++ b/docs/management_DeviceCredentialsManager.js.html @@ -24,7 +24,7 @@
@@ -177,7 +177,7 @@

management/DeviceCredentialsManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html index 6c0901e8f..193092e27 100644 --- a/docs/management_EmailProviderManager.js.html +++ b/docs/management_EmailProviderManager.js.html @@ -24,7 +24,7 @@
@@ -198,7 +198,7 @@

management/EmailProviderManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html index 48202748c..c6d6055ac 100644 --- a/docs/management_EmailTemplatesManager.js.html +++ b/docs/management_EmailTemplatesManager.js.html @@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@

management/EmailTemplatesManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html index c01d116bc..e36674eb9 100644 --- a/docs/management_GrantsManager.js.html +++ b/docs/management_GrantsManager.js.html @@ -24,7 +24,7 @@
@@ -170,7 +170,7 @@

management/GrantsManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html index 96b17ee17..5ed1bd434 100644 --- a/docs/management_GuardianManager.js.html +++ b/docs/management_GuardianManager.js.html @@ -24,7 +24,7 @@
@@ -328,7 +328,7 @@

management/GuardianManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html index 71ce6691b..de285223b 100644 --- a/docs/management_JobsManager.js.html +++ b/docs/management_JobsManager.js.html @@ -24,7 +24,7 @@
@@ -413,7 +413,7 @@

management/JobsManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html index a32ec12bc..87e079abc 100644 --- a/docs/management_LogsManager.js.html +++ b/docs/management_LogsManager.js.html @@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@

management/LogsManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html index 4bb10dba6..971b156a3 100644 --- a/docs/management_ManagementTokenProvider.js.html +++ b/docs/management_ManagementTokenProvider.js.html @@ -24,7 +24,7 @@
@@ -192,7 +192,7 @@

management/ManagementTokenProvider.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html index cc059ef03..ab9f6782e 100644 --- a/docs/management_PromptsManager.js.html +++ b/docs/management_PromptsManager.js.html @@ -24,7 +24,7 @@
@@ -155,7 +155,7 @@

management/PromptsManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html index f69d6d479..5a669be5f 100644 --- a/docs/management_ResourceServersManager.js.html +++ b/docs/management_ResourceServersManager.js.html @@ -24,7 +24,7 @@
@@ -238,7 +238,7 @@

management/ResourceServersManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html index ab80951eb..fbe6a645b 100644 --- a/docs/management_RolesManager.js.html +++ b/docs/management_RolesManager.js.html @@ -24,7 +24,7 @@
@@ -453,7 +453,7 @@

management/RolesManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html index f813f6be4..59f018785 100644 --- a/docs/management_RulesConfigsManager.js.html +++ b/docs/management_RulesConfigsManager.js.html @@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@

management/RulesConfigsManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html index 65bb8954f..5d7535f4c 100644 --- a/docs/management_RulesManager.js.html +++ b/docs/management_RulesManager.js.html @@ -24,7 +24,7 @@
@@ -248,7 +248,7 @@

management/RulesManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html index b1a4f039f..9c2a2adc8 100644 --- a/docs/management_StatsManager.js.html +++ b/docs/management_StatsManager.js.html @@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@

management/StatsManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html index 34e16bd5f..851f3375b 100644 --- a/docs/management_TenantManager.js.html +++ b/docs/management_TenantManager.js.html @@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@

management/TenantManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html index 113d1bf3c..5b8587b6f 100644 --- a/docs/management_TicketsManager.js.html +++ b/docs/management_TicketsManager.js.html @@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@

management/TicketsManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html index 95fcfd3d0..028842ba2 100644 --- a/docs/management_UserBlocksManager.js.html +++ b/docs/management_UserBlocksManager.js.html @@ -24,7 +24,7 @@
@@ -229,7 +229,7 @@

management/UserBlocksManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html index 832a49996..a3f8211a8 100644 --- a/docs/management_UsersManager.js.html +++ b/docs/management_UsersManager.js.html @@ -24,7 +24,7 @@
@@ -927,7 +927,7 @@

management/UsersManager.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_index.js.html b/docs/management_index.js.html index bd6156704..313b163c5 100644 --- a/docs/management_index.js.html +++ b/docs/management_index.js.html @@ -24,7 +24,7 @@
@@ -976,6 +976,7 @@

management/index.js

* // Pagination settings. * var params = { * search_engine: 'v3', + * q: 'name:*jane*', * per_page: 10, * page: 0 * }; @@ -986,6 +987,7 @@

management/index.js

* * @param {Object} [params] Users params. * @param {Number} [params.search_engine] The version of the search engine to use. + * @param {String} [params.q] User Search string to filter which users are returned. Follows Lucene query string syntax as documented at https://auth0.com/docs/api/management/v2#!/Users/get_users. * @param {Number} [params.per_page] Number of results per page. * @param {Number} [params.page] Page number, zero indexed. * @param {Function} [cb] Callback function. @@ -1390,7 +1392,7 @@

management/index.js

* * @param {Object} params params object * @param {String} params.id user_id - * @param {String} data data object containing list of role IDs + * @param {Object} data data object containing list of role IDs * @param {String} data.roles Array of role IDs * @param {Function} [cb] Callback function. * @@ -2950,7 +2952,7 @@

management/index.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html index beaf697ed..80c80a6fd 100644 --- a/docs/module-auth.AuthenticationClient.html +++ b/docs/module-auth.AuthenticationClient.html @@ -24,7 +24,7 @@
@@ -3822,7 +3822,7 @@
Examples

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html index 5cca41240..80b7c7301 100644 --- a/docs/module-auth.DatabaseAuthenticator.html +++ b/docs/module-auth.DatabaseAuthenticator.html @@ -24,7 +24,7 @@
@@ -1738,7 +1738,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html index b8f357216..3982d9c2c 100644 --- a/docs/module-auth.OAUthWithIDTokenValidation.html +++ b/docs/module-auth.OAUthWithIDTokenValidation.html @@ -24,7 +24,7 @@
@@ -101,7 +101,7 @@

Source:
@@ -450,7 +450,7 @@
Parameters:

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html index fe6720748..7fb70dc3b 100644 --- a/docs/module-auth.OAuthAuthenticator.html +++ b/docs/module-auth.OAuthAuthenticator.html @@ -24,7 +24,7 @@
@@ -536,7 +536,7 @@

Source:
@@ -1164,14 +1164,14 @@

Example
-

refreshToken(userData) → {Promise|undefined}

+

refreshToken(data) → {Promise|undefined}

-

Sign in using a refresh token

+

Exchange a refresh token

@@ -1251,7 +1251,7 @@
Parameters:
- userData + data @@ -1268,7 +1268,7 @@
Parameters:
-

User credentials object.

+

Data object.

@@ -1372,7 +1372,8 @@
Example

Given a refresh token from a previous authentication request - it will return a JSON with the access_token and id_token. + it will return a JSON with the access_token and id_token if + the openid scope was originally included. More information in the API Docs @@ -1380,16 +1381,15 @@

Example

var data = {
-  client_id: '{CLIENT_ID}', // Optional field.
   refresh_token: '{REFRESH_TOKEN}',
 };
 
-auth0.oauth.refreshToken(data, function (err, userData) {
+auth0.oauth.refreshToken(data, function (err, data) {
   if (err) {
     // Handle error.
   }
 
-  console.log(userData);
+  console.log(data);
 });
@@ -1845,7 +1845,7 @@

socialSig
Source:
@@ -2050,7 +2050,7 @@

Returns:

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html index 6b4dd491a..217632bb7 100644 --- a/docs/module-auth.PasswordlessAuthenticator.html +++ b/docs/module-auth.PasswordlessAuthenticator.html @@ -24,7 +24,7 @@
@@ -1492,7 +1492,7 @@
Examples

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html index ecf882540..10a1ecf99 100644 --- a/docs/module-auth.TokensManager.html +++ b/docs/module-auth.TokensManager.html @@ -24,7 +24,7 @@
@@ -352,7 +352,7 @@
Parameters:

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html index c6664357a..c3580e465 100644 --- a/docs/module-auth.UsersManager.html +++ b/docs/module-auth.UsersManager.html @@ -24,7 +24,7 @@
@@ -1009,7 +1009,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.html b/docs/module-auth.html index 5f31661c2..19be5022d 100644 --- a/docs/module-auth.html +++ b/docs/module-auth.html @@ -24,7 +24,7 @@
@@ -108,7 +108,7 @@

Classes


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-errors.html b/docs/module-errors.html index ba83f853f..137f2583a 100644 --- a/docs/module-errors.html +++ b/docs/module-errors.html @@ -24,7 +24,7 @@
@@ -254,7 +254,7 @@

(st
- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html index f69d82d5e..54fce6e7f 100644 --- a/docs/module-management.BlacklistedTokensManager.html +++ b/docs/module-management.BlacklistedTokensManager.html @@ -24,7 +24,7 @@
@@ -991,7 +991,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html index 401bda83e..c8e7b949f 100644 --- a/docs/module-management.BrandingManager.html +++ b/docs/module-management.BrandingManager.html @@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html index 74e4efc91..6b0256ed4 100644 --- a/docs/module-management.ClientGrantsManager.html +++ b/docs/module-management.ClientGrantsManager.html @@ -24,7 +24,7 @@
@@ -1636,7 +1636,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html index a5d4b0146..da43661df 100644 --- a/docs/module-management.ClientsManager.html +++ b/docs/module-management.ClientsManager.html @@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html index 09313b8ba..d803270e1 100644 --- a/docs/module-management.ConnectionsManager.html +++ b/docs/module-management.ConnectionsManager.html @@ -24,7 +24,7 @@
@@ -1899,7 +1899,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html index a2f58e6bf..141c038fe 100644 --- a/docs/module-management.CustomDomainsManager.html +++ b/docs/module-management.CustomDomainsManager.html @@ -24,7 +24,7 @@
@@ -1731,7 +1731,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html index 8d5658130..03bedbf27 100644 --- a/docs/module-management.DeviceCredentialsManager.html +++ b/docs/module-management.DeviceCredentialsManager.html @@ -24,7 +24,7 @@
@@ -1179,7 +1179,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html index 98b68990c..6340eb0e7 100644 --- a/docs/module-management.EmailProviderManager.html +++ b/docs/module-management.EmailProviderManager.html @@ -24,7 +24,7 @@
@@ -1480,7 +1480,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html index cfe8647da..ecc88d351 100644 --- a/docs/module-management.EmailTemplatesManager.html +++ b/docs/module-management.EmailTemplatesManager.html @@ -24,7 +24,7 @@
@@ -1304,7 +1304,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html index dfdbc7616..ccca49c36 100644 --- a/docs/module-management.GrantsManager.html +++ b/docs/module-management.GrantsManager.html @@ -24,7 +24,7 @@
@@ -1515,7 +1515,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html index 865df2f99..509f48439 100644 --- a/docs/module-management.GuardianManager.html +++ b/docs/module-management.GuardianManager.html @@ -24,7 +24,7 @@
@@ -1440,7 +1440,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html index cb838e052..bb0837333 100644 --- a/docs/module-management.JobsManager.html +++ b/docs/module-management.JobsManager.html @@ -24,7 +24,7 @@
@@ -2198,7 +2198,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html index b5307d3f3..bbc74eb06 100644 --- a/docs/module-management.LogsManager.html +++ b/docs/module-management.LogsManager.html @@ -24,7 +24,7 @@
@@ -1286,7 +1286,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html index 7fd390a6e..4cae25aa7 100644 --- a/docs/module-management.ManagementClient.html +++ b/docs/module-management.ManagementClient.html @@ -24,7 +24,7 @@
@@ -2301,7 +2301,7 @@

a
Source:
@@ -2680,7 +2680,7 @@

Source:
@@ -3037,7 +3037,7 @@

assi
Source:
@@ -3174,7 +3174,7 @@

Parameters:
-String +Object @@ -3394,7 +3394,7 @@

blackli
Source:
@@ -3694,7 +3694,7 @@

Source:
@@ -4566,7 +4566,7 @@

cre
Source:
@@ -5002,7 +5002,7 @@

cr
Source:
@@ -5218,7 +5218,7 @@

Source:
@@ -5402,7 +5402,7 @@

Source:
@@ -5582,7 +5582,7 @@

Source:
@@ -5774,7 +5774,7 @@

c
Source:
@@ -5992,7 +5992,7 @@

createRole<
Source:
@@ -6429,7 +6429,7 @@

createUser<
Source:
@@ -6649,7 +6649,7 @@

deleteA
Source:
@@ -7640,7 +7640,7 @@

del
Source:
@@ -8180,7 +8180,7 @@

de
Source:
@@ -8364,7 +8364,7 @@

Source:
@@ -8633,7 +8633,7 @@

d
Source:
@@ -8902,7 +8902,7 @@

deleteRole<
Source:
@@ -9440,7 +9440,7 @@

dele
Source:
@@ -9709,7 +9709,7 @@

deleteUser<
Source:
@@ -9978,7 +9978,7 @@

Source:
@@ -10279,7 +10279,7 @@

Source:
@@ -10576,7 +10576,7 @@

exportUser
Source:
@@ -10990,7 +10990,7 @@

getAcce
Source:
@@ -11098,7 +11098,7 @@

ge
Source:
@@ -11282,7 +11282,7 @@

g
Source:
@@ -12981,7 +12981,7 @@

getCus
Source:
@@ -13250,7 +13250,7 @@

getCu
Source:
@@ -13366,7 +13366,7 @@

getDaily
Source:
@@ -13846,7 +13846,7 @@

getEm
Source:
@@ -14161,7 +14161,7 @@

getEm
Source:
@@ -14834,7 +14834,7 @@

Source:
@@ -15099,7 +15099,7 @@

Source:
@@ -15364,7 +15364,7 @@

getJobSource:
@@ -15638,7 +15638,7 @@

getLogSource:
@@ -15907,7 +15907,7 @@

getLogsSource:
@@ -16414,7 +16414,7 @@

g
Source:
@@ -16638,7 +16638,7 @@

getR
Source:
@@ -16907,7 +16907,7 @@

get
Source:
@@ -17234,7 +17234,7 @@

getRoleSource:
@@ -17503,7 +17503,7 @@

getRolesSource:
@@ -18426,7 +18426,7 @@

getRul
Source:
@@ -18546,7 +18546,7 @@

getT
Source:
@@ -18730,7 +18730,7 @@

getUserSource:
@@ -18995,7 +18995,7 @@

getUserB
Source:
@@ -19264,7 +19264,7 @@

Source:
@@ -19533,7 +19533,7 @@

getUserLog
Source:
@@ -19908,7 +19908,7 @@

get
Source:
@@ -20283,7 +20283,7 @@

getUserRo
Source:
@@ -20793,6 +20793,42 @@

Parameters:
+ + + q + + + + + +String + + + + + + + + + <optional>
+ + + + + + + + + + + +

User Search string to filter which users are returned. Follows Lucene query string syntax as documented at https://auth0.com/docs/api/management/v2#!/Users/get_users.

+ + + + + + per_page @@ -20962,6 +20998,7 @@
Example
// Pagination settings.
 var params = {
   search_engine: 'v3',
+  q: 'name:*jane*',
   per_page: 10,
   page: 0
 };
@@ -21022,7 +21059,7 @@ 

getUse
Source:
@@ -21243,7 +21280,7 @@

getUser
Source:
@@ -21468,7 +21505,7 @@

importUser
Source:
@@ -21766,7 +21803,7 @@

linkUsersSource:
@@ -22101,7 +22138,7 @@

Source:
@@ -22366,7 +22403,7 @@

Source:
@@ -22745,7 +22782,7 @@

Source:
@@ -23102,7 +23139,7 @@

re
Source:
@@ -23459,7 +23496,7 @@

Source:
@@ -23730,7 +23767,7 @@

setRule
Source:
@@ -24087,7 +24124,7 @@

unblockUse
Source:
@@ -24356,7 +24393,7 @@

unblockUse
Source:
@@ -24625,7 +24662,7 @@

unlinkUser
Source:
@@ -24948,7 +24985,7 @@

upda
Source:
@@ -26179,7 +26216,7 @@

up
Source:
@@ -26432,7 +26469,7 @@

u
Source:
@@ -26738,7 +26775,7 @@

u
Source:
@@ -27044,7 +27081,7 @@

updateRole<
Source:
@@ -27654,7 +27691,7 @@

u
Source:
@@ -27870,7 +27907,7 @@

updateUser<
Source:
@@ -28176,7 +28213,7 @@

upd
Source:
@@ -28485,7 +28522,7 @@

ver
Source:
@@ -28723,7 +28760,7 @@

Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html index 0bc8a8c57..5ba74d760 100644 --- a/docs/module-management.ManagementTokenProvider.html +++ b/docs/module-management.ManagementTokenProvider.html @@ -24,7 +24,7 @@
@@ -633,7 +633,7 @@
Returns:

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:52 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html index 2c1797c00..f4fc61b4f 100644 --- a/docs/module-management.PromptsManager.html +++ b/docs/module-management.PromptsManager.html @@ -24,7 +24,7 @@
@@ -942,7 +942,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:52 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html index baaa0ac04..e42f1ad73 100644 --- a/docs/module-management.ResourceServersManager.html +++ b/docs/module-management.ResourceServersManager.html @@ -24,7 +24,7 @@
@@ -1904,7 +1904,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:52 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html index 81528cc9f..e692664d3 100644 --- a/docs/module-management.RetryRestClient.html +++ b/docs/module-management.RetryRestClient.html @@ -24,7 +24,7 @@
@@ -377,7 +377,7 @@
Parameters:

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:52 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html index 5ce3055a3..b317adf6b 100644 --- a/docs/module-management.RolesManager.html +++ b/docs/module-management.RolesManager.html @@ -24,7 +24,7 @@
@@ -4217,7 +4217,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:52 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html index 94b575198..2726df133 100644 --- a/docs/module-management.RulesConfigsManager.html +++ b/docs/module-management.RulesConfigsManager.html @@ -24,7 +24,7 @@
@@ -1317,7 +1317,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:52 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html index 960660cb2..a09255828 100644 --- a/docs/module-management.RulesManager.html +++ b/docs/module-management.RulesManager.html @@ -24,7 +24,7 @@
@@ -1910,7 +1910,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:52 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html index e8b765825..127f05c26 100644 --- a/docs/module-management.StatsManager.html +++ b/docs/module-management.StatsManager.html @@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:52 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html index 32be39197..6dae361c1 100644 --- a/docs/module-management.TenantManager.html +++ b/docs/module-management.TenantManager.html @@ -24,7 +24,7 @@
@@ -871,7 +871,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:52 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html index 8600f2c9f..5309933fb 100644 --- a/docs/module-management.TicketsManager.html +++ b/docs/module-management.TicketsManager.html @@ -24,7 +24,7 @@
@@ -805,7 +805,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:52 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html index e65dc5ff5..14ffb1a71 100644 --- a/docs/module-management.UserBlocksManager.html +++ b/docs/module-management.UserBlocksManager.html @@ -24,7 +24,7 @@
@@ -1432,7 +1432,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:52 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html index 8b693473a..1f67aaad9 100644 --- a/docs/module-management.UsersManager.html +++ b/docs/module-management.UsersManager.html @@ -24,7 +24,7 @@
@@ -5753,7 +5753,7 @@
Example

- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:52 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.html b/docs/module-management.html index ecf1efd0f..47af76a22 100644 --- a/docs/module-management.html +++ b/docs/module-management.html @@ -24,7 +24,7 @@
@@ -165,7 +165,7 @@

Classes


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-utils.html b/docs/module-utils.html index 8d919d4f5..186f51281 100644 --- a/docs/module-utils.html +++ b/docs/module-utils.html @@ -24,7 +24,7 @@
@@ -447,7 +447,7 @@

(static)
- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:52 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/utils.js.html b/docs/utils.js.html index b71efcb9f..8e73241cd 100644 --- a/docs/utils.js.html +++ b/docs/utils.js.html @@ -24,7 +24,7 @@
@@ -168,7 +168,7 @@

utils.js


- Generated by JSDoc 3.6.3 on Tue Sep 17 2019 12:48:42 GMT-0700 (Pacific Daylight Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Wed Jan 15 2020 11:28:51 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/package.json b/package.json index ae3fa1323..88f40f6cd 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "auth0", - "version": "2.20.0", + "version": "2.21.0", "description": "SDK for Auth0 API v2", "main": "src/index.js", "files": [