From fc3d2060af577d108c022d0863b072620e5b1829 Mon Sep 17 00:00:00 2001 From: Adam Mcgrath Date: Fri, 15 Oct 2021 12:13:45 +0100 Subject: [PATCH] Release v2.37.0 (#668) --- CHANGELOG.md | 12 + 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 | 6 +- docs/errors.js.html | 4 +- docs/external-RestClient.html | 4 +- docs/global.html | 4 +- docs/index.html | 4 +- docs/index.js.html | 4 +- docs/management_ActionsManager.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 | 39 +- 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_OrganizationsManager.js.html | 41 +- 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 | 12 +- docs/module-auth.AuthenticationClient.html | 117 +- 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 +- docs/module-management.ActionsManager.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 | 18 +- ...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 | 6 +- docs/module-management.LogStreamsManager.html | 4 +- docs/module-management.LogsManager.html | 4 +- docs/module-management.ManagementClient.html | 525 ++-- ...le-management.ManagementTokenProvider.html | 4 +- docs/module-management.MigrationsManager.html | 4 +- ...odule-management.OrganizationsManager.html | 2288 +++++++++++++---- 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 +- 89 files changed, 2536 insertions(+), 848 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 49787593e..c290dc4b1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,17 @@ # Change Log +## [v2.37.0](https://github.com/auth0/node-auth0/tree/v2.37.0) (2021-10-14) + +[Full Changelog](https://github.com/auth0/node-auth0/compare/v2.36.2...v2.37.0) + +**Added** + +- Add support for checking connection status [\#662](https://github.com/auth0/node-auth0/pull/662) ([frederikprijck](https://github.com/frederikprijck)) + +**Fixed** + +- Fix undefined tokenProvider when access token is provided. [\#642](https://github.com/auth0/node-auth0/pull/642) ([Gilighost](https://github.com/Gilighost)) + ## [v2.36.2](https://github.com/auth0/node-auth0/tree/v2.36.2) (2021-09-20) [Full Changelog](https://github.com/auth0/node-auth0/compare/v2.36.1...v2.36.2) diff --git a/docs/RetryRestClient.js.html b/docs/RetryRestClient.js.html index 798a85efd..ef6fd2474 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/auth_DatabaseAuthenticator.js.html b/docs/auth_DatabaseAuthenticator.js.html index dd1023639..1dce67bd8 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/auth_OAUthWithIDTokenValidation.js.html b/docs/auth_OAUthWithIDTokenValidation.js.html index ed552ecf1..f39dcfd20 100644 --- a/docs/auth_OAUthWithIDTokenValidation.js.html +++ b/docs/auth_OAUthWithIDTokenValidation.js.html @@ -24,7 +24,7 @@
@@ -179,7 +179,7 @@

auth/OAUthWithIDTokenValidation.js


- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html index 8db6caa4c..274910fd8 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html index 944ab2501..903db519b 100644 --- a/docs/auth_PasswordlessAuthenticator.js.html +++ b/docs/auth_PasswordlessAuthenticator.js.html @@ -24,7 +24,7 @@
@@ -351,7 +351,7 @@

auth/PasswordlessAuthenticator.js


- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html index 9fc924172..15f4f249d 100644 --- a/docs/auth_TokensManager.js.html +++ b/docs/auth_TokensManager.js.html @@ -24,7 +24,7 @@
@@ -308,7 +308,7 @@

auth/TokensManager.js


- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html index f4e06fff6..d01d021d0 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/auth_idToken.js.html b/docs/auth_idToken.js.html index 8b69987b3..3e6341cfb 100644 --- a/docs/auth_idToken.js.html +++ b/docs/auth_idToken.js.html @@ -24,7 +24,7 @@
@@ -215,7 +215,7 @@

auth/idToken.js


- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html index c58543b68..752c84c66 100644 --- a/docs/auth_index.js.html +++ b/docs/auth_index.js.html @@ -24,7 +24,7 @@
@@ -636,6 +636,8 @@

auth/index.js

* @param {String} userData.username Username. * @param {String} userData.password User password. * @param {String} [userData.realm] Name of the realm to use to authenticate or the connection name + * @param {Object} [options] Additional options. + * @param {String} [options.forwardedFor] Value to be used for auth0-forwarded-for header * * @return {Promise|undefined} */ @@ -689,7 +691,7 @@

auth/index.js


- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/errors.js.html b/docs/errors.js.html index cc9f7999a..851383128 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html index bcf779e60..05e905ce6 100644 --- a/docs/external-RestClient.html +++ b/docs/external-RestClient.html @@ -24,7 +24,7 @@
@@ -1839,7 +1839,7 @@


- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/global.html b/docs/global.html index d32a5e0f0..c10576e80 100644 --- a/docs/global.html +++ b/docs/global.html @@ -24,7 +24,7 @@
@@ -423,7 +423,7 @@
Returns:

- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/index.html b/docs/index.html index 8f0e4c447..4bda30303 100644 --- a/docs/index.html +++ b/docs/index.html @@ -24,7 +24,7 @@
@@ -178,7 +178,7 @@

License


- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/index.js.html b/docs/index.js.html index fb818728d..6fef4ef47 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_ActionsManager.js.html b/docs/management_ActionsManager.js.html index 0ca4864ef..b2ac6fc92 100644 --- a/docs/management_ActionsManager.js.html +++ b/docs/management_ActionsManager.js.html @@ -24,7 +24,7 @@
@@ -712,7 +712,7 @@

management/ActionsManager.js


- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html index 146d1620a..7fd9fea02 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_BrandingManager.js.html b/docs/management_BrandingManager.js.html index 0befcb10e..1d3d8fc07 100644 --- a/docs/management_BrandingManager.js.html +++ b/docs/management_BrandingManager.js.html @@ -24,7 +24,7 @@
@@ -234,7 +234,7 @@

management/BrandingManager.js


- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html index a9d3b1b8a..92ee57b2c 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html index 4bb683deb..9ef7c1e0b 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html index 7110883a0..579fbd302 100644 --- a/docs/management_ConnectionsManager.js.html +++ b/docs/management_ConnectionsManager.js.html @@ -24,7 +24,7 @@
@@ -92,6 +92,13 @@

management/ConnectionsManager.js

); this.resource = new RetryRestClient(auth0RestClient, options.retry); + var statusClient = new Auth0RestClient( + options.baseUrl + '/connections/:id/status', + clientOptions, + options.tokenProvider + ); + this.status = new RetryRestClient(statusClient, options.retry); + /** * Provides an abstraction layer for consuming the * {@link https://auth0.com/docs/api/management/v2#!/Connections/delete_users_by_email @@ -233,6 +240,34 @@

management/ConnectionsManager.js

*/ utils.wrapPropertyMethod(ConnectionsManager, 'delete', 'resource.delete'); +/** + * Checks the status of an ad/ldap connection referenced by its ID. + * + * @method checkStatus + * @memberOf module:management.OrganizationsManager.prototype + * + * @example + * var params = {id : 'CONNECTION_ID'} + * @example <caption> + * This methods takes the connection ID and returns the status when online, or an error when offline. + * </caption> + * + * management.connections.checkStatus( {id : 'CONNECTION_ID'}, function (err, status) { + * if (err) { + * console.log('OFFLINE', err); + * } else { + * console.log('ONLINE', status); + * } + * }); + * + * @param {Object} params Connection parameters + * @param {String} params.id ID of the Connection. + * @param {Function} [cb] Callback function. + * + * @return {Promise|undefined} + */ +utils.wrapPropertyMethod(ConnectionsManager, 'checkStatus', 'status.get'); + /** * Delete a connection user by email. * @@ -284,7 +319,7 @@

management/ConnectionsManager.js


- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html index 983f9f0ef..82ac04c63 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html index 503969147..215b61107 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html index c13bbcf8a..763377335 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html index ffbe4e4b4..6873e0487 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html index 6cffb5c7a..173908691 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html index 384a96e5e..060adf987 100644 --- a/docs/management_GuardianManager.js.html +++ b/docs/management_GuardianManager.js.html @@ -24,7 +24,7 @@
@@ -559,7 +559,7 @@

management/GuardianManager.js


- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_HooksManager.js.html b/docs/management_HooksManager.js.html index f2807b299..035e08b92 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html index a64a1274b..537aab5de 100644 --- a/docs/management_JobsManager.js.html +++ b/docs/management_JobsManager.js.html @@ -24,7 +24,7 @@
@@ -440,7 +440,7 @@

management/JobsManager.js


- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_LogStreamsManager.js.html b/docs/management_LogStreamsManager.js.html index 8454aefd5..768d85034 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html index 1c73b0092..4c2172cdf 100644 --- a/docs/management_LogsManager.js.html +++ b/docs/management_LogsManager.js.html @@ -24,7 +24,7 @@
@@ -167,7 +167,7 @@

management/LogsManager.js


- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html index ac65dd775..05063916c 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_MigrationsManager.js.html b/docs/management_MigrationsManager.js.html index 8e47468ed..a386739d7 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_OrganizationsManager.js.html b/docs/management_OrganizationsManager.js.html index 8e2423c48..bf99c729d 100644 --- a/docs/management_OrganizationsManager.js.html +++ b/docs/management_OrganizationsManager.js.html @@ -24,7 +24,7 @@
@@ -305,7 +305,8 @@

management/OrganizationsManager.js

* console.log(enabled_connections); * }); * - * @param {String} [organization_id] Organization ID + * @param {Object} params Organization parameters. + * @param {String} params.id Organization ID. * @param {Function} [cb] Callback function. * * @return {Promise|undefined} @@ -330,7 +331,9 @@

management/OrganizationsManager.js

* console.log(enabled_connection); * }); * - * @param {String} [organization_id] Organization ID + * @param {Object} params Organization parameters. + * @param {String} params.id Organization ID. + * @param {String} params.connection_id Connection ID. * @param {Function} [cb] Callback function. * * @return {Promise|undefined} @@ -355,6 +358,7 @@

management/OrganizationsManager.js

* } * }); * + * @param {Object} params Organization parameters * @param {String} params.id ID of the Organization. * @param {Object} data enable connection data * @param {String} data.connection_id connection ID to enable @@ -396,7 +400,7 @@

management/OrganizationsManager.js

* // Handle error. * } * }); - * + * @param {Object} params Organization parameters * @param {String} params.id ID of the Organization. * @param {String} params.connection_id ID of the Connection. * @param {Function} [cb] Callback function. @@ -444,6 +448,7 @@

management/OrganizationsManager.js

* } * }); * + * @param {Object} params Organization parameters * @param {String} params.id ID of the Organization. * @param {String} params.connection_id ID of the Connection. * @param {Object} data Updated connection. @@ -497,7 +502,8 @@

management/OrganizationsManager.js

* console.log(members); * }); * - * @param {String} [params.id] Organization ID + * @param {Object} params Organization parameters + * @param {String} params.id Organization ID * @param {String} [params.from] For checkpoint pagination, the Id from which to start selection from. * @param {Number} [params.take] For checkpoint pagination, the number of entries to retrieve. Default 50. * @param {Function} [cb] Callback function. @@ -523,6 +529,7 @@

management/OrganizationsManager.js

* } * }); * + * @param {Object} params Organization parameters * @param {String} params.id ID of the Organization. * @param {Object} data add members data * @param {Array} data.members Array of user IDs @@ -564,6 +571,7 @@

management/OrganizationsManager.js

* } * }); * + * @param {Object} params Organization parameters * @param {String} params.id ID of the Organization. * @param {Object} data add members data * @param {Array} data.members Array of user IDs @@ -609,7 +617,15 @@

management/OrganizationsManager.js

* console.log(invites); * }); * - * @param {String} [params.id] Organization ID + * @param {Object} params Organization parameters + * @param {String} params.id Organization ID + * @param {Number} [params.per_page] Number of results per page. + * @param {Number} [params.page] Page number, zero indexed. + * @param {String} [params.from] For checkpoint pagination, the Id from which to start selection from. + * @param {Number} [params.take] For checkpoint pagination, the number of entries to retrieve. Default 50. + * @param {String} [params.fields] Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. + * @param {Boolean} [params.include_fields] Whether specified fields are to be included (true) or excluded (false). Defaults to true. + * @param {String} [params.sort] Field to sort by. Use field:order where order is 1 for ascending and -1 for descending Defaults to created_at:-1. * @param {Function} [cb] Callback function. * * @return {Promise|undefined} @@ -634,8 +650,10 @@

management/OrganizationsManager.js

* console.log(invite); * }); * - * @param {String} [organization_id] Organization ID - * @param {Function} [cb] Callback function. + * @param {Object} params Organization parameters + * @param {String} params.id Organization ID + * @param {String} params.invitation_id Invitation ID + * @param {Function} [cb] Callback function. * * @return {Promise|undefined} */ @@ -677,6 +695,7 @@

