diff --git a/CHANGELOG.md b/CHANGELOG.md index df760e176..f0f09245e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # Change Log +## [v3.1.0](https://github.com/auth0/node-auth0/tree/v3.1.0) (2023-01-12) + +[Full Changelog](https://github.com/auth0/node-auth0/compare/v3.0.1...v3.1.0) + +**Added** + +- [SDK-3868] Add support for managing client credentials [\#774](https://github.com/auth0/node-auth0/pull/774) ([adamjmcgrath](https://github.com/adamjmcgrath)) +- [SDK-3856] Add `client_assertion` to authenticate clients [\#761](https://github.com/auth0/node-auth0/pull/761) ([adamjmcgrath](https://github.com/adamjmcgrath)) + ## [v3.0.1](https://github.com/auth0/node-auth0/tree/v3.0.1) (2022-12-22) [Full Changelog](https://github.com/auth0/node-auth0/compare/v3.0.0...v3.0.1) diff --git a/docs/ActionsManager.html b/docs/ActionsManager.html index b136ea88d..33573dca1 100644 --- a/docs/ActionsManager.html +++ b/docs/ActionsManager.html @@ -24,8 +24,8 @@
@@ -4937,7 +4937,7 @@
Example

diff --git a/docs/AttackProtectionManager.html b/docs/AttackProtectionManager.html index cc3f9c185..b3f128261 100644 --- a/docs/AttackProtectionManager.html +++ b/docs/AttackProtectionManager.html @@ -24,8 +24,8 @@
@@ -1807,7 +1807,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/AuthenticationClient.html b/docs/AuthenticationClient.html index 2bbb44579..5f3964870 100644 --- a/docs/AuthenticationClient.html +++ b/docs/AuthenticationClient.html @@ -24,8 +24,8 @@
@@ -294,6 +294,78 @@
Parameters:
+ + + clientAssertionSigningKey + + + + + +string + + + + + + + + + <optional>
+ + + + + + + + + + + +

Private key used to sign the client assertion JWT.

+ + + + + + + + + clientAssertionSigningAlg + + + + + +string + + + + + + + + + <optional>
+ + + + + + + + + + + +

Default RS256

+ + + + + + supportedAlgorithms @@ -506,7 +578,7 @@

databaseSource:
@@ -580,7 +652,7 @@

oauthSource:
@@ -654,7 +726,7 @@

passwordl
Source:
@@ -728,7 +800,7 @@

tokensSource:
@@ -802,7 +874,7 @@

usersSource:
@@ -886,7 +958,7 @@

changeP
Source:
@@ -1222,7 +1294,7 @@

Source:
@@ -1502,7 +1574,7 @@

get
Source:
@@ -1864,7 +1936,7 @@

getProfile<
Source:
@@ -2042,7 +2114,7 @@

password
Source:
@@ -2472,7 +2544,7 @@

refreshTo
Source:
@@ -2709,7 +2781,7 @@

Source:
@@ -3044,7 +3116,7 @@

reque
Source:
@@ -3371,7 +3443,7 @@

request
Source:
@@ -3979,7 +4051,7 @@

verify
Source:
@@ -4294,7 +4366,7 @@

verifySM
Source:
@@ -4622,7 +4694,7 @@

Examples

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/BlacklistedTokensManager.html b/docs/BlacklistedTokensManager.html index 12393c8d4..c42392ef1 100644 --- a/docs/BlacklistedTokensManager.html +++ b/docs/BlacklistedTokensManager.html @@ -24,8 +24,8 @@
@@ -915,7 +915,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/BrandingManager.html b/docs/BrandingManager.html index 20ff6decf..4d8e9aca7 100644 --- a/docs/BrandingManager.html +++ b/docs/BrandingManager.html @@ -24,8 +24,8 @@
@@ -3097,7 +3097,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/ClientCredentialsManager.html b/docs/ClientCredentialsManager.html new file mode 100644 index 000000000..49277bca3 --- /dev/null +++ b/docs/ClientCredentialsManager.html @@ -0,0 +1,1422 @@ + + + + + + ClientCredentialsManager - Documentation + + + + + + + + + + + + + + + + + +
+ +

ClientCredentialsManager

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

+ ClientCredentialsManager +

+ +

The client credentials class provides a simple abstraction for performing CRUD operations +on Auth0 ClientCredentials.

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

Constructor

+ + +

new ClientCredentialsManager(options)

+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +object + + + + +

The client options.

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

The URL of the API.

+ +
headers + + +object + + + + + + <optional>
+ + + + + +
+

Headers to be included in all requests.

+ +
retry + + +object + + + + + + <optional>
+ + + + + +
+

Retry Policy Config

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

Members

+ + + +
+

resource :external:RestClient

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

Methods

+ + + +
+ + + +

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

+ + + + + +
+

Create a new client credential.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
params.client_id + + +string + + + + + + + + + + +

The client id.

+ +
data + + +object + + + + + + + + + + +

Client Credential data object.

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

Callback function.

+ +
+ + + + + + + + + + + + + + +
+
Returns:
+ + + +
+
+ Type: +
+
+ +Promise +| + +undefined + + +
+
+ + + +
+ + + +
+
Example
+ +
var params = { client_id: CLIENT_ID };
+
+management.clientCredentials.create(params, data, function (err, credential) {
+  if (err) {
+    // Handle error.
+  }
+
+  // The credential created.
+  console.log({credential});
+});
+ +
+ +
+ + +
+ + + +

delete(cbopt) → {Promise|undefined}

+ + + + + +
+

Delete a credential for a given client.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
params.client_id + + +string + + + + + + + + + + +

The client id.

+ +
params.credential_id + + +string + + + + + + + + + + +

The credential id.

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

Callback function.

+ +
+ + + + + + + + + + + + + + +
+
Returns:
+ + + +
+
+ Type: +
+
+ +Promise +| + +undefined + + +
+
+ + + +
+ + + +
+
Example
+ +
var params = { client_id: CLIENT_ID, credential_id: CREDENTIAL_ID };
+
+management.clientCredentials.delete(params, data, function (err) {
+  if (err) {
+    // Handle error.
+  }
+});
+ +
+ +
+ + +
+ + + +

get(cbopt) → {Promise|undefined}

+ + + + + +
+

Return a credential for a given client.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
params.client_id + + +string + + + + + + + + + + +

The client id.

+ +
params.credential_id + + +string + + + + + + + + + + +

The credential id.

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

Callback function.

+ +
+ + + + + + + + + + + + + + +
+
Returns:
+ + + +
+
+ Type: +
+
+ +Promise +| + +undefined + + +
+
+ + + +
+ + + +
+
Example
+ +
var params = { client_id: CLIENT_ID, credential_id: CREDENTIAL_ID };
+
+management.clientCredentials.getById(data, function (err, credential) {
+  if (err) {
+    // Handle error.
+  }
+
+  // A specific credential associated with that credential.
+  console.log({credential});
+});
+ +
+ +
+ + +
+ + + +

getAll(cbopt) → {Promise|undefined}

+ + + + + +
+

Return a list of credentials for a given client.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
params.client_id + + +string + + + + + + + + + + +

The client id.

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

Callback function.

