From 7d2f5f95b3476645db00574f4e96fbbf2886659d Mon Sep 17 00:00:00 2001 From: davidpatrick Date: Fri, 21 Feb 2020 15:16:01 -0800 Subject: [PATCH] Release v2.23.0 --- CHANGELOG.md | 21 + docs/RetryRestClient.js.html | 4 +- docs/auth_DatabaseAuthenticator.js.html | 4 +- docs/auth_OAUthWithIDTokenValidation.js.html | 4 +- docs/auth_OAuthAuthenticator.js.html | 4 +- docs/auth_PasswordlessAuthenticator.js.html | 4 +- docs/auth_TokensManager.js.html | 4 +- docs/auth_UsersManager.js.html | 4 +- docs/auth_idToken.js.html | 4 +- docs/auth_index.js.html | 16 +- docs/errors.js.html | 4 +- docs/external-RestClient.html | 4 +- docs/global.html | 4 +- docs/index.html | 4 +- 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_HooksManager.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 | 19 +- 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 | 89 +- docs/module-auth.AuthenticationClient.html | 74 +- docs/module-auth.DatabaseAuthenticator.html | 4 +- ...odule-auth.OAUthWithIDTokenValidation.html | 4 +- docs/module-auth.OAuthAuthenticator.html | 4 +- ...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 | 6 +- docs/module-management.GuardianManager.html | 4 +- docs/module-management.HooksManager.html | 4 +- docs/module-management.JobsManager.html | 4 +- docs/module-management.LogsManager.html | 4 +- docs/module-management.ManagementClient.html | 1197 +++++++++++++---- ...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 | 94 +- ...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 +- 81 files changed, 1356 insertions(+), 450 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d76602562..4b1551371 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,26 @@ # Change Log +## [v2.23.0](https://github.com/auth0/node-auth0/tree/v2.23.0) (2020-02-21) + +**Added** + +- [DXEX-455] Allow custom headers to be set in Management/Auth Clients. [\#460](https://github.com/auth0/node-auth0/pull/460) ([seejee](https://github.com/seejee)) + +**Changed** + +- Updates node-jwks-rsa [\#461](https://github.com/auth0/node-auth0/pull/461) ([davidpatrick](https://github.com/davidpatrick)) + +**Fixed** + +- Update lru-memoizer dependency to avoid DeprecationWarning Buffer() [\#459](https://github.com/auth0/node-auth0/pull/459) ([jalie](https://github.com/jalie)) +- getUsersInRole Docs [\#457](https://github.com/auth0/node-auth0/pull/457) ([davidpatrick](https://github.com/davidpatrick)) + +**Security** + +- [Security] Bump codecov from 3.5.0 to 3.6.5 [\#462](https://github.com/auth0/node-auth0/pull/462) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) + +[Full Changelog](https://github.com/auth0/node-auth0/compare/v2.22.0...v2.23.0) + ## [v2.22.0](https://github.com/auth0/node-auth0/tree/v2.22.0) (2020-01-24) **Added** diff --git a/docs/RetryRestClient.js.html b/docs/RetryRestClient.js.html index 52e83d11a..827559651 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_DatabaseAuthenticator.js.html b/docs/auth_DatabaseAuthenticator.js.html index f679831c1..111473081 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_OAUthWithIDTokenValidation.js.html b/docs/auth_OAUthWithIDTokenValidation.js.html index 8c6d7eccf..7a6a952c4 100644 --- a/docs/auth_OAUthWithIDTokenValidation.js.html +++ b/docs/auth_OAUthWithIDTokenValidation.js.html @@ -24,7 +24,7 @@
@@ -176,7 +176,7 @@

auth/OAUthWithIDTokenValidation.js


- Generated by JSDoc 3.6.3 on Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html index 6d4a4b199..28be0c6d2 100644 --- a/docs/auth_OAuthAuthenticator.js.html +++ b/docs/auth_OAuthAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -455,7 +455,7 @@

auth/OAuthAuthenticator.js


- Generated by JSDoc 3.6.3 on Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html index b1a0b3dd0..21283209d 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html index 0184b4eb4..4a26f20fb 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html index 3364db4d0..11b4dc7ef 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_idToken.js.html b/docs/auth_idToken.js.html index bae452ab4..3a5c7f345 100644 --- a/docs/auth_idToken.js.html +++ b/docs/auth_idToken.js.html @@ -24,7 +24,7 @@
@@ -202,7 +202,7 @@

auth/idToken.js