management/OrganizationsManager.js

* } * }); * + * @param {Object} params Organization parameters * @param {String} params.id ID of the Organization. * @param {Array} data Invitation data * @param {Object} data.inviter The person who is sending the invite. @@ -727,6 +746,7 @@

management/OrganizationsManager.js

* } * }); * + * @param {Object} params Organization parameters * @param {String} params.id ID of the Organization. * @param {String} params.invitation_id Invitation ID * @param {Function} [cb] Callback function. @@ -777,6 +797,7 @@

management/OrganizationsManager.js

* console.log(roles); * }); * + * @param {Object} params Organization parameters * @param {String} params.id ID of the Organization. * @param {String} params.user_id ID of the user. * @param {Function} [cb] Callback function. @@ -803,6 +824,7 @@

management/OrganizationsManager.js

* } * }); * + * @param {Object} params Organization parameters * @param {String} params.id ID of the Organization. * @param {String} params.user_id ID of the user. * @param {Object} data Add member roles data. @@ -852,6 +874,7 @@

management/OrganizationsManager.js

* } * }); * + * @param {Object} params Organization parameters * @param {String} params.id ID of the Organization. * @param {String} params.user_id Id of the User * @param {Object} data Remove member roles data. @@ -898,7 +921,7 @@

management/OrganizationsManager.js


- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html index b604b40a5..dffa02986 100644 --- a/docs/management_PromptsManager.js.html +++ b/docs/management_PromptsManager.js.html @@ -24,7 +24,7 @@
@@ -265,7 +265,7 @@

management/PromptsManager.js


- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html index c0ff13d2c..c9c980228 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html index 3e38ecbb6..c7b3c46d4 100644 --- a/docs/management_RolesManager.js.html +++ b/docs/management_RolesManager.js.html @@ -24,7 +24,7 @@
@@ -462,7 +462,7 @@

management/RolesManager.js


- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html index d2d3f0a23..b83ec0359 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html index 9c83298ad..dc7252c41 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html index 3d8e76d14..62e601ba8 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html index e662c7238..f18f45f89 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html index a4a904f47..569d48192 100644 --- a/docs/management_TicketsManager.js.html +++ b/docs/management_TicketsManager.js.html @@ -24,7 +24,7 @@
@@ -186,7 +186,7 @@

management/TicketsManager.js


- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html index f42d3a73d..e8963739d 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html index 6dd14669f..0fd178bd0 100644 --- a/docs/management_UsersManager.js.html +++ b/docs/management_UsersManager.js.html @@ -24,7 +24,7 @@
@@ -1011,7 +1011,7 @@

management/UsersManager.js


- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/management_index.js.html b/docs/management_index.js.html index 3b35e0aae..cb4f2a721 100644 --- a/docs/management_index.js.html +++ b/docs/management_index.js.html @@ -24,7 +24,7 @@
@@ -173,7 +173,6 @@