+ +
+ + + + + + + + + + + + + + +
+
Returns:
+ + + +
+
+ Type: +
+
+ +Promise +| + +undefined + + +
+
+ + + +
+ + + +
+
Example
+ +
var params = { client_id: CLIENT_ID };
+
+management.clientCredentials.getAll(params, function (err, credentials) {
+  if (err) {
+    // Handle error.
+  }
+
+  // A list of credentials associated with that client.
+  console.log({credentials});
+});
+ +
+ +
+ + + + + + +
+ +
+ + + + +
+ +
+ +
+ Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme. +
+ + + + + \ No newline at end of file diff --git a/docs/ClientGrantsManager.html b/docs/ClientGrantsManager.html index 9a4f11f32..2ec0bed07 100644 --- a/docs/ClientGrantsManager.html +++ b/docs/ClientGrantsManager.html @@ -24,8 +24,8 @@
@@ -1560,7 +1560,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/ClientsManager.html b/docs/ClientsManager.html index 7b62791e5..c1965d372 100644 --- a/docs/ClientsManager.html +++ b/docs/ClientsManager.html @@ -24,8 +24,8 @@
@@ -2178,7 +2178,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/ConnectionsManager.html b/docs/ConnectionsManager.html index 466cdd0a5..618ed8725 100644 --- a/docs/ConnectionsManager.html +++ b/docs/ConnectionsManager.html @@ -24,8 +24,8 @@
@@ -2468,7 +2468,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/CustomDomainsManager.html b/docs/CustomDomainsManager.html index 6be1f75f1..9d8e0f56e 100644 --- a/docs/CustomDomainsManager.html +++ b/docs/CustomDomainsManager.html @@ -24,8 +24,8 @@
@@ -1655,7 +1655,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/DatabaseAuthenticator.html b/docs/DatabaseAuthenticator.html index 2957ca0e5..03a752be8 100644 --- a/docs/DatabaseAuthenticator.html +++ b/docs/DatabaseAuthenticator.html @@ -24,8 +24,8 @@
@@ -1686,7 +1686,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/DeviceCredentialsManager.html b/docs/DeviceCredentialsManager.html index f8c35eb5c..a9ecdcd08 100644 --- a/docs/DeviceCredentialsManager.html +++ b/docs/DeviceCredentialsManager.html @@ -24,8 +24,8 @@
@@ -1139,7 +1139,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/EmailProviderManager.html b/docs/EmailProviderManager.html index aec193adc..95941eb32 100644 --- a/docs/EmailProviderManager.html +++ b/docs/EmailProviderManager.html @@ -24,8 +24,8 @@
@@ -1404,7 +1404,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/EmailTemplatesManager.html b/docs/EmailTemplatesManager.html index 9f8ac4397..0392e7978 100644 --- a/docs/EmailTemplatesManager.html +++ b/docs/EmailTemplatesManager.html @@ -24,8 +24,8 @@
@@ -1228,7 +1228,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/GrantsManager.html b/docs/GrantsManager.html index edf13eca7..8ce6441a0 100644 --- a/docs/GrantsManager.html +++ b/docs/GrantsManager.html @@ -24,8 +24,8 @@
@@ -1139,7 +1139,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/GuardianManager.html b/docs/GuardianManager.html index 63da631c7..3c1daea7a 100644 --- a/docs/GuardianManager.html +++ b/docs/GuardianManager.html @@ -24,8 +24,8 @@
@@ -4919,7 +4919,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/HooksManager.html b/docs/HooksManager.html index 97975ee93..856e44c58 100644 --- a/docs/HooksManager.html +++ b/docs/HooksManager.html @@ -24,8 +24,8 @@
@@ -3023,7 +3023,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/JobsManager.html b/docs/JobsManager.html index 21ab38ddd..df34fc750 100644 --- a/docs/JobsManager.html +++ b/docs/JobsManager.html @@ -24,8 +24,8 @@
@@ -2870,7 +2870,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/LogStreamsManager.html b/docs/LogStreamsManager.html index 097fb708e..8b9424515 100644 --- a/docs/LogStreamsManager.html +++ b/docs/LogStreamsManager.html @@ -24,8 +24,8 @@
@@ -1687,7 +1687,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:22 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/LogsManager.html b/docs/LogsManager.html index da955c179..4eb864d5d 100644 --- a/docs/LogsManager.html +++ b/docs/LogsManager.html @@ -24,8 +24,8 @@
@@ -1282,7 +1282,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:22 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/ManagementClient.html b/docs/ManagementClient.html index e3003194a..d698420cf 100644 --- a/docs/ManagementClient.html +++ b/docs/ManagementClient.html @@ -24,8 +24,8 @@
@@ -104,7 +104,7 @@

new M
Source:
@@ -167,7 +167,8 @@

Parameters:

Options for the ManagementClient SDK. If a token is provided only the domain is required, other parameters are ignored. -If no token is provided domain, clientId, clientSecret and scopes are required

+If no token is provided domain, clientId, clientSecret (or clientAssertionSigningKey) +and scopes are required

@@ -353,6 +354,86 @@
Parameters:
+ + + clientAssertionSigningKey + + + + + +string + + + + + + + + + <optional>
+ + + + + + + + + + + + + + + +

Private key used to sign the client assertion JWT.

+ + + + + + + + + clientAssertionSigningAlg + + + + + +string + + + + + + + + + <optional>
+ + + + + + + + + + + + + + + +

Default 'RS256'.

+ + + + + + audience @@ -776,6 +857,20 @@
Examples
} }); +

+ Initialize your client class, by using a Non Interactive Client to fetch an access_token + via the Client Credentials Grant, providing a Private Key using the private_key_jwt token + endpoint auth method. +

+ +
var ManagementClient = require('auth0').ManagementClient;
+var auth0 = new ManagementClient({
+  domain: '{YOUR_ACCOUNT}.auth0.com',
+  clientId: '{YOUR_NON_INTERACTIVE_CLIENT_ID}',
+  clientAssertionSigningKey: fs.readFileSync('private-key.pem'),
+  scope: "read:users write:users"
+});
+
@@ -841,7 +936,7 @@

actionsSource:
@@ -915,7 +1010,7 @@

attac
Source:
@@ -990,7 +1085,7 @@

blac
Source:
@@ -1065,7 +1160,7 @@

brandingSource:
@@ -1092,6 +1187,81 @@
Type:
+

+ + + +
+

clientCredentials :module:management.ClientCredentialsManager

+ + + + +
+

Simple abstraction for performing CRUD operations on the +client credentials endpoint.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + +
Type:
+
    +
  • + +module:management.ClientCredentialsManager + + +
  • +
+ + + + +
@@ -1140,7 +1310,7 @@

clientGra
Source:
@@ -1215,7 +1385,7 @@

clientsSource:
@@ -1290,7 +1460,7 @@

connection
Source:
@@ -1365,7 +1535,7 @@

customDo
Source:
@@ -1440,7 +1610,7 @@

devi
Source:
@@ -1515,7 +1685,7 @@

emailPro
Source:
@@ -1590,7 +1760,7 @@

emailTe
Source:
@@ -1665,7 +1835,7 @@

grantsSource:
@@ -1740,7 +1910,7 @@

guardianSource:
@@ -1815,7 +1985,7 @@

hooksSource:
@@ -1889,7 +2059,7 @@

jobsSource:
@@ -1963,7 +2133,7 @@

logsSource:
@@ -2037,7 +2207,7 @@

logStreams<
Source:
@@ -2111,7 +2281,7 @@

migrations<
Source:
@@ -2185,7 +2355,7 @@

organiza
Source:
@@ -2259,7 +2429,7 @@

promptsSource:
@@ -2334,7 +2504,7 @@

resour
Source:
@@ -2409,7 +2579,7 @@

rolesSource:
@@ -2484,7 +2654,7 @@

rulesSource:
@@ -2558,7 +2728,7 @@

rulesConf
Source:
@@ -2632,7 +2802,7 @@

statsSource:
@@ -2706,7 +2876,7 @@

tenantSource:
@@ -2780,7 +2950,7 @@

ticketsSource:
@@ -2855,7 +3025,7 @@

userBlocks<
Source:
@@ -2930,7 +3100,7 @@

usersSource:
@@ -3014,7 +3184,7 @@

addHook
Source:
@@ -3319,7 +3489,7 @@

a
Source:
@@ -3698,7 +3868,7 @@

Source:
@@ -4055,7 +4225,7 @@

assi
Source:
@@ -4412,7 +4582,7 @@

assi
Source:
@@ -4795,7 +4965,7 @@

blackli
Source:
@@ -5095,7 +5265,7 @@

Source:
@@ -5313,7 +5483,7 @@

createCli
Source:
@@ -5531,7 +5701,7 @@

crea
Source:
@@ -5749,7 +5919,7 @@

creat
Source:
@@ -5967,7 +6137,7 @@

cre
Source:
@@ -6185,7 +6355,7 @@

Source:
@@ -6403,7 +6573,7 @@

cr
Source:
@@ -6619,7 +6789,7 @@

Source:
@@ -6803,7 +6973,7 @@

Source:
@@ -6983,7 +7153,7 @@

createHook<
Source:
@@ -7201,7 +7371,7 @@

create
Source:
@@ -7419,7 +7589,7 @@

Source:
@@ -7611,7 +7781,7 @@

c
Source:
@@ -7829,7 +7999,7 @@

createRole<
Source:
@@ -8048,7 +8218,7 @@

createRule<
Source:
@@ -8266,7 +8436,7 @@

createUser<
Source:
@@ -8486,7 +8656,7 @@

deleteA
Source:
@@ -8670,7 +8840,7 @@

Source:
@@ -8920,7 +9090,7 @@

deleteCli
Source:
@@ -9189,7 +9359,7 @@

dele
Source:
@@ -9458,7 +9628,7 @@

delet
Source:
@@ -9727,7 +9897,7 @@

del
Source:
@@ -9996,7 +10166,7 @@

Source:
@@ -10267,7 +10437,7 @@

de
Source:
@@ -10451,7 +10621,7 @@