- Generated by JSDoc 3.6.3 on Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html index 5b1ec5717..4e891958c 100644 --- a/docs/auth_index.js.html +++ b/docs/auth_index.js.html @@ -24,7 +24,7 @@
@@ -45,6 +45,7 @@

auth/index.js

var utils = require('../utils'); var jsonToBase64 = utils.jsonToBase64; var ArgumentError = require('rest-facade').ArgumentError; +var assign = Object.assign || require('object.assign'); // Authenticators. var OAuthAuthenticator = require('./OAuthAuthenticator'); @@ -84,6 +85,7 @@

auth/index.js

* @param {String} [options.clientSecret] Default client Secret. * @param {String} [options.supportedAlgorithms] Algorithms that your application expects to receive * @param {Boolean} [options.__bypassIdTokenValidation] Whether the id_token should be validated or not + * @param {Object} [options.headers] Additional headers that will be added to the outgoing requests. */ var AuthenticationClient = function(options) { if (!options || typeof options !== 'object') { @@ -94,14 +96,16 @@

auth/index.js

throw new ArgumentError('Must provide a domain'); } + var defaultHeaders = { + 'User-agent': 'node.js/' + process.version.replace('v', ''), + 'Content-Type': 'application/json' + }; + var managerOptions = { clientId: options.clientId, domain: options.domain, clientSecret: options.clientSecret, - headers: { - 'User-agent': 'node.js/' + process.version.replace('v', ''), - 'Content-Type': 'application/json' - }, + headers: assign(defaultHeaders, options.headers || {}), baseUrl: util.format(BASE_URL_FORMAT, options.domain), supportedAlgorithms: options.supportedAlgorithms, __bypassIdTokenValidation: options.__bypassIdTokenValidation @@ -603,7 +607,7 @@

auth/index.js


- Generated by JSDoc 3.6.3 on Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/errors.js.html b/docs/errors.js.html index 2e7795380..ee8bcd1f0 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html index 73059f90a..24f35312c 100644 --- a/docs/external-RestClient.html +++ b/docs/external-RestClient.html @@ -24,7 +24,7 @@
@@ -1639,7 +1639,7 @@


- Generated by JSDoc 3.6.3 on Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/global.html b/docs/global.html index 680051818..3237012ad 100644 --- a/docs/global.html +++ b/docs/global.html @@ -24,7 +24,7 @@
@@ -423,7 +423,7 @@
Returns:

- Generated by JSDoc 3.6.3 on Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/index.html b/docs/index.html index 449f49a74..27373ba00 100644 --- a/docs/index.html +++ b/docs/index.html @@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@

License


- Generated by JSDoc 3.6.3 on Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/index.js.html b/docs/index.js.html index e0ab2fe19..227d299ed 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html index 33e7415e5..8dea1c859 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_BrandingManager.js.html b/docs/management_BrandingManager.js.html index 8ac9b7165..aa7f6cdbb 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html index aa2876bba..66972579c 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html index 41565ceb8..83dff6425 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html index 2d5c37139..1bbed4270 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html index b6d38b8d3..a0f690e6e 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html index cf867c92c..da46a9b79 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html index 0e2e20576..60879bb61 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html index 42e3661bc..f7d2844e5 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html index f1ad9b4d9..98eb4c31e 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html index f3a4f30be..5c28db391 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_HooksManager.js.html b/docs/management_HooksManager.js.html index aae8164b8..7e6239bf4 100644 --- a/docs/management_HooksManager.js.html +++ b/docs/management_HooksManager.js.html @@ -24,7 +24,7 @@
@@ -419,7 +419,7 @@

management/HooksManager.js


- Generated by JSDoc 3.6.3 on Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html index 21b86972b..7dd3eca9a 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html index 8c8de9abd..c41174636 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html index 33e8fe17f..99bec8cb2 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html index 54f907bd3..8a8573820 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html index b96cd31fc..82255a129 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html index b97a2ba54..b7b81d63c 100644 --- a/docs/management_RolesManager.js.html +++ b/docs/management_RolesManager.js.html @@ -24,7 +24,7 @@
@@ -375,16 +375,23 @@

management/RolesManager.js

* @memberOf module:management.RolesManager.prototype * * @example - * params = {id : 'ROLE_ID'} + * var params = { + * roleId: 'ROLE_ID' + * per_page: 50, + * page: 0 + * }; + * * @example <caption> - * This method takes a roleId and returns the users with that role assigned + * This method takes a roleId and returns all users within that role * </caption> * - * management.roles.getUsers( {id : 'ROLE_ID'}, function (err, users) { + * management.roles.getUsers(params, function (err, users) { * console.log(users); * }); * - * @param {String} [email] Email address of user(s) to find + * @param {String} [roleId] Id of the role + * @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} @@ -453,7 +460,7 @@

management/RolesManager.js


- Generated by JSDoc 3.6.3 on Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html index bd1452f51..a40e3bdec 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html index ddc2ab3ab..f9d7ac9dd 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html index 775d65142..bbb23f9af 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html index a2970fb79..7ae0b9e16 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html index 7fd8f83d1..59f0536de 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html index 5959c37aa..04c4e7d8f 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html index 4f9191f45..86914e017 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_index.js.html b/docs/management_index.js.html index 5bb8ba090..7890e4c02 100644 --- a/docs/management_index.js.html +++ b/docs/management_index.js.html @@ -24,7 +24,7 @@
@@ -72,6 +72,7 @@

management/index.js

var CustomDomainsManager = require('./CustomDomainsManager'); var RolesManager = require('./RolesManager'); var HooksManager = require('./HooksManager'); +var BrandingManager = require('./BrandingManager'); var BASE_URL_FORMAT = 'https://%s/api/v2'; var MANAGEMENT_API_AUD_FORMAT = 'https://%s/api/v2/'; @@ -130,6 +131,7 @@

management/index.js

* @param {Number} [options.tokenProvider.cacheTTLInSeconds] By default the `expires_in` value will be used to determine the cached time of the token, this can be overridden. * @param {Boolean} [options.retry.enabled=true] Enabled or Disable Retry Policy functionality. * @param {Number} [options.retry.maxRetries=10] Retry failed requests X times. + * @param {Object} [options.headers] Additional headers that will be added to the outgoing requests. * */ var ManagementClient = function(options) { @@ -142,11 +144,15 @@

management/index.js

} var baseUrl = util.format(BASE_URL_FORMAT, options.domain); + var userAgent = options.userAgent || 'node.js/' + process.version.replace('v', ''); + + var defaultHeaders = { + 'User-agent': 'node.js/' + process.version.replace('v', ''), + 'Content-Type': 'application/json' + }; + var managerOptions = { - headers: { - 'User-agent': 'node.js/' + process.version.replace('v', ''), - 'Content-Type': 'application/json' - }, + headers: assign(defaultHeaders, options.headers || {}), baseUrl: baseUrl }; @@ -354,6 +360,14 @@

management/index.js

* @type {HooksManager} */ this.hooks = new HooksManager(managerOptions); + + /** + * Simple abstraction for performing CRUD operations on the + * branding endpoint. + * + * @type {HooksManager} + */ + this.branding = new BrandingManager(managerOptions); }; /** @@ -2920,18 +2934,23 @@

management/index.js

* @memberOf module:management.ManagementClient.prototype * * @example - * var params = { id :'ROLE_ID'}; - * @example <caption> - * This method takes a roleId and - * returns all users within that role + * var params = { + * id: 'ROLE_ID' + * per_page: 50, + * page: 0 + * }; * + * @example <caption> + * This method takes a roleId and returns all users within that role * </caption> * * management.getUsersInRole(params, function (err, users) { * console.log(users); * }); * - * @param {String} [roleId] Id of the role + * @param {String} [id] Id of the role + * @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} @@ -3175,6 +3194,54 @@

management/index.js

*/ utils.wrapPropertyMethod(ManagementClient, 'getAccessToken', 'tokenProvider.getAccessToken'); +/** + * Update the branding settings. + * + * @method updateBrandingSettings + * @memberOf module:management.ManagementClient.prototype + * + * @example + * management.updateBrandingSettings(data, function (err, branding) { + * if (err) { + * // Handle error. + * } + * + * // Updated branding + * console.log(branding); + * }); + * + * @param {Object} params Branding parameters. + * @param {Object} data Updated branding data. + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod(ManagementClient, 'updateBrandingSettings', 'branding.updateSettings'); + +/** + * Get the branding settings.. + * + * @method getBrandingSettings + * @memberOf module:management.ManagementClient.prototype + * + * @example + * management.getBrandingSettings(data, function (err, branding) { + * if (err) { + * // Handle error. + * } + * + * // Branding + * console.log(branding); + * }); + * + * @param {Object} params Branding parameters. + * @param {Object} data Branding data. + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod(ManagementClient, 'getBrandingSettings', 'branding.getSettings'); + module.exports = ManagementClient; @@ -3188,7 +3255,7 @@

management/index.js


- Generated by JSDoc 3.6.3 on Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html index adce3aae2..1a249b9b8 100644 --- a/docs/module-auth.AuthenticationClient.html +++ b/docs/module-auth.AuthenticationClient.html @@ -24,7 +24,7 @@
@@ -103,7 +103,7 @@

n
Source:
@@ -367,6 +367,42 @@

Parameters:
+ + + + headers + + + + + +Object + + + + + + + + + <optional>
+ + + + + + + + + + + +

Additional headers that will be added to the outgoing requests.

+ + + + + @@ -472,7 +508,7 @@

databaseSource:
@@ -546,7 +582,7 @@

oauthSource:
@@ -620,7 +656,7 @@

passwordl
Source:
@@ -694,7 +730,7 @@

tokensSource:
@@ -768,7 +804,7 @@

usersSource:
@@ -852,7 +888,7 @@

changeP
Source:
@@ -1142,7 +1178,7 @@

Source:
@@ -1422,7 +1458,7 @@

get
Source:
@@ -1738,7 +1774,7 @@

getProfile<
Source:
@@ -1916,7 +1952,7 @@

password
Source:
@@ -2237,7 +2273,7 @@

refreshTo
Source:
@@ -2474,7 +2510,7 @@

Source:
@@ -2736,7 +2772,7 @@

reque
Source:
@@ -3017,7 +3053,7 @@

request
Source:
@@ -3533,7 +3569,7 @@

verifySM
Source:
@@ -3822,7 +3858,7 @@

Examples

- Generated by JSDoc 3.6.3 on Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html index c09d487de..03f1b827a 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html index a7ada05a7..b13a7ff10 100644 --- a/docs/module-auth.OAUthWithIDTokenValidation.html +++ b/docs/module-auth.OAUthWithIDTokenValidation.html @@ -24,7 +24,7 @@
@@ -450,7 +450,7 @@
Parameters:

- Generated by JSDoc 3.6.3 on Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html index 5eaa64bd7..137ac0644 100644 --- a/docs/module-auth.OAuthAuthenticator.html +++ b/docs/module-auth.OAuthAuthenticator.html @@ -24,7 +24,7 @@
@@ -2050,7 +2050,7 @@
Returns:

- Generated by JSDoc 3.6.3 on Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html index b2d67bd02..d9d7a0caa 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html index 76674ecb2..ab644ea01 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html index b9694dd95..6a45cef6e 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.html b/docs/module-auth.html index 6a2924f69..9f85f6066 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-errors.html b/docs/module-errors.html index d913ebfba..839a6ffa1 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html index aa2d93dc3..f712ad34f 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html index 5dbb34192..7749a28e2 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html index 1e712b97a..ab7c65b3c 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html index 1e27293c9..17b79b863 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html index 67b9a81ee..8bc8c9788 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html index 1f7403e0e..f706a54c9 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html index ca8b0134e..055d68d56 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html index c70fca90b..57f0b20bf 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html index 46903741f..6b8792497 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html index c4e3f643e..4e2d3c000 100644 --- a/docs/module-management.GrantsManager.html +++ b/docs/module-management.GrantsManager.html @@ -24,7 +24,7 @@
@@ -842,7 +842,7 @@

deleteGran
Source:
@@ -1515,7 +1515,7 @@

Example

- Generated by JSDoc 3.6.3 on Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html index 5c94854c5..d16aad48a 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.HooksManager.html b/docs/module-management.HooksManager.html index effe0331e..feabe7dc3 100644 --- a/docs/module-management.HooksManager.html +++ b/docs/module-management.HooksManager.html @@ -24,7 +24,7 @@
@@ -3099,7 +3099,7 @@
Example

- Generated by JSDoc 3.6.3 on Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html index 3a2c74a51..40e262d57 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html index 215fc2a34..b63b5f5ad 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html index 46926257e..4c4449758 100644 --- a/docs/module-management.ManagementClient.html +++ b/docs/module-management.ManagementClient.html @@ -24,7 +24,7 @@
@@ -106,7 +106,7 @@

new M
Source:
@@ -600,6 +600,46 @@

Parameters:
+ + + + headers + + + + + +Object + + + + + + + + + <optional>
+ + + + + + + + + + + + + + + +

Additional headers that will be added to the outgoing requests.

+ + + + + @@ -723,7 +763,7 @@

blac
Source:
@@ -750,6 +790,81 @@

Type:
+
+ + + +
+

branding :HooksManager

+ + + + +
+

Simple abstraction for performing CRUD operations on the +branding endpoint.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+
    +
  • + +HooksManager + + +
    • +
+ + + + +
@@ -798,7 +913,7 @@

clientGra
Source:
@@ -873,7 +988,7 @@

clientsSource:
@@ -948,7 +1063,7 @@

connection
Source:
@@ -1023,7 +1138,7 @@

customDo
Source:
@@ -1098,7 +1213,7 @@

devi
Source:
@@ -1173,7 +1288,7 @@

emailPro
Source:
@@ -1248,7 +1363,7 @@

emailTe
Source:
@@ -1323,7 +1438,7 @@

grantsSource:
@@ -1398,7 +1513,7 @@

guardianSource:
@@ -1473,7 +1588,7 @@

hooksSource:
@@ -1547,7 +1662,7 @@

jobsSource:
@@ -1621,7 +1736,7 @@

logsSource:
@@ -1696,7 +1811,7 @@

resour
Source:
@@ -1771,7 +1886,7 @@

rolesSource:
@@ -1846,7 +1961,7 @@

rulesSource:
@@ -1920,7 +2035,7 @@

rulesConf
Source:
@@ -1994,7 +2109,7 @@

statsSource:
@@ -2068,7 +2183,7 @@

tenantSource:
@@ -2142,7 +2257,7 @@

ticketsSource:
@@ -2217,7 +2332,7 @@

userBlocks<
Source:
@@ -2292,7 +2407,7 @@

usersSource:
@@ -2376,7 +2491,7 @@

addHookS
Source:
@@ -2681,7 +2796,7 @@

a
Source:
@@ -3060,7 +3175,7 @@

Source:
@@ -3417,7 +3532,7 @@

assi
Source:
@@ -3774,7 +3889,7 @@

blackli
Source:
@@ -4074,7 +4189,7 @@

Source:
@@ -4292,7 +4407,7 @@

createCli
Source:
@@ -4510,7 +4625,7 @@

crea
Source:
@@ -4728,7 +4843,7 @@

creat
Source:
@@ -4946,7 +5061,7 @@

cre
Source:
@@ -5164,7 +5279,7 @@

Source:
@@ -5382,7 +5497,7 @@

cr
Source:
@@ -5598,7 +5713,7 @@

Source:
@@ -5782,7 +5897,7 @@

Source:
@@ -5962,7 +6077,7 @@

createHook<
Source:
@@ -6180,7 +6295,7 @@

Source:
@@ -6372,7 +6487,7 @@

c
Source:
@@ -6590,7 +6705,7 @@

createRole<
Source:
@@ -6809,7 +6924,7 @@

createRule<
Source:
@@ -7027,7 +7142,7 @@

createUser<
Source:
@@ -7247,7 +7362,7 @@

deleteA
Source:
@@ -7431,7 +7546,7 @@

deleteCli
Source:
@@ -7700,7 +7815,7 @@

dele
Source:
@@ -7969,7 +8084,7 @@

delet
Source:
@@ -8238,7 +8353,7 @@

del
Source:
@@ -8507,7 +8622,7 @@

Source:
@@ -8778,7 +8893,7 @@

de
Source:
@@ -8962,7 +9077,7 @@

Source:
@@ -9231,7 +9346,7 @@

deleteHook<
Source:
@@ -9500,7 +9615,7 @@

d
Source:
@@ -9769,7 +9884,7 @@

deleteRole<
Source:
@@ -10038,7 +10153,7 @@

deleteRule<
Source:
@@ -10307,7 +10422,7 @@

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

deleteUser<
Source:
@@ -10845,7 +10960,7 @@

Source:
@@ -11146,7 +11261,7 @@

Source:
@@ -11443,7 +11558,7 @@

exportUser
Source:
@@ -11857,7 +11972,7 @@

getAcce
Source:
@@ -11965,7 +12080,7 @@

ge
Source:
@@ -12149,7 +12264,7 @@

g
Source:
@@ -12286,14 +12401,14 @@

Example
-

getClient(params, cbopt) → {Promise|undefined}

+

getBrandingSettings(params, data, cbopt) → {Promise|undefined}

-

Get an Auth0 client.

+

Get the branding settings..

@@ -12329,7 +12444,7 @@

getClientSource:
@@ -12400,58 +12515,41 @@
Parameters:
-

Client parameters.

+

Branding parameters.

- - - - - - - - - - - - - - - - - - + + - - + + - + + - - -
NameTypeDescription
client_iddata -String +Object + - + - -

Application client ID.

-
+ + +

Branding data.

@@ -12538,12 +12636,13 @@
Returns:
Example
- 
management.getClient({ client_id: CLIENT_ID }, function (err, client) {
+    
management.getBrandingSettings(data, function (err, branding) {
   if (err) {
     // Handle error.
   }
 
-  console.log(client);
+// Branding
+   console.log(branding);
 });
@@ -12555,14 +12654,14 @@
Example
-

getClientGrants(paramsopt, cbopt) → {Promise|undefined}

+

getClient(params, cbopt) → {Promise|undefined}

-

Get all Auth0 Client Grants.

+

Get an Auth0 client.

@@ -12598,7 +12697,7 @@

getCli
Source:
@@ -12659,8 +12758,6 @@

Parameters:
- <optional>
- @@ -12671,7 +12768,7 @@
Parameters:
-

Client Grants parameters.

+

Client parameters.

@@ -12685,8 +12782,6 @@
Parameters:
Type - Attributes - @@ -12699,70 +12794,24 @@
Parameters:
- per_page - - - - - -Number - - - - - - - - - <optional>
- - - - - - - - - - - -

Number of results per page.

- - - - - - - - - page + client_id -Number +String - - - <optional>
- - - - - - - -

Page number, zero indexed.

+

Application client ID.

@@ -12857,20 +12906,12 @@
Returns:
Example
-

- This method takes an optional object as first argument that may be used to - specify pagination settings. If pagination options are not present, - the first page of a limited number of results will be returned. -

- - 
// Pagination settings.
-var params = {
-  per_page: 10,
-  page: 0
-};
+    
management.getClient({ client_id: CLIENT_ID }, function (err, client) {
+  if (err) {
+    // Handle error.
+  }
 
-management.getClientGrants(params, function (err, grants) {
-  console.log(grants.length);
+  console.log(client);
 });
@@ -12882,14 +12923,14 @@
Example
-

getClients(paramsopt, cbopt) → {Promise|undefined}

+

getClientGrants(paramsopt, cbopt) → {Promise|undefined}

-

Get all Auth0 clients.

+

Get all Auth0 Client Grants.

@@ -12925,7 +12966,7 @@

getClients<
Source:
@@ -12998,7 +13039,7 @@

Parameters:
-

Clients parameters.

+

Client Grants parameters.

@@ -13196,8 +13237,8 @@
Example
page: 0 }; -management.getClients(params, function (err, clients) { - console.log(clients.length); +management.getClientGrants(params, function (err, grants) { + console.log(grants.length); });

@@ -13209,14 +13250,14 @@
Example
-

getConnection(params, cbopt) → {Promise|undefined}

+

getClients(paramsopt, cbopt) → {Promise|undefined}

-

Get an Auth0 connection.

+

Get all Auth0 clients.

@@ -13252,7 +13293,7 @@

getConne
Source:
@@ -13313,6 +13354,8 @@

Parameters:
+ <optional>
+ @@ -13323,7 +13366,7 @@
Parameters:
-

Connection parameters.

+

Clients parameters.

@@ -13337,6 +13380,8 @@
Parameters:
Type + Attributes + @@ -13349,7 +13394,330 @@
Parameters:
- id + per_page + + + + + +Number + + + + + + + + + <optional>
+ + + + + + + + + + + +

Number of results per page.

+ + + + + + + + + page + + + + + +Number + + + + + + + + + <optional>
+ + + + + + + + + + + +

Page number, zero indexed.

+ + + + + + + + + + + + + + + + + cb + + + + + +function + + + + + + + + + <optional>
+ + + + + + + + + + + +

Callback function.

+ + + + + + + + + + + + + + + + + + + + + +
+
Returns:
+ + + +
+
+ Type: +
+
+ +Promise +| + +undefined + + +
+
+ + + +
+ + + +
+
Example
+ +

+ This method takes an optional object as first argument that may be used to + specify pagination settings. If pagination options are not present, + the first page of a limited number of results will be returned. +

+ + 
// Pagination settings.
+var params = {
+  per_page: 10,
+  page: 0
+};
+
+management.getClients(params, function (err, clients) {
+  console.log(clients.length);
+});
+ +
+ +
+ + +
+ + + +

getConnection(params, cbopt) → {Promise|undefined}

+ + + + + +
+

Get an Auth0 connection.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -3130,13 +3202,17 @@
Returns:
Examples
- 
params = {id : 'ROLE_ID'}
+ 
var params = {
+  roleId: 'ROLE_ID'
+  per_page: 50,
+  page: 0
+};

- This method takes a roleId and returns the users with that role assigned + This method takes a roleId and returns all users within that role

- 
management.roles.getUsers( {id : 'ROLE_ID'}, function (err, users) {
+    
management.roles.getUsers(params, function (err, users) {
   console.log(users);
 });

 
@@ -4217,7 +4293,7 @@ 
Example

 

 
 

-    Generated by JSDoc 3.6.3 on Fri Jan 24 2020 10:30:34 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
index 15c7fecf1..b976ae251 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 Fri Jan 24 2020 10:30:34 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
index acb5eb2c4..df521ae84 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 Fri Jan 24 2020 10:30:34 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
index 8f7737fd9..fad5d77dd 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 Fri Jan 24 2020 10:30:34 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
index 455916f8b..07a8228a0 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 Fri Jan 24 2020 10:30:34 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
index 736238f74..c127cb06c 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 Fri Jan 24 2020 10:30:34 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html
index 41f587391..721dd8d41 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 Fri Jan 24 2020 10:30:34 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
index 05255a6c6..1190c6617 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 Fri Jan 24 2020 10:30:34 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-management.html b/docs/module-management.html
index 3a31c0ec9..3a337ac36 100644
--- a/docs/module-management.html
+++ b/docs/module-management.html
@@ -24,7 +24,7 @@
 
 
 
 
 

@@ -168,7 +168,7 @@ 
Classes

 

 
 

-    Generated by JSDoc 3.6.3 on Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/module-utils.html b/docs/module-utils.html
index aa457d8d2..5aef78c60 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 Fri Jan 24 2020 10:30:34 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/docs/utils.js.html b/docs/utils.js.html
index b144f6e24..c67354430 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
 

 
 
diff --git a/package.json b/package.json
index 34ff5296c..70498370b 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "auth0",
-  "version": "2.22.0",
+  "version": "2.23.0",
   "description": "SDK for Auth0 API v2",
   "main": "src/index.js",
   "files": [
NameTypeAttributesDescription
params + + +Object + + + + + + + + + + +

Connection parameters.

+ + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + @@ -23173,12 +23613,14 @@
Returns:
Examples
- 
var params =  { id :'ROLE_ID'};
+ 
var params = {
+  id: 'ROLE_ID'
+  per_page: 50,
+  page: 0
+};

- This method takes a roleId and - returns all users within that role - + This method takes a roleId and returns all users within that role 

management.getUsersInRole(params, function (err, users) {
@@ -23238,7 +23680,7 @@ 
importUser
     
     
Source:

     

     
 
@@ -23536,7 +23978,7 @@ 
linkUsersSource:
     

     
 
@@ -23871,7 +24313,7 @@ 
Source:
     

     
 
@@ -24136,7 +24578,7 @@ 
remo
     
     
Source:

     

     
 
@@ -24441,7 +24883,7 @@ 
Source:
     

     
 
@@ -24820,7 +25262,7 @@ 
Source:
     

     
 
@@ -25177,7 +25619,7 @@ 
re
     
     
Source:

     

     
 
@@ -25534,7 +25976,7 @@ 

     
     
Source:

     

     
 
@@ -25805,7 +26247,7 @@ 
setRule
     
     
Source:

     

     
 
@@ -26162,7 +26604,7 @@ 
unblockUse
     
     
Source:

     

     
 
@@ -26431,7 +26873,7 @@ 
unblockUse
     
     
Source:

     

     
 
@@ -26700,7 +27142,7 @@ 
unlinkUser
     
     
Source:

     

     
 
@@ -27023,7 +27465,7 @@ 
upda
     
     
Source:

     

     
 
@@ -27285,6 +27727,259 @@ 
Example
+
+ + + +

updateBrandingSettings(params, data, cbopt) → {Promise|undefined}

+ + + + + +
+

Update the branding settings.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + +
NameTypeDescription
id @@ -13521,7 +13889,7 @@

getConn
Source:
@@ -13848,7 +14216,7 @@

getCus
Source:
@@ -14117,7 +14485,7 @@

getCu
Source:
@@ -14233,7 +14601,7 @@

getDaily
Source:
@@ -14533,7 +14901,7 @@

g
Source:
@@ -14713,7 +15081,7 @@

getEm
Source:
@@ -15028,7 +15396,7 @@

getEm
Source:
@@ -15297,7 +15665,7 @@

getGrantsSource:
@@ -15701,7 +16069,7 @@

Source:
@@ -15966,7 +16334,7 @@

Source:
@@ -16231,7 +16599,7 @@

getHookSource:
@@ -16500,7 +16868,7 @@

getHooksSource:
@@ -16827,7 +17195,7 @@

getHook
Source:
@@ -17097,7 +17465,7 @@

getJobSource:
@@ -17371,7 +17739,7 @@

getLogSource:
@@ -17640,7 +18008,7 @@

getLogsSource:
@@ -18147,7 +18515,7 @@

g
Source:
@@ -18371,7 +18739,7 @@

getR
Source:
@@ -18640,7 +19008,7 @@

get
Source:
@@ -18967,7 +19335,7 @@

getRoleSource:
@@ -19236,7 +19604,7 @@

getRolesSource:
@@ -19563,7 +19931,7 @@

getRuleSource:
@@ -19832,7 +20200,7 @@

getRulesSource:
@@ -20159,7 +20527,7 @@

getRul
Source:
@@ -20279,7 +20647,7 @@

getT
Source:
@@ -20463,7 +20831,7 @@

getUserSource:
@@ -20728,7 +21096,7 @@

getUserB
Source:
@@ -20997,7 +21365,7 @@

Source:
@@ -21266,7 +21634,7 @@

getUserLog
Source:
@@ -21641,7 +22009,7 @@

get
Source:
@@ -22016,7 +22384,7 @@

getUserRo
Source:
@@ -22391,7 +22759,7 @@

getUsersSource:
@@ -22792,7 +23160,7 @@

getUse
Source:
@@ -22970,7 +23338,7 @@

Example
-

getUsersInRole(roleIdopt, cbopt) → {Promise|undefined}

+

getUsersInRole(idopt, cbopt) → {Promise|undefined}

@@ -23013,7 +23381,7 @@

getUser
Source:
@@ -23054,18 +23422,90 @@

Parameters:

id + + +String + + + + + + <optional>
+ + + + + + 		+

Id of the role

+ +
params.per_page + + +Number + + + + + + <optional>
+ + + + + + 		+

Number of results per page.

+ +
roleIdparams.page -String +Number @@ -23086,7 +23526,7 @@
Parameters:
 -

Id of the role

+

Page number, zero indexed.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
params + + +Object + + + + + + + + + + +

Branding parameters.

+ +
data + + +Object + + + + + + + + + + +

Updated branding data.

+ +
cb + + +function + + + + + + <optional>
+ + + + + + 		+

Callback function.

+ +
+ + + + + + + + + + + + + + +
+
Returns:
+ + + +
+
+ Type: +
+
+ +Promise +| + +undefined + + +
+
+ + + +
+ + + +
+
Example
+ + 
management.updateBrandingSettings(data, function (err, branding) {
+  if (err) {
+    // Handle error.
+  }
+
+// Updated branding
+   console.log(branding);
+});
+ +
+ + + +
@@ -27332,7 +28027,7 @@

updateCli
Source:
@@ -27638,7 +28333,7 @@

upda
Source:
@@ -27948,7 +28643,7 @@

updat
Source:
@@ -28254,7 +28949,7 @@

up
Source:
@@ -28507,7 +29202,7 @@

u
Source:
@@ -28813,7 +29508,7 @@

updateHook<
Source:
@@ -29118,7 +29813,7 @@

upda
Source:
@@ -29423,7 +30118,7 @@

u
Source:
@@ -29729,7 +30424,7 @@

updateRole<
Source:
@@ -30034,7 +30729,7 @@

updateRule<
Source:
@@ -30339,7 +31034,7 @@

u
Source:
@@ -30555,7 +31250,7 @@

updateUser<
Source:
@@ -30861,7 +31556,7 @@

upd
Source:
@@ -31170,7 +31865,7 @@

ver
Source:
@@ -31408,7 +32103,7 @@

Example

- Generated by JSDoc 3.6.3 on Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html index 1ef1a73cd..cfb0e4aed 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 Fri Jan 24 2020 10:30:33 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html index 16a95b424..d3b0a7a49 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 Fri Jan 24 2020 10:30:34 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html index d07209c9a..0df0be4a8 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 Fri Jan 24 2020 10:30:34 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html index f957e3fbf..84acdc373 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 Fri Jan 24 2020 10:30:34 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.3 on Fri Feb 21 2020 15:15:58 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html index 037d5ff50..b4e0d9add 100644 --- a/docs/module-management.RolesManager.html +++ b/docs/module-management.RolesManager.html @@ -24,7 +24,7 @@
@@ -1282,7 +1282,7 @@

assignUser
Source:
@@ -2927,7 +2927,7 @@

Examples
-

getUsers(emailopt, cbopt) → {Promise|undefined}

+

getUsers(roleIdopt, cbopt) → {Promise|undefined}

@@ -3016,7 +3016,7 @@
Parameters:
emailroleId @@ -3043,7 +3043,79 @@
Parameters:
 -

Email address of user(s) to find

+

Id of the role

+ +
params.per_page + + +Number + + + + + + <optional>
+ + + + + + 		+

Number of results per page.

+ +
params.page + + +Number + + + + + + <optional>
+ + + + + + 		+

Page number, zero indexed.