From 0144fb3dc7545027f696f55d0ec689d49e0e8e18 Mon Sep 17 00:00:00 2001 From: David Patrick Date: Wed, 6 Jan 2021 10:41:14 -0800 Subject: [PATCH] Release v2.31.1 (#567) --- CHANGELOG.md | 14 + 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 | 4 +- docs/errors.js.html | 4 +- docs/external-RestClient.html | 4 +- docs/global.html | 4 +- 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_HooksManager.js.html | 4 +- docs/management_JobsManager.js.html | 4 +- docs/management_LogStreamsManager.js.html | 4 +- docs/management_LogsManager.js.html | 4 +- ...management_ManagementTokenProvider.js.html | 4 +- docs/management_MigrationsManager.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 | 61 +- docs/module-auth.AuthenticationClient.html | 4 +- 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 | 4 +- docs/module-management.GuardianManager.html | 4 +- docs/module-management.HooksManager.html | 4 +- docs/module-management.JobsManager.html | 278 ++++++++- docs/module-management.LogStreamsManager.html | 4 +- docs/module-management.LogsManager.html | 4 +- docs/module-management.ManagementClient.html | 567 +++++++++++++++--- ...le-management.ManagementTokenProvider.html | 4 +- docs/module-management.MigrationsManager.html | 4 +- docs/module-management.PromptsManager.html | 8 +- ...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 +- 85 files changed, 988 insertions(+), 260 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index aa76860ae..be335bb9f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,19 @@ # Change Log +## [v2.31.1](https://github.com/auth0/node-auth0/tree/v2.31.1) (2021-01-05) + +**Fixed** + +- Expose getJobErrors to management client [\#563](https://github.com/auth0/node-auth0/pull/563) ([davidaubin19](https://github.com/davidaubin19)) +- Fix passing a custom User-Agent to Axios. [\#562](https://github.com/auth0/node-auth0/pull/562) ([djanowski](https://github.com/djanowski)) +- Expose assignUsersToRole to ManagementClient [\#561](https://github.com/auth0/node-auth0/pull/561) ([davidaubin19](https://github.com/davidaubin19)) + +**Security** + +- [Security] Bump axios from 0.19.2 to 0.21.1 [\#565](https://github.com/auth0/node-auth0/pull/565) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview)) + +[Full Changelog](https://github.com/auth0/node-auth0/compare/v2.31.0...v2.31.1) + ## [v2.31.0](https://github.com/auth0/node-auth0/tree/v2.31.0) (2020-12-08) **Added** diff --git a/docs/RetryRestClient.js.html b/docs/RetryRestClient.js.html index 64e305b17..0eca15f60 100644 --- a/docs/RetryRestClient.js.html +++ b/docs/RetryRestClient.js.html @@ -24,7 +24,7 @@
@@ -159,7 +159,7 @@

RetryRestClient.js


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_DatabaseAuthenticator.js.html b/docs/auth_DatabaseAuthenticator.js.html index 05e6f1542..1a517a33d 100644 --- a/docs/auth_DatabaseAuthenticator.js.html +++ b/docs/auth_DatabaseAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -348,7 +348,7 @@

auth/DatabaseAuthenticator.js


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_OAUthWithIDTokenValidation.js.html b/docs/auth_OAUthWithIDTokenValidation.js.html index 143bc966d..8403edff6 100644 --- a/docs/auth_OAUthWithIDTokenValidation.js.html +++ b/docs/auth_OAUthWithIDTokenValidation.js.html @@ -24,7 +24,7 @@
@@ -175,7 +175,7 @@

auth/OAUthWithIDTokenValidation.js


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html index 94ffd8689..fa91f1d85 100644 --- a/docs/auth_OAuthAuthenticator.js.html +++ b/docs/auth_OAuthAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -461,7 +461,7 @@

auth/OAuthAuthenticator.js


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html index 8835fb28d..771732e2b 100644 --- a/docs/auth_PasswordlessAuthenticator.js.html +++ b/docs/auth_PasswordlessAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -320,7 +320,7 @@

auth/PasswordlessAuthenticator.js


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html index 92235c039..c88ff1922 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html index ef1a2cdc6..3c16961c3 100644 --- a/docs/auth_UsersManager.js.html +++ b/docs/auth_UsersManager.js.html @@ -24,7 +24,7 @@
@@ -223,7 +223,7 @@

auth/UsersManager.js


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_idToken.js.html b/docs/auth_idToken.js.html index ad1d8c66c..f19b993f7 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html index c5569bf05..9c87db9d6 100644 --- a/docs/auth_index.js.html +++ b/docs/auth_index.js.html @@ -24,7 +24,7 @@
@@ -615,7 +615,7 @@

auth/index.js


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/errors.js.html b/docs/errors.js.html index abdcc6a6a..222622d3b 100644 --- a/docs/errors.js.html +++ b/docs/errors.js.html @@ -24,7 +24,7 @@
@@ -111,7 +111,7 @@

errors.js


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html index d34e362fb..08f4074b0 100644 --- a/docs/external-RestClient.html +++ b/docs/external-RestClient.html @@ -24,7 +24,7 @@
@@ -1639,7 +1639,7 @@


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/global.html b/docs/global.html index 345c8793c..17caad953 100644 --- a/docs/global.html +++ b/docs/global.html @@ -24,7 +24,7 @@
@@ -423,7 +423,7 @@
Returns:

- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/index.html b/docs/index.html index 336b7d8f9..d52401aa5 100644 --- a/docs/index.html +++ b/docs/index.html @@ -24,7 +24,7 @@
@@ -61,7 +61,7 @@

Installation

Documentation

You can find this library documentation in this page.

-

For more information about auth0 check our documentation page.

+

For more information about auth0 check our documentation page.

Authentication API Client

This client must be used to access Auth0's Authentication API.

The AuthenticationClient constructor takes an optional client ID, if specified it will be used as default value for all endpoints that accept a client ID.

@@ -176,7 +176,7 @@

License


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/index.js.html b/docs/index.js.html index e8190fcf7..8cf330b4c 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html index c8aae6f5b..caf780a35 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_BrandingManager.js.html b/docs/management_BrandingManager.js.html index ae7c0fb3f..3f507d607 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html index 7c062b5de..313cb862f 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html index f731f1d2e..3e4d75e7f 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html index e03a84b26..c3be84314 100644 --- a/docs/management_ConnectionsManager.js.html +++ b/docs/management_ConnectionsManager.js.html @@ -24,7 +24,7 @@
@@ -284,7 +284,7 @@

management/ConnectionsManager.js


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html index 2d083bec4..2e4ba4804 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html index 90d8c7bda..c88a16cb6 100644 --- a/docs/management_DeviceCredentialsManager.js.html +++ b/docs/management_DeviceCredentialsManager.js.html @@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@

management/DeviceCredentialsManager.js


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html index d320b6555..b37bd9546 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html index 380c0dde4..7fb5964eb 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html index edf3ad769..2e492fab2 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html index e2a0efba2..308ddb778 100644 --- a/docs/management_GuardianManager.js.html +++ b/docs/management_GuardianManager.js.html @@ -24,7 +24,7 @@
@@ -508,7 +508,7 @@

management/GuardianManager.js


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_HooksManager.js.html b/docs/management_HooksManager.js.html index 68e0ac269..5e29bb560 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html index e893a7411..f9aa922fb 100644 --- a/docs/management_JobsManager.js.html +++ b/docs/management_JobsManager.js.html @@ -24,7 +24,7 @@
@@ -439,7 +439,7 @@

management/JobsManager.js


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_LogStreamsManager.js.html b/docs/management_LogStreamsManager.js.html index 50df79e57..764a1cb01 100644 --- a/docs/management_LogStreamsManager.js.html +++ b/docs/management_LogStreamsManager.js.html @@ -24,7 +24,7 @@
@@ -230,7 +230,7 @@

management/LogStreamsManager.js


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html index 63579190e..9e379af1b 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html index 3eb5b1e8b..fe2f9b3d6 100644 --- a/docs/management_ManagementTokenProvider.js.html +++ b/docs/management_ManagementTokenProvider.js.html @@ -24,7 +24,7 @@
@@ -194,7 +194,7 @@

management/ManagementTokenProvider.js


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_MigrationsManager.js.html b/docs/management_MigrationsManager.js.html index 78a082c55..2b794048d 100644 --- a/docs/management_MigrationsManager.js.html +++ b/docs/management_MigrationsManager.js.html @@ -24,7 +24,7 @@
@@ -159,7 +159,7 @@

management/MigrationsManager.js


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html index 52e507112..71ef1eb82 100644 --- a/docs/management_PromptsManager.js.html +++ b/docs/management_PromptsManager.js.html @@ -24,7 +24,7 @@
@@ -261,7 +261,7 @@

management/PromptsManager.js


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html index 58bbcbc67..863d2bf15 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html index b604eb0b5..3e9912553 100644 --- a/docs/management_RolesManager.js.html +++ b/docs/management_RolesManager.js.html @@ -24,7 +24,7 @@
@@ -460,7 +460,7 @@

management/RolesManager.js


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html index d38ab43b1..c2fc05926 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html index a76c48add..adf9ff60d 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html index aa2075a8b..a9c5970f8 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html index c934e47d9..3ff81bc64 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html index 4c8144ef0..18c4d7637 100644 --- a/docs/management_TicketsManager.js.html +++ b/docs/management_TicketsManager.js.html @@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@

management/TicketsManager.js


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html index d208fe567..8492126dd 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html index 48326f1b9..96d584a20 100644 --- a/docs/management_UsersManager.js.html +++ b/docs/management_UsersManager.js.html @@ -24,7 +24,7 @@
@@ -977,7 +977,7 @@

management/UsersManager.js


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/management_index.js.html b/docs/management_index.js.html index 08742f007..7a61a765f 100644 --- a/docs/management_index.js.html +++ b/docs/management_index.js.html @@ -24,7 +24,7 @@
@@ -1451,6 +1451,35 @@

management/index.js

*/ utils.wrapPropertyMethod(ManagementClient, 'assignRolestoUser', 'users.assignRoles'); +/** + * Assign users to a role + * + * @method assignUsersToRole + * @memberOf module:management.ManagementClient.prototype + * + * @example + * var params = { id :'ROLE_ID'}; + * var data = { "users" : ["userId1","userId2"]}; + * + * management.roles.assignUsers(params, data, function (err, user) { + * if (err) { + * // Handle error. + * } + * + * // permissions added. + * }); + * + * @param {String} params.id ID of the Role. + * @param {Object} data permissions data + * @param {String} data.permissions Array of permissions + * @param {String} data.permissions.permission_name Name of a permission + * @param {String} data.permissions.resource_server_identifier Identifier for a resource + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod(ManagementClient, 'assignUsersToRole', 'roles.assignUsers'); + /** * Remove roles from a user * @@ -2224,6 +2253,34 @@

management/index.js

*/ utils.wrapPropertyMethod(ManagementClient, 'exportUsers', 'jobs.exportUsers'); +/** + * Given a job ID, retrieve the failed/errored items + * + * @method errors + * @memberOf module:management.JobsManager.prototype + * + * @example + * var params = { + * id: '{JOB_ID}' + * }; + * + * management.jobs.errors(params, function (err, job) { + * if (err) { + * // Handle error. + * } + * + * // Retrieved job. + * console.log(job); + * }); + * + * @param {Object} params Job parameters. + * @param {String} params.id Job ID. + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod(ManagementClient, 'getJobErrors', 'jobs.errors'); + /** * Send a verification email to a user. * @@ -3749,7 +3806,7 @@

management/index.js


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html index 29c10d273..e8b5d111d 100644 --- a/docs/module-auth.AuthenticationClient.html +++ b/docs/module-auth.AuthenticationClient.html @@ -24,7 +24,7 @@
@@ -4207,7 +4207,7 @@
Examples

- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html index f12b64aee..99ffb9568 100644 --- a/docs/module-auth.DatabaseAuthenticator.html +++ b/docs/module-auth.DatabaseAuthenticator.html @@ -24,7 +24,7 @@
@@ -1765,7 +1765,7 @@
Example

- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html index 467f8b70e..6d53d0cb6 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html index c47defe12..59dd5da51 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html index b684b13a1..4dfd5cd83 100644 --- a/docs/module-auth.PasswordlessAuthenticator.html +++ b/docs/module-auth.PasswordlessAuthenticator.html @@ -24,7 +24,7 @@
@@ -1537,7 +1537,7 @@
Examples

- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html index 0d091baa4..8812d86f9 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html index e241a4c45..b53c258fe 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-auth.html b/docs/module-auth.html index f762aabe6..bad738bd4 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-errors.html b/docs/module-errors.html index f1847d707..dab1ef5b5 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html index cca7a3c1f..0cf706701 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html index 3bc95e61e..700c1597d 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html index cd7d683b1..55282ae96 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html index e8a13271b..2917e5aaa 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html index 65318555f..8085a325d 100644 --- a/docs/module-management.ConnectionsManager.html +++ b/docs/module-management.ConnectionsManager.html @@ -24,7 +24,7 @@
@@ -2269,7 +2269,7 @@
Example

- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html index 21dd9f6b6..0f052956b 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html index 1e180020c..6ba5d9fb7 100644 --- a/docs/module-management.DeviceCredentialsManager.html +++ b/docs/module-management.DeviceCredentialsManager.html @@ -24,7 +24,7 @@
@@ -1215,7 +1215,7 @@
Example

- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html index f7aa94edb..b34aca674 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html index ec2187953..4fbe4db35 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html index 2804cfda0..af6e04e36 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html index 7b2993036..56707c497 100644 --- a/docs/module-management.GuardianManager.html +++ b/docs/module-management.GuardianManager.html @@ -24,7 +24,7 @@
@@ -4415,7 +4415,7 @@
Example

- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.HooksManager.html b/docs/module-management.HooksManager.html index 53adb8f4d..6b2aa9c75 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html index 3860cfcae..2178b4a73 100644 --- a/docs/module-management.JobsManager.html +++ b/docs/module-management.JobsManager.html @@ -24,7 +24,7 @@
@@ -796,6 +796,280 @@
Parameters:
+
+
Returns:
+ + + +
+
+ Type: +
+
+ +Promise +| + +undefined + + +
+
+ + + +
+ + + +
+
Example
+ +
var params = {
+  id: '{JOB_ID}'
+};
+
+management.jobs.errors(params, function (err, job) {
+  if (err) {
+    // Handle error.
+  }
+
+  // Retrieved job.
+  console.log(job);
+});
+ +
+ +
+ + +
+ + + +

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

+ + + + + +
+

Given a job ID, retrieve the failed/errored items

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
params + + +Object + + + + + + + + + + +

Job parameters.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
id + + +String + + + + +

Job ID.

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

Callback function.

+ +
+ + + + + + + + + + + + + +
Returns:
@@ -2835,7 +3109,7 @@
Example

- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.LogStreamsManager.html b/docs/module-management.LogStreamsManager.html index 96a740e21..9c98bbb38 100644 --- a/docs/module-management.LogStreamsManager.html +++ b/docs/module-management.LogStreamsManager.html @@ -24,7 +24,7 @@
@@ -1763,7 +1763,7 @@
Example

- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html index bf9f3ed17..c6f6704db 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html index 59a552d06..b479a6092 100644 --- a/docs/module-management.ManagementClient.html +++ b/docs/module-management.ManagementClient.html @@ -24,7 +24,7 @@
@@ -2713,7 +2713,7 @@

addHookS
Source:
@@ -3018,7 +3018,7 @@

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

Source:
@@ -4064,6 +4064,389 @@
Example

+
+ + + +

assignUsersToRole(data, cbopt) → {Promise|undefined}

+ + + + + +
+

Assign users to a role

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
params.id + + +String + + + + + + + + + + +

ID of the Role.

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

permissions data

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
permissions + + +String + + + + +

Array of permissions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
permission_name + + +String + + + + +

Name of a permission

+ +
resource_server_identifier + + +String + + + + +

Identifier for a resource

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

Callback function.

+ +
+ + + + + + + + + + + + + + +
+
Returns:
+ + + +
+
+ Type: +
+
+ +Promise +| + +undefined + + +
+
+ + + +
+ + + +
+
Example
+ +
var params =  { id :'ROLE_ID'};
+var data = { "users" : ["userId1","userId2"]};
+
+management.roles.assignUsers(params, data, function (err, user) {
+  if (err) {
+    // Handle error.
+  }
+
+  // permissions added.
+});
+ +
+ +
+ +
@@ -4111,7 +4494,7 @@

blackli
Source:
@@ -4411,7 +4794,7 @@

Source:
@@ -5283,7 +5666,7 @@

cre
Source:
@@ -5719,7 +6102,7 @@

cr
Source:
@@ -5935,7 +6318,7 @@

Source:
@@ -6119,7 +6502,7 @@

Source:
@@ -6299,7 +6682,7 @@

createHook<
Source:
@@ -6517,7 +6900,7 @@

create
Source:
@@ -6735,7 +7118,7 @@

Source:
@@ -6927,7 +7310,7 @@

c
Source:
@@ -7145,7 +7528,7 @@

createRole<
Source:
@@ -8793,7 +9176,7 @@

del
Source:
@@ -9333,7 +9716,7 @@

de
Source:
@@ -9517,7 +9900,7 @@

Source:
@@ -9786,7 +10169,7 @@

deleteHook<
Source:
@@ -10055,7 +10438,7 @@

delete
Source:
@@ -10324,7 +10707,7 @@

d
Source:
@@ -10593,7 +10976,7 @@

deleteRole<
Source:
@@ -11131,7 +11514,7 @@

dele
Source:
@@ -12267,7 +12650,7 @@

exportUser
Source:
@@ -12681,7 +13064,7 @@

getAcce
Source:
@@ -12789,7 +13172,7 @@

ge
Source:
@@ -12973,7 +13356,7 @@

g
Source:
@@ -13153,7 +13536,7 @@

ge
Source:
@@ -14925,7 +15308,7 @@

getCus
Source:
@@ -15194,7 +15577,7 @@

getCu
Source:
@@ -15310,7 +15693,7 @@

getDaily
Source:
@@ -15826,7 +16209,7 @@

getEm
Source:
@@ -16141,7 +16524,7 @@

getEm
Source:
@@ -16814,7 +17197,7 @@

Source:
@@ -17079,7 +17462,7 @@

Source:
@@ -17344,7 +17727,7 @@

Source:
@@ -17558,7 +17941,7 @@

get
Source:
@@ -17738,7 +18121,7 @@

Source:
@@ -17952,7 +18335,7 @@

Source:
@@ -18132,7 +18515,7 @@

Source:
@@ -18312,7 +18695,7 @@

ge
Source:
@@ -18492,7 +18875,7 @@

getHookSource:
@@ -18761,7 +19144,7 @@

getHooksSource:
@@ -19088,7 +19471,7 @@

getHook
Source:
@@ -19358,7 +19741,7 @@

getJobSource:
@@ -19632,7 +20015,7 @@

getLogSource:
@@ -19901,7 +20284,7 @@

getLogsSource:
@@ -20408,7 +20791,7 @@

getLogStr
Source:
@@ -20677,7 +21060,7 @@

getMigra
Source:
@@ -20862,7 +21245,7 @@

g
Source:
@@ -21086,7 +21469,7 @@

get
Source:
@@ -21270,7 +21653,7 @@

getR
Source:
@@ -21539,7 +21922,7 @@

get
Source:
@@ -21866,7 +22249,7 @@

getRoleSource:
@@ -22135,7 +22518,7 @@

getRolesSource:
@@ -23058,7 +23441,7 @@

getRul
Source:
@@ -23242,7 +23625,7 @@

getT
Source:
@@ -23691,7 +24074,7 @@

getUserB
Source:
@@ -23960,7 +24343,7 @@

Source:
@@ -24604,7 +24987,7 @@

get
Source:
@@ -25976,7 +26359,7 @@

getUser
Source:
@@ -26276,7 +26659,7 @@

importUser
Source:
@@ -26704,7 +27087,7 @@

importU
Source:
@@ -27130,7 +27513,7 @@

Source:
@@ -27786,7 +28169,7 @@

Source:
@@ -28051,7 +28434,7 @@

remo
Source:
@@ -28356,7 +28739,7 @@

Source:
@@ -28735,7 +29118,7 @@

Source:
@@ -29092,7 +29475,7 @@

re
Source:
@@ -29449,7 +29832,7 @@

Source:
@@ -29720,7 +30103,7 @@

setRule
Source:
@@ -30077,7 +30460,7 @@

unblockUse
Source:
@@ -30346,7 +30729,7 @@

unblockUse
Source:
@@ -31247,7 +31630,7 @@

Source:
@@ -32422,7 +32805,7 @@

up
Source:
@@ -32675,7 +33058,7 @@

u
Source:
@@ -32981,7 +33364,7 @@

u
Source:
@@ -33233,7 +33616,7 @@

u
Source:
@@ -33483,7 +33866,7 @@

Source:
@@ -33734,7 +34117,7 @@

Source:
@@ -34035,7 +34418,7 @@

Source:
@@ -34336,7 +34719,7 @@

Source:
@@ -34586,7 +34969,7 @@

updateHook<
Source:
@@ -34891,7 +35274,7 @@

upda
Source:
@@ -35196,7 +35579,7 @@

update
Source:
@@ -35501,7 +35884,7 @@

updat
Source:
@@ -35721,7 +36104,7 @@

Source:
@@ -35937,7 +36320,7 @@

u
Source:
@@ -36243,7 +36626,7 @@

updateRole<
Source:
@@ -36853,7 +37236,7 @@

u
Source:
@@ -37684,7 +38067,7 @@

ver
Source:
@@ -37922,7 +38305,7 @@

Example

- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html index 24b9401dd..b621b25e3 100644 --- a/docs/module-management.ManagementTokenProvider.html +++ b/docs/module-management.ManagementTokenProvider.html @@ -24,7 +24,7 @@
@@ -673,7 +673,7 @@
Returns:

- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.MigrationsManager.html b/docs/module-management.MigrationsManager.html index be6f6c9a1..38b1f4a2a 100644 --- a/docs/module-management.MigrationsManager.html +++ b/docs/module-management.MigrationsManager.html @@ -24,7 +24,7 @@
@@ -885,7 +885,7 @@
Example

- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html index 312ec5991..d4fbcdb43 100644 --- a/docs/module-management.PromptsManager.html +++ b/docs/module-management.PromptsManager.html @@ -24,7 +24,7 @@
@@ -839,7 +839,7 @@

Source:
@@ -1712,7 +1712,7 @@

Source:
@@ -2257,7 +2257,7 @@
Example

- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html index 656055922..28b71a9cc 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html index 048cc3972..823c01c7a 100644 --- a/docs/module-management.RetryRestClient.html +++ b/docs/module-management.RetryRestClient.html @@ -24,7 +24,7 @@
@@ -417,7 +417,7 @@
Parameters:

- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html index d198b8e1b..b9ad9ff84 100644 --- a/docs/module-management.RolesManager.html +++ b/docs/module-management.RolesManager.html @@ -24,7 +24,7 @@
@@ -4293,7 +4293,7 @@
Example

- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html index 466a78d0a..cab403ecf 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html index 6b48c71b3..4ffc27c2c 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html index 9689ce00e..131f017f9 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html index d4121219e..d34535860 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html index 09217a724..48cd03071 100644 --- a/docs/module-management.TicketsManager.html +++ b/docs/module-management.TicketsManager.html @@ -24,7 +24,7 @@
@@ -1121,7 +1121,7 @@
Example

- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html index 4414ea348..052151bb2 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.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html index 0b9107617..88cca3bac 100644 --- a/docs/module-management.UsersManager.html +++ b/docs/module-management.UsersManager.html @@ -24,7 +24,7 @@
@@ -6148,7 +6148,7 @@
Example

- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-management.html b/docs/module-management.html index fd94fabd9..5f2c56522 100644 --- a/docs/module-management.html +++ b/docs/module-management.html @@ -24,7 +24,7 @@
@@ -174,7 +174,7 @@

Classes


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/module-utils.html b/docs/module-utils.html index 9022eee7c..b0cb3d289 100644 --- a/docs/module-utils.html +++ b/docs/module-utils.html @@ -24,7 +24,7 @@
@@ -363,7 +363,7 @@

(static)
- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/docs/utils.js.html b/docs/utils.js.html index 2b12767eb..d8f70666d 100644 --- a/docs/utils.js.html +++ b/docs/utils.js.html @@ -24,7 +24,7 @@
@@ -140,7 +140,7 @@

utils.js


- Generated by JSDoc 3.6.6 on Mon Dec 07 2020 20:00:30 GMT-0800 (Pacific Standard Time) using the Minami theme. + Generated by JSDoc 3.6.6 on Tue Jan 05 2021 10:39:49 GMT-0800 (Pacific Standard Time) using the Minami theme.
diff --git a/package.json b/package.json index 7079c4040..52e46fd35 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "auth0", - "version": "2.31.0", + "version": "2.31.1", "description": "SDK for Auth0 API v2", "main": "src/index.js", "files": [