deleteGran
Source:
@@ -10751,7 +10921,7 @@

Source:
@@ -11020,7 +11190,7 @@

deleteHook<
Source:
@@ -11289,7 +11459,7 @@

delete
Source:
@@ -11558,7 +11728,7 @@

d
Source:
@@ -11827,7 +11997,7 @@

deleteRole<
Source:
@@ -12096,7 +12266,7 @@

deleteRule<
Source:
@@ -12365,7 +12535,7 @@

dele
Source:
@@ -12634,7 +12804,7 @@

deleteUser<
Source:
@@ -12903,7 +13073,7 @@

Source:
@@ -13204,7 +13374,7 @@

Source:
@@ -13501,7 +13671,7 @@

exportUser
Source:
@@ -13915,7 +14085,7 @@

getAcce
Source:
@@ -14023,7 +14193,7 @@

ge
Source:
@@ -14207,7 +14377,7 @@

g
Source:
@@ -14387,7 +14557,7 @@

ge
Source:
@@ -14640,7 +14810,7 @@

Source:
@@ -14893,7 +15063,7 @@

getClientSource:
@@ -15214,7 +15384,7 @@

getCli
Source:
@@ -15541,7 +15711,7 @@

getClients<
Source:
@@ -15868,7 +16038,7 @@

getConne
Source:
@@ -16137,7 +16307,7 @@

getConn
Source:
@@ -16464,7 +16634,7 @@

getCus
Source:
@@ -16733,7 +16903,7 @@

getCu
Source:
@@ -16849,7 +17019,7 @@

Source:
@@ -17142,7 +17312,7 @@

getDaily
Source:
@@ -17442,7 +17612,7 @@

g
Source:
@@ -17658,7 +17828,7 @@

getEm
Source:
@@ -17973,7 +18143,7 @@

getEm
Source:
@@ -18242,7 +18412,7 @@

getGrantsSource:
@@ -18646,7 +18816,7 @@

Source:
@@ -18911,7 +19081,7 @@

Source:
@@ -19176,7 +19346,7 @@

Source:
@@ -19390,7 +19560,7 @@

get
Source:
@@ -19570,7 +19740,7 @@

Source:
@@ -19784,7 +19954,7 @@

Source:
@@ -19998,7 +20168,7 @@

Source:
@@ -20178,7 +20348,7 @@

Source:
@@ -20358,7 +20528,7 @@

ge
Source:
@@ -20538,7 +20708,7 @@

getHookSource:
@@ -20807,7 +20977,7 @@

getHooksSource:
@@ -21134,7 +21304,7 @@

getHook
Source:
@@ -21404,7 +21574,7 @@

getJobSource:
@@ -21678,7 +21848,7 @@

getJobErr
Source:
@@ -21952,7 +22122,7 @@

getLogSource:
@@ -22221,7 +22391,7 @@

getLogsSource:
@@ -22728,7 +22898,7 @@

getLogStr
Source:
@@ -23000,7 +23170,7 @@

getLogSt
Source:
@@ -23171,7 +23341,7 @@

getMigra
Source:
@@ -23356,7 +23526,7 @@

g
Source:
@@ -23580,7 +23750,7 @@

get
Source:
@@ -23760,7 +23930,7 @@

getR
Source:
@@ -24029,7 +24199,7 @@

get
Source:
@@ -24356,7 +24526,7 @@

getRoleSource:
@@ -24625,7 +24795,7 @@

getRolesSource:
@@ -24952,7 +25122,7 @@

getRuleSource:
@@ -25221,7 +25391,7 @@

getRulesSource:
@@ -25548,7 +25718,7 @@

getRul
Source:
@@ -25732,7 +25902,7 @@

getT
Source:
@@ -25916,7 +26086,7 @@

getUserSource:
@@ -26181,7 +26351,7 @@

getUserB
Source:
@@ -26450,7 +26620,7 @@

Source:
@@ -26719,7 +26889,7 @@

getUserLog
Source:
@@ -27094,7 +27264,7 @@

get
Source:
@@ -27469,7 +27639,7 @@

getUserRo
Source:
@@ -27844,7 +28014,7 @@

getUsersSource:
@@ -28245,7 +28415,7 @@

getUse
Source:
@@ -28601,7 +28771,7 @@

getUser
Source:
@@ -28973,7 +29143,7 @@

importUser
Source:
@@ -29401,7 +29571,7 @@

importU
Source:
@@ -29827,7 +29997,7 @@

Source:
@@ -30096,7 +30266,7 @@

linkUsersSource:
@@ -30483,7 +30653,7 @@

Source:
@@ -30748,7 +30918,7 @@

remo
Source:
@@ -31053,7 +31223,7 @@

Source:
@@ -31432,7 +31602,7 @@

Source:
@@ -31789,7 +31959,7 @@

re
Source:
@@ -32146,7 +32316,7 @@

Source:
@@ -32612,7 +32782,7 @@

Source:
@@ -32862,7 +33032,7 @@

setRule
Source:
@@ -33219,7 +33389,7 @@

unblockUse
Source:
@@ -33488,7 +33658,7 @@

Source:
@@ -33757,7 +33927,7 @@

unlinkUser
Source:
@@ -34080,7 +34250,7 @@

upda
Source:
@@ -34389,7 +34559,7 @@

Source:
@@ -34642,7 +34812,7 @@

updateCli
Source:
@@ -34948,7 +35118,7 @@

upda
Source:
@@ -35258,7 +35428,7 @@

updat
Source:
@@ -35564,7 +35734,7 @@

Source:
@@ -35883,7 +36053,7 @@

up
Source:
@@ -36136,7 +36306,7 @@

up
Source:
@@ -36442,7 +36612,7 @@

u
Source:
@@ -36692,7 +36862,7 @@

Source:
@@ -36944,7 +37114,7 @@

Source:
@@ -37195,7 +37365,7 @@

Source:
@@ -37446,7 +37616,7 @@

Source:
@@ -37747,7 +37917,7 @@

Source:
@@ -38048,7 +38218,7 @@

Source:
@@ -38298,7 +38468,7 @@

updateHook<
Source:
@@ -38603,7 +38773,7 @@

upda
Source:
@@ -38908,7 +39078,7 @@

update
Source:
@@ -39213,7 +39383,7 @@

updat
Source:
@@ -39433,7 +39603,7 @@

Source:
@@ -39649,7 +39819,7 @@

u
Source:
@@ -39955,7 +40125,7 @@

updateRole<
Source:
@@ -40260,7 +40430,7 @@

updateRule<
Source:
@@ -40565,7 +40735,7 @@

u
Source:
@@ -40781,7 +40951,7 @@

updateUser<
Source:
@@ -41087,7 +41257,7 @@

upd
Source:
@@ -41396,7 +41566,7 @@

ver
Source:
@@ -41634,7 +41804,7 @@

Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:22 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/ManagementTokenProvider.html b/docs/ManagementTokenProvider.html index 033dfaa43..8c014f56e 100644 --- a/docs/ManagementTokenProvider.html +++ b/docs/ManagementTokenProvider.html @@ -24,8 +24,8 @@
@@ -303,6 +303,82 @@
Parameters:
+ + + clientAssertionSigningKey + + + + + +string + + + + + + + + + + + + + + + + + + + + + + +

Private key used to sign the client assertion JWT.

+ + + + + + + + + clientAssertionSigningAlg + + + + + +string + + + + + + + + + + + + + + + + + + + + + + +

Default 'RS256'.

+ + + + + + scope @@ -594,7 +670,7 @@

(async) Source:
@@ -671,7 +747,7 @@

Returns:

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:22 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/MigrationsManager.html b/docs/MigrationsManager.html index 89d35ce17..015c4b173 100644 --- a/docs/MigrationsManager.html +++ b/docs/MigrationsManager.html @@ -24,8 +24,8 @@
@@ -913,7 +913,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:22 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/OAUthWithIDTokenValidation.html b/docs/OAUthWithIDTokenValidation.html index b161cbcaa..78f942258 100644 --- a/docs/OAUthWithIDTokenValidation.html +++ b/docs/OAUthWithIDTokenValidation.html @@ -24,8 +24,8 @@
@@ -692,7 +692,7 @@
Returns:

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:22 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/OAuthAuthenticator.html b/docs/OAuthAuthenticator.html index b8e0b0f30..6adecac5b 100644 --- a/docs/OAuthAuthenticator.html +++ b/docs/OAuthAuthenticator.html @@ -24,8 +24,8 @@
@@ -101,7 +101,7 @@

new
Source:
@@ -328,6 +328,78 @@