management/index.js

} this.tokenProvider = new ManagementTokenProvider(config); - managerOptions.tokenProvider = this.tokenProvider; } else if (typeof options.token !== 'string' || options.token.length === 0) { throw new ArgumentError('Must provide a token'); } else { @@ -185,6 +184,8 @@

management/index.js

managerOptions.headers['Authorization'] = 'Bearer ' + options.token; } + managerOptions.tokenProvider = this.tokenProvider; + if (options.telemetry !== false) { var clientInfo = options.clientInfo || generateClientInfo(); if ('string' === typeof clientInfo.name && clientInfo.name.length > 0) { @@ -2320,6 +2321,11 @@

management/index.js

* * @param {Object} data User data object. * @param {String} data.user_id ID of the user to be verified. + * @param {String} [data.organization_id] Organization ID + * @param {String} [data.client_id] client_id of the client (application). If no value provided, the global Client ID will be used. + * @param {Object} [data.identity] Used to verify secondary, federated, and passwordless-email identities. + * @param {String} data.identity.user_id user_id of the identity. + * @param {String} data.identity.provider provider of the identity. * @param {Function} [cb] Callback function. * * @return {Promise|undefined} @@ -3942,7 +3948,7 @@

management/index.js


- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html index cf8651e74..d35ba67dd 100644 --- a/docs/module-auth.AuthenticationClient.html +++ b/docs/module-auth.AuthenticationClient.html @@ -24,7 +24,7 @@
@@ -2001,7 +2001,7 @@
Example
-

passwordGrant(userData) → {Promise|undefined}

+

passwordGrant(userData, optionsopt) → {Promise|undefined}

@@ -2076,6 +2076,8 @@
Parameters:
Type + Attributes + @@ -2101,6 +2103,14 @@
Parameters:
+ + + + + + + + @@ -2234,6 +2244,105 @@
Parameters:
+ + + + + + + + + + + + options + + + + + +Object + + + + + + + + + <optional>
+ + + + + + + + + + + +

Additional options.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
forwardedFor + + +String + + + + + + <optional>
+ + + + + +
+

Value to be used for auth0-forwarded-for header

+ +
@@ -2365,7 +2474,7 @@

refreshTo
Source:
@@ -4515,7 +4624,7 @@

Examples

- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html index de2542c9c..0b69379b8 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html index 6ae6cc6fb..76e38f5d0 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html index b4383c18d..871dac8a7 100644 --- a/docs/module-auth.OAuthAuthenticator.html +++ b/docs/module-auth.OAuthAuthenticator.html @@ -24,7 +24,7 @@
@@ -2100,7 +2100,7 @@
Returns:

- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html index 9279341be..634483691 100644 --- a/docs/module-auth.PasswordlessAuthenticator.html +++ b/docs/module-auth.PasswordlessAuthenticator.html @@ -24,7 +24,7 @@
@@ -1843,7 +1843,7 @@
Examples

- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html index 3db2a3c09..5c333179e 100644 --- a/docs/module-auth.TokensManager.html +++ b/docs/module-auth.TokensManager.html @@ -24,7 +24,7 @@
@@ -1368,7 +1368,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html index f45346305..2a06d4f5e 100644 --- a/docs/module-auth.UsersManager.html +++ b/docs/module-auth.UsersManager.html @@ -24,7 +24,7 @@
@@ -1010,7 +1010,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-auth.html b/docs/module-auth.html index 6e6b1f95e..b96910331 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-errors.html b/docs/module-errors.html index 97337a061..098b07f5d 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.ActionsManager.html b/docs/module-management.ActionsManager.html index e702fb19f..8f91892a2 100644 --- a/docs/module-management.ActionsManager.html +++ b/docs/module-management.ActionsManager.html @@ -24,7 +24,7 @@
@@ -4718,7 +4718,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html index aae7ff451..2e6d32df2 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.BrandingManager.html b/docs/module-management.BrandingManager.html index ced1fab26..ac6c9d1a9 100644 --- a/docs/module-management.BrandingManager.html +++ b/docs/module-management.BrandingManager.html @@ -24,7 +24,7 @@
@@ -1770,7 +1770,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html index c46e45c82..33011b285 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html index 97e24d354..ef89695e9 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html index bc3b39034..95bf38594 100644 --- a/docs/module-management.ConnectionsManager.html +++ b/docs/module-management.ConnectionsManager.html @@ -24,7 +24,7 @@
@@ -532,7 +532,7 @@

(inner)
Source:
@@ -616,7 +616,7 @@

createSource:
@@ -834,7 +834,7 @@

deleteSource:
@@ -1103,7 +1103,7 @@

deleteSource:
@@ -1398,7 +1398,7 @@

getSource:
@@ -1667,7 +1667,7 @@

getAllSource:
@@ -1994,7 +1994,7 @@

updateSource:
@@ -2269,7 +2269,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html index 08e1ba488..7ac0dced9 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html index 23b04959b..3309a247b 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html index f67ffafcb..ef15350d4 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html index 39237c28b..3af2b3529 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html index 7ccd06925..06f320ead 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html index bae37465e..51fff8996 100644 --- a/docs/module-management.GuardianManager.html +++ b/docs/module-management.GuardianManager.html @@ -24,7 +24,7 @@
@@ -4920,7 +4920,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.HooksManager.html b/docs/module-management.HooksManager.html index 0f14b28c6..3cdaddc72 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html index 47058282a..6a5d43c82 100644 --- a/docs/module-management.JobsManager.html +++ b/docs/module-management.JobsManager.html @@ -24,7 +24,7 @@
@@ -890,7 +890,7 @@

errorsSource:
@@ -3145,7 +3145,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.LogStreamsManager.html b/docs/module-management.LogStreamsManager.html index 945245ef4..1d709304a 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html index cb3d4c009..f65716266 100644 --- a/docs/module-management.LogsManager.html +++ b/docs/module-management.LogsManager.html @@ -24,7 +24,7 @@
@@ -1358,7 +1358,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html index 32a47cfdb..d90740fac 100644 --- a/docs/module-management.ManagementClient.html +++ b/docs/module-management.ManagementClient.html @@ -24,7 +24,7 @@
@@ -763,7 +763,7 @@

actionsSource:
@@ -838,7 +838,7 @@

blac
Source:
@@ -913,7 +913,7 @@

brandingSource:
@@ -988,7 +988,7 @@

clientGra
Source:
@@ -1063,7 +1063,7 @@

clientsSource:
@@ -1138,7 +1138,7 @@

connection
Source:
@@ -1213,7 +1213,7 @@

customDo
Source:
@@ -1288,7 +1288,7 @@

devi
Source:
@@ -1363,7 +1363,7 @@

emailPro
Source:
@@ -1438,7 +1438,7 @@

emailTe
Source:
@@ -1513,7 +1513,7 @@

grantsSource:
@@ -1588,7 +1588,7 @@

guardianSource:
@@ -1663,7 +1663,7 @@

hooksSource:
@@ -1737,7 +1737,7 @@

jobsSource:
@@ -1811,7 +1811,7 @@

logsSource:
@@ -1885,7 +1885,7 @@

logStreams<
Source:
@@ -1959,7 +1959,7 @@

migrations<
Source:
@@ -2033,7 +2033,7 @@

organiza
Source:
@@ -2107,7 +2107,7 @@

promptsSource:
@@ -2182,7 +2182,7 @@

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

rolesSource:
@@ -2332,7 +2332,7 @@

rulesSource:
@@ -2406,7 +2406,7 @@

rulesConf
Source:
@@ -2480,7 +2480,7 @@

statsSource:
@@ -2554,7 +2554,7 @@

tenantSource:
@@ -2628,7 +2628,7 @@

ticketsSource:
@@ -2703,7 +2703,7 @@

userBlocks<
Source:
@@ -2778,7 +2778,7 @@

usersSource:
@@ -2862,7 +2862,7 @@

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

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

Source:
@@ -3903,7 +3903,7 @@

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

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

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

Source:
@@ -5161,7 +5161,7 @@

createCli
Source:
@@ -5379,7 +5379,7 @@

crea
Source:
@@ -5597,7 +5597,7 @@

creat
Source:
@@ -5815,7 +5815,7 @@

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

Source:
@@ -6251,7 +6251,7 @@

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

Source:
@@ -6651,7 +6651,7 @@

Source:
@@ -6831,7 +6831,7 @@

createHook<
Source:
@@ -7049,7 +7049,7 @@

create
Source:
@@ -7267,7 +7267,7 @@

Source:
@@ -7459,7 +7459,7 @@

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

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

createRule<
Source:
@@ -8114,7 +8114,7 @@

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

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

Source:
@@ -8768,7 +8768,7 @@

deleteCli
Source:
@@ -9037,7 +9037,7 @@

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

delet
Source:
@@ -9575,7 +9575,7 @@

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

Source:
@@ -10115,7 +10115,7 @@

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

Source:
@@ -10568,7 +10568,7 @@

deleteHook<
Source:
@@ -10837,7 +10837,7 @@

delete
Source:
@@ -11106,7 +11106,7 @@

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

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

deleteRule<
Source:
@@ -11913,7 +11913,7 @@

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

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

Source:
@@ -12752,7 +12752,7 @@

Source:
@@ -13049,7 +13049,7 @@

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

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

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

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

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

Source:
@@ -14441,7 +14441,7 @@

getClientSource:
@@ -14710,7 +14710,7 @@

getCli
Source:
@@ -15037,7 +15037,7 @@

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

getConne
Source:
@@ -15633,7 +15633,7 @@

getConn
Source:
@@ -15960,7 +15960,7 @@

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

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

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

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

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

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

getGrantsSource:
@@ -17849,7 +17849,7 @@

Source:
@@ -18114,7 +18114,7 @@

Source:
@@ -18379,7 +18379,7 @@

Source:
@@ -18593,7 +18593,7 @@

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

Source:
@@ -18987,7 +18987,7 @@

Source:
@@ -19201,7 +19201,7 @@

Source:
@@ -19381,7 +19381,7 @@

Source:
@@ -19561,7 +19561,7 @@

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

getHookSource:
@@ -20010,7 +20010,7 @@

getHooksSource:
@@ -20337,7 +20337,7 @@

getHook
Source:
@@ -20607,7 +20607,7 @@

getJobSource:
@@ -20881,7 +20881,7 @@

getLogSource:
@@ -21150,7 +21150,7 @@

getLogsSource:
@@ -21657,7 +21657,7 @@

getLogStr
Source:
@@ -21926,7 +21926,7 @@

getMigra
Source:
@@ -22111,7 +22111,7 @@

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

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

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

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

getRoleSource:
@@ -23380,7 +23380,7 @@

getRolesSource:
@@ -23707,7 +23707,7 @@

getRuleSource:
@@ -23976,7 +23976,7 @@

getRulesSource:
@@ -24303,7 +24303,7 @@

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

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

getUserSource:
@@ -24936,7 +24936,7 @@

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

Source:
@@ -25474,7 +25474,7 @@

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

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

getUserRo
Source:
@@ -26599,7 +26599,7 @@

getUsersSource:
@@ -27000,7 +27000,7 @@

getUse
Source:
@@ -27356,7 +27356,7 @@

getUser
Source:
@@ -27728,7 +27728,7 @@

importUser
Source:
@@ -28156,7 +28156,7 @@

importU
Source:
@@ -28582,7 +28582,7 @@

Source:
@@ -28851,7 +28851,7 @@

linkUsersSource:
@@ -29238,7 +29238,7 @@

Source:
@@ -29503,7 +29503,7 @@

remo
Source:
@@ -29808,7 +29808,7 @@

Source:
@@ -30187,7 +30187,7 @@

Source:
@@ -30544,7 +30544,7 @@

re
Source:
@@ -30901,7 +30901,7 @@

Source:
@@ -30986,6 +30986,8 @@

Parameters:
Type + Attributes + @@ -31011,6 +31013,14 @@
Parameters:
+ + + + + + + + @@ -31021,6 +31031,191 @@
Parameters:
+ + + + organization_id + + + + + +String + + + + + + + + + <optional>
+ + + + + + + + + + + +

Organization ID

+ + + + + + + + + client_id + + + + + +String + + + + + + + + + <optional>
+ + + + + + + + + + + +

client_id of the client (application). If no value provided, the global Client ID will be used.

+ + + + + + + + + identity + + + + + +Object + + + + + + + + + <optional>
+ + + + + + + + + + + +

Used to verify secondary, federated, and passwordless-email identities.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
user_id + + +String + + + + +

user_id of the identity.

+ +
provider + + +String + + + + +

provider of the identity.

+ +
+ + + + + + @@ -31172,7 +31367,7 @@

Source:
@@ -31422,7 +31617,7 @@

setRule
Source:
@@ -31779,7 +31974,7 @@

unblockUse
Source:
@@ -32048,7 +32243,7 @@

unblockUse
Source:
@@ -32317,7 +32512,7 @@

unlinkUser
Source:
@@ -32640,7 +32835,7 @@

upda
Source:
@@ -32949,7 +33144,7 @@

Source:
@@ -33202,7 +33397,7 @@

updateCli
Source:
@@ -33508,7 +33703,7 @@

upda
Source:
@@ -33818,7 +34013,7 @@

updat
Source:
@@ -34124,7 +34319,7 @@

up
Source:
@@ -34377,7 +34572,7 @@

u
Source:
@@ -34683,7 +34878,7 @@

u
Source:
@@ -34935,7 +35130,7 @@

u
Source:
@@ -35185,7 +35380,7 @@

Source:
@@ -35436,7 +35631,7 @@

Source:
@@ -35687,7 +35882,7 @@

Source:
@@ -35988,7 +36183,7 @@

Source:
@@ -36289,7 +36484,7 @@

Source:
@@ -36539,7 +36734,7 @@

updateHook<
Source:
@@ -36844,7 +37039,7 @@

upda
Source:
@@ -37149,7 +37344,7 @@

update
Source:
@@ -37454,7 +37649,7 @@

updat
Source:
@@ -37674,7 +37869,7 @@

Source:
@@ -37890,7 +38085,7 @@

u
Source:
@@ -38196,7 +38391,7 @@

updateRole<
Source:
@@ -38501,7 +38696,7 @@

updateRule<
Source:
@@ -38806,7 +39001,7 @@

u
Source:
@@ -39022,7 +39217,7 @@

updateUser<
Source:
@@ -39328,7 +39523,7 @@

upd
Source:
@@ -39637,7 +39832,7 @@

ver
Source:
@@ -39875,7 +40070,7 @@

Example

- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html index 5df72b1c5..c75fd45fc 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.MigrationsManager.html b/docs/module-management.MigrationsManager.html index 5a6058627..49d64c19e 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.OrganizationsManager.html b/docs/module-management.OrganizationsManager.html index ea9d5b4a6..8762404ad 100644 --- a/docs/module-management.OrganizationsManager.html +++ b/docs/module-management.OrganizationsManager.html @@ -24,7 +24,7 @@
@@ -499,7 +499,7 @@

Methods

-

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

+

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

@@ -542,7 +542,7 @@

a
Source:
@@ -588,13 +588,13 @@

Parameters:
- params.id + params -String +Object @@ -612,6 +612,49 @@
Parameters:
+ +

Organization parameters

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

ID of the Organization.

@@ -619,6 +662,14 @@
Parameters:
+ + + + + + @@ -829,7 +880,7 @@
Example
-

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

+

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

@@ -872,7 +923,7 @@

addMemb
Source:
@@ -918,13 +969,13 @@

Parameters:
- params.id + params -String +Object @@ -943,16 +994,33 @@
Parameters:
-

ID of the Organization.

+

Organization parameters

- - + + + + + + + + + + + + + + + + + + + - + - + + + + + + + + + +String + + + + + @@ -983,6 +1069,14 @@
Parameters:
+ +
NameTypeDescription
params.user_idid @@ -965,13 +1033,31 @@
Parameters:
- + + + +

ID of the Organization.

+
user_id + -
+ + + + + + @@ -1167,7 +1261,7 @@
Example
-

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

+

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

@@ -1210,7 +1304,7 @@

addMembers<
Source:
@@ -1256,13 +1350,13 @@

Parameters:
- params.id + params -String +Object @@ -1280,6 +1374,49 @@
Parameters:
+ +

Organization parameters

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

ID of the Organization.

@@ -1287,6 +1424,14 @@
Parameters:
+ + + + + + @@ -1470,14 +1615,14 @@
Example
-

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

+

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

-

Create a new organization.

+

Checks the status of an ad/ldap connection referenced by its ID.

@@ -1513,7 +1658,7 @@

createSource:
@@ -1559,7 +1704,7 @@
Parameters:
- data + params @@ -1584,7 +1729,58 @@
Parameters:
-

Organization data object.

+

Connection parameters

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

ID of the Connection.

+ +
+ @@ -1669,14 +1865,20 @@
Returns:
-
Example
+
Examples
-
management.organizations.create(data, function (err) {
+    
var params = {id : 'CONNECTION_ID'}
+ +

+ This methods takes the connection ID and returns the status when online, or an error when offline. +

+ +
management.connections.checkStatus( {id : 'CONNECTION_ID'}, function (err, status) {
   if (err) {
-    // Handle error.
+    console.log('OFFLINE', err);
+  } else {
+    console.log('ONLINE', status);
   }
-
-  // Organization created.
 });
@@ -1688,14 +1890,14 @@
Example
-

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

+

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

-

Create an invitation in an organization

+

Create a new organization.

@@ -1731,7 +1933,7 @@

creat
Source:
@@ -1777,13 +1979,13 @@

Parameters:
- params.id + data -String +Object @@ -1802,7 +2004,7 @@
Parameters:
-

ID of the Organization.

+

Organization data object.

@@ -1811,13 +2013,13 @@
Parameters:
- data + cb -Array +function @@ -1826,6 +2028,8 @@
Parameters:
+ <optional>
+ @@ -1836,16 +2040,145 @@
Parameters:
-

Invitation data

+

Callback function.

- + + - - - - - - + + +
Name
+ + + + + + + + + + + + + + +
+
Returns:
+ + + +
+
+ Type: +
+
+ +Promise +| + +undefined + + +
+
+ + + +
+ + + +
+
Example
+ +
management.organizations.create(data, function (err) {
+  if (err) {
+    // Handle error.
+  }
+
+  // Organization created.
+});
+ +
+ +

+ + +
+ + + +

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

+ + + + + +
+

Create an invitation in an organization

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + @@ -1864,7 +2197,7 @@
Parameters:
- + - + @@ -1949,13 +2282,13 @@
Parameters:
- + + + @@ -2000,7 +2335,7 @@
Parameters:
- + + + - + - - -
NameType
inviterparams @@ -1889,7 +2222,7 @@
Parameters:
-

The person who is sending the invite.

+

Organization parameters

@@ -1915,7 +2248,7 @@
Parameters:
nameid @@ -1932,7 +2265,7 @@
Parameters:
-

Name of the person who is sending the invite

+

ID of the Organization.

inviteedata -Object +Array @@ -1974,7 +2307,7 @@
Parameters:
-

Invitee to whom invitation is intended for

+

Invitation data

@@ -1988,6 +2321,8 @@
Parameters:
TypeAttributes
emailinviter @@ -2013,28 +2348,45 @@
Parameters:
+ + + + + + -

Email of the invitee to whom invitation is intended for

+

The person who is sending the invite.

-
+ + + + + + - - - + + + + + + + + + + - + - - + + - + + +
Name
TypeDescription
client_idname @@ -2047,19 +2399,19 @@
Parameters:
- - + + +

Name of the person who is sending the invite

-
- -

Auth0 client used to resolve the default application login URI. This endpoint must expect &invitation=... and &organization=... parameters (added by API2) to continue the flow with /authorize. If client_id does not have configured login URI, use the tenant level default login route if configured, otherwise return 400

@@ -2068,13 +2420,13 @@
Parameters:
- connection_id + invitee -String +Object @@ -2083,8 +2435,6 @@
Parameters:
- <optional>
- @@ -2095,16 +2445,33 @@
Parameters:
-

Force user to authenticate against a specific identity provider.

+

Invitee to whom invitation is intended for

- - + + + + + + + + + + + + + + + + + + + - + - - + + - + + +
NameTypeDescription
app_metadataemail @@ -2117,21 +2484,19 @@
Parameters:
- - <optional>
- - + +
+

Email of the invitee to whom invitation is intended for

-
- -

Application metadata to be assigned to the user after accept the invitation.

@@ -2140,13 +2505,13 @@
Parameters:
- user_metadata + client_id -Object +String @@ -2155,7 +2520,113 @@
Parameters:
- <optional>
+ + + + + + + + + + +

Auth0 client used to resolve the default application login URI. This endpoint must expect &invitation=... and &organization=... parameters (added by API2) to continue the flow with /authorize. If client_id does not have configured login URI, use the tenant level default login route if configured, otherwise return 400

+ + + + + + + + + connection_id + + + + + +String + + + + + + + + + <optional>
+ + + + + + + + + + + +

Force user to authenticate against a specific identity provider.

+ + + + + + + + + app_metadata + + + + + +Object + + + + + + + + + <optional>
+ + + + + + + + + + + +

Application metadata to be assigned to the user after accept the invitation.

+ + + + + + + + + user_metadata + + + + + +Object + + + + + + + + + <optional>
@@ -2227,8 +2698,275 @@
Parameters:
- <optional>
- + <optional>
+ + + + + + + + + + + +

Number of seconds for which the invitation is valid before expiration. If unspecified or set to 0, this value defaults to 604800 seconds (7 days). Upper limit on ttl_sec is 30 days.

+ + + + + + + + + send_invitation_email + + + + + +Boolean + + + + + + + + + <optional>
+ + + + + + + + + + + +

Whether the user will receive an invitation email (true) or no email (false). Default is true.

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

Callback function.

+ + + + + + + + + + + + + + + + + + + + + +
+
Returns:
+ + + +
+
+ Type: +
+
+ +Promise +| + +undefined + + +
+
+ + + +
+ + + +
+
Example
+ +
var params =  { id :'ORGANIZATION_ID'};
+var data = {
+  client_id: CLIENT_ID,
+  invitee: { email: 'invitee@example.com' },
+  inviter: { name: 'John Doe' }
+};
+
+management.organizations.createInvitation(params, data, function (err) {
+  if (err) {
+    // Handle error.
+  }
+});
+ +
+ +
+ + +
+ + + +

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

+ + + + + +
+

Delete an existing organization.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + +
NameTypeAttributesDescription
params + + +Object + + + + + @@ -2239,43 +2977,50 @@
Parameters:
-

Number of seconds for which the invitation is valid before expiration. If unspecified or set to 0, this value defaults to 604800 seconds (7 days). Upper limit on ttl_sec is 30 days.

+

Organization parameters.

-
+ + + + + + + + + + + + + + + + - + - - @@ -2370,17 +3115,12 @@
Returns:
Example
-
var params =  { id :'ORGANIZATION_ID'};
-var data = {
-  client_id: CLIENT_ID,
-  invitee: { email: 'invitee@example.com' },
-  inviter: { name: 'John Doe' }
-};
-
-management.organizations.createInvitation(params, data, function (err) {
+    
management.organizations.delete({ id: ORGANIZATION_ID }, function (err) {
   if (err) {
     // Handle error.
   }
+
+  // Organization deleted.
 });
@@ -2392,14 +3132,14 @@
Example
-

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

+

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

-

Delete an existing organization.

+

Delete an invitation from an organization

@@ -2435,7 +3175,7 @@

deleteSource:
@@ -2506,7 +3246,7 @@
Parameters:

+ + + + + + + + + + + + + + + + @@ -2644,12 +3410,12 @@
Returns:
Example
-
management.organizations.delete({ id: ORGANIZATION_ID }, function (err) {
+    
var params =  { id :'ORGANIZATION_ID', invitation_id: 'INVITATION_ID };
+
+management.organizations.deleteInvitation(params, function (err) {
   if (err) {
     // Handle error.
   }
-
-  // Organization deleted.
 });
@@ -2661,14 +3427,14 @@
Example
-

deleteInvitation(cbopt) → {Promise|undefined}

+

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

-

Delete an invitation from an organization

+

Get all organizations.

@@ -2704,7 +3470,7 @@

delet
Source:
@@ -2750,13 +3516,13 @@

Parameters:
- + @@ -2896,12 +3801,20 @@
Returns:
Example
-
var params =  { id :'ORGANIZATION_ID', invitation_id: 'INVITATION_ID };
-
-management.organizations.deleteInvitation(params, function (err) {
-  if (err) {
-    // Handle error.
-  }
+        

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

+ +
// Pagination settings.
+var params = {
+  per_page: 10,
+  page: 0
+};
+
+management.organizations.getAll(params, function (err, organizations) {
+  console.log(organizations.length);
 });
@@ -2913,14 +3826,14 @@
Example
-

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

+

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

-

Get all organizations.

+

Get an Auth0 organization.

@@ -2956,7 +3869,7 @@

getAllSource:
@@ -3017,8 +3930,6 @@
Parameters:

- - @@ -3057,79 +3966,7 @@
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - @@ -3287,20 +4078,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.organizations.getByID({ id: ORGANIZATION_ID }, function (err, role) {
+  if (err) {
+    // Handle error.
+  }
 
-management.organizations.getAll(params, function (err, organizations) {
-  console.log(organizations.length);
+  console.log(organization);
 });
@@ -3312,7 +4095,7 @@
Example
-

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

+

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

@@ -3355,7 +4138,7 @@

getByIDSource:
@@ -3452,7 +4235,7 @@
Parameters:

- + @@ -3564,7 +4347,7 @@
Returns:
Example
-
management.organizations.getByID({ id: ORGANIZATION_ID }, function (err, role) {
+    
management.organizations.getByName({ name: ORGANIZATION_NAME}, function (err, role) {
   if (err) {
     // Handle error.
   }
@@ -3581,14 +4364,14 @@ 
Example
-

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

+

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

-

Get an Auth0 organization.

+

Get Enabled Connection in a Organization

@@ -3624,7 +4407,7 @@

getByNameSource:
@@ -3721,7 +4504,7 @@
Parameters:

- + + + + + + + + + + + + + + + + + @@ -3831,14 +4640,16 @@
Returns:
-
Example
+
Examples
-
management.organizations.getByName({ name: ORGANIZATION_NAME}, function (err, role) {
-  if (err) {
-    // Handle error.
-  }
+    
var params = {id : 'ORGANIZATION_ID', connection_id: 'CONNECTION_ID'}
- console.log(organization); +

+ This methods takes the organization ID and connection ID and returns the enabled connection +

+ +
management.organizations.getEnabledConnections( {id : 'ORGANIZATION_ID', connection_id: 'CONNECTION_ID'}, function (err, enabled_connection) {
+  console.log(enabled_connection);
 });
@@ -3850,14 +4661,14 @@
Example
-

getEnabledConnection(organization_idopt, cbopt) → {Promise|undefined}

+

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

-

Get Enabled Connection in a Organization

+

Get Enabled Connections in a Organization

@@ -3893,7 +4704,7 @@

g
Source:
@@ -3912,8 +4723,61 @@

g -

Parameters:
- +
Parameters:
+ + +
NameTypeDescription
send_invitation_emailid -Boolean +String - - <optional>
- - - - - -
-

Whether the user will receive an invitation email (true) or no email (false). Default is true.

+

Organization ID.

-

Organization parameters.

+

Organization parameters

@@ -2549,7 +3289,33 @@
Parameters:
-

Organization ID.

+

ID of the Organization.

+ +
invitation_id + + +String + + + + +

Invitation ID

params.idparams -String +Object @@ -2765,6 +3531,8 @@
Parameters:
+ <optional>
+ @@ -2775,7 +3543,98 @@
Parameters:
-

ID of the Organization.

+

Organizations parameters.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -2784,7 +3643,7 @@
Parameters:
- + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
per_page + + +Number + + + + + + <optional>
+ + + + + +
+

Number of results per page.

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

Page number, zero indexed.

params.invitation_idfrom @@ -2799,6 +3658,8 @@
Parameters:
+ <optional>
+ @@ -2809,7 +3670,51 @@
Parameters:
-

Invitation ID

+

For checkpoint pagination, the Id from which to start selection from.

+ +
take + + +Number + + + + + + <optional>
+ + + + + +
+

For checkpoint pagination, the number of entries to retrieve. Default 50.

+ +
+
- <optional>
- @@ -3029,7 +3940,7 @@
Parameters:
-

Organizations parameters.

+

Organization parameters.

@@ -3043,8 +3954,6 @@
Parameters:
TypeAttributes
per_page - - -Number - - - - - - <optional>
- - - - - -
-

Number of results per page.

- -
page - - -Number - - - - - - <optional>
- - - - - -
-

Page number, zero indexed.

- -
fromid @@ -3142,57 +3979,11 @@
Parameters:
- - <optional>
- - - - - -
-

For checkpoint pagination, the Id from which to start selection from.

- -
take - - -Number - - - - - - <optional>
- - - - - -
-

For checkpoint pagination, the number of entries to retrieve. Default 50.

+

Organization ID.

idname @@ -3469,7 +4252,7 @@
Parameters:
-

Organization ID.

+

Organization name.

nameid @@ -3738,7 +4521,33 @@
Parameters:
-

Organization name.

+

Organization ID.

+ +
connection_id + + +String + + + + +

Connection ID.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -4053,14 +4913,14 @@
Returns:
Examples
-
var params = {id : 'ORGANIZATION_ID', connection_id: 'CONNECTION_ID'}
+
var params = {id : 'ORGANIZATION_ID'}

- This methods takes the organization ID and connection ID and returns the enabled connection + This method takes an organization ID and returns the enabled connections in an Organization

-
management.organizations.getEnabledConnections( {id : 'ORGANIZATION_ID', connection_id: 'CONNECTION_ID'}, function (err, enabled_connection) {
-  console.log(enabled_connection);
+    
management.organizations.getEnabledConnections( {id : 'ORGANIZATION_ID'}, function (err, enabled_connections) {
+  console.log(enabled_connections);
 });
@@ -4072,14 +4932,14 @@
Examples
-

getEnabledConnections(organization_idopt, cbopt) → {Promise|undefined}

+

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

-

Get Enabled Connections in a Organization

+

Get an Invitation in a Organization

@@ -4115,7 +4975,7 @@

Source:
@@ -4161,13 +5021,13 @@

Parameters:
- + + + + + @@ -4275,14 +5210,14 @@
Returns:
Examples
-
var params = {id : 'ORGANIZATION_ID'}
+
var params = {id : 'ORGANIZATION_ID', invitation_id: 'INVITATION_ID'}

- This method takes an organization ID and returns the enabled connections in an Organization + This methods takes the organization ID and user ID and returns the invitation

-
management.organizations.getEnabledConnections( {id : 'ORGANIZATION_ID'}, function (err, enabled_connections) {
-  console.log(enabled_connections);
+    
management.organizations.getInvitation({id : 'ORGANIZATION_ID', invitation_id: 'INVITATION_ID'}, function (err, invite) {
+  console.log(invite);
 });
@@ -4294,14 +5229,14 @@
Examples
-

getInvitation(organization_idopt, cbopt) → {Promise|undefined}

+

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

-

Get an Invitation in a Organization

+

Get Invites in a Organization

@@ -4337,7 +5272,7 @@

getInvit
Source:
@@ -4383,13 +5318,13 @@

Parameters:
- + - + + +
NameTypeAttributesDescription
params + + +Object + + + + + + + + + + +

Organization parameters.

+ + @@ -3925,8 +4789,6 @@
Parameters:
- - @@ -3939,7 +4801,7 @@
Parameters:
- + - - + + - + + +
TypeAttributes
organization_idid @@ -3952,21 +4814,19 @@
Parameters:
- - <optional>
- - + +
+

Organization ID.

-
-
-

Organization ID

organization_idparams -String +Object @@ -4176,8 +5036,6 @@
Parameters:
- <optional>
- @@ -4187,6 +5045,49 @@
Parameters:
+
+

Organization parameters

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

Organization ID

@@ -4195,6 +5096,40 @@
Parameters:
+
invitation_id + + +String + + + + +

Invitation ID

+ +
+ + +
cb
organization_idparams -String +Object @@ -4398,8 +5333,6 @@
Parameters:
- <optional>
- @@ -4410,22 +5343,41 @@
Parameters:
-

Organization ID

+

Organization parameters

-
+ + + + + + + + + + + + + + + + + + - + - -
NameTypeAttributesDescription
cbid -function +String @@ -4434,8 +5386,6 @@
Parameters:
- <optional>
- @@ -4446,166 +5396,232 @@
Parameters:
-

Callback function.

+

Organization ID

- - - - - - - - - - - + + + per_page + + + + +Number -
-
Returns:
- + + -
-
- Type: -
-
- -Promise -| + + + + <optional>
+ -undefined + + + + -
-
+ + +

Number of results per page.

+ + + -
+ + + page + + + + +Number -
-
Examples
-
var params = {id : 'ORGANIZATION_ID', invitation_id: 'INVITATION_ID'}
+ + -

- This methods takes the organization ID and user ID and returns the invitation -

- -
management.organizations.getInvitation({id : 'ORGANIZATION_ID', invitation_id: 'INVITATION_ID'}, function (err, invite) {
-  console.log(invite);
-});
+ + + + <optional>
+ -
+ -
- + + -
- + -

getInvitations(cbopt) → {Promise|undefined}

+ +

Page number, zero indexed.

+ + + + + + from + + + + +String -
-

Get Invites in a Organization

-
+ + + + + + <optional>
+ + + + + -
+ - + +

For checkpoint pagination, the Id from which to start selection from.

+ + + - + + + take + - + + + +Number - - + + - + + + + <optional>
+ - + - + + + - + - + +

For checkpoint pagination, the number of entries to retrieve. Default 50.

+ + + - -
Source:
-
- + + + fields + - + + + +String - - -
+ + + + + + <optional>
+ + + + + + + +

Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.

+ + + + + + + include_fields + + + + +Boolean -
Parameters:
- - - - - - - + + - + + - + - + + + - - - + + + + - - + + + + + +
NameType + + <optional>
+ - -
AttributesDescription
+

Whether specified fields are to be included (true) or excluded (false). Defaults to true.

+ +
params.idsort @@ -4632,7 +5648,15 @@
Parameters:
-

Organization ID

+

Field to sort by. Use field:order where order is 1 for ascending and -1 for descending Defaults to created_at:-1.

+ +
+ @@ -4738,7 +5762,7 @@
Examples
-

getMemberRoles(cbopt) → {Promise|undefined}

+

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

@@ -4781,7 +5805,7 @@

getMemb
Source:
@@ -4827,13 +5851,13 @@

Parameters:
- params.id + params -String +Object @@ -4852,16 +5876,33 @@
Parameters:
-

ID of the Organization.

+

Organization parameters

- - + + + + + + + + + + + + + + + + + + + - + - + + + + + + + + + +String + + + + + @@ -4892,6 +5951,14 @@
Parameters:
+ +
NameTypeDescription
params.user_idid @@ -4874,13 +5915,31 @@
Parameters:
- + + + +

ID of the Organization.

+
user_id + -
+ + + + + + @@ -4992,7 +6059,7 @@
Examples
-

getMembers(cbopt) → {Promise|undefined}

+

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

@@ -5035,7 +6102,7 @@

getMembers<
Source:
@@ -5054,8 +6121,61 @@

getMembers< -

Parameters:
- +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -5286,7 +6412,7 @@
Examples
-

removeEnabledConnection(cbopt) → {Promise|undefined}

+

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

@@ -5329,7 +6455,7 @@

Source:
@@ -5375,13 +6501,13 @@
Parameters:

- + - + + +
NameTypeAttributesDescription
params + + +Object + + + + + + + + + + +

Organization parameters

+ + @@ -5081,7 +6201,7 @@
Parameters:
- + - + - + + +
params.idid @@ -5096,8 +6216,6 @@
Parameters:
- <optional>
- @@ -5117,7 +6235,7 @@
Parameters:
params.fromfrom @@ -5153,7 +6271,7 @@
Parameters:
params.taketake @@ -5186,6 +6304,14 @@
Parameters:
+ + +
params.idparams -String +Object @@ -5400,16 +6526,33 @@
Parameters:
-

ID of the Organization.

+

Organization parameters

-
+ + + + + + + + + + + + + + + + - + - + + + + + + + + + +String + + + + + @@ -5440,6 +6601,14 @@
Parameters:
+ +
NameTypeDescription
params.connection_idid @@ -5422,13 +6565,31 @@
Parameters:
- + + + +

ID of the Organization.

+
connection_id + -
+ + + + + + @@ -5538,7 +6707,7 @@
Example
-

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

+

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

@@ -5581,7 +6750,7 @@

remo
Source:
@@ -5627,13 +6796,13 @@

Parameters:
- params.id + params -String +Object @@ -5652,16 +6821,33 @@
Parameters:
-

ID of the Organization.

+

Organization parameters

- - + + + + + + + + + + + + + + + + + + + - + - + + + + + + + + + +String + + + + + @@ -5692,6 +6896,14 @@
Parameters:
+ +
NameTypeDescription
params.user_idid @@ -5674,13 +6860,31 @@
Parameters:
- + + + +

ID of the Organization.

+
user_id + -
+ + + + + + @@ -5876,7 +7088,7 @@
Example
-

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

+

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

@@ -5919,7 +7131,7 @@

removeMe
Source:
@@ -5965,13 +7177,13 @@

Parameters:
- params.id + params -String +Object @@ -5989,6 +7201,49 @@
Parameters:
+ +

Organization parameters

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

ID of the Organization.

@@ -5996,6 +7251,14 @@
Parameters:
+ + + + + + @@ -6486,7 +7749,7 @@
Example
-

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

+

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

@@ -6529,7 +7792,7 @@

Source:
@@ -6575,13 +7838,13 @@
Parameters:
- params.id + params -String +Object @@ -6600,16 +7863,33 @@
Parameters:
-

ID of the Organization.

+

Organization parameters

- - + + + + + + + + + + + + + + + + + + + - + - + + + + + + + + + +String + + + + + @@ -6640,6 +7938,14 @@
Parameters:
+ +
NameTypeDescription
params.connection_idid @@ -6622,13 +7902,31 @@
Parameters:
- + + + +

ID of the Organization.

+
connection_id + -
+ + + + + + @@ -6785,7 +8091,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.PromptsManager.html b/docs/module-management.PromptsManager.html index d6048ea2a..9f839b0e9 100644 --- a/docs/module-management.PromptsManager.html +++ b/docs/module-management.PromptsManager.html @@ -24,7 +24,7 @@
@@ -839,7 +839,7 @@

Source:
@@ -1708,7 +1708,7 @@

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

- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html index 1a15134be..b38c9b62c 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:49 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html index 09485249a..cf5d5223b 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:49 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html index af6ab2e36..ed4dc253c 100644 --- a/docs/module-management.RolesManager.html +++ b/docs/module-management.RolesManager.html @@ -24,7 +24,7 @@
@@ -4365,7 +4365,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:49 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html index ab75fa126..86bdb087d 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:49 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html index 5580e267a..06fa83336 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:49 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html index b19aa90bf..2a22ea3bc 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:49 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html index cda9a71b4..0fcd31456 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:49 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html index dd52fcb76..508d35d27 100644 --- a/docs/module-management.TicketsManager.html +++ b/docs/module-management.TicketsManager.html @@ -24,7 +24,7 @@
@@ -1578,7 +1578,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:49 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.UserBlocksManager.html b/docs/module-management.UserBlocksManager.html index f485abb37..440125baf 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:49 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html index 7462764c9..6f4343410 100644 --- a/docs/module-management.UsersManager.html +++ b/docs/module-management.UsersManager.html @@ -24,7 +24,7 @@
@@ -6548,7 +6548,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:49 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-management.html b/docs/module-management.html index c90f71b4e..72ad67b77 100644 --- a/docs/module-management.html +++ b/docs/module-management.html @@ -24,7 +24,7 @@
@@ -180,7 +180,7 @@

Classes


- Generated by JSDoc 3.6.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/module-utils.html b/docs/module-utils.html index 84b1e56cd..5219b7599 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:49 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/utils.js.html b/docs/utils.js.html index 4e19db2bd..f31934550 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.7 on Mon Sep 20 2021 12:24:45 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Thu Oct 14 2021 09:34:48 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/package.json b/package.json index 7b9764c3e..d10c30fdc 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "auth0", - "version": "2.36.2", + "version": "2.37.0", "description": "SDK for Auth0 API v2", "main": "src/index.js", "sideEffects": false,