auth0 7.6.0 → 7.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. package/dist/cjs/management/Client.d.ts +3 -0
  2. package/dist/cjs/management/Client.js +45 -40
  3. package/dist/cjs/management/api/requests/requests.d.ts +48 -2
  4. package/dist/cjs/management/api/resources/clients/client/Client.d.ts +1 -0
  5. package/dist/cjs/management/api/resources/clients/client/Client.js +3 -1
  6. package/dist/cjs/management/api/resources/connections/resources/keys/client/Client.d.ts +3 -3
  7. package/dist/cjs/management/api/resources/connections/resources/keys/client/Client.js +3 -3
  8. package/dist/cjs/management/api/resources/experimentation/resources/segments/client/Client.d.ts +2 -1
  9. package/dist/cjs/management/api/resources/experimentation/resources/segments/client/Client.js +4 -2
  10. package/dist/cjs/management/api/resources/index.d.ts +1 -0
  11. package/dist/cjs/management/api/resources/index.js +2 -1
  12. package/dist/cjs/management/api/resources/portals/client/Client.d.ts +112 -0
  13. package/dist/cjs/management/api/resources/portals/client/Client.js +395 -0
  14. package/dist/cjs/management/api/resources/portals/client/index.d.ts +1 -0
  15. package/dist/cjs/management/api/resources/portals/client/index.js +2 -0
  16. package/dist/cjs/management/api/resources/portals/exports.d.ts +2 -0
  17. package/dist/cjs/management/api/resources/portals/exports.js +21 -0
  18. package/dist/cjs/management/api/resources/portals/index.d.ts +1 -0
  19. package/dist/cjs/management/api/resources/portals/index.js +17 -0
  20. package/dist/cjs/management/api/resources/users/client/Client.d.ts +57 -0
  21. package/dist/cjs/management/api/resources/users/client/Client.js +185 -0
  22. package/dist/cjs/management/api/types/types.d.ts +461 -4
  23. package/dist/cjs/management/api/types/types.js +92 -22
  24. package/dist/cjs/management/version.d.ts +1 -1
  25. package/dist/cjs/management/version.js +1 -1
  26. package/dist/cjs/management/wrapper/ManagementClient.d.ts +4 -1
  27. package/dist/cjs/management/wrapper/ManagementClient.js +2 -1
  28. package/dist/cjs/management/wrapper/auth-helpers.d.ts +3 -0
  29. package/dist/cjs/management/wrapper/auth-helpers.js +5 -0
  30. package/dist/cjs/management/wrapper/domain.d.ts +12 -0
  31. package/dist/cjs/management/wrapper/domain.js +28 -0
  32. package/dist/cjs/management/wrapper/management-auth.d.ts +2 -1
  33. package/dist/cjs/management/wrapper/management-auth.js +2 -1
  34. package/dist/cjs/management/wrapper/token-provider.js +4 -4
  35. package/dist/esm/management/Client.d.mts +3 -0
  36. package/dist/esm/management/Client.mjs +5 -0
  37. package/dist/esm/management/api/requests/requests.d.mts +48 -2
  38. package/dist/esm/management/api/resources/clients/client/Client.d.mts +1 -0
  39. package/dist/esm/management/api/resources/clients/client/Client.mjs +3 -1
  40. package/dist/esm/management/api/resources/connections/resources/keys/client/Client.d.mts +3 -3
  41. package/dist/esm/management/api/resources/connections/resources/keys/client/Client.mjs +3 -3
  42. package/dist/esm/management/api/resources/experimentation/resources/segments/client/Client.d.mts +2 -1
  43. package/dist/esm/management/api/resources/experimentation/resources/segments/client/Client.mjs +4 -2
  44. package/dist/esm/management/api/resources/index.d.mts +1 -0
  45. package/dist/esm/management/api/resources/index.mjs +1 -0
  46. package/dist/esm/management/api/resources/portals/client/Client.d.mts +112 -0
  47. package/dist/esm/management/api/resources/portals/client/Client.mjs +358 -0
  48. package/dist/esm/management/api/resources/portals/client/index.d.mts +1 -0
  49. package/dist/esm/management/api/resources/portals/client/index.mjs +1 -0
  50. package/dist/esm/management/api/resources/portals/exports.d.mts +2 -0
  51. package/dist/esm/management/api/resources/portals/exports.mjs +3 -0
  52. package/dist/esm/management/api/resources/portals/index.d.mts +1 -0
  53. package/dist/esm/management/api/resources/portals/index.mjs +1 -0
  54. package/dist/esm/management/api/resources/users/client/Client.d.mts +57 -0
  55. package/dist/esm/management/api/resources/users/client/Client.mjs +185 -0
  56. package/dist/esm/management/api/types/types.d.mts +461 -4
  57. package/dist/esm/management/api/types/types.mjs +70 -1
  58. package/dist/esm/management/version.d.mts +1 -1
  59. package/dist/esm/management/version.mjs +1 -1
  60. package/dist/esm/management/wrapper/ManagementClient.d.mts +4 -1
  61. package/dist/esm/management/wrapper/ManagementClient.mjs +3 -2
  62. package/dist/esm/management/wrapper/auth-helpers.d.mts +3 -0
  63. package/dist/esm/management/wrapper/auth-helpers.mjs +5 -0
  64. package/dist/esm/management/wrapper/domain.d.mts +12 -0
  65. package/dist/esm/management/wrapper/domain.mjs +25 -0
  66. package/dist/esm/management/wrapper/management-auth.d.mts +2 -1
  67. package/dist/esm/management/wrapper/management-auth.mjs +2 -1
  68. package/dist/esm/management/wrapper/token-provider.mjs +4 -4
  69. package/package.json +12 -1
  70. package/reference.md +462 -3