Parameters:
+ + + clientAssertionSigningKey + + + + + +string + + + + + + + + + <optional>
+ + + + + + + + + + + +

Private key used to sign the client assertion JWT.

+ + + + + + + + + clientAssertionSigningAlg + + + + + +string + + + + + + + + + <optional>
+ + + + + + + + + + + +

Default 'RS256'.

+ + + + + + __bypassIdTokenValidation @@ -457,7 +529,7 @@

Source:
@@ -774,7 +846,7 @@

password
Source:
@@ -1239,7 +1311,7 @@

refreshTo
Source:
@@ -1502,7 +1574,7 @@

signInSource:
@@ -1938,7 +2010,7 @@

socialSig
Source:
@@ -2169,7 +2241,7 @@

Returns:

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:22 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/OrganizationsManager.html b/docs/OrganizationsManager.html index 898bbaaa9..fe6d60e9a 100644 --- a/docs/OrganizationsManager.html +++ b/docs/OrganizationsManager.html @@ -24,8 +24,8 @@
@@ -7826,7 +7826,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:22 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/PasswordlessAuthenticator.html b/docs/PasswordlessAuthenticator.html index 4256ef7a8..836b62de0 100644 --- a/docs/PasswordlessAuthenticator.html +++ b/docs/PasswordlessAuthenticator.html @@ -24,8 +24,8 @@
@@ -100,7 +100,7 @@

Source:
@@ -221,6 +221,42 @@
Parameters:
+ + + domain + + + + + +string + + + + + + + + + <optional>
+ + + + + + + + + + + +

Required if using clientAssertionSigningKey.

+ + + + + + clientId @@ -292,6 +328,78 @@
Parameters:
+ + + + clientAssertionSigningKey + + + + + +string + + + + + + + + + <optional>
+ + + + + + + + + + + +

Private key used to sign the client assertion JWT.

+ + + + + + + + + clientAssertionSigningAlg + + + + + +string + + + + + + + + + <optional>
+ + + + + + + + + + + +

Default 'RS256'.

+ + + + + @@ -412,7 +520,7 @@

sendEmailSource:
@@ -831,7 +939,7 @@

sendSMSSource:
@@ -1208,7 +1316,7 @@

