From b486af7dfe743be22dc2502c0a10312b7e58b27e Mon Sep 17 00:00:00 2001 From: Adam Mcgrath Date: Mon, 10 Oct 2022 12:13:03 +0100 Subject: [PATCH] Release v2.43.0 (#745) --- CHANGELOG.md | 8 + docs/ActionsManager.html | 113 +- docs/AttackProtectionManager.html | 16 +- docs/AuthenticationClient.html | 2 +- docs/BlacklistedTokensManager.html | 87 +- docs/BrandingManager.html | 253 +- docs/ClientGrantsManager.html | 91 +- docs/ClientsManager.html | 170 +- docs/ConnectionsManager.html | 172 +- docs/CustomDomainsManager.html | 168 +- docs/DatabaseAuthenticator.html | 2 +- docs/DeviceCredentialsManager.html | 89 +- docs/EmailProviderManager.html | 91 +- docs/EmailTemplatesManager.html | 89 +- docs/GrantsManager.html | 87 +- docs/GuardianManager.html | 708 ++- docs/HooksManager.html | 101 +- docs/JobsManager.html | 245 +- docs/LogStreamsManager.html | 93 +- docs/LogsManager.html | 87 +- docs/ManagementClient.html | 380 +- docs/ManagementTokenProvider.html | 2 +- docs/MigrationsManager.html | 86 +- docs/OAUthWithIDTokenValidation.html | 2 +- docs/OAuthAuthenticator.html | 2 +- docs/OrganizationsManager.html | 125 +- docs/PasswordlessAuthenticator.html | 2 +- docs/PromptsManager.html | 166 +- docs/ResourceServersManager.html | 93 +- ...om_ngonzalvez_rest-facade%7Dexternal_.html | 2 +- docs/RetryRestClient.html | 2 +- docs/RetryRestClient.js.html | 2 +- docs/RolesManager.html | 103 +- docs/RulesConfigsManager.html | 89 +- docs/RulesManager.html | 93 +- docs/StatsManager.html | 87 +- docs/TenantManager.html | 87 +- docs/TicketsManager.html | 87 +- docs/TokensManager.html | 2 +- docs/UserBlocksManager.html | 12 +- docs/UsersManager.html | 4340 +++++++++++------ docs/auth_DatabaseAuthenticator.js.html | 2 +- docs/auth_OAUthWithIDTokenValidation.js.html | 2 +- docs/auth_OAuthAuthenticator.js.html | 2 +- docs/auth_PasswordlessAuthenticator.js.html | 2 +- docs/auth_TokensManager.js.html | 2 +- docs/auth_UsersManager.js.html | 2 +- docs/auth_idToken.js.html | 2 +- docs/auth_index.js.html | 2 +- docs/errors.js.html | 2 +- docs/external-RestClient.html | 4 +- docs/global.html | 2 +- docs/index.html | 2 +- docs/index.js.html | 2 +- docs/management_ActionsManager.js.html | 87 +- ...management_AttackProtectionManager.js.html | 49 +- ...anagement_BlacklistedTokensManager.js.html | 38 +- docs/management_BrandingManager.js.html | 47 +- docs/management_ClientGrantsManager.js.html | 38 +- docs/management_ClientsManager.js.html | 44 +- docs/management_ConnectionsManager.js.html | 50 +- docs/management_CustomDomainsManager.js.html | 44 +- ...anagement_DeviceCredentialsManager.js.html | 32 +- docs/management_EmailProviderManager.js.html | 38 +- docs/management_EmailTemplatesManager.js.html | 33 +- docs/management_GrantsManager.js.html | 38 +- docs/management_GuardianManager.js.html | 101 +- docs/management_HooksManager.js.html | 45 +- docs/management_JobsManager.js.html | 46 +- docs/management_LogStreamsManager.js.html | 37 +- docs/management_LogsManager.js.html | 37 +- ...management_ManagementTokenProvider.js.html | 2 +- docs/management_MigrationsManager.js.html | 33 +- docs/management_OrganizationsManager.js.html | 81 +- docs/management_PromptsManager.js.html | 42 +- .../management_ResourceServersManager.js.html | 37 +- docs/management_RolesManager.js.html | 54 +- docs/management_RulesConfigsManager.js.html | 37 +- docs/management_RulesManager.js.html | 37 +- docs/management_StatsManager.js.html | 33 +- docs/management_TenantManager.js.html | 33 +- docs/management_TicketsManager.js.html | 33 +- docs/management_UserBlocksManager.js.html | 42 +- docs/management_UsersManager.js.html | 109 +- docs/management_index.js.html | 4 +- docs/utils.js.html | 2 +- package.json | 2 +- 87 files changed, 6760 insertions(+), 3089 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 70e1e2d79..00b008b95 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Change Log +## [v2.43.0](https://github.com/auth0/node-auth0/tree/v2.43.0) (2022-10-10) + +[Full Changelog](https://github.com/auth0/node-auth0/compare/v2.42.0...v2.43.0) + +**Added** + +- Add option to include response headers in the result [\#744](https://github.com/auth0/node-auth0/pull/744) ([adamjmcgrath](https://github.com/adamjmcgrath)) + ## [v2.42.0](https://github.com/auth0/node-auth0/tree/v2.42.0) (2022-05-23) [Full Changelog](https://github.com/auth0/node-auth0/compare/v2.41.0...v2.42.0) diff --git a/docs/ActionsManager.html b/docs/ActionsManager.html index 65dcbaae8..7e772923d 100644 --- a/docs/ActionsManager.html +++ b/docs/ActionsManager.html @@ -102,7 +102,7 @@

new Act
Source:
@@ -335,6 +335,85 @@

Parameters:
+

Members

+ + + +
+

resource :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the +Auth0 Actions endpoint.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -388,7 +467,7 @@

createSource:
@@ -609,7 +688,7 @@

createVe
Source:
@@ -911,7 +990,7 @@

deleteSource:
@@ -1181,7 +1260,7 @@

deploySource:
@@ -1449,7 +1528,7 @@

deployVe
Source:
@@ -1769,7 +1848,7 @@

getSource:
@@ -2038,7 +2117,7 @@

getAllSource:
@@ -2439,7 +2518,7 @@

getAllT
Source:
@@ -2766,7 +2845,7 @@

getExecut
Source:
@@ -3035,7 +3114,7 @@

get
Source:
@@ -3307,7 +3386,7 @@

getVersion<
Source:
@@ -3601,7 +3680,7 @@

getVersion
Source:
@@ -3964,7 +4043,7 @@

testSource:
@@ -4266,7 +4345,7 @@

updateSource:
@@ -4582,7 +4661,7 @@

Source:
@@ -4858,7 +4937,7 @@

Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/AttackProtectionManager.html b/docs/AttackProtectionManager.html index 52178b818..52720de8a 100644 --- a/docs/AttackProtectionManager.html +++ b/docs/AttackProtectionManager.html @@ -100,7 +100,7 @@

Source:
@@ -422,7 +422,7 @@

Source:
@@ -641,7 +641,7 @@

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

Source:
@@ -1079,7 +1079,7 @@

Source:
@@ -1332,7 +1332,7 @@

Source:
@@ -1585,7 +1585,7 @@

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

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/AuthenticationClient.html b/docs/AuthenticationClient.html index e95fdcbf4..383ccfb6a 100644 --- a/docs/AuthenticationClient.html +++ b/docs/AuthenticationClient.html @@ -4622,7 +4622,7 @@
Examples

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/BlacklistedTokensManager.html b/docs/BlacklistedTokensManager.html index 78d57311d..a1ad8ac63 100644 --- a/docs/BlacklistedTokensManager.html +++ b/docs/BlacklistedTokensManager.html @@ -101,7 +101,7 @@

Source:
@@ -334,6 +334,85 @@
Parameters:
+

Members

+ + + +
+

resource :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the +Auth0 Blacklisted Tokens endpoint.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -387,7 +466,7 @@

addSource:
@@ -687,7 +766,7 @@

getAllSource:
@@ -836,7 +915,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/BrandingManager.html b/docs/BrandingManager.html index 7204ef847..dbbe16b93 100644 --- a/docs/BrandingManager.html +++ b/docs/BrandingManager.html @@ -100,7 +100,7 @@

new Br
Source:
@@ -333,6 +333,235 @@

Parameters:
+

Members

+ + + +
+

brandingTemplates :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the +Branding new universal login template endpoint.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + + +
+

brandingThemes :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the +Branding theme endpoint.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + + +
+

resource :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the +Branding endpoint.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -386,7 +615,7 @@

createThem
Source:
@@ -605,7 +834,7 @@

deleteThem
Source:
@@ -876,7 +1105,7 @@

Source:
@@ -1126,7 +1355,7 @@

getDef
Source:
@@ -1311,7 +1540,7 @@

getSetting
Source:
@@ -1564,7 +1793,7 @@

getThemeSource:
@@ -1836,7 +2065,7 @@

Source:
@@ -2089,7 +2318,7 @@

Source:
@@ -2339,7 +2568,7 @@

updateS
Source:
@@ -2592,7 +2821,7 @@

updateThem
Source:
@@ -2868,7 +3097,7 @@

Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/ClientGrantsManager.html b/docs/ClientGrantsManager.html index 0bbf016ac..fc805b1de 100644 --- a/docs/ClientGrantsManager.html +++ b/docs/ClientGrantsManager.html @@ -101,7 +101,7 @@

ne
Source:
@@ -334,6 +334,85 @@

Parameters:
+

Members

+ + + +
+

resource :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the +Auth0 Client Grants endpoint.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -387,7 +466,7 @@

createSource:
@@ -605,7 +684,7 @@

deleteSource:
@@ -874,7 +953,7 @@

getAllSource:
@@ -1202,7 +1281,7 @@

updateSource:
@@ -1481,7 +1560,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/ClientsManager.html b/docs/ClientsManager.html index 182661c2e..ae682087f 100644 --- a/docs/ClientsManager.html +++ b/docs/ClientsManager.html @@ -105,7 +105,7 @@

new Cli
Source:
@@ -338,6 +338,160 @@

Parameters:
+

Members

+ + + +
+

resource :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the +Auth0 Clients endpoint.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + + +
+

rotateSecretResource :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the +Auth0 Clients Rotate a client secret.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -391,7 +545,7 @@

createSource:
@@ -609,7 +763,7 @@

deleteSource:
@@ -878,7 +1032,7 @@

getSource:
@@ -1147,7 +1301,7 @@

getAllSource:
@@ -1474,7 +1628,7 @@

rot
Source:
@@ -1697,7 +1851,7 @@

updateSource:
@@ -1972,7 +2126,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/ConnectionsManager.html b/docs/ConnectionsManager.html index a6eea8a77..26979d700 100644 --- a/docs/ConnectionsManager.html +++ b/docs/ConnectionsManager.html @@ -100,7 +100,7 @@

new
Source:
@@ -333,6 +333,160 @@

Parameters:
+

Members

+ + + +
+

resource :external:RestClient

+ + + + +
+

Provides an abstraction layer for performing CRUD operations on +Auth0 Connections.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + + +
+

user :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the +endpoint.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -386,7 +540,7 @@

checkStatu
Source:
@@ -661,7 +815,7 @@

createSource:
@@ -879,7 +1033,7 @@

deleteSource:
@@ -1148,7 +1302,7 @@

dele
Source:
@@ -1443,7 +1597,7 @@

getSource:
@@ -1712,7 +1866,7 @@

getAllSource:
@@ -2039,7 +2193,7 @@

updateSource:
@@ -2314,7 +2468,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/CustomDomainsManager.html b/docs/CustomDomainsManager.html index 361b2e78d..00740d521 100644 --- a/docs/CustomDomainsManager.html +++ b/docs/CustomDomainsManager.html @@ -105,7 +105,7 @@

n
Source:
@@ -338,6 +338,160 @@

Parameters:
+

Members

+ + + +
+

resource :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the +Auth0 Custom Domains endpoint.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + + +
+

vefifyResource :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the +Auth0 Custom Domains Verify endpoint.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -391,7 +545,7 @@

createSource:
@@ -609,7 +763,7 @@

deleteSource:
@@ -878,7 +1032,7 @@

getSource:
@@ -1147,7 +1301,7 @@

getAllSource:
@@ -1263,7 +1417,7 @@

verifySource:
@@ -1501,7 +1655,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/DatabaseAuthenticator.html b/docs/DatabaseAuthenticator.html index b3be09c74..8819e83e3 100644 --- a/docs/DatabaseAuthenticator.html +++ b/docs/DatabaseAuthenticator.html @@ -1686,7 +1686,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/DeviceCredentialsManager.html b/docs/DeviceCredentialsManager.html index 7a5ca061e..f7d33a60b 100644 --- a/docs/DeviceCredentialsManager.html +++ b/docs/DeviceCredentialsManager.html @@ -100,7 +100,7 @@

Source:
@@ -333,6 +333,85 @@
Parameters:
+

Members

+ + + +
+

resource :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the +Auth0 DeviceCredentialsManagers endpoint.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -386,7 +465,7 @@

create
Source:
@@ -604,7 +683,7 @@

deleteSource:
@@ -875,7 +954,7 @@

getAllSource:
@@ -1060,7 +1139,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/EmailProviderManager.html b/docs/EmailProviderManager.html index d88317035..896be5e64 100644 --- a/docs/EmailProviderManager.html +++ b/docs/EmailProviderManager.html @@ -100,7 +100,7 @@

n
Source:
@@ -333,6 +333,85 @@

Parameters:
+

Members

+ + + +
+

resource :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the +Auth0 Clients endpoint.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -386,7 +465,7 @@

configureSource:
@@ -604,7 +683,7 @@

deleteSource:
@@ -788,7 +867,7 @@

getSource:
@@ -1103,7 +1182,7 @@

updateSource:
@@ -1325,7 +1404,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/EmailTemplatesManager.html b/docs/EmailTemplatesManager.html index c591bb8c1..0d2048eee 100644 --- a/docs/EmailTemplatesManager.html +++ b/docs/EmailTemplatesManager.html @@ -101,7 +101,7 @@

Source:
@@ -334,6 +334,85 @@

Parameters:
+

Members

+ + + +
+

resource :external:RestClient

+ + + + +
+

Provides an abstraction layer for performing CRUD operations on +Auth0's Email Templates.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -387,7 +466,7 @@

createSource:
@@ -605,7 +684,7 @@

getSource:
@@ -874,7 +953,7 @@

updateSource:
@@ -1149,7 +1228,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/GrantsManager.html b/docs/GrantsManager.html index 037422976..262f8964a 100644 --- a/docs/GrantsManager.html +++ b/docs/GrantsManager.html @@ -101,7 +101,7 @@

new Gran
Source:
@@ -334,6 +334,85 @@

Parameters:
+

Members

+ + + +
+

resource :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the +Auth0 Grants endpoint.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -387,7 +466,7 @@

deleteSource:
@@ -687,7 +766,7 @@

getAllSource:
@@ -1060,7 +1139,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/GuardianManager.html b/docs/GuardianManager.html index 8b4d49cb4..92c74eb03 100644 --- a/docs/GuardianManager.html +++ b/docs/GuardianManager.html @@ -100,7 +100,7 @@

new Gu
Source:
@@ -333,6 +333,676 @@

Parameters:
+

Members

+ + + +
+

enrollments :external:RestClient

+ + + + +
+

Provides an abstraction layer for retrieving Guardian enrollments.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + + +
+

factors :external:RestClient

+ + + + +
+

Provides an abstraction layer for retrieving Guardian factors.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + + +
+

factorSettings :external:RestClient

+ + + + +
+

Provides an abstraction layer for configuring Factor settings

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + + +
+

factorsPhoneMessageTypes :external:RestClient

+ + + + +
+

Provides an abstraction layer for retrieving Guardian phone factor message types.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + + +
+

factorsPhoneSelectedProvider :external:RestClient

+ + + + +
+

Provides an abstraction layer for retrieving Guardian phone factor selected provider.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + + +
+

factorsProviders :external:RestClient

+ + + + +
+

Provides an abstraction layer for retrieving Guardian factor providers.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + + +
+

factorsTemplates :external:RestClient

+ + + + +
+

Provides an abstraction layer for retrieving Guardian factor templates.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + + +
+

policies :external:RestClient

+ + + + +
+

Provides an abstraction layer for retrieving Guardian policies.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + + +
+

tickets :external:RestClient

+ + + + +
+

Provides an abstraction layer for retrieving Guardian tickets.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -386,7 +1056,7 @@

Source:
@@ -566,7 +1236,7 @@

Source:
@@ -831,7 +1501,7 @@

getF
Source:
@@ -1045,7 +1715,7 @@

getFactors<
Source:
@@ -1225,7 +1895,7 @@

getF
Source:
@@ -1439,7 +2109,7 @@

get
Source:
@@ -1653,7 +2323,7 @@

Source:
@@ -1918,7 +2588,7 @@

Source:
@@ -2098,7 +2768,7 @@

Source:
@@ -2278,7 +2948,7 @@

getPolicie
Source:
@@ -2458,7 +3128,7 @@

updateFac
Source:
@@ -2708,7 +3378,7 @@

u
Source:
@@ -2960,7 +3630,7 @@

u
Source:
@@ -3177,7 +3847,7 @@

Source:
@@ -3428,7 +4098,7 @@

Source:
@@ -3729,7 +4399,7 @@

Source:
@@ -4030,7 +4700,7 @@

updateP
Source:
@@ -4249,7 +4919,7 @@

Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/HooksManager.html b/docs/HooksManager.html index 725e807b6..10a260151 100644 --- a/docs/HooksManager.html +++ b/docs/HooksManager.html @@ -101,7 +101,7 @@

new Hooks
Source:
@@ -334,6 +334,85 @@

Parameters:
+

Members

+ + + +
+

resource :external:RestClient

+ + + + +
+

Provides an abstraction layer for performing CRUD operations on +Auth0 HooksManagers.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -387,7 +466,7 @@

addSecrets<
Source:
@@ -693,7 +772,7 @@

createSource:
@@ -911,7 +990,7 @@

deleteSource:
@@ -1180,7 +1259,7 @@

getSource:
@@ -1449,7 +1528,7 @@

getAllSource:
@@ -1776,7 +1855,7 @@

getSecrets<
Source:
@@ -2047,7 +2126,7 @@

removeSe
Source:
@@ -2353,7 +2432,7 @@

updateSource:
@@ -2669,7 +2748,7 @@

updateSe
Source:
@@ -2944,7 +3023,7 @@

Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/JobsManager.html b/docs/JobsManager.html index c24daa225..605dbe4d7 100644 --- a/docs/JobsManager.html +++ b/docs/JobsManager.html @@ -100,7 +100,7 @@

new JobsMa
Source:
@@ -333,6 +333,235 @@

Parameters:
+

Members

+ + + +
+

jobErrors :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the +Errors endpoint.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + + +
+

jobs :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the +Jobs endpoint.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + + +
+

usersExports :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the +Create job to export users endpoint

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -386,7 +615,7 @@

errorsSource:
@@ -660,7 +889,7 @@

exportUser
Source:
@@ -1074,7 +1303,7 @@

getSource:
@@ -1352,7 +1581,7 @@

importUser
Source:
@@ -1780,7 +2009,7 @@

importU
Source:
@@ -2206,7 +2435,7 @@

verifyEmai
Source:
@@ -2641,7 +2870,7 @@

Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/LogStreamsManager.html b/docs/LogStreamsManager.html index 990759f4c..4b81c1b9e 100644 --- a/docs/LogStreamsManager.html +++ b/docs/LogStreamsManager.html @@ -101,7 +101,7 @@

new
Source:
@@ -334,6 +334,85 @@

Parameters:
+

Members

+ + + +
+

resource :external:RestClient

+ + + + +
+

Provides an abstraction layer for performing CRUD operations on +Auth0 Log Streams.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -387,7 +466,7 @@

createSource:
@@ -605,7 +684,7 @@

deleteSource:
@@ -874,7 +953,7 @@

getSource:
@@ -1143,7 +1222,7 @@

getAllSource:
@@ -1323,7 +1402,7 @@

updateSource:
@@ -1608,7 +1687,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/LogsManager.html b/docs/LogsManager.html index 9993feed8..926d83426 100644 --- a/docs/LogsManager.html +++ b/docs/LogsManager.html @@ -100,7 +100,7 @@

new LogsMa
Source:
@@ -333,6 +333,85 @@

Parameters:
+

Members

+ + + +
+

resource :external:RestClient

+ + + + +
+

Provides an abstraction layer for performing CRUD operations on +Auth0 Logs.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -386,7 +465,7 @@

getSource:
@@ -655,7 +734,7 @@

getAllSource:
@@ -1203,7 +1282,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/ManagementClient.html b/docs/ManagementClient.html index 9694dfbba..c6f935e10 100644 --- a/docs/ManagementClient.html +++ b/docs/ManagementClient.html @@ -638,6 +638,46 @@
Parameters:
+ + + + includeResponseHeaders + + + + + +object + + + + + + + + + <optional>
+ + + + + + + + + + + + + + + +

Include the response headers in the payload in the format { data, headers }.

+ + + + + @@ -761,7 +801,7 @@

actionsSource:
@@ -835,7 +875,7 @@

attac
Source:
@@ -910,7 +950,7 @@

blac
Source:
@@ -985,7 +1025,7 @@

brandingSource:
@@ -1060,7 +1100,7 @@

clientGra
Source:
@@ -1135,7 +1175,7 @@

clientsSource:
@@ -1210,7 +1250,7 @@

connection
Source:
@@ -1285,7 +1325,7 @@

customDo
Source:
@@ -1360,7 +1400,7 @@

devi
Source:
@@ -1435,7 +1475,7 @@

emailPro
Source:
@@ -1510,7 +1550,7 @@

emailTe
Source:
@@ -1585,7 +1625,7 @@

grantsSource:
@@ -1660,7 +1700,7 @@

guardianSource:
@@ -1735,7 +1775,7 @@

hooksSource:
@@ -1809,7 +1849,7 @@

jobsSource:
@@ -1883,7 +1923,7 @@

logsSource:
@@ -1957,7 +1997,7 @@

logStreams<
Source:
@@ -2031,7 +2071,7 @@

migrations<
Source:
@@ -2105,7 +2145,7 @@

organiza
Source:
@@ -2179,7 +2219,7 @@

promptsSource:
@@ -2254,7 +2294,7 @@

resour
Source:
@@ -2329,7 +2369,7 @@

rolesSource:
@@ -2404,7 +2444,7 @@

rulesSource:
@@ -2478,7 +2518,7 @@

rulesConf
Source:
@@ -2552,7 +2592,7 @@

statsSource:
@@ -2626,7 +2666,7 @@

tenantSource:
@@ -2700,7 +2740,7 @@

ticketsSource:
@@ -2775,7 +2815,7 @@

userBlocks<
Source:
@@ -2850,7 +2890,7 @@

usersSource:
@@ -2934,7 +2974,7 @@

addHook
Source:
@@ -3239,7 +3279,7 @@

a
Source:
@@ -3618,7 +3658,7 @@

Source:
@@ -3975,7 +4015,7 @@

assi
Source:
@@ -4332,7 +4372,7 @@

assi
Source:
@@ -4715,7 +4755,7 @@

blackli
Source:
@@ -5015,7 +5055,7 @@

Source:
@@ -5233,7 +5273,7 @@

createCli
Source:
@@ -5451,7 +5491,7 @@

crea
Source:
@@ -5669,7 +5709,7 @@

creat
Source:
@@ -5887,7 +5927,7 @@

cre
Source:
@@ -6105,7 +6145,7 @@

Source:
@@ -6323,7 +6363,7 @@

cr
Source:
@@ -6539,7 +6579,7 @@

Source:
@@ -6723,7 +6763,7 @@

Source:
@@ -6903,7 +6943,7 @@

createHook<
Source:
@@ -7121,7 +7161,7 @@

create
Source:
@@ -7339,7 +7379,7 @@

Source:
@@ -7531,7 +7571,7 @@

c
Source:
@@ -7749,7 +7789,7 @@

createRole<
Source:
@@ -7968,7 +8008,7 @@

createRule<
Source:
@@ -8186,7 +8226,7 @@

createUser<
Source:
@@ -8406,7 +8446,7 @@

deleteA
Source:
@@ -8590,7 +8630,7 @@

Source:
@@ -8840,7 +8880,7 @@

deleteCli
Source:
@@ -9109,7 +9149,7 @@

dele
Source:
@@ -9378,7 +9418,7 @@

delet
Source:
@@ -9647,7 +9687,7 @@

del
Source:
@@ -9916,7 +9956,7 @@

Source:
@@ -10187,7 +10227,7 @@

de
Source:
@@ -10371,7 +10411,7 @@

deleteGran
Source:
@@ -10671,7 +10711,7 @@

Source:
@@ -10940,7 +10980,7 @@

deleteHook<
Source:
@@ -11209,7 +11249,7 @@

delete
Source:
@@ -11478,7 +11518,7 @@

d
Source:
@@ -11747,7 +11787,7 @@

deleteRole<
Source:
@@ -12016,7 +12056,7 @@

deleteRule<
Source:
@@ -12285,7 +12325,7 @@

dele
Source:
@@ -12554,7 +12594,7 @@

deleteUser<
Source:
@@ -12823,7 +12863,7 @@

Source:
@@ -13124,7 +13164,7 @@

Source:
@@ -13421,7 +13461,7 @@

exportUser
Source:
@@ -13835,7 +13875,7 @@

getAcce
Source:
@@ -13943,7 +13983,7 @@

ge
Source:
@@ -14127,7 +14167,7 @@

g
Source:
@@ -14307,7 +14347,7 @@

ge
Source:
@@ -14560,7 +14600,7 @@

Source:
@@ -14813,7 +14853,7 @@

getClientSource:
@@ -15082,7 +15122,7 @@

getCli
Source:
@@ -15409,7 +15449,7 @@

getClients<
Source:
@@ -15736,7 +15776,7 @@

getConne
Source:
@@ -16005,7 +16045,7 @@

getConn
Source:
@@ -16332,7 +16372,7 @@

getCus
Source:
@@ -16601,7 +16641,7 @@

getCu
Source:
@@ -16717,7 +16757,7 @@

Source:
@@ -17010,7 +17050,7 @@

getDaily
Source:
@@ -17310,7 +17350,7 @@

g
Source:
@@ -17526,7 +17566,7 @@

getEm
Source:
@@ -17841,7 +17881,7 @@

getEm
Source:
@@ -18110,7 +18150,7 @@

getGrantsSource:
@@ -18514,7 +18554,7 @@

Source:
@@ -18779,7 +18819,7 @@

Source:
@@ -19044,7 +19084,7 @@

Source:
@@ -19258,7 +19298,7 @@

get
Source:
@@ -19438,7 +19478,7 @@

Source:
@@ -19652,7 +19692,7 @@

Source:
@@ -19866,7 +19906,7 @@

Source:
@@ -20046,7 +20086,7 @@

Source:
@@ -20226,7 +20266,7 @@

ge
Source:
@@ -20406,7 +20446,7 @@

getHookSource:
@@ -20675,7 +20715,7 @@

getHooksSource:
@@ -21002,7 +21042,7 @@

getHook
Source:
@@ -21272,7 +21312,7 @@

getJobSource:
@@ -21546,7 +21586,7 @@

getJobErr
Source:
@@ -21820,7 +21860,7 @@

getLogSource:
@@ -22089,7 +22129,7 @@

getLogsSource:
@@ -22596,7 +22636,7 @@

getLogStr
Source:
@@ -22868,7 +22908,7 @@

getLogSt
Source:
@@ -23039,7 +23079,7 @@

getMigra
Source:
@@ -23224,7 +23264,7 @@

g
Source:
@@ -23448,7 +23488,7 @@

get
Source:
@@ -23628,7 +23668,7 @@

getR
Source:
@@ -23897,7 +23937,7 @@

get
Source:
@@ -24224,7 +24264,7 @@

getRoleSource:
@@ -24493,7 +24533,7 @@

getRolesSource:
@@ -24820,7 +24860,7 @@

getRuleSource:
@@ -25089,7 +25129,7 @@

getRulesSource:
@@ -25416,7 +25456,7 @@

getRul
Source:
@@ -25600,7 +25640,7 @@

getT
Source:
@@ -25784,7 +25824,7 @@

getUserSource:
@@ -26049,7 +26089,7 @@

getUserB
Source:
@@ -26318,7 +26358,7 @@

Source:
@@ -26587,7 +26627,7 @@

getUserLog
Source:
@@ -26962,7 +27002,7 @@

get
Source:
@@ -27337,7 +27377,7 @@

getUserRo
Source:
@@ -27712,7 +27752,7 @@

getUsersSource:
@@ -28113,7 +28153,7 @@

getUse
Source:
@@ -28469,7 +28509,7 @@

getUser
Source:
@@ -28841,7 +28881,7 @@

importUser
Source:
@@ -29269,7 +29309,7 @@

importU
Source:
@@ -29695,7 +29735,7 @@

Source:
@@ -29964,7 +30004,7 @@

linkUsersSource:
@@ -30351,7 +30391,7 @@

Source:
@@ -30616,7 +30656,7 @@

remo
Source:
@@ -30921,7 +30961,7 @@

Source:
@@ -31300,7 +31340,7 @@

Source:
@@ -31657,7 +31697,7 @@

re
Source:
@@ -32014,7 +32054,7 @@

Source:
@@ -32480,7 +32520,7 @@

Source:
@@ -32730,7 +32770,7 @@

setRule
Source:
@@ -33087,7 +33127,7 @@

unblockUse
Source:
@@ -33356,7 +33396,7 @@

Source:
@@ -33625,7 +33665,7 @@

unlinkUser
Source:
@@ -33948,7 +33988,7 @@

upda
Source:
@@ -34257,7 +34297,7 @@

Source:
@@ -34510,7 +34550,7 @@

updateCli
Source:
@@ -34816,7 +34856,7 @@

upda
Source:
@@ -35126,7 +35166,7 @@

updat
Source:
@@ -35432,7 +35472,7 @@

Source:
@@ -35751,7 +35791,7 @@

up
Source:
@@ -36004,7 +36044,7 @@

up
Source:
@@ -36310,7 +36350,7 @@

u
Source:
@@ -36560,7 +36600,7 @@

Source:
@@ -36812,7 +36852,7 @@

Source:
@@ -37063,7 +37103,7 @@

Source:
@@ -37314,7 +37354,7 @@

Source:
@@ -37615,7 +37655,7 @@

Source:
@@ -37916,7 +37956,7 @@

Source:
@@ -38166,7 +38206,7 @@

updateHook<
Source:
@@ -38471,7 +38511,7 @@

upda
Source:
@@ -38776,7 +38816,7 @@

update
Source:
@@ -39081,7 +39121,7 @@

updat
Source:
@@ -39301,7 +39341,7 @@

Source:
@@ -39517,7 +39557,7 @@

u
Source:
@@ -39823,7 +39863,7 @@

updateRole<
Source:
@@ -40128,7 +40168,7 @@

updateRule<
Source:
@@ -40433,7 +40473,7 @@

u
Source:
@@ -40649,7 +40689,7 @@

updateUser<
Source:
@@ -40955,7 +40995,7 @@

upd
Source:
@@ -41264,7 +41304,7 @@

ver
Source:
@@ -41502,7 +41542,7 @@

Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/ManagementTokenProvider.html b/docs/ManagementTokenProvider.html index 2a3faf514..1e1368e63 100644 --- a/docs/ManagementTokenProvider.html +++ b/docs/ManagementTokenProvider.html @@ -671,7 +671,7 @@
Returns:

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/MigrationsManager.html b/docs/MigrationsManager.html index b1dfdf501..3e3ba7115 100644 --- a/docs/MigrationsManager.html +++ b/docs/MigrationsManager.html @@ -100,7 +100,7 @@

new
Source:
@@ -333,6 +333,84 @@

Parameters:
+

Members

+ + + +
+

resource :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the migrations endpoint

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -386,7 +464,7 @@

getMigra
Source:
@@ -599,7 +677,7 @@

updat
Source:
@@ -835,7 +913,7 @@

Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/OAUthWithIDTokenValidation.html b/docs/OAUthWithIDTokenValidation.html index f2a8106ab..73f61a439 100644 --- a/docs/OAUthWithIDTokenValidation.html +++ b/docs/OAUthWithIDTokenValidation.html @@ -692,7 +692,7 @@
Returns:

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/OAuthAuthenticator.html b/docs/OAuthAuthenticator.html index c120dd3ca..a75cb0195 100644 --- a/docs/OAuthAuthenticator.html +++ b/docs/OAuthAuthenticator.html @@ -2169,7 +2169,7 @@
Returns:

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/OrganizationsManager.html b/docs/OrganizationsManager.html index f06329657..a97046942 100644 --- a/docs/OrganizationsManager.html +++ b/docs/OrganizationsManager.html @@ -101,7 +101,7 @@

n
Source:
@@ -334,6 +334,85 @@

Parameters:
+

Members

+ + + +
+

organizations :external:RestClient

+ + + + +
+

Provides an abstraction layer for performing CRUD operations on +https://auth0.com/docs/api/v2.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -387,7 +466,7 @@

a
Source:
@@ -768,7 +847,7 @@

addMemb
Source:
@@ -1149,7 +1228,7 @@

addMembers<
Source:
@@ -1503,7 +1582,7 @@

createSource:
@@ -1721,7 +1800,7 @@

creat
Source:
@@ -2476,7 +2555,7 @@

deleteSource:
@@ -2745,7 +2824,7 @@

delet
Source:
@@ -3040,7 +3119,7 @@

getAllSource:
@@ -3439,7 +3518,7 @@

getByIDSource:
@@ -3708,7 +3787,7 @@

getByNameSource:
@@ -3977,7 +4056,7 @@

g
Source:
@@ -4274,7 +4353,7 @@

Source:
@@ -4545,7 +4624,7 @@

getInvit
Source:
@@ -4871,7 +4950,7 @@

getInvi
Source:
@@ -5432,7 +5511,7 @@

getMemb
Source:
@@ -5758,7 +5837,7 @@

getMembers<
Source:
@@ -6111,7 +6190,7 @@

Source:
@@ -6406,7 +6485,7 @@

remo
Source:
@@ -6787,7 +6866,7 @@

removeMe
Source:
@@ -7142,7 +7221,7 @@

updateSource:
@@ -7448,7 +7527,7 @@

Source:
@@ -7747,7 +7826,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/PasswordlessAuthenticator.html b/docs/PasswordlessAuthenticator.html index 0e998bfdd..6c0a15fb8 100644 --- a/docs/PasswordlessAuthenticator.html +++ b/docs/PasswordlessAuthenticator.html @@ -1804,7 +1804,7 @@
Examples

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/PromptsManager.html b/docs/PromptsManager.html index 5a2e34ecf..46d81207b 100644 --- a/docs/PromptsManager.html +++ b/docs/PromptsManager.html @@ -100,7 +100,7 @@

new Pro
Source:
@@ -333,6 +333,160 @@

Parameters:
+

Members

+ + + +
+

customTextByLanguage :external:RestClient

+ + + + +
+

Retrieve custom text for a specific prompt and language. +Custom Text endpoint

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + + +
+

resource :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the +Prompts endpoint.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -386,7 +540,7 @@

Source:
@@ -683,7 +837,7 @@

getSetting
Source:
@@ -936,7 +1090,7 @@

Source:
@@ -1259,7 +1413,7 @@

updateS
Source:
@@ -1481,7 +1635,7 @@

Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/ResourceServersManager.html b/docs/ResourceServersManager.html index fbbac2e9b..56c9def09 100644 --- a/docs/ResourceServersManager.html +++ b/docs/ResourceServersManager.html @@ -105,7 +105,7 @@

Source:
@@ -338,6 +338,85 @@

Parameters:
+

Members

+ + + +
+

resource :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the +Auth0 Resource Servers endpoint.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -391,7 +470,7 @@

createSource:
@@ -609,7 +688,7 @@

deleteSource:
@@ -878,7 +957,7 @@

getSource:
@@ -1147,7 +1226,7 @@

getAllSource:
@@ -1474,7 +1553,7 @@

updateSource:
@@ -1749,7 +1828,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/RestClient%0A%7B@link%20https___github.com_ngonzalvez_rest-facade%7Dexternal_.html b/docs/RestClient%0A%7B@link%20https___github.com_ngonzalvez_rest-facade%7Dexternal_.html index 4e3a04737..9f2dcb62c 100644 --- a/docs/RestClient%0A%7B@link%20https___github.com_ngonzalvez_rest-facade%7Dexternal_.html +++ b/docs/RestClient%0A%7B@link%20https___github.com_ngonzalvez_rest-facade%7Dexternal_.html @@ -136,7 +136,7 @@


- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/RetryRestClient.html b/docs/RetryRestClient.html index 879228120..c0627f816 100644 --- a/docs/RetryRestClient.html +++ b/docs/RetryRestClient.html @@ -377,7 +377,7 @@

Parameters:

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/RetryRestClient.js.html b/docs/RetryRestClient.js.html index 1fecf6ed1..9ce5216ef 100644 --- a/docs/RetryRestClient.js.html +++ b/docs/RetryRestClient.js.html @@ -157,7 +157,7 @@

RetryRestClient.js


- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/RolesManager.html b/docs/RolesManager.html index fee94eacf..7f48d5504 100644 --- a/docs/RolesManager.html +++ b/docs/RolesManager.html @@ -101,7 +101,7 @@

new Roles
Source:
@@ -334,6 +334,85 @@

Parameters:
+

Members

+ + + +
+

resource :external:RestClient

+ + + + +
+

Provides an abstraction layer for performing CRUD operations on +Auth0 RolesManagers.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -387,7 +466,7 @@

addPerm
Source:
@@ -770,7 +849,7 @@

assignUser
Source:
@@ -1153,7 +1232,7 @@

createSource:
@@ -1371,7 +1450,7 @@

deleteSource:
@@ -1640,7 +1719,7 @@

getSource:
@@ -1909,7 +1988,7 @@

getAllSource:
@@ -2236,7 +2315,7 @@

getPerm
Source:
@@ -2516,7 +2595,7 @@

getUsersSource:
@@ -2886,7 +2965,7 @@

remo
Source:
@@ -3269,7 +3348,7 @@

updateSource:
@@ -3554,7 +3633,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/RulesConfigsManager.html b/docs/RulesConfigsManager.html index 0007d0589..34fc26535 100644 --- a/docs/RulesConfigsManager.html +++ b/docs/RulesConfigsManager.html @@ -101,7 +101,7 @@

ne
Source:
@@ -334,6 +334,85 @@

Parameters:
+

Members

+ + + +
+

resource :external:RestClient

+ + + + +
+

Provides an abstraction layer for performing CRUD operations on +Auth0 RulesConfigsManager.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -387,7 +466,7 @@

deleteSource:
@@ -656,7 +735,7 @@

getAllSource:
@@ -836,7 +915,7 @@

setSource:
@@ -1162,7 +1241,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/RulesManager.html b/docs/RulesManager.html index 1b04e35ed..629ca5911 100644 --- a/docs/RulesManager.html +++ b/docs/RulesManager.html @@ -101,7 +101,7 @@

new Rules
Source:
@@ -334,6 +334,85 @@

Parameters:
+

Members

+ + + +
+

resource :external:RestClient

+ + + + +
+

Provides an abstraction layer for performing CRUD operations on +Auth0 RulesManagers.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -387,7 +466,7 @@

createSource:
@@ -605,7 +684,7 @@

deleteSource:
@@ -874,7 +953,7 @@

getSource:
@@ -1143,7 +1222,7 @@

getAllSource:
@@ -1470,7 +1549,7 @@

updateSource:
@@ -1755,7 +1834,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/StatsManager.html b/docs/StatsManager.html index 4152cc155..b1312ec59 100644 --- a/docs/StatsManager.html +++ b/docs/StatsManager.html @@ -100,7 +100,7 @@

new Stats
Source:
@@ -333,6 +333,85 @@

Parameters:
+

Members

+ + + +
+

resource :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the +Stats endpoint.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -386,7 +465,7 @@

ge
Source:
@@ -570,7 +649,7 @@

getDailySource:
@@ -839,7 +918,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/TenantManager.html b/docs/TenantManager.html index 31d9521a1..1814397db 100644 --- a/docs/TenantManager.html +++ b/docs/TenantManager.html @@ -100,7 +100,7 @@

new Tena
Source:
@@ -333,6 +333,85 @@

Parameters:
+

Members

+ + + +
+

resource :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the +Stats endpoint.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -386,7 +465,7 @@

getSetting
Source:
@@ -606,7 +685,7 @@

updateS
Source:
@@ -791,7 +870,7 @@

Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/TicketsManager.html b/docs/TicketsManager.html index 39986b7d1..ff8301236 100644 --- a/docs/TicketsManager.html +++ b/docs/TicketsManager.html @@ -100,7 +100,7 @@

new Tic
Source:
@@ -333,6 +333,85 @@

Parameters:
+

Members

+ + + +
+

resource :external:RestClient

+ + + + +
+

Provides an abstraction layer for consuming the +Tickets endpoint.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + +

Methods

@@ -386,7 +465,7 @@

changeP
Source:
@@ -957,7 +1036,7 @@

verifyEmai
Source:
@@ -1498,7 +1577,7 @@

Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/TokensManager.html b/docs/TokensManager.html index 6bb43899d..d389c9244 100644 --- a/docs/TokensManager.html +++ b/docs/TokensManager.html @@ -1366,7 +1366,7 @@
Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/UserBlocksManager.html b/docs/UserBlocksManager.html index ac7551778..c87bbef60 100644 --- a/docs/UserBlocksManager.html +++ b/docs/UserBlocksManager.html @@ -100,7 +100,7 @@

new
Source:
@@ -386,7 +386,7 @@

deleteSource:
@@ -655,7 +655,7 @@

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

getSource:
@@ -1193,7 +1193,7 @@

getByI
Source:
@@ -1431,7 +1431,7 @@

Example

- Generated by JSDoc 3.6.7 on Mon May 23 2022 13:08:55 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.10 on Mon Oct 10 2022 11:39:34 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/UsersManager.html b/docs/UsersManager.html index 3d8982514..d73d86cdd 100644 --- a/docs/UsersManager.html +++ b/docs/UsersManager.html @@ -333,24 +333,18 @@
Parameters:
- - -

Methods

+

Members

-
- - - -

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

+
+

enrollments :external:RestClient

-
-

Assign permissions to a user

+

Provides an abstraction layer for retrieving Guardian enrollments.

@@ -386,7 +380,7 @@

assi
Source:
@@ -399,296 +393,1330 @@

assi +

Type:
+ -
Parameters:
- - - - - - + + + +
+

identities :external:RestClient

-
- - - - - - - +
+

Provides a simple abstraction layer for linking user accounts.

+
- - - - - - - +
- -
- + - + - - - - - - - - +
+

invalidateRememberBrowsers :external:RestClient

- -
- - +
+

Provides an abstraction layer for invalidating all remembered browsers for MFA.

+
- - + - - - - + +
Source:
+
+ - + + - - +
Type:
+ - + + - - -
NameTypeAttributesDescription
params - - -object - - - + - + - - -

params object

- - + - - - - - - + - + - + - + - - - + - - - - - + - + - + + + + +
Type:
+ - - - -
NameTypeDescription
id - - -string + +
Source:
+
+ + - - 		-

user_id

- -
+ + - -
data - - -string + + - - - - - -

data object containing list of permissions

- - - - - - - - - - - +
-
- - + - - - - - + - + - + - + - - + - -
NameTypeDescription
permissions - - -string + + - - -

Array of permission IDs

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

Callback function.

- -
+
+ + +
+

multifactor :external:RestClient

+
+

Provides an abstraction layer for consuming the +Multifactor Provider endpoint.

+
-
-
Returns:
+
- + -
-
- Type: -
-
- -Promise -| + -undefined + + -
-
+ + -
+ + -
-
Example
+ - 
var params =  { id : 'USER_ID';
-var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
+    
 
-management.users.assignPermissions(params, data, function (err, user) {
+    
+
+    
+    
Source:

+    

+    
+
+    
+
+    
+
+    
+
+
+
+
+    
Type:

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

permissions :external:RestClient

+ + + + +
+

Provides an abstraction layer for CRD on permissions directly on a user

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + + +
+

recoveryCodeRegenerations :external:RestClient

+ + + + +
+

Provides an abstraction layer for regenerating Guardian recovery codes.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + + +
+

roles :external:RestClient

+ + + + +
+

Provides an abstraction layer for CRD on roles for a user

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + + +
+

userLogs :external:RestClient

+ + + + +
+

Provides a simple abstraction layer for user logs

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + + +
+

usersByEmail :external:RestClient

+ + + + +
+

Provides an abstraction layer for the new "users-by-email" API

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + + + + +

Methods

+ + + +
+ + + +

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

+ + + + + +
+

Assign permissions to a user

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
params + + +object + + + + + + + + + + +

params object

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
id + + +string + + + + +

user_id

+ +
+ + +
data + + +string + + + + + + + + + + +

data object containing list of permissions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
permissions + + +string + + + + +

Array of permission IDs

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

Callback function.

+ +
+ + + + + + + + + + + + + + +
+
Returns:
+ + + +
+
+ Type: +
+
+ +Promise +| + +undefined + + +
+
+ + + +
+ + + +
+
Example
+ + 
var params =  { id : 'USER_ID';
+var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
+
+management.users.assignPermissions(params, data, function (err, user) {
+  if (err) {
+    // Handle error.
+  }
+
+  // permissions added.
+});
+ +
+ +
+ + +
+ + + +

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

+ + + + + +
+

Assign roles to a user

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
params + + +object + + + + + + + + + + +

params object

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
id + + +string + + + + +

user_id

+ +
+ + +
data + + +string + + + + + + + + + + +

data object containing list of role IDs

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
roles + + +string + + + + +

Array of role IDs

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

Callback function.

+ +
+ + + + + + + + + + + + + + +
+
Returns:
+ + + +
+
+ Type: +
+
+ +Promise +| + +undefined + + +
+
+ + + +
+ + + +
+
Example
+ + 
var params =  { id : 'USER_ID';
+var data = { "roles" : ["roleId1", "roleID2"]};
+
+management.users.assignRoles(params, data, function (err, user) {
   if (err) {
     // Handle error.
   }
 
-  // permissions added.
+  // roles added.
 });
@@ -700,14 +1728,14 @@
Example
-

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

+

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

-

Assign roles to a user

+

Create a new user.

@@ -743,7 +1771,7 @@

assignRole
Source:
@@ -780,43 +1808,208 @@

Parameters:
- Description - - + Description + + + + + + + + + data + + + + + +object + + + + + + + + + + + + + + + + + + +

User data.

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

Callback function.

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

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

+ + + + + +
+

Delete a user by its id.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + - +
- - - params - - - - -object - - - - - - - - - - - -

params object

- - +
Parameters:
+ @@ -828,6 +2021,8 @@
Parameters:
+ + @@ -840,47 +2035,13 @@
Parameters:
- - - - - - - - - - - - - - -
TypeAttributes
id - - -string - - - - -

user_id

- -
- - - - - - - - - - data + params -string +object @@ -899,7 +2060,7 @@
Parameters:
-

data object containing list of role IDs

+

The user data object..

@@ -925,7 +2086,7 @@
Parameters:
- roles + id @@ -942,7 +2103,7 @@
Parameters:
-

Array of role IDs

+

The user id.

@@ -986,7 +2147,7 @@
Parameters:
-

Callback function.

+

Callback function

@@ -1037,15 +2198,12 @@
Returns:
Example
- 
var params =  { id : 'USER_ID';
-var data = { "roles" : ["roleId1", "roleID2"]};
-
-management.users.assignRoles(params, data, function (err, user) {
+    
management.users.delete({ id: USER_ID }, function (err) {
   if (err) {
     // Handle error.
   }
 
-  // roles added.
+  // User deleted.
 });
@@ -1057,14 +2215,14 @@
Example
-

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

+

deleteAll(cbopt) → {Promise|undefined}

-

Create a new user.

+

Delete all users.

@@ -1088,6 +2246,8 @@

createDeprecated:
  • This method will be removed in the next major release.
+ @@ -1100,7 +2260,7 @@

createSource:
@@ -1144,40 +2304,6 @@
Parameters:
- - - data - - - - - -object - - - - - - - - - - - - - - - - - - -

User data.

- - - - - - cb @@ -1207,7 +2333,7 @@
Parameters:
-

Callback function.

+

Callback function

@@ -1258,12 +2384,12 @@
Returns:
Example
- 
management.users.create(data, function (err) {
+    
management.users.deleteAll(function (err) {
   if (err) {
     // Handle error.
   }
 
-  // User created.
+  // Users deleted
 });
@@ -1275,14 +2401,14 @@
Example
-

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

+

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

-

Delete a user by its id.

+

Delete a multifactor provider.

@@ -1318,7 +2444,7 @@

deleteSource:
@@ -1389,7 +2515,7 @@
Parameters:
-

The user data object..

+

Data object.

@@ -1438,6 +2564,32 @@
Parameters:
+ + + + provider + + + + + +string + + + + + + + + + + +

Multifactor provider.

+ + + + + @@ -1527,12 +2679,14 @@
Returns:
Example
- 
management.users.delete({ id: USER_ID }, function (err) {
+    
var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
+
+management.users.deleteMultifactorProvider(params, function (err, user) {
   if (err) {
     // Handle error.
   }
 
-  // User deleted.
+  // Users accounts unlinked.
 });
@@ -1544,14 +2698,14 @@
Example
-

deleteAll(cbopt) → {Promise|undefined}

+

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

-

Delete all users.

+

Get a user by its id.

@@ -1575,8 +2729,6 @@

deleteAllDeprecated:
  • This method will be removed in the next major release.
- @@ -1589,7 +2741,7 @@

deleteAllSource:
@@ -1618,19 +2770,104 @@
Parameters:
Name - Type + Type + + + Attributes + + + + + Description + + + + + + + + + data + + + + + +object + + + + + + + + + + + + + + + + + + +

The user data object.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - + - + + - - - + + +
NameTypeDescription
id + + +string + + + + Attributes +

The user id.

+ +
Description
+ + + + - @@ -1662,7 +2899,7 @@
Parameters:
-

Callback function

+

Callback function.

@@ -1713,12 +2950,8 @@
Returns:
Example
- 
management.users.deleteAll(function (err) {
-  if (err) {
-    // Handle error.
-  }
-
-  // Users deleted
+    
management.users.get({ id: USER_ID }, function (err, user) {
+  console.log(user);
 });
@@ -1730,14 +2963,14 @@
Example
-

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

+

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

-

Delete a multifactor provider.

+

Get all users.

@@ -1773,7 +3006,7 @@

Source:
@@ -1834,6 +3067,8 @@
Parameters:
+ <optional>
+ @@ -1844,7 +3079,7 @@
Parameters:
-

Data object.

+

Users params.

@@ -1858,6 +3093,8 @@
Parameters:
Type + Attributes + @@ -1870,24 +3107,34 @@
Parameters:
- id + per_page -string +number + + + <optional>
+ + + + + + + -

The user id.

+

Number of results per page.

@@ -1896,24 +3143,34 @@
Parameters:
- provider + page -string +number + + + <optional>
+ + + + + + + -

Multifactor provider.

+

Page number, zero indexed.

@@ -1957,7 +3214,7 @@
Parameters:
-

Callback function

+

Callback function.

@@ -2008,14 +3265,20 @@
Returns:
Example
- 
var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-
-management.users.deleteMultifactorProvider(params, function (err, user) {
-  if (err) {
-    // Handle error.
-  }
+        

+  This method takes an optional object as first argument that may be used to
+  specify pagination settings and the search query. 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
+};
 
-  // Users accounts unlinked.
+management.users.getAll(params, function (err, users) {
+  console.log(users.length);
 });
@@ -2027,14 +3290,14 @@
Example
-

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

+

getByEmail(emailopt, optionsopt, cbopt) → {Promise|undefined}

-

Get a user by its id.

+

Get Users by an Email Address

@@ -2070,7 +3333,7 @@

getSource:
@@ -2116,7 +3379,43 @@
Parameters:
- data + email + + + + + +string + + + + + + + + + <optional>
+ + + + + + + + + + + +

Email address of user(s) to find

+ + + + + + + + + options @@ -2131,6 +3430,8 @@
Parameters:
+ <optional>
+ @@ -2141,7 +3442,7 @@
Parameters:
-

The user data object.

+

Additional options to pass to the endpoint

@@ -2155,6 +3456,8 @@
Parameters:
Type + Attributes + @@ -2167,7 +3470,7 @@
Parameters:
- id + fields @@ -2180,11 +3483,57 @@
Parameters:
+ + + <optional>
+ + + + + + + -

The user id.

+

Comma-separated list of fields to include or exclude in the result

+ + + + + + + + + include_fields + + + + + +boolean + + + + + + + + + <optional>
+ + + + + + + + + + + +

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

@@ -2279,8 +3628,13 @@
Returns:
Example
- 
management.users.get({ id: USER_ID }, function (err, user) {
-  console.log(user);
+        

+  This method takes a first argument as the Email address to look for
+  users, and uses the /users-by-email API, not the search API
+

+    
+    
management.users.getByEmail('email@address', function (err, users) {
+  console.log(users);
 });
@@ -2292,14 +3646,14 @@
Example
-

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

+

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

-

Get all users.

+

Get a list of Guardian enrollments.

@@ -2335,7 +3689,7 @@

getAllSource:
@@ -2381,7 +3735,7 @@
Parameters:
- params + data @@ -2396,8 +3750,6 @@
Parameters:
- <optional>
- @@ -2408,7 +3760,7 @@
Parameters:
-

Users params.

+

The user data object.

@@ -2422,84 +3774,36 @@
Parameters:
Type - Attributes - - Description - - - - - - - - - per_page - - - - - -number - - - - - - - - - <optional>
- - - - - - - - - - - -

Number of results per page.

- - - + Description + + + - page + id -number +string - - - <optional>
- - - - - - - -

Page number, zero indexed.

+

The user id.

@@ -2594,20 +3898,8 @@
Returns:
Example
-

- This method takes an optional object as first argument that may be used to - specify pagination settings and the search query. 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.users.getAll(params, function (err, users) {
-  console.log(users.length);
+    
management.users.getGuardianEnrollments({ id: USER_ID }, function (err, enrollments) {
+  console.log(enrollments);
 });
@@ -2619,14 +3911,14 @@
Example
-

getByEmail(emailopt, optionsopt, cbopt) → {Promise|undefined}

+

getInfo(accessToken, cbopt) → {Promise|undefined}

-

Get Users by an Email Address

+

Given an access token get the user profile linked to it.

@@ -2662,7 +3954,7 @@

getByEmail<
Source:
@@ -2708,98 +4000,7 @@

Parameters:
- email - - - - - -string - - - - - - - - - <optional>
- - - - - - - - - - - -

Email address of user(s) to find

- - - - - - - - - options - - - - - -object - - - - - - - - - <optional>
- - - - - - - - - - - -

Additional options to pass to the endpoint

- - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDescription
fieldsaccessToken @@ -2814,44 +4015,6 @@
Parameters:
 - <optional>
- - - - - - 		-

Comma-separated list of fields to include or exclude in the result

- -
include_fields - - -boolean - - - - - - <optional>
- @@ -2862,15 +4025,7 @@
Parameters:
 -

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

- -
- +

User access token.

@@ -2958,12 +4113,17 @@
Returns:
Example

- This method takes a first argument as the Email address to look for - users, and uses the /users-by-email API, not the search API + Get the user information based on the Auth0 access token (obtained during + login). Find more information in the + API Docs.

- 
management.users.getByEmail('email@address', function (err, users) {
-  console.log(users);
+    
auth0.users.getInfo(accessToken, function (err, userInfo) {
+  if (err) {
+    // Handle error.
+  }
+
+  console.log(userInfo);
 });

@@ -2975,14 +4135,14 @@
Example
-

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

+

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

-

Get a list of Guardian enrollments.

+

Get a list of permissions for a user.

@@ -3018,7 +4178,7 @@

Source:
@@ -3227,8 +4387,8 @@

Returns:
Example
- 
management.users.getGuardianEnrollments({ id: USER_ID }, function (err, enrollments) {
-  console.log(enrollments);
+    
management.users.getPermissions({ id: USER_ID }, function (err, permissions) {
+  console.log(permissions);
 });
@@ -3240,14 +4400,14 @@
Example
-

getInfo(accessToken, cbopt) → {Promise|undefined}

+

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

-

Given an access token get the user profile linked to it.

+

Get a list of roles for a user.

@@ -3283,7 +4443,7 @@

getInfoSource:
@@ -3315,8 +4475,59 @@
Parameters:
Type - Attributes - + Attributes + + + + + Description + + + + + + + + + data + + + + + +object + + + + + + + + + + + + + + + + + + +

The user data object.

+ + + + + + + + + + + + + @@ -3329,7 +4540,7 @@
Parameters:
- + - - + + - + + +
NameType
accessTokenid @@ -3342,19 +4553,19 @@
Parameters:
 - - + + +

The user id.

-
- -

User access token.

@@ -3441,18 +4652,8 @@
Returns:
Example
-

- Get the user information based on the Auth0 access token (obtained during - login). Find more information in the - API Docs. -

- - 
auth0.users.getInfo(accessToken, function (err, userInfo) {
-  if (err) {
-    // Handle error.
-  }
-
-  console.log(userInfo);
+    
management.users.getRoles({ id: USER_ID }, function (err, roles) {
+  console.log(roles);
 });
@@ -3464,14 +4665,14 @@
Example
-

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

+

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

-

Get a list of permissions for a user.

+

Get a list of organizations for a user.

@@ -3507,7 +4708,7 @@

getPerm
Source:
@@ -3716,8 +4917,8 @@

Returns:
Example
- 
management.users.getPermissions({ id: USER_ID }, function (err, permissions) {
-  console.log(permissions);
+    
management.users.getUserOrganizations({ id: USER_ID }, function (err, orgs) {
+  console.log(orgs);
 });
@@ -3729,14 +4930,14 @@
Example
-

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

+

impersonate(userId, settings, cbopt) → {Promise|undefined}

-

Get a list of roles for a user.

+

Impersonate the user with the given user ID.

@@ -3772,7 +4973,7 @@

getRolesSource:
@@ -3818,7 +5019,41 @@
Parameters:
- data + userId + + + + + +string + + + + + + + + + + + + + + + + + + +

User ID token.

+ + + + + + + + + settings @@ -3843,7 +5078,7 @@
Parameters:
-

The user data object.

+

Impersonation settings.

@@ -3857,6 +5092,8 @@
Parameters:
Type + Attributes + @@ -3869,7 +5106,7 @@
Parameters:
- id + impersonator_id @@ -3882,11 +5119,123 @@
Parameters:
+ + + + + + + + -

The user id.

+

Impersonator user ID.

+ + + + + + + + + protocol + + + + + +string + + + + + + + + + + + + + + + + + + +

The authentication protocol.

+ + + + + + + + + token + + + + + +string + + + + + + + + + + + + + + + + + + +

API v1 token obtained for impersonation

+ + + + + + + + + clientId + + + + + +string + + + + + + + + + <optional>
+ + + + + + + + + + + +

Client id used for impersonation. Uses the one supplied in the constructor by default.

@@ -3981,8 +5330,24 @@
Returns:
Example
- 
management.users.getRoles({ id: USER_ID }, function (err, roles) {
-  console.log(roles);
+        

+  Gets a link that can be used once to log in as a specific user. Useful for
+  troubleshooting. Find more information in the
+  [API Docs](https://auth0.com/docs/auth-api#!#post--users--user_id--impersonate).
+

+    
+    
var settings = {
+  impersonator_id: '{IMPERSONATOR_ID}',
+  protocol: 'oauth2',
+  additionalParameters: {}  // Optional additional params.
+};
+
+auth0.users.impersonate(userId, settings, function (err, link) {
+  if (err) {
+    // Handle error.
+  }
+
+  console.log(link);
 });
@@ -3994,14 +5359,14 @@
Example
-

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

+

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

-

Get a list of organizations for a user.

+

Invalidate all remembered browsers for MFA.

@@ -4037,7 +5402,7 @@

g
Source:
@@ -4083,7 +5448,7 @@

Parameters:
- data + params @@ -4246,8 +5611,12 @@
Returns:
Example
- 
management.users.getUserOrganizations({ id: USER_ID }, function (err, orgs) {
-  console.log(orgs);
+    
management.users.invalidateRememberBrowser({ id: USER_ID }, function (err, result) {
+  if (err) {
+    // Handle error.
+  }
+
+  // Invalidated all remembered browsers.
 });
@@ -4259,14 +5628,14 @@
Example
-

impersonate(userId, settings, cbopt) → {Promise|undefined}

+
-

Impersonate the user with the given user ID.

+

Link the user with another account.

@@ -4302,7 +5671,7 @@

impersonat
Source:
@@ -4373,7 +5742,7 @@

Parameters:
-

User ID token.

+

ID of the primary user.

@@ -4382,7 +5751,7 @@
Parameters:
- settings + params @@ -4407,7 +5776,7 @@
Parameters:
-

Impersonation settings.

+

Secondary user data.

@@ -4421,8 +5790,6 @@
Parameters:
Type - Attributes - @@ -4435,7 +5802,7 @@
Parameters:
- impersonator_id + user_id @@ -4448,19 +5815,11 @@
Parameters:
- - - - - - - - -

Impersonator user ID.

+

ID of the user to be linked.

@@ -4469,7 +5828,7 @@
Parameters:
- protocol + connection_id @@ -4482,19 +5841,11 @@
Parameters:
- - - - - - - - -

The authentication protocol.

+

ID of the connection to be used.

@@ -4503,7 +5854,7 @@
Parameters:
- token + provider @@ -4516,19 +5867,11 @@
Parameters:
- - - - - - - - -

API v1 token obtained for impersonation

+

Identity provider of the secondary user account being linked.

@@ -4537,7 +5880,7 @@
Parameters:
- clientId + link_with @@ -4550,21 +5893,11 @@
Parameters:
- - - <optional>
- - - - - - - -

Client id used for impersonation. Uses the one supplied in the constructor by default.

+

JWT for the secondary account being linked. If sending this parameter, provider, user_id, and connection_id must not be sent.

@@ -4659,24 +5992,18 @@
Returns:
Example
-

- Gets a link that can be used once to log in as a specific user. Useful for - troubleshooting. Find more information in the - [API Docs](https://auth0.com/docs/auth-api#!#post--users--user_id--impersonate). -

- - 
var settings = {
-  impersonator_id: '{IMPERSONATOR_ID}',
-  protocol: 'oauth2',
-  additionalParameters: {}  // Optional additional params.
+    
var userId = 'USER_ID';
+var params = {
+  user_id: 'OTHER_USER_ID',
+  connection_id: 'CONNECTION_ID'
 };
 
-auth0.users.impersonate(userId, settings, function (err, link) {
+management.users.link(userId, params, function (err, user) {
   if (err) {
     // Handle error.
   }
 
-  console.log(link);
+  // Users linked.
 });
@@ -4688,14 +6015,14 @@
Example
-

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

+

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

-

Invalidate all remembered browsers for MFA.

+

Get user's log events.

@@ -4731,7 +6058,7 @@

Source:
@@ -4802,7 +6129,7 @@
Parameters:
-

The user data object.

+

Get logs data.

@@ -4845,7 +6172,111 @@
Parameters:
-

The user id.

+

User id.

+ + + + + + + + + per_page + + + + + +number + + + + + + + + + + +

Number of results per page.

+ + + + + + + + + page + + + + + +number + + + + + + + + + + +

Page number, zero indexed.

+ + + + + + + + + sort + + + + + +string + + + + + + + + + + +

The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.

+ + + + + + + + + include_totals + + + + + +boolean + + + + + + + + + + +

true if a query summary must be included in the result, false otherwise. Default false;

@@ -4940,12 +6371,14 @@
Returns:
Example
- 
management.users.invalidateRememberBrowser({ id: USER_ID }, function (err, result) {
+    
var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
+
+management.users.logs(params, function (err, logs) {
   if (err) {
     // Handle error.
   }
 
-  // Invalidated all remembered browsers.
+  console.log(logs);
 });
@@ -4957,14 +6390,14 @@
Example
- +

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

-

Link the user with another account.

+

Generate new Guardian recovery code.

@@ -4993,121 +6426,34 @@

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

Members

+ + + +
+

enrollments :external:RestClient

+ + + + +
+

Provides an abstraction layer for retrieving Guardian enrollments.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+ + + + + + +
+ + + +
+

identities :external:RestClient

+ + + + +
+

Provides a simple abstraction layer for linking user accounts.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ -undefined + + - +
- -
+
Type:
+ - 
var params = { id: USER_ID };
-var metadata = {
-  foo: 'bar'
-};
 
-management.users.updateAppMetadata(params, metadata, function (err, user) {
-  if (err) {
-    // Handle error.
-  }
 
-  // Updated user.
-  console.log(user);
-});
-
+ -
- - - -

updateUserMetadata(params, metadata, cbopt) → {Promise|undefined}

+
+

invalidateRememberBrowsers :external:RestClient

-
-

Update the user metadata.

+

Provides an abstraction layer for invalidating all remembered browsers for MFA.

@@ -7679,7 +9116,7 @@

upd
Source:
@@ -7692,297 +9129,256 @@

upd +

Type:
+ -
Parameters:
- - - - - - + + + +
+

multifactor :external:RestClient

-
- - - - - - - +
+

Provides an abstraction layer for consuming the +Multifactor Provider endpoint.

+
+ + + + + +
-
- - - - + - + - - - + - + - - + +
+

Provides an abstraction layer for CRD on permissions directly on a user

+
+ + + + + +
-
- - - + - + - - - + - + - - + - - - - + - + - - - +
Type:
+ - - - -
NameTypeAttributesDescription
params - - -object + + - - - + - + - - -

The user data object..

- - + - - - - - - + - + - + +
Source:
+
+ - + - - - + - + - - - - - + + + - + + + + + +
+

permissions :external:RestClient

-
- - - -
NameTypeDescription
id + +
Type:
+ 		-

The user id.

- -
- -
metadata - - -object + + - - - + - + - - -

New user metadata.

- -
cb - - -function + +
Source:
+
+ + - - 		- - <optional>
- + + - - - 		-

Callback function

- -
+ + +
+ + +
+

recoveryCodeRegenerations :external:RestClient

+
+

Provides an abstraction layer for regenerating Guardian recovery codes.

+
-
-
Returns:
- +
-
-
- Type: -
-
- -Promise -| + -undefined + + -
-
+ + -
+ + -
-
Example
+ - 
var params = { id: USER_ID };
-var metadata = {
-  address: '123th Node.js Street'
-};
+    
 
-management.users.updateUserMetadata(params, metadata, function (err, user) {
-  if (err) {
-    // Handle error.
-  }
+    
 
-  // Updated user.
-  console.log(user);
-});
+ -
+ +
Source:
+
+ -
- - + - +
Type:
+ -
-
- -

- UsersManager -

- -

Abstracts interaction with the users endpoint.

- - -
-
-
- - -
+
- -

Constructor

- + + +
+

roles :external:RestClient

-

new UsersManager(options)

- +
+

Provides an abstraction layer for CRD on roles for a user

+
@@ -8017,7 +9413,7 @@

new Users
Source:
@@ -8030,225 +9426,171 @@

new Users +

Type:
+ -
Parameters:
- - - - - - - - - - - + + +
+

userLogs :external:RestClient

-
- - - - - - - - - - - - - + - -
NameTypeDescription
options - - -object +
+

Provides a simple abstraction layer for user logs

+
- - 		-

The client options.

- - +
- - - - - - + - + - - - + - + - - - + - - - - - + - + - - - + +
Source:
+
+ - + - - + + - - - - - + + - - - + + + + +
+

usersByEmail :external:RestClient

-
- - - - - - - - - - +
- + -
- + - -
NameTypeAttributesDescription
baseUrl - - -string + + - - - + - + - - -

The URL of the API.

- -
headers + +
Type:
+ 		- - <optional>
- - - - 		-

Headers to be included in all requests.

- -
retry - - -object +
+

Provides an abstraction layer for the new "users-by-email" API

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

Retry Policy Config

- -
- -
+ + + + + + + + +
Source:
+
+ + + + + +
Type:
+
- -
+ + - - - - - +
+ @@ -8303,7 +9645,7 @@

assi
Source:
@@ -8660,7 +10002,7 @@

assignRole
Source:
@@ -9017,7 +10359,7 @@

createSource:
@@ -9235,7 +10577,7 @@

deleteSource:
@@ -9506,7 +10848,7 @@

deleteAllSource:
@@ -9690,7 +11032,7 @@

Source:
@@ -9987,7 +11329,7 @@

getSource:
@@ -10252,7 +11594,7 @@

getAllSource:
@@ -10579,7 +11921,7 @@

getByEmail<
Source:
@@ -10935,7 +12277,7 @@

Source:
@@ -11424,7 +12766,7 @@

getPerm
Source:
@@ -11689,7 +13031,7 @@

getRolesSource:
@@ -11954,7 +13296,7 @@

g
Source:
@@ -12648,7 +13990,7 @@

Source:
@@ -12917,7 +14259,7 @@