package/reference.md CHANGED
@@ -1834,6 +1834,7 @@ const pageableResponse = await client.clients.list({
1834
1834
  is_first_party: true,
1835
1835
  app_type: "app_type",
1836
1836
  external_client_id: "external_client_id",
1837
+ agent_id: "agent_id",
1837
1838
  q: "q",
1838
1839
  });
1839
1840
  for await (const item of pageableResponse) {
@@ -1851,6 +1852,7 @@ let page = await client.clients.list({
1851
1852
  is_first_party: true,
1852
1853
  app_type: "app_type",
1853
1854
  external_client_id: "external_client_id",
1855
+ agent_id: "agent_id",
1854
1856
  q: "q",
1855
1857
  });
1856
1858
  while (page.hasNextPage()) {
@@ -8510,6 +8512,256 @@ await client.organizations.update("id");
8510
8512
  </dl>
8511
8513
  </details>
8512
8514
 
8515
+ ## Portals
8516
+
8517
+ <details><summary><code>client.portals.<a href="/src/management/api/resources/portals/client/Client.ts">list</a>() -> Management.ListPortalsResponseContent</code></summary>
8518
+ <dl>
8519
+ <dd>
8520
+
8521
+ #### 🔌 Usage
8522
+
8523
+ <dl>
8524
+ <dd>
8525
+
8526
+ <dl>
8527
+ <dd>
8528
+
8529
+ ```typescript
8530
+ await client.portals.list();
8531
+ ```
8532
+
8533
+ </dd>
8534
+ </dl>
8535
+ </dd>
8536
+ </dl>
8537
+
8538
+ #### ⚙️ Parameters
8539
+
8540
+ <dl>
8541
+ <dd>
8542
+
8543
+ <dl>
8544
+ <dd>
8545
+
8546
+ **requestOptions:** `PortalsClient.RequestOptions`
8547
+
8548
+ </dd>
8549
+ </dl>
8550
+ </dd>
8551
+ </dl>
8552
+
8553
+ </dd>
8554
+ </dl>
8555
+ </details>
8556
+
8557
+ <details><summary><code>client.portals.<a href="/src/management/api/resources/portals/client/Client.ts">create</a>({ ...params }) -> Management.Portal</code></summary>
8558
+ <dl>
8559
+ <dd>
8560
+
8561
+ #### 🔌 Usage
8562
+
8563
+ <dl>
8564
+ <dd>
8565
+
8566
+ <dl>
8567
+ <dd>
8568
+
8569
+ ```typescript
8570
+ await client.portals.create({
8571
+ slug: "slug",
8572
+ name: "name",
8573
+ client: {
8574
+ token_endpoint_auth_method: "client_secret_post",
8575
+ client_id: "client_id",
8576
+ client_secret: "client_secret",
8577
+ },
8578
+ });
8579
+ ```
8580
+
8581
+ </dd>
8582
+ </dl>
8583
+ </dd>
8584
+ </dl>
8585
+
8586
+ #### ⚙️ Parameters
8587
+
8588
+ <dl>
8589
+ <dd>
8590
+
8591
+ <dl>
8592
+ <dd>
8593
+
8594
+ **request:** `Management.CreatePortalRequestContent`
8595
+
8596
+ </dd>
8597
+ </dl>
8598
+
8599
+ <dl>
8600
+ <dd>
8601
+
8602
+ **requestOptions:** `PortalsClient.RequestOptions`
8603
+
8604
+ </dd>
8605
+ </dl>
8606
+ </dd>
8607
+ </dl>
8608
+
8609
+ </dd>
8610
+ </dl>
8611
+ </details>
8612
+
8613
+ <details><summary><code>client.portals.<a href="/src/management/api/resources/portals/client/Client.ts">get</a>(id) -> Management.Portal</code></summary>
8614
+ <dl>
8615
+ <dd>
8616
+
8617
+ #### 🔌 Usage
8618
+
8619
+ <dl>
8620
+ <dd>
8621
+
8622
+ <dl>
8623
+ <dd>
8624
+
8625
+ ```typescript
8626
+ await client.portals.get("id");
8627
+ ```
8628
+
8629
+ </dd>
8630
+ </dl>
8631
+ </dd>
8632
+ </dl>
8633
+
8634
+ #### ⚙️ Parameters
8635
+
8636
+ <dl>
8637
+ <dd>
8638
+
8639
+ <dl>
8640
+ <dd>
8641
+
8642
+ **id:** `Management.PortalId`
8643
+
8644
+ </dd>
8645
+ </dl>
8646
+
8647
+ <dl>
8648
+ <dd>
8649
+
8650
+ **requestOptions:** `PortalsClient.RequestOptions`
8651
+
8652
+ </dd>
8653
+ </dl>
8654
+ </dd>
8655
+ </dl>
8656
+
8657
+ </dd>
8658
+ </dl>
8659
+ </details>
8660
+
8661
+ <details><summary><code>client.portals.<a href="/src/management/api/resources/portals/client/Client.ts">delete</a>(id) -> void</code></summary>
8662
+ <dl>
8663
+ <dd>
8664
+
8665
+ #### 🔌 Usage
8666
+
8667
+ <dl>
8668
+ <dd>
8669
+
8670
+ <dl>
8671
+ <dd>
8672
+
8673
+ ```typescript
8674
+ await client.portals.delete("id");
8675
+ ```
8676
+
8677
+ </dd>
8678
+ </dl>
8679
+ </dd>
8680
+ </dl>
8681
+
8682
+ #### ⚙️ Parameters
8683
+
8684
+ <dl>
8685
+ <dd>
8686
+
8687
+ <dl>
8688
+ <dd>
8689
+
8690
+ **id:** `Management.PortalId`
8691
+
8692
+ </dd>
8693
+ </dl>
8694
+
8695
+ <dl>
8696
+ <dd>
8697
+
8698
+ **requestOptions:** `PortalsClient.RequestOptions`
8699
+
8700
+ </dd>
8701
+ </dl>
8702
+ </dd>
8703
+ </dl>
8704
+
8705
+ </dd>
8706
+ </dl>
8707
+ </details>
8708
+
8709
+ <details><summary><code>client.portals.<a href="/src/management/api/resources/portals/client/Client.ts">update</a>(id, { ...params }) -> Management.Portal</code></summary>
8710
+ <dl>
8711
+ <dd>
8712
+
8713
+ #### 🔌 Usage
8714
+
8715
+ <dl>
8716
+ <dd>
8717
+
8718
+ <dl>
8719
+ <dd>
8720
+
8721
+ ```typescript
8722
+ await client.portals.update("id");
8723
+ ```
8724
+
8725
+ </dd>
8726
+ </dl>
8727
+ </dd>
8728
+ </dl>
8729
+
8730
+ #### ⚙️ Parameters
8731
+
8732
+ <dl>
8733
+ <dd>
8734
+
8735
+ <dl>
8736
+ <dd>
8737
+
8738
+ **id:** `Management.PortalId`
8739
+
8740
+ </dd>
8741
+ </dl>
8742
+
8743
+ <dl>
8744
+ <dd>
8745
+
8746
+ **request:** `Management.UpdatePortalRequestContent`
8747
+
8748
+ </dd>
8749
+ </dl>
8750
+
8751
+ <dl>
8752
+ <dd>
8753
+
8754
+ **requestOptions:** `PortalsClient.RequestOptions`
8755
+
8756
+ </dd>
8757
+ </dl>
8758
+ </dd>
8759
+ </dl>
8760
+
8761
+ </dd>
8762
+ </dl>
8763
+ </details>
8764
+
8513
8765
  ## Prompts
8514
8766
 
8515
8767
  <details><summary><code>client.prompts.<a href="/src/management/api/resources/prompts/client/Client.ts">getSettings</a>() -> Management.GetSettingsResponseContent</code></summary>
@@ -13285,6 +13537,211 @@ await client.users.update("id");
13285
13537
  </dl>
13286
13538
  </details>
13287
13539
 
13540
+ <details><summary><code>client.users.<a href="/src/management/api/resources/users/client/Client.ts">listConsentSigningKeys</a>(id) -> Management.ListUserConsentSigningKeysResponseContent</code></summary>
13541
+ <dl>
13542
+ <dd>
13543
+
13544
+ #### 📝 Description
13545
+
13546
+ <dl>
13547
+ <dd>
13548
+
13549
+ <dl>
13550
+ <dd>
13551
+
13552
+ Retrieve all consent signing keys registered for a user. Returns an empty `keys` array when the user has no keys registered.
13553
+
13554
+ </dd>
13555
+ </dl>
13556
+ </dd>
13557
+ </dl>
13558
+
13559
+ #### 🔌 Usage
13560
+
13561
+ <dl>
13562
+ <dd>
13563
+
13564
+ <dl>
13565
+ <dd>
13566
+
13567
+ ```typescript
13568
+ await client.users.listConsentSigningKeys("id");
13569
+ ```
13570
+
13571
+ </dd>
13572
+ </dl>
13573
+ </dd>
13574
+ </dl>
13575
+
13576
+ #### ⚙️ Parameters
13577
+
13578
+ <dl>
13579
+ <dd>
13580
+
13581
+ <dl>
13582
+ <dd>
13583
+
13584
+ **id:** `string` — The ID of the user.
13585
+
13586
+ </dd>
13587
+ </dl>
13588
+
13589
+ <dl>
13590
+ <dd>
13591
+
13592
+ **requestOptions:** `UsersClient.RequestOptions`
13593
+
13594
+ </dd>
13595
+ </dl>
13596
+ </dd>
13597
+ </dl>
13598
+
13599
+ </dd>
13600
+ </dl>
13601
+ </details>
13602
+
13603
+ <details><summary><code>client.users.<a href="/src/management/api/resources/users/client/Client.ts">getConsentSigningKey</a>(id, kid) -> Management.ConsentSigningKey</code></summary>
13604
+ <dl>
13605
+ <dd>
13606
+
13607
+ #### 📝 Description
13608
+
13609
+ <dl>
13610
+ <dd>
13611
+
13612
+ <dl>
13613
+ <dd>
13614
+
13615
+ Retrieve a single consent signing key for a user by its key identifier (kid). Returns 404 if the key does not exist.
13616
+
13617
+ </dd>
13618
+ </dl>
13619
+ </dd>
13620
+ </dl>
13621
+
13622
+ #### 🔌 Usage
13623
+
13624
+ <dl>
13625
+ <dd>
13626
+
13627
+ <dl>
13628
+ <dd>
13629
+
13630
+ ```typescript
13631
+ await client.users.getConsentSigningKey("id", "kid");
13632
+ ```
13633
+
13634
+ </dd>
13635
+ </dl>
13636
+ </dd>
13637
+ </dl>
13638
+
13639
+ #### ⚙️ Parameters
13640
+
13641
+ <dl>
13642
+ <dd>
13643
+
13644
+ <dl>
13645
+ <dd>
13646
+
13647
+ **id:** `string` — The ID of the user.
13648
+
13649
+ </dd>
13650
+ </dl>
13651
+
13652
+ <dl>
13653
+ <dd>
13654
+
13655
+ **kid:** `string` — The key identifier of the consent signing key.
13656
+
13657
+ </dd>
13658
+ </dl>
13659
+
13660
+ <dl>
13661
+ <dd>
13662
+
13663
+ **requestOptions:** `UsersClient.RequestOptions`
13664
+
13665
+ </dd>
13666
+ </dl>
13667
+ </dd>
13668
+ </dl>
13669
+
13670
+ </dd>
13671
+ </dl>
13672
+ </details>
13673
+
13674
+ <details><summary><code>client.users.<a href="/src/management/api/resources/users/client/Client.ts">deleteConsentSigningKey</a>(id, kid) -> void</code></summary>
13675
+ <dl>
13676
+ <dd>
13677
+
13678
+ #### 📝 Description
13679
+
13680
+ <dl>
13681
+ <dd>
13682
+
13683
+ <dl>
13684
+ <dd>
13685
+
13686
+ Remove a single consent signing key for a user by its key identifier (kid). The operation is idempotent and returns 204 whether or not the key existed.
13687
+
13688
+ </dd>
13689
+ </dl>
13690
+ </dd>
13691
+ </dl>
13692
+
13693
+ #### 🔌 Usage
13694
+
13695
+ <dl>
13696
+ <dd>
13697
+
13698
+ <dl>
13699
+ <dd>
13700
+
13701
+ ```typescript
13702
+ await client.users.deleteConsentSigningKey("id", "kid");
13703
+ ```
13704
+
13705
+ </dd>
13706
+ </dl>
13707
+ </dd>
13708
+ </dl>
13709
+
13710
+ #### ⚙️ Parameters
13711
+
13712
+ <dl>
13713
+ <dd>
13714
+
13715
+ <dl>
13716
+ <dd>
13717
+
13718
+ **id:** `string` — The ID of the user.
13719
+
13720
+ </dd>
13721
+ </dl>
13722
+
13723
+ <dl>
13724
+ <dd>
13725
+
13726
+ **kid:** `string` — The key identifier of the consent signing key.
13727
+
13728
+ </dd>
13729
+ </dl>
13730
+
13731
+ <dl>
13732
+ <dd>
13733
+
13734
+ **requestOptions:** `UsersClient.RequestOptions`
13735
+
13736
+ </dd>
13737
+ </dl>
13738
+ </dd>
13739
+ </dl>
13740
+
13741
+ </dd>
13742
+ </dl>
13743
+ </details>
13744
+
13288
13745
  <details><summary><code>client.users.<a href="/src/management/api/resources/users/client/Client.ts">regenerateRecoveryCode</a>(id) -> Management.RegenerateUsersRecoveryCodeResponseContent</code></summary>
13289
13746
  <dl>
13290
13747
  <dd>
@@ -18830,7 +19287,7 @@ await client.connections.clients.update("id", [
18830
19287
  <dl>
18831
19288
  <dd>
18832
19289
 
18833
- Gets the connection keys for the Okta or OIDC connection strategy.
19290
+ Gets the connection keys for the Okta, OIDC, or SAML (samlp) connection strategy.
18834
19291
 
18835
19292
  </dd>
18836
19293
  </dl>
@@ -18893,7 +19350,7 @@ await client.connections.keys.get("id");
18893
19350
  <dl>
18894
19351
  <dd>
18895
19352
 
18896
- Provision initial connection keys for Okta or OIDC connection strategies. This endpoint allows you to create keys before configuring the connection to use Private Key JWT authentication, enabling zero-downtime transitions.
19353
+ Provision initial connection keys for Okta, OIDC, or SAML (samlp) connection strategies. This endpoint allows you to create keys before configuring the connection to use Private Key JWT authentication, enabling zero-downtime transitions.
18897
19354
 
18898
19355
  </dd>
18899
19356
  </dl>
@@ -18964,7 +19421,7 @@ await client.connections.keys.create("id");
18964
19421
  <dl>
18965
19422
  <dd>
18966
19423
 
18967
- Rotates the connection keys for the Okta or OIDC connection strategies.
19424
+ Rotates the connection keys for the Okta, OIDC, or SAML (samlp) connection strategies.
18968
19425
 
18969
19426
  </dd>
18970
19427
  </dl>
@@ -20797,6 +21254,7 @@ const pageableResponse = await client.experimentation.segments.list({
20797
21254
  from: "from",
20798
21255
  take: 1,
20799
21256
  type: "auth0",
21257
+ status: "active",
20800
21258
  });
20801
21259
  for await (const item of pageableResponse) {
20802
21260
  console.log(item);
@@ -20807,6 +21265,7 @@ let page = await client.experimentation.segments.list({
20807
21265
  from: "from",
20808
21266
  take: 1,
20809
21267
  type: "auth0",
21268
+ status: "active",
20810
21269
  });
20811
21270
  while (page.hasNextPage()) {
20812
21271
  page = await page.getNextPage();