signInSource:
@@ -1804,7 +1912,7 @@
Examples

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:22 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/PromptsManager.html b/docs/PromptsManager.html index a5cf9d91d..1f46be2bf 100644 --- a/docs/PromptsManager.html +++ b/docs/PromptsManager.html @@ -24,8 +24,8 @@
@@ -1635,7 +1635,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:22 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/ResourceServersManager.html b/docs/ResourceServersManager.html index 858ce2929..0942d3978 100644 --- a/docs/ResourceServersManager.html +++ b/docs/ResourceServersManager.html @@ -24,8 +24,8 @@
@@ -1828,7 +1828,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:22 GMT+0000 (Greenwich Mean 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 0ae860c4f..ec3303ccb 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 @@ -25,8 +25,8 @@
@@ -136,7 +136,7 @@


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:22 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/RetryRestClient.html b/docs/RetryRestClient.html index 65ae108b4..269c8719b 100644 --- a/docs/RetryRestClient.html +++ b/docs/RetryRestClient.html @@ -24,8 +24,8 @@
@@ -377,7 +377,7 @@
Parameters:

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:22 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/RetryRestClient.js.html b/docs/RetryRestClient.js.html index 5010e6171..14ffbb071 100644 --- a/docs/RetryRestClient.js.html +++ b/docs/RetryRestClient.js.html @@ -24,8 +24,8 @@
@@ -157,7 +157,7 @@

RetryRestClient.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/RolesManager.html b/docs/RolesManager.html index a1274b049..787838b13 100644 --- a/docs/RolesManager.html +++ b/docs/RolesManager.html @@ -24,8 +24,8 @@
@@ -3633,7 +3633,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:22 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/RulesConfigsManager.html b/docs/RulesConfigsManager.html index 81a264574..28b6d1bf2 100644 --- a/docs/RulesConfigsManager.html +++ b/docs/RulesConfigsManager.html @@ -24,8 +24,8 @@
@@ -1241,7 +1241,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:22 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/RulesManager.html b/docs/RulesManager.html index 8d0d06626..12e0e495f 100644 --- a/docs/RulesManager.html +++ b/docs/RulesManager.html @@ -24,8 +24,8 @@
@@ -1834,7 +1834,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:22 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/StatsManager.html b/docs/StatsManager.html index 2c9f8cbb0..be6f74739 100644 --- a/docs/StatsManager.html +++ b/docs/StatsManager.html @@ -24,8 +24,8 @@
@@ -918,7 +918,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:22 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/TenantManager.html b/docs/TenantManager.html index 36f50a1b9..0ce0a25a1 100644 --- a/docs/TenantManager.html +++ b/docs/TenantManager.html @@ -24,8 +24,8 @@
@@ -870,7 +870,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:22 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/TicketsManager.html b/docs/TicketsManager.html index bb8bf298d..f3a427dfb 100644 --- a/docs/TicketsManager.html +++ b/docs/TicketsManager.html @@ -24,8 +24,8 @@
@@ -1577,7 +1577,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:22 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/TokensManager.html b/docs/TokensManager.html index 25e5b09c0..a4cf14a1f 100644 --- a/docs/TokensManager.html +++ b/docs/TokensManager.html @@ -24,8 +24,8 @@
@@ -100,7 +100,7 @@

new Toke
Source:
@@ -257,6 +257,42 @@

Parameters:
+ + + domain + + + + + +string + + + + + + + + + <optional>
+ + + + + + + + + + + +

Required if using clientAssertionSigningKey.

+ + + + + + clientId @@ -328,6 +364,78 @@
Parameters:
+ + + + clientAssertionSigningKey + + + + + +string + + + + + + + + + <optional>
+ + + + + + + + + + + +

Private key used to sign the client assertion JWT.

+ + + + + + + + + clientAssertionSigningAlg + + + + + +string + + + + + + + + + <optional>
+ + + + + + + + + + + +

Default 'RS256'.

+ + + + + @@ -423,7 +531,7 @@

get
Source:
@@ -811,7 +919,7 @@

getInfoSource:
@@ -1036,7 +1144,7 @@

rev
Source:
@@ -1366,7 +1474,7 @@

Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:22 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/UserBlocksManager.html b/docs/UserBlocksManager.html index 8e6b6e87c..5343865fa 100644 --- a/docs/UserBlocksManager.html +++ b/docs/UserBlocksManager.html @@ -24,8 +24,8 @@
@@ -1431,7 +1431,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:22 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/UsersManager.html b/docs/UsersManager.html index f5a3e3ebb..e8d2751f1 100644 --- a/docs/UsersManager.html +++ b/docs/UsersManager.html @@ -24,8 +24,8 @@
@@ -17216,7 +17216,7 @@
Example

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:22 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/auth_DatabaseAuthenticator.js.html b/docs/auth_DatabaseAuthenticator.js.html index ef9614582..3e0aeabea 100644 --- a/docs/auth_DatabaseAuthenticator.js.html +++ b/docs/auth_DatabaseAuthenticator.js.html @@ -24,8 +24,8 @@
@@ -332,7 +332,7 @@

auth/DatabaseAuthenticator.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/auth_OAUthWithIDTokenValidation.js.html b/docs/auth_OAUthWithIDTokenValidation.js.html index 30bab2628..6b8976c92 100644 --- a/docs/auth_OAUthWithIDTokenValidation.js.html +++ b/docs/auth_OAUthWithIDTokenValidation.js.html @@ -24,8 +24,8 @@
@@ -176,7 +176,7 @@

auth/OAUthWithIDTokenValidation.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html index 1d058f36c..16d6dddb6 100644 --- a/docs/auth_OAuthAuthenticator.js.html +++ b/docs/auth_OAuthAuthenticator.js.html @@ -24,8 +24,8 @@
@@ -45,6 +45,7 @@

auth/OAuthAuthenticator.js

const RestClient = require('rest-facade').Client; const { SanitizedError } = require('../errors'); const OAUthWithIDTokenValidation = require('./OAUthWithIDTokenValidation'); +const { addClientAuthentication } = require('./clientAuthentication'); function getParamsFromOptions(options) { const params = {}; @@ -73,6 +74,8 @@

auth/OAuthAuthenticator.js

* @param {string} options.domain AuthenticationClient server domain * @param {string} [options.clientId] Default client ID. * @param {string} [options.clientSecret] Default client Secret. + * @param {string} [options.clientAssertionSigningKey] Private key used to sign the client assertion JWT. + * @param {string} [options.clientAssertionSigningAlg] Default 'RS256'. * @param {boolean} [options.__bypassIdTokenValidation] Whether the id_token should be validated or not */ constructor(options) { @@ -97,8 +100,22 @@

auth/OAuthAuthenticator.js

this.oauth = new RestClient(`${options.baseUrl}/oauth/:type`, clientOptions); this.oauthWithIDTokenValidation = new OAUthWithIDTokenValidation(this.oauth, options); + this.domain = options.domain; this.clientId = options.clientId; this.clientSecret = options.clientSecret; + this.clientAssertionSigningKey = options.clientAssertionSigningKey; + this.clientAssertionSigningAlg = options.clientAssertionSigningAlg; + } + + _addClientAuthentication(payload, required) { + return addClientAuthentication({ + payload, + required, + domain: this.domain, + clientSecret: this.clientSecret, + clientAssertionSigningKey: this.clientAssertionSigningKey, + clientAssertionSigningAlg: this.clientAssertionSigningAlg, + }); } /** @@ -215,12 +232,11 @@

auth/OAuthAuthenticator.js

throw new ArgumentError('Missing user data object'); } - const data = { + const data = this._addClientAuthentication({ client_id: this.clientId, - client_secret: this.clientSecret, grant_type: 'password', ...userData, - }; + }); if (typeof data.username !== 'string' || data.username.split().length === 0) { throw new ArgumentError('username field is required'); @@ -280,12 +296,11 @@

auth/OAuthAuthenticator.js

throw new ArgumentError('Missing data object'); } - data = { + data = this._addClientAuthentication({ client_id: this.clientId, - client_secret: this.clientSecret, grant_type: 'refresh_token', ...data, - }; + }); if (typeof data.refresh_token !== 'string' || data.refresh_token.split().length === 0) { throw new ArgumentError('refresh_token is required'); @@ -339,21 +354,19 @@

auth/OAuthAuthenticator.js

throw new ArgumentError('Missing options object'); } - const data = { - grant_type: 'client_credentials', - client_id: this.clientId, - client_secret: this.clientSecret, - ...options, - }; + const data = this._addClientAuthentication( + { + grant_type: 'client_credentials', + client_id: this.clientId, + ...options, + }, + true + ); if (!data.client_id || data.client_id.trim().length === 0) { throw new ArgumentError('client_id field is required'); } - if (!data.client_secret || data.client_secret.trim().length === 0) { - throw new ArgumentError('client_secret field is required'); - } - const params = { type: 'token', }; @@ -403,12 +416,11 @@

auth/OAuthAuthenticator.js

throw new ArgumentError('Missing options object'); } - const data = { + const data = this._addClientAuthentication({ grant_type: 'authorization_code', client_id: this.clientId, - client_secret: this.clientSecret, ...options, - }; + }); if (!data.code || data.code.trim().length === 0) { throw new ArgumentError('code field is required'); @@ -443,7 +455,7 @@

auth/OAuthAuthenticator.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html index 9c1f3f2ea..71494f169 100644 --- a/docs/auth_PasswordlessAuthenticator.js.html +++ b/docs/auth_PasswordlessAuthenticator.js.html @@ -24,8 +24,8 @@
@@ -43,6 +43,7 @@

auth/PasswordlessAuthenticator.js

const { ArgumentError } = require('rest-facade');
 const RestClient = require('rest-facade').Client;
 const { sanitizeArguments } = require('../utils');
+const { addClientAuthentication } = require('./clientAuthentication');
 
 function getParamsFromOptions(options) {
   const params = {};
@@ -65,8 +66,11 @@ 

auth/PasswordlessAuthenticator.js

/** * @param {object} options Authenticator options. * @param {string} options.baseUrl The auth0 account URL. + * @param {string} [options.domain] Required if using clientAssertionSigningKey. * @param {string} [options.clientId] Default client ID. * @param {string} [options.clientSecret] Default client secret. + * @param {string} [options.clientAssertionSigningKey] Private key used to sign the client assertion JWT. + * @param {string} [options.clientAssertionSigningAlg] Default 'RS256'. * @param {OAuthAuthenticator} oauth OAuthAuthenticator instance. */ constructor(options, oauth) { @@ -90,8 +94,22 @@

auth/PasswordlessAuthenticator.js

this.oauth = oauth; this.passwordless = new RestClient(`${options.baseUrl}/passwordless/start`, clientOptions); + this.domain = options.domain; this.clientId = options.clientId; this.clientSecret = options.clientSecret; + this.clientAssertionSigningKey = options.clientAssertionSigningKey; + this.clientAssertionSigningAlg = options.clientAssertionSigningAlg; + } + + _addClientAuthentication(payload, required) { + return addClientAuthentication({ + payload, + required, + domain: this.domain, + clientSecret: this.clientSecret, + clientAssertionSigningKey: this.clientAssertionSigningKey, + clientAssertionSigningAlg: this.clientAssertionSigningAlg, + }); } /** @@ -162,11 +180,10 @@

auth/PasswordlessAuthenticator.js

throw new ArgumentError('Missing user data object'); } - const data = { + const data = this._addClientAuthentication({ client_id: this.clientId, - client_secret: this.clientSecret, ...userData, - }; + }); if (typeof data.username !== 'string' || data.username.trim().length === 0) { throw new ArgumentError('username field (phone number) is required'); @@ -242,11 +259,10 @@

auth/PasswordlessAuthenticator.js

*/ sendEmail(userData, options, cb) { const { options: sanitizedOptions, cb: sanitizedCb } = sanitizeArguments(options, cb); - const data = { + const data = this._addClientAuthentication({ client_id: this.clientId, - client_secret: this.clientSecret, ...userData, - }; + }); const params = getParamsFromOptions(sanitizedOptions); // Don't let the user override the connection nor the grant type. @@ -299,11 +315,10 @@

auth/PasswordlessAuthenticator.js

*/ sendSMS(userData, options, cb) { const { options: sanitizedOptions, cb: sanitizedCb } = sanitizeArguments(options, cb); - const data = { + const data = this._addClientAuthentication({ client_id: this.clientId, - client_secret: this.clientSecret, ...userData, - }; + }); const params = getParamsFromOptions(sanitizedOptions); // Don't let the user override the connection nor the grant type. @@ -338,7 +353,7 @@

auth/PasswordlessAuthenticator.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html index eed9b6234..b5c5a6458 100644 --- a/docs/auth_TokensManager.js.html +++ b/docs/auth_TokensManager.js.html @@ -24,8 +24,8 @@
@@ -42,6 +42,7 @@

auth/TokensManager.js

const axios = require('axios');
 const { ArgumentError } = require('rest-facade');
+const { addClientAuthentication } = require('./clientAuthentication');
 
 /**
  * Provides methods for getting token data and exchanging tokens.
@@ -51,8 +52,11 @@ 

auth/TokensManager.js

* @param {object} options Manager options. * @param {string} options.baseUrl The auth0 account URL. * @param {string} [options.headers] Default request headers. + * @param {string} [options.domain] Required if using clientAssertionSigningKey. * @param {string} [options.clientId] Default client ID. * @param {string} [options.clientSecret] Default client Secret. + * @param {string} [options.clientAssertionSigningKey] Private key used to sign the client assertion JWT. + * @param {string} [options.clientAssertionSigningAlg] Default 'RS256'. */ constructor(options) { if (typeof options !== 'object') { @@ -65,8 +69,11 @@

auth/TokensManager.js

this.baseUrl = options.baseUrl; this.headers = options.headers || {}; + this.domain = options.domain; this.clientId = options.clientId || ''; this.clientSecret = options.clientSecret || ''; + this.clientAssertionSigningKey = options.clientAssertionSigningKey; + this.clientAssertionSigningAlg = options.clientAssertionSigningAlg; } /** @@ -255,11 +262,16 @@

auth/TokensManager.js

); } - const body = { - client_id: this.clientId, - client_secret: this.clientSecret, - ...data, - }; + const body = addClientAuthentication({ + payload: { + client_id: this.clientId, + ...data, + }, + domain: this.domain, + clientSecret: this.clientSecret, + clientAssertionSigningKey: this.clientAssertionSigningKey, + clientAssertionSigningAlg: this.clientAssertionSigningAlg, + }); const { headers } = this; @@ -294,7 +306,7 @@

auth/TokensManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html index 1aa27cc0d..e25f60dc7 100644 --- a/docs/auth_UsersManager.js.html +++ b/docs/auth_UsersManager.js.html @@ -24,8 +24,8 @@
@@ -213,7 +213,7 @@

auth/UsersManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/auth_clientAuthentication.js.html b/docs/auth_clientAuthentication.js.html new file mode 100644 index 000000000..6164dc92b --- /dev/null +++ b/docs/auth_clientAuthentication.js.html @@ -0,0 +1,147 @@ + + + + + + auth/clientAuthentication.js - Documentation + + + + + + + + + + + + + + + + + +
+ +

auth/clientAuthentication.js

+ + + + + + + +
+
+
const { ArgumentError } = require('rest-facade');
+const jwt = require('jsonwebtoken');
+const uuid = require('uuid');
+
+/**
+ * Create a JWT signed with the clientAssertionSigningKey
+ * for use on clients with token endpoint auth method of private_key_jwt.
+ *
+ * @param {string} domain The domain of the Authorization Server (can be a custom domain).
+ * @param {string} clientId The Client ID.
+ * @param {string} clientAssertionSigningKey A private key in PEM format to sign the client assertion JWT.
+ * @param {string} clientAssertionSigningAlg The alg to use to sign the JWT (default RS256)
+ * @returns {string} A JWT.
+ */
+const createClientAssertionJWT = ({
+  clientId,
+  clientAssertionSigningKey,
+  clientAssertionSigningAlg,
+  domain,
+}) => {
+  const now = Math.floor(Date.now() / 1000);
+  const payload = {
+    iss: clientId,
+    sub: clientId,
+    aud: `https://${domain}/`,
+    iat: now,
+    exp: now + 180,
+    jti: uuid.v4(),
+  };
+  return jwt.sign(payload, clientAssertionSigningKey, {
+    algorithm: clientAssertionSigningAlg || 'RS256',
+  });
+};
+
+/**
+ * Adds client authentication, if available, to the payload of the following requests:
+ * - /oauth/token
+ * - /oauth/revoke
+ * - /mfa/associate
+ * - /mfa/challenge
+ * - /passwordless/start
+ *
+ * Adds `client_secret` for Client Secret Post token endpoint auth method (the SDK doesn't use Client Secret Basic)
+ * Adds `client_assertion` and `client_assertion_type` for Private Key JWT token endpoint auth method.
+ *
+ * If `clientAssertionSigningKey` is provided it takes precedent over `clientSecret` .
+ *
+ * @param {object} payload The body of the request to be authenticated.
+ * @param {string} domain The domain of the Authorization Server (can be a custom domain).
+ * @param {boolean} [required] True if client authentication is required.
+ * @param {string} [clientAssertionSigningKey] A private key in PEM format to sign the client assertion JWT.
+ * @param {string} clientAssertionSigningAlg The alg to use to sign the JWT (default RS256)
+ * @param {string} [clientSecret] The client secret.
+ * @returns {object} The payload with additional fields for client authentication.
+ */
+const addClientAuthentication = ({
+  payload,
+  domain,
+  required,
+  clientAssertionSigningKey,
+  clientAssertionSigningAlg,
+  clientSecret,
+}) => {
+  const clientId = payload.client_id;
+  if (clientAssertionSigningKey && !payload.client_assertion) {
+    payload.client_assertion = createClientAssertionJWT({
+      clientId,
+      clientAssertionSigningKey,
+      clientAssertionSigningAlg,
+      domain,
+    });
+    payload.client_assertion_type = 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer';
+  } else if (clientSecret && !payload.client_secret) {
+    payload.client_secret = clientSecret;
+  }
+  if (
+    required &&
+    (!payload.client_secret || payload.client_secret.trim().length === 0) &&
+    (!payload.client_assertion || payload.client_assertion.trim().length === 0)
+  ) {
+    throw new ArgumentError('The client_secret or client_assertion field is required.');
+  }
+  return payload;
+};
+
+module.exports.addClientAuthentication = addClientAuthentication;
+
+
+
+ + + + +
+ +
+ +
+ Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme. +
+ + + + + diff --git a/docs/auth_idToken.js.html b/docs/auth_idToken.js.html index e5c33badb..a305d7e48 100644 --- a/docs/auth_idToken.js.html +++ b/docs/auth_idToken.js.html @@ -24,8 +24,8 @@
@@ -219,7 +219,7 @@

auth/idToken.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html index d7f838b9d..fc6efbc64 100644 --- a/docs/auth_index.js.html +++ b/docs/auth_index.js.html @@ -24,8 +24,8 @@
@@ -79,6 +79,8 @@

auth/index.js

* @param {string} options.domain AuthenticationClient server domain. * @param {string} [options.clientId] Default client ID. * @param {string} [options.clientSecret] Default client Secret. + * @param {string} [options.clientAssertionSigningKey] Private key used to sign the client assertion JWT. + * @param {string} [options.clientAssertionSigningAlg] Default RS256 * @param {string} [options.supportedAlgorithms] Algorithms that your application expects to receive * @param {boolean} [options.__bypassIdTokenValidation] Whether the id_token should be validated or not * @param {object} [options.headers] Additional headers that will be added to the outgoing requests. @@ -101,6 +103,8 @@

auth/index.js

clientId: options.clientId, domain: options.domain, clientSecret: options.clientSecret, + clientAssertionSigningKey: options.clientAssertionSigningKey, + clientAssertionSigningAlg: options.clientAssertionSigningAlg, headers: Object.assign(defaultHeaders, options.headers || {}), baseUrl: util.format(BASE_URL_FORMAT, options.domain), supportedAlgorithms: options.supportedAlgorithms, @@ -619,7 +623,7 @@

auth/index.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/errors.js.html b/docs/errors.js.html index 8b0c49bbf..41ff88769 100644 --- a/docs/errors.js.html +++ b/docs/errors.js.html @@ -24,8 +24,8 @@
@@ -112,7 +112,7 @@

errors.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html index dcdc7de0d..53738874f 100644 --- a/docs/external-RestClient.html +++ b/docs/external-RestClient.html @@ -24,8 +24,8 @@
@@ -140,7 +140,7 @@


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/global.html b/docs/global.html index da111e8e3..f41eb4c62 100644 --- a/docs/global.html +++ b/docs/global.html @@ -24,8 +24,8 @@
@@ -114,6 +114,601 @@

Methods

+
+ + + +

addClientAuthentication(payload, domain, requiredopt, clientAssertionSigningKeyopt, clientAssertionSigningAlg, clientSecretopt) → {object}

+ + + + + +
+

Adds client authentication, if available, to the payload of the following requests:

+
    +
  • /oauth/token
  • +
  • /oauth/revoke
  • +
  • /mfa/associate
  • +
  • /mfa/challenge
  • +
  • /passwordless/start
  • +
+

Adds client_secret for Client Secret Post token endpoint auth method (the SDK doesn't use Client Secret Basic) +Adds client_assertion and client_assertion_type for Private Key JWT token endpoint auth method.

+

If clientAssertionSigningKey is provided it takes precedent over clientSecret .

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
payload + + +object + + + + + + + + + + +

The body of the request to be authenticated.

+ +
domain + + +string + + + + + + + + + + +

The domain of the Authorization Server (can be a custom domain).

+ +
required + + +boolean + + + + + + <optional>
+ + + + + +
+

True if client authentication is required.

+ +
clientAssertionSigningKey + + +string + + + + + + <optional>
+ + + + + +
+

A private key in PEM format to sign the client assertion JWT.

+ +
clientAssertionSigningAlg + + +string + + + + + + + + + + +

The alg to use to sign the JWT (default RS256)

+ +
clientSecret + + +string + + + + + + <optional>
+ + + + + +
+

The client secret.

+ +
+ + + + + + + + + + + + + + +
+
Returns:
+ + + +
+
+ Type: +
+
+ +object + + +
+
+ + +
+

The payload with additional fields for client authentication.

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

createClientAssertionJWT(domain, clientId, clientAssertionSigningKey, clientAssertionSigningAlg) → {string}

+ + + + + +
+

Create a JWT signed with the clientAssertionSigningKey +for use on clients with token endpoint auth method of private_key_jwt.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
domain + + +string + + + + +

The domain of the Authorization Server (can be a custom domain).

+ +
clientId + + +string + + + + +

The Client ID.

+ +
clientAssertionSigningKey + + +string + + + + +

A private key in PEM format to sign the client assertion JWT.

+ +
clientAssertionSigningAlg + + +string + + + + +

The alg to use to sign the JWT (default RS256)

+ +
+ + + + + + + + + + + + + + +
+
Returns:
+ + + +
+
+ Type: +
+
+ +string + + +
+
+ + +
+

A JWT.

+
+ + +
+ + + +
+ +
@@ -976,7 +1571,7 @@
Returns:

- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/index.html b/docs/index.html index 273c96377..88c7f6935 100644 --- a/docs/index.html +++ b/docs/index.html @@ -24,8 +24,8 @@
@@ -138,7 +138,7 @@

What is Auth0?


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/index.js.html b/docs/index.js.html index 0179a0dd2..c426bb7e5 100644 --- a/docs/index.js.html +++ b/docs/index.js.html @@ -24,8 +24,8 @@
@@ -63,7 +63,7 @@

index.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_ActionsManager.js.html b/docs/management_ActionsManager.js.html index e6dc13fdf..810986f70 100644 --- a/docs/management_ActionsManager.js.html +++ b/docs/management_ActionsManager.js.html @@ -24,8 +24,8 @@
@@ -578,7 +578,7 @@

management/ActionsManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_AttackProtectionManager.js.html b/docs/management_AttackProtectionManager.js.html index 773bd04ed..e08d7c748 100644 --- a/docs/management_AttackProtectionManager.js.html +++ b/docs/management_AttackProtectionManager.js.html @@ -24,8 +24,8 @@
@@ -210,7 +210,7 @@

management/AttackProtectionManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html index 6f8142581..35873d77b 100644 --- a/docs/management_BlacklistedTokensManager.js.html +++ b/docs/management_BlacklistedTokensManager.js.html @@ -24,8 +24,8 @@
@@ -119,7 +119,7 @@

management/BlacklistedTokensManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_BrandingManager.js.html b/docs/management_BrandingManager.js.html index 5023f83f8..9f0ab0253 100644 --- a/docs/management_BrandingManager.js.html +++ b/docs/management_BrandingManager.js.html @@ -24,8 +24,8 @@
@@ -302,7 +302,7 @@

management/BrandingManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_ClientCredentialsManager.js.html b/docs/management_ClientCredentialsManager.js.html new file mode 100644 index 000000000..21cea79af --- /dev/null +++ b/docs/management_ClientCredentialsManager.js.html @@ -0,0 +1,173 @@ + + + + + + management/ClientCredentialsManager.js - Documentation + + + + + + + + + + + + + + + + + +
+ +

management/ClientCredentialsManager.js

+ + + + + + + +
+
+
const BaseManager = require('./BaseManager');
+
+/**
+ * The client credentials class provides a simple abstraction for performing CRUD operations
+ * on Auth0 ClientCredentials.
+ */
+class ClientCredentialsManager extends BaseManager {
+  /**
+   * @param {object} options            The client options.
+   * @param {string} options.baseUrl    The URL of the API.
+   * @param {object} [options.headers]  Headers to be included in all requests.
+   * @param {object} [options.retry]    Retry Policy Config
+   */
+  constructor(options) {
+    super(options);
+
+    /**
+     * @type {external:RestClient}
+     */
+    this.resource = this._getRestClient('/clients/:client_id/credentials/:credential_id');
+  }
+
+  /**
+   * Create a new client credential.
+   *
+   * @example
+   * var params = { client_id: CLIENT_ID };
+   *
+   * management.clientCredentials.create(params, data, function (err, credential) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   // The credential created.
+   *   console.log({credential});
+   * });
+   * @param   {string}    params.client_id   The client id.
+   * @param   {object}    data               Client Credential data object.
+   * @param   {Function}  [cb]               Callback function.
+   * @returns  {Promise|undefined}
+   */
+  create(...args) {
+    return this.resource.create(...args);
+  }
+
+  /**
+   * Return a list of credentials for a given client.
+   *
+   * @example
+   * var params = { client_id: CLIENT_ID };
+   *
+   * management.clientCredentials.getAll(params, function (err, credentials) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   // A list of credentials associated with that client.
+   *   console.log({credentials});
+   * });
+   * @param   {string}    params.client_id   The client id.
+   * @param   {Function}  [cb]               Callback function.
+   * @returns  {Promise|undefined}
+   */
+  getAll(...args) {
+    return this.resource.getAll(...args);
+  }
+
+  /**
+   * Return a credential for a given client.
+   *
+   * @example
+   * var params = { client_id: CLIENT_ID, credential_id: CREDENTIAL_ID };
+   *
+   * management.clientCredentials.getById(data, function (err, credential) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   // A specific credential associated with that credential.
+   *   console.log({credential});
+   * });
+   * @param   {string}    params.client_id      The client id.
+   * @param   {string}    params.credential_id  The credential id.
+   * @param   {Function}  [cb]                  Callback function.
+   * @returns  {Promise|undefined}
+   */
+  get(...args) {
+    return this.resource.get(...args);
+  }
+
+  /**
+   * Delete a credential for a given client.
+   *
+   * @example
+   * var params = { client_id: CLIENT_ID, credential_id: CREDENTIAL_ID };
+   *
+   * management.clientCredentials.delete(params, data, function (err) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   * });
+   * @param   {string}    params.client_id      The client id.
+   * @param   {string}    params.credential_id  The credential id.
+   * @param   {Function}  [cb]                  Callback function.
+   * @returns  {Promise|undefined}
+   */
+  delete(...args) {
+    return this.resource.delete(...args);
+  }
+}
+
+module.exports = ClientCredentialsManager;
+
+
+
+ + + + +
+ +
+ +
+ Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme. +
+ + + + + diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html index eee517ef7..6f699d0dc 100644 --- a/docs/management_ClientGrantsManager.js.html +++ b/docs/management_ClientGrantsManager.js.html @@ -24,8 +24,8 @@
@@ -176,7 +176,7 @@

management/ClientGrantsManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html index 56a434736..74ea9b217 100644 --- a/docs/management_ClientsManager.js.html +++ b/docs/management_ClientsManager.js.html @@ -24,8 +24,8 @@
@@ -236,7 +236,7 @@

management/ClientsManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html index 58b0ea898..0c069834e 100644 --- a/docs/management_ConnectionsManager.js.html +++ b/docs/management_ConnectionsManager.js.html @@ -24,8 +24,8 @@
@@ -260,7 +260,7 @@

management/ConnectionsManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html index c96b52690..a1f1c1b69 100644 --- a/docs/management_CustomDomainsManager.js.html +++ b/docs/management_CustomDomainsManager.js.html @@ -24,8 +24,8 @@
@@ -193,7 +193,7 @@

management/CustomDomainsManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html index 7c615142a..4c9f9c3d7 100644 --- a/docs/management_DeviceCredentialsManager.js.html +++ b/docs/management_DeviceCredentialsManager.js.html @@ -24,8 +24,8 @@
@@ -143,7 +143,7 @@

management/DeviceCredentialsManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html index dc428201b..6723c9506 100644 --- a/docs/management_EmailProviderManager.js.html +++ b/docs/management_EmailProviderManager.js.html @@ -24,8 +24,8 @@
@@ -153,7 +153,7 @@

management/EmailProviderManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html index 814ed8699..a0f598177 100644 --- a/docs/management_EmailTemplatesManager.js.html +++ b/docs/management_EmailTemplatesManager.js.html @@ -24,8 +24,8 @@
@@ -142,7 +142,7 @@

management/EmailTemplatesManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html index dc8683cfb..2e9fc4189 100644 --- a/docs/management_GrantsManager.js.html +++ b/docs/management_GrantsManager.js.html @@ -24,8 +24,8 @@
@@ -136,7 +136,7 @@

management/GrantsManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html index b9c5c8962..83f17fb96 100644 --- a/docs/management_GuardianManager.js.html +++ b/docs/management_GuardianManager.js.html @@ -24,8 +24,8 @@
@@ -413,7 +413,7 @@

management/GuardianManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_HooksManager.js.html b/docs/management_HooksManager.js.html index c449594b0..221085d65 100644 --- a/docs/management_HooksManager.js.html +++ b/docs/management_HooksManager.js.html @@ -24,8 +24,8 @@
@@ -347,7 +347,7 @@

management/HooksManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html index 776834add..50ab9bebd 100644 --- a/docs/management_JobsManager.js.html +++ b/docs/management_JobsManager.js.html @@ -24,8 +24,8 @@
@@ -376,7 +376,7 @@

management/JobsManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_LogStreamsManager.js.html b/docs/management_LogStreamsManager.js.html index 75c632cb1..e0a76cdf6 100644 --- a/docs/management_LogStreamsManager.js.html +++ b/docs/management_LogStreamsManager.js.html @@ -24,8 +24,8 @@
@@ -188,7 +188,7 @@

management/LogStreamsManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html index 61dc14542..957a3e02b 100644 --- a/docs/management_LogsManager.js.html +++ b/docs/management_LogsManager.js.html @@ -24,8 +24,8 @@
@@ -134,7 +134,7 @@

management/LogsManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html index 5a21f62c9..056a12c1d 100644 --- a/docs/management_ManagementTokenProvider.js.html +++ b/docs/management_ManagementTokenProvider.js.html @@ -24,8 +24,8 @@
@@ -54,6 +54,8 @@

management/ManagementTokenProvider.js

* @param {string} options.domain ManagementClient server domain. * @param {string} options.clientId Non Interactive Client Id. * @param {string} options.clientSecret Non Interactive Client Secret. + * @param {string} options.clientAssertionSigningKey Private key used to sign the client assertion JWT. + * @param {string} options.clientAssertionSigningAlg Default 'RS256'. * @param {string} options.scope Non Interactive Client Scope. * @param {string} options.audience Audience of the Management API. * @param {boolean} [options.enableCache=true] Enabled or Disable Cache @@ -75,8 +77,11 @@

management/ManagementTokenProvider.js

throw new ArgumentError('Must provide a clientId'); } - if (!params.clientSecret || params.clientSecret.length === 0) { - throw new ArgumentError('Must provide a clientSecret'); + if ( + (!params.clientSecret || params.clientSecret.length === 0) && + (!params.clientAssertionSigningKey || params.clientAssertionSigningKey.length === 0) + ) { + throw new ArgumentError('Must provide a clientSecret or a clientAssertionSigningKey'); } if (!params.audience || params.audience.length === 0) { @@ -106,6 +111,8 @@

management/ManagementTokenProvider.js

domain: this.options.domain, clientId: this.options.clientId, clientSecret: this.options.clientSecret, + clientAssertionSigningKey: this.options.clientAssertionSigningKey, + clientAssertionSigningAlg: this.options.clientAssertionSigningAlg, telemetry: this.options.telemetry, clientInfo: this.options.clientInfo, headers: this.options.headers, @@ -187,7 +194,7 @@

management/ManagementTokenProvider.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_MigrationsManager.js.html b/docs/management_MigrationsManager.js.html index f5695cec3..089940acb 100644 --- a/docs/management_MigrationsManager.js.html +++ b/docs/management_MigrationsManager.js.html @@ -24,8 +24,8 @@
@@ -128,7 +128,7 @@

management/MigrationsManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_OrganizationsManager.js.html b/docs/management_OrganizationsManager.js.html index eb1103799..9deba07b8 100644 --- a/docs/management_OrganizationsManager.js.html +++ b/docs/management_OrganizationsManager.js.html @@ -24,8 +24,8 @@
@@ -773,7 +773,7 @@

management/OrganizationsManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_PromptsManager.js.html b/docs/management_PromptsManager.js.html index f70d2f487..4e5b421fa 100644 --- a/docs/management_PromptsManager.js.html +++ b/docs/management_PromptsManager.js.html @@ -24,8 +24,8 @@
@@ -214,7 +214,7 @@

management/PromptsManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html index 26d6e3b52..ee68732d5 100644 --- a/docs/management_ResourceServersManager.js.html +++ b/docs/management_ResourceServersManager.js.html @@ -24,8 +24,8 @@
@@ -195,7 +195,7 @@

management/ResourceServersManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html index 54846cba5..0b52c1356 100644 --- a/docs/management_RolesManager.js.html +++ b/docs/management_RolesManager.js.html @@ -24,8 +24,8 @@
@@ -381,7 +381,7 @@

management/RolesManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html index 2672ed76f..3ebec387e 100644 --- a/docs/management_RulesConfigsManager.js.html +++ b/docs/management_RulesConfigsManager.js.html @@ -24,8 +24,8 @@
@@ -138,7 +138,7 @@

management/RulesConfigsManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html index 69d1e9941..4b8143733 100644 --- a/docs/management_RulesManager.js.html +++ b/docs/management_RulesManager.js.html @@ -24,8 +24,8 @@
@@ -200,7 +200,7 @@

management/RulesManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html index 72f0e0c89..a10bbc50c 100644 --- a/docs/management_StatsManager.js.html +++ b/docs/management_StatsManager.js.html @@ -24,8 +24,8 @@
@@ -136,7 +136,7 @@

management/StatsManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html index 43ee95d0c..515d41bd4 100644 --- a/docs/management_TenantManager.js.html +++ b/docs/management_TenantManager.js.html @@ -24,8 +24,8 @@
@@ -128,7 +128,7 @@

management/TenantManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html index 0449a4353..082db052c 100644 --- a/docs/management_TicketsManager.js.html +++ b/docs/management_TicketsManager.js.html @@ -24,8 +24,8 @@
@@ -156,7 +156,7 @@

management/TicketsManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_UserBlocksManager.js.html b/docs/management_UserBlocksManager.js.html index 57bfd1477..97232cb1d 100644 --- a/docs/management_UserBlocksManager.js.html +++ b/docs/management_UserBlocksManager.js.html @@ -24,8 +24,8 @@
@@ -173,7 +173,7 @@

management/UserBlocksManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html index 4c46e5c56..1d8e108f5 100644 --- a/docs/management_UsersManager.js.html +++ b/docs/management_UsersManager.js.html @@ -24,8 +24,8 @@
@@ -814,7 +814,7 @@

management/UsersManager.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/management_index.js.html b/docs/management_index.js.html index 137d5d0a4..0fc2ee4d1 100644 --- a/docs/management_index.js.html +++ b/docs/management_index.js.html @@ -24,8 +24,8 @@
@@ -46,6 +46,7 @@

management/index.js

const { ArgumentError } = require('rest-facade'); // Managers. +const ClientCredentialsManager = require('./ClientCredentialsManager'); const ClientsManager = require('./ClientsManager'); const ClientGrantsManager = require('./ClientGrantsManager'); const GrantsManager = require('./GrantsManager'); @@ -115,16 +116,32 @@

management/index.js

* cacheTTLInSeconds: 10 * } * }); + * @example <caption> + * Initialize your client class, by using a Non Interactive Client to fetch an access_token + * via the Client Credentials Grant, providing a Private Key using the private_key_jwt token + * endpoint auth method. + * </caption> + * + * var ManagementClient = require('auth0').ManagementClient; + * var auth0 = new ManagementClient({ + * domain: '{YOUR_ACCOUNT}.auth0.com', + * clientId: '{YOUR_NON_INTERACTIVE_CLIENT_ID}', + * clientAssertionSigningKey: fs.readFileSync('private-key.pem'), + * scope: "read:users write:users" + * }); */ class ManagementClient { /** * @param {object} options Options for the ManagementClient SDK. * If a token is provided only the domain is required, other parameters are ignored. - * If no token is provided domain, clientId, clientSecret and scopes are required + * If no token is provided domain, clientId, clientSecret (or clientAssertionSigningKey) + * and scopes are required * @param {string} options.domain ManagementClient server domain. * @param {string} [options.token] API access token. * @param {string} [options.clientId] Management API Non Interactive Client Id. * @param {string} [options.clientSecret] Management API Non Interactive Client Secret. + * @param {string} [options.clientAssertionSigningKey] Private key used to sign the client assertion JWT. + * @param {string} [options.clientAssertionSigningAlg] Default 'RS256'. * @param {string} [options.audience] Management API Audience. By default is your domain's, e.g. the domain is `tenant.auth0.com` and the audience is `http://tenant.auth0.com/api/v2/` * @param {string} [options.scope] Management API Scopes. * @param {boolean} [options.tokenProvider.enableCache=true] Enabled or Disable Cache. @@ -202,6 +219,14 @@

management/index.js

*/ this.clients = new ClientsManager(managerOptions); + /** + * Simple abstraction for performing CRUD operations on the + * client credentials endpoint. + * + * @type {module:management.ClientCredentialsManager} + */ + this.clientCredentials = new ClientCredentialsManager(managerOptions); + /** * Simple abstraction for performing CRUD operations on the client grants * endpoint. @@ -3432,7 +3457,7 @@

management/index.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/docs/utils.js.html b/docs/utils.js.html index fe58afb5d..00fb6246b 100644 --- a/docs/utils.js.html +++ b/docs/utils.js.html @@ -24,8 +24,8 @@
@@ -112,7 +112,7 @@

utils.js


- Generated by JSDoc 3.6.10 on Thu Dec 22 2022 21:12:57 GMT+0000 (Greenwich Mean Time) using the Minami theme. + Generated by JSDoc 3.6.11 on Thu Jan 12 2023 15:46:21 GMT+0000 (Greenwich Mean Time) using the Minami theme.
diff --git a/package.json b/package.json index b32ef2c19..1ae072a70 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "auth0", - "version": "3.0.1", + "version": "3.1.0", "description": "SDK for Auth0 API v2", "main": "src/index.js", "sideEffects": false,