auth0 6.1.0 → 6.2.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 (156) hide show
  1. package/dist/cjs/management/Client.d.ts +3 -0
  2. package/dist/cjs/management/Client.js +93 -88
  3. package/dist/cjs/management/api/requests/requests.d.ts +175 -3
  4. package/dist/cjs/management/api/resources/agents/client/Client.d.ts +100 -0
  5. package/dist/cjs/management/api/resources/agents/client/Client.js +383 -0
  6. package/dist/cjs/management/api/resources/agents/client/index.d.ts +1 -0
  7. package/dist/cjs/management/api/resources/agents/client/index.js +2 -0
  8. package/dist/cjs/management/api/resources/agents/exports.d.ts +2 -0
  9. package/dist/cjs/management/api/resources/agents/exports.js +21 -0
  10. package/dist/cjs/management/api/resources/agents/index.d.ts +1 -0
  11. package/dist/cjs/management/api/resources/agents/index.js +17 -0
  12. package/dist/cjs/management/api/resources/clientGrants/client/Client.d.ts +1 -0
  13. package/dist/cjs/management/api/resources/clientGrants/client/Client.js +3 -1
  14. package/dist/cjs/management/api/resources/clientGrants/resources/organizations/client/Client.d.ts +1 -0
  15. package/dist/cjs/management/api/resources/clientGrants/resources/organizations/client/Client.js +3 -1
  16. package/dist/cjs/management/api/resources/connections/client/Client.d.ts +1 -0
  17. package/dist/cjs/management/api/resources/connections/client/Client.js +3 -1
  18. package/dist/cjs/management/api/resources/connections/resources/directoryProvisioning/client/Client.d.ts +46 -1
  19. package/dist/cjs/management/api/resources/connections/resources/directoryProvisioning/client/Client.js +140 -2
  20. package/dist/cjs/management/api/resources/eventStreams/resources/deliveries/client/Client.d.ts +1 -2
  21. package/dist/cjs/management/api/resources/eventStreams/resources/deliveries/client/Client.js +66 -54
  22. package/dist/cjs/management/api/resources/flows/resources/executions/client/Client.d.ts +1 -0
  23. package/dist/cjs/management/api/resources/flows/resources/executions/client/Client.js +3 -1
  24. package/dist/cjs/management/api/resources/groups/client/Client.d.ts +1 -0
  25. package/dist/cjs/management/api/resources/groups/client/Client.js +3 -1
  26. package/dist/cjs/management/api/resources/index.d.ts +1 -0
  27. package/dist/cjs/management/api/resources/index.js +2 -1
  28. package/dist/cjs/management/api/resources/organizations/client/Client.d.ts +6 -1
  29. package/dist/cjs/management/api/resources/organizations/client/Client.js +25 -16
  30. package/dist/cjs/management/api/resources/organizations/resources/clients/client/Client.d.ts +119 -0
  31. package/dist/cjs/management/api/resources/organizations/resources/clients/client/Client.js +422 -0
  32. package/dist/cjs/management/api/resources/organizations/resources/clients/client/index.d.ts +1 -0
  33. package/dist/cjs/management/api/resources/organizations/resources/clients/client/index.js +2 -0
  34. package/dist/cjs/management/api/resources/organizations/resources/clients/exports.d.ts +2 -0
  35. package/dist/cjs/management/api/resources/organizations/resources/clients/exports.js +21 -0
  36. package/dist/cjs/management/api/resources/organizations/resources/clients/index.d.ts +1 -0
  37. package/dist/cjs/management/api/resources/organizations/resources/clients/index.js +17 -0
  38. package/dist/cjs/management/api/resources/organizations/resources/enabledConnections/client/Client.d.ts +1 -0
  39. package/dist/cjs/management/api/resources/organizations/resources/enabledConnections/client/Client.js +3 -0
  40. package/dist/cjs/management/api/resources/organizations/resources/index.d.ts +1 -0
  41. package/dist/cjs/management/api/resources/organizations/resources/index.js +2 -1
  42. package/dist/cjs/management/api/resources/organizations/resources/members/client/Client.d.ts +2 -1
  43. package/dist/cjs/management/api/resources/organizations/resources/members/client/Client.js +4 -2
  44. package/dist/cjs/management/api/resources/organizations/resources/members/resources/roles/client/Client.d.ts +2 -0
  45. package/dist/cjs/management/api/resources/organizations/resources/members/resources/roles/client/Client.js +2 -0
  46. package/dist/cjs/management/api/resources/organizations/resources/roles/client/Client.d.ts +3 -0
  47. package/dist/cjs/management/api/resources/organizations/resources/roles/client/Client.js +7 -2
  48. package/dist/cjs/management/api/resources/organizations/resources/roles/resources/groups/client/Client.d.ts +34 -0
  49. package/dist/cjs/management/api/resources/organizations/resources/roles/resources/groups/client/Client.js +145 -0
  50. package/dist/cjs/management/api/resources/organizations/resources/roles/resources/groups/client/index.d.ts +1 -0
  51. package/dist/cjs/management/api/resources/organizations/resources/roles/resources/groups/client/index.js +2 -0
  52. package/dist/cjs/management/api/resources/organizations/resources/roles/resources/groups/exports.d.ts +2 -0
  53. package/dist/cjs/management/api/resources/organizations/resources/roles/resources/groups/exports.js +21 -0
  54. package/dist/cjs/management/api/resources/organizations/resources/roles/resources/groups/index.d.ts +1 -0
  55. package/dist/cjs/management/api/resources/organizations/resources/roles/resources/groups/index.js +17 -0
  56. package/dist/cjs/management/api/resources/organizations/resources/roles/resources/index.d.ts +1 -0
  57. package/dist/cjs/management/api/resources/organizations/resources/roles/resources/index.js +2 -1
  58. package/dist/cjs/management/api/resources/organizations/resources/roles/resources/members/client/Client.d.ts +5 -0
  59. package/dist/cjs/management/api/resources/organizations/resources/roles/resources/members/client/Client.js +5 -0
  60. package/dist/cjs/management/api/resources/roles/client/Client.d.ts +3 -1
  61. package/dist/cjs/management/api/resources/roles/client/Client.js +6 -2
  62. package/dist/cjs/management/api/resources/roles/resources/users/client/Client.d.ts +3 -0
  63. package/dist/cjs/management/api/resources/roles/resources/users/client/Client.js +5 -1
  64. package/dist/cjs/management/api/resources/users/resources/groups/client/Client.d.ts +1 -0
  65. package/dist/cjs/management/api/resources/users/resources/groups/client/Client.js +3 -1
  66. package/dist/cjs/management/api/resources/users/resources/permissions/client/Client.d.ts +2 -0
  67. package/dist/cjs/management/api/resources/users/resources/permissions/client/Client.js +2 -0
  68. package/dist/cjs/management/api/resources/users/resources/refreshToken/client/Client.d.ts +1 -0
  69. package/dist/cjs/management/api/resources/users/resources/refreshToken/client/Client.js +3 -1
  70. package/dist/cjs/management/api/resources/users/resources/roles/client/Client.d.ts +2 -0
  71. package/dist/cjs/management/api/resources/users/resources/roles/client/Client.js +2 -0
  72. package/dist/cjs/management/api/resources/users/resources/sessions/client/Client.d.ts +1 -0
  73. package/dist/cjs/management/api/resources/users/resources/sessions/client/Client.js +3 -1
  74. package/dist/cjs/management/api/types/types.d.ts +255 -10
  75. package/dist/cjs/management/api/types/types.js +70 -22
  76. package/dist/cjs/management/version.d.ts +1 -1
  77. package/dist/cjs/management/version.js +1 -1
  78. package/dist/esm/management/Client.d.mts +3 -0
  79. package/dist/esm/management/Client.mjs +5 -0
  80. package/dist/esm/management/api/requests/requests.d.mts +175 -3
  81. package/dist/esm/management/api/resources/agents/client/Client.d.mts +100 -0
  82. package/dist/esm/management/api/resources/agents/client/Client.mjs +346 -0
  83. package/dist/esm/management/api/resources/agents/client/index.d.mts +1 -0
  84. package/dist/esm/management/api/resources/agents/client/index.mjs +1 -0
  85. package/dist/esm/management/api/resources/agents/exports.d.mts +2 -0
  86. package/dist/esm/management/api/resources/agents/exports.mjs +3 -0
  87. package/dist/esm/management/api/resources/agents/index.d.mts +1 -0
  88. package/dist/esm/management/api/resources/agents/index.mjs +1 -0
  89. package/dist/esm/management/api/resources/clientGrants/client/Client.d.mts +1 -0
  90. package/dist/esm/management/api/resources/clientGrants/client/Client.mjs +3 -1
  91. package/dist/esm/management/api/resources/clientGrants/resources/organizations/client/Client.d.mts +1 -0
  92. package/dist/esm/management/api/resources/clientGrants/resources/organizations/client/Client.mjs +3 -1
  93. package/dist/esm/management/api/resources/connections/client/Client.d.mts +1 -0
  94. package/dist/esm/management/api/resources/connections/client/Client.mjs +3 -1
  95. package/dist/esm/management/api/resources/connections/resources/directoryProvisioning/client/Client.d.mts +46 -1
  96. package/dist/esm/management/api/resources/connections/resources/directoryProvisioning/client/Client.mjs +140 -2
  97. package/dist/esm/management/api/resources/eventStreams/resources/deliveries/client/Client.d.mts +1 -2
  98. package/dist/esm/management/api/resources/eventStreams/resources/deliveries/client/Client.mjs +66 -54
  99. package/dist/esm/management/api/resources/flows/resources/executions/client/Client.d.mts +1 -0
  100. package/dist/esm/management/api/resources/flows/resources/executions/client/Client.mjs +3 -1
  101. package/dist/esm/management/api/resources/groups/client/Client.d.mts +1 -0
  102. package/dist/esm/management/api/resources/groups/client/Client.mjs +3 -1
  103. package/dist/esm/management/api/resources/index.d.mts +1 -0
  104. package/dist/esm/management/api/resources/index.mjs +1 -0
  105. package/dist/esm/management/api/resources/organizations/client/Client.d.mts +6 -1
  106. package/dist/esm/management/api/resources/organizations/client/Client.mjs +11 -2
  107. package/dist/esm/management/api/resources/organizations/resources/clients/client/Client.d.mts +119 -0
  108. package/dist/esm/management/api/resources/organizations/resources/clients/client/Client.mjs +385 -0
  109. package/dist/esm/management/api/resources/organizations/resources/clients/client/index.d.mts +1 -0
  110. package/dist/esm/management/api/resources/organizations/resources/clients/client/index.mjs +1 -0
  111. package/dist/esm/management/api/resources/organizations/resources/clients/exports.d.mts +2 -0
  112. package/dist/esm/management/api/resources/organizations/resources/clients/exports.mjs +3 -0
  113. package/dist/esm/management/api/resources/organizations/resources/clients/index.d.mts +1 -0
  114. package/dist/esm/management/api/resources/organizations/resources/clients/index.mjs +1 -0
  115. package/dist/esm/management/api/resources/organizations/resources/enabledConnections/client/Client.d.mts +1 -0
  116. package/dist/esm/management/api/resources/organizations/resources/enabledConnections/client/Client.mjs +3 -0
  117. package/dist/esm/management/api/resources/organizations/resources/index.d.mts +1 -0
  118. package/dist/esm/management/api/resources/organizations/resources/index.mjs +1 -0
  119. package/dist/esm/management/api/resources/organizations/resources/members/client/Client.d.mts +2 -1
  120. package/dist/esm/management/api/resources/organizations/resources/members/client/Client.mjs +4 -2
  121. package/dist/esm/management/api/resources/organizations/resources/members/resources/roles/client/Client.d.mts +2 -0
  122. package/dist/esm/management/api/resources/organizations/resources/members/resources/roles/client/Client.mjs +2 -0
  123. package/dist/esm/management/api/resources/organizations/resources/roles/client/Client.d.mts +3 -0
  124. package/dist/esm/management/api/resources/organizations/resources/roles/client/Client.mjs +5 -0
  125. package/dist/esm/management/api/resources/organizations/resources/roles/resources/groups/client/Client.d.mts +34 -0
  126. package/dist/esm/management/api/resources/organizations/resources/roles/resources/groups/client/Client.mjs +108 -0
  127. package/dist/esm/management/api/resources/organizations/resources/roles/resources/groups/client/index.d.mts +1 -0
  128. package/dist/esm/management/api/resources/organizations/resources/roles/resources/groups/client/index.mjs +1 -0
  129. package/dist/esm/management/api/resources/organizations/resources/roles/resources/groups/exports.d.mts +2 -0
  130. package/dist/esm/management/api/resources/organizations/resources/roles/resources/groups/exports.mjs +3 -0
  131. package/dist/esm/management/api/resources/organizations/resources/roles/resources/groups/index.d.mts +1 -0
  132. package/dist/esm/management/api/resources/organizations/resources/roles/resources/groups/index.mjs +1 -0
  133. package/dist/esm/management/api/resources/organizations/resources/roles/resources/index.d.mts +1 -0
  134. package/dist/esm/management/api/resources/organizations/resources/roles/resources/index.mjs +1 -0
  135. package/dist/esm/management/api/resources/organizations/resources/roles/resources/members/client/Client.d.mts +5 -0
  136. package/dist/esm/management/api/resources/organizations/resources/roles/resources/members/client/Client.mjs +5 -0
  137. package/dist/esm/management/api/resources/roles/client/Client.d.mts +3 -1
  138. package/dist/esm/management/api/resources/roles/client/Client.mjs +6 -2
  139. package/dist/esm/management/api/resources/roles/resources/users/client/Client.d.mts +3 -0
  140. package/dist/esm/management/api/resources/roles/resources/users/client/Client.mjs +5 -1
  141. package/dist/esm/management/api/resources/users/resources/groups/client/Client.d.mts +1 -0
  142. package/dist/esm/management/api/resources/users/resources/groups/client/Client.mjs +3 -1
  143. package/dist/esm/management/api/resources/users/resources/permissions/client/Client.d.mts +2 -0
  144. package/dist/esm/management/api/resources/users/resources/permissions/client/Client.mjs +2 -0
  145. package/dist/esm/management/api/resources/users/resources/refreshToken/client/Client.d.mts +1 -0
  146. package/dist/esm/management/api/resources/users/resources/refreshToken/client/Client.mjs +3 -1
  147. package/dist/esm/management/api/resources/users/resources/roles/client/Client.d.mts +2 -0
  148. package/dist/esm/management/api/resources/users/resources/roles/client/Client.mjs +2 -0
  149. package/dist/esm/management/api/resources/users/resources/sessions/client/Client.d.mts +1 -0
  150. package/dist/esm/management/api/resources/users/resources/sessions/client/Client.mjs +3 -1
  151. package/dist/esm/management/api/types/types.d.mts +255 -10
  152. package/dist/esm/management/api/types/types.mjs +54 -6
  153. package/dist/esm/management/version.d.mts +1 -1
  154. package/dist/esm/management/version.mjs +1 -1
  155. package/package.json +45 -12
  156. package/reference.md +1463 -406
package/reference.md CHANGED
@@ -506,6 +506,351 @@ await client.actions.test("id", {
506
506
  </dl>
507
507
  </details>
508
508
 
509
+ ## Agents
510
+
511
+ <details><summary><code>client.agents.<a href="/src/management/api/resources/agents/client/Client.ts">list</a>({ ...params }) -> core.Page&lt;Management.AgentResponseContent, Management.ListAgentsResponseContent&gt;</code></summary>
512
+ <dl>
513
+ <dd>
514
+
515
+ #### 📝 Description
516
+
517
+ <dl>
518
+ <dd>
519
+
520
+ <dl>
521
+ <dd>
522
+
523
+ Get agents
524
+
525
+ </dd>
526
+ </dl>
527
+ </dd>
528
+ </dl>
529
+
530
+ #### 🔌 Usage
531
+
532
+ <dl>
533
+ <dd>
534
+
535
+ <dl>
536
+ <dd>
537
+
538
+ ```typescript
539
+ const pageableResponse = await client.agents.list({
540
+ from: "from",
541
+ take: 1,
542
+ });
543
+ for await (const item of pageableResponse) {
544
+ console.log(item);
545
+ }
546
+
547
+ // Or you can manually iterate page-by-page
548
+ let page = await client.agents.list({
549
+ from: "from",
550
+ take: 1,
551
+ });
552
+ while (page.hasNextPage()) {
553
+ page = page.getNextPage();
554
+ }
555
+
556
+ // You can also access the underlying response
557
+ const response = page.response;
558
+ ```
559
+
560
+ </dd>
561
+ </dl>
562
+ </dd>
563
+ </dl>
564
+
565
+ #### ⚙️ Parameters
566
+
567
+ <dl>
568
+ <dd>
569
+
570
+ <dl>
571
+ <dd>
572
+
573
+ **request:** `Management.ListAgentsRequestParameters`
574
+
575
+ </dd>
576
+ </dl>
577
+
578
+ <dl>
579
+ <dd>
580
+
581
+ **requestOptions:** `AgentsClient.RequestOptions`
582
+
583
+ </dd>
584
+ </dl>
585
+ </dd>
586
+ </dl>
587
+
588
+ </dd>
589
+ </dl>
590
+ </details>
591
+
592
+ <details><summary><code>client.agents.<a href="/src/management/api/resources/agents/client/Client.ts">create</a>({ ...params }) -> Management.AgentResponseContent</code></summary>
593
+ <dl>
594
+ <dd>
595
+
596
+ #### 📝 Description
597
+
598
+ <dl>
599
+ <dd>
600
+
601
+ <dl>
602
+ <dd>
603
+
604
+ Create an agent
605
+
606
+ </dd>
607
+ </dl>
608
+ </dd>
609
+ </dl>
610
+
611
+ #### 🔌 Usage
612
+
613
+ <dl>
614
+ <dd>
615
+
616
+ <dl>
617
+ <dd>
618
+
619
+ ```typescript
620
+ await client.agents.create({
621
+ name: "name",
622
+ });
623
+ ```
624
+
625
+ </dd>
626
+ </dl>
627
+ </dd>
628
+ </dl>
629
+
630
+ #### ⚙️ Parameters
631
+
632
+ <dl>
633
+ <dd>
634
+
635
+ <dl>
636
+ <dd>
637
+
638
+ **request:** `Management.CreateAgentRequestContent`
639
+
640
+ </dd>
641
+ </dl>
642
+
643
+ <dl>
644
+ <dd>
645
+
646
+ **requestOptions:** `AgentsClient.RequestOptions`
647
+
648
+ </dd>
649
+ </dl>
650
+ </dd>
651
+ </dl>
652
+
653
+ </dd>
654
+ </dl>
655
+ </details>
656
+
657
+ <details><summary><code>client.agents.<a href="/src/management/api/resources/agents/client/Client.ts">read</a>(id) -> Management.AgentResponseContent</code></summary>
658
+ <dl>
659
+ <dd>
660
+
661
+ #### 📝 Description
662
+
663
+ <dl>
664
+ <dd>
665
+
666
+ <dl>
667
+ <dd>
668
+
669
+ Get an agent
670
+
671
+ </dd>
672
+ </dl>
673
+ </dd>
674
+ </dl>
675
+
676
+ #### 🔌 Usage
677
+
678
+ <dl>
679
+ <dd>
680
+
681
+ <dl>
682
+ <dd>
683
+
684
+ ```typescript
685
+ await client.agents.read("id");
686
+ ```
687
+
688
+ </dd>
689
+ </dl>
690
+ </dd>
691
+ </dl>
692
+
693
+ #### ⚙️ Parameters
694
+
695
+ <dl>
696
+ <dd>
697
+
698
+ <dl>
699
+ <dd>
700
+
701
+ **id:** `string` — The agent ID
702
+
703
+ </dd>
704
+ </dl>
705
+
706
+ <dl>
707
+ <dd>
708
+
709
+ **requestOptions:** `AgentsClient.RequestOptions`
710
+
711
+ </dd>
712
+ </dl>
713
+ </dd>
714
+ </dl>
715
+
716
+ </dd>
717
+ </dl>
718
+ </details>
719
+
720
+ <details><summary><code>client.agents.<a href="/src/management/api/resources/agents/client/Client.ts">delete</a>(id) -> void</code></summary>
721
+ <dl>
722
+ <dd>
723
+
724
+ #### 📝 Description
725
+
726
+ <dl>
727
+ <dd>
728
+
729
+ <dl>
730
+ <dd>
731
+
732
+ Delete an agent
733
+
734
+ </dd>
735
+ </dl>
736
+ </dd>
737
+ </dl>
738
+
739
+ #### 🔌 Usage
740
+
741
+ <dl>
742
+ <dd>
743
+
744
+ <dl>
745
+ <dd>
746
+
747
+ ```typescript
748
+ await client.agents.delete("id");
749
+ ```
750
+
751
+ </dd>
752
+ </dl>
753
+ </dd>
754
+ </dl>
755
+
756
+ #### ⚙️ Parameters
757
+
758
+ <dl>
759
+ <dd>
760
+
761
+ <dl>
762
+ <dd>
763
+
764
+ **id:** `string` — The agent ID
765
+
766
+ </dd>
767
+ </dl>
768
+
769
+ <dl>
770
+ <dd>
771
+
772
+ **requestOptions:** `AgentsClient.RequestOptions`
773
+
774
+ </dd>
775
+ </dl>
776
+ </dd>
777
+ </dl>
778
+
779
+ </dd>
780
+ </dl>
781
+ </details>
782
+
783
+ <details><summary><code>client.agents.<a href="/src/management/api/resources/agents/client/Client.ts">update</a>(id, { ...params }) -> Management.AgentResponseContent</code></summary>
784
+ <dl>
785
+ <dd>
786
+
787
+ #### 📝 Description
788
+
789
+ <dl>
790
+ <dd>
791
+
792
+ <dl>
793
+ <dd>
794
+
795
+ Update an agent
796
+
797
+ </dd>
798
+ </dl>
799
+ </dd>
800
+ </dl>
801
+
802
+ #### 🔌 Usage
803
+
804
+ <dl>
805
+ <dd>
806
+
807
+ <dl>
808
+ <dd>
809
+
810
+ ```typescript
811
+ await client.agents.update("id");
812
+ ```
813
+
814
+ </dd>
815
+ </dl>
816
+ </dd>
817
+ </dl>
818
+
819
+ #### ⚙️ Parameters
820
+
821
+ <dl>
822
+ <dd>
823
+
824
+ <dl>
825
+ <dd>
826
+
827
+ **id:** `string` — The agent ID
828
+
829
+ </dd>
830
+ </dl>
831
+
832
+ <dl>
833
+ <dd>
834
+
835
+ **request:** `Management.PatchAgentRequestParameters`
836
+
837
+ </dd>
838
+ </dl>
839
+
840
+ <dl>
841
+ <dd>
842
+
843
+ **requestOptions:** `AgentsClient.RequestOptions`
844
+
845
+ </dd>
846
+ </dl>
847
+ </dd>
848
+ </dl>
849
+
850
+ </dd>
851
+ </dl>
852
+ </details>
853
+
509
854
  ## Branding
510
855
 
511
856
  <details><summary><code>client.branding.<a href="/src/management/api/resources/branding/client/Client.ts">get</a>() -> Management.GetBrandingResponseContent</code></summary>
@@ -657,6 +1002,7 @@ Retrieve a list of [client grants](https://auth0.com/docs/get-started/applicatio
657
1002
 
658
1003
  ```typescript
659
1004
  const pageableResponse = await client.clientGrants.list({
1005
+ include_totals: true,
660
1006
  from: "from",
661
1007
  take: 1,
662
1008
  audience: "audience",
@@ -671,6 +1017,7 @@ for await (const item of pageableResponse) {
671
1017
 
672
1018
  // Or you can manually iterate page-by-page
673
1019
  let page = await client.clientGrants.list({
1020
+ include_totals: true,
674
1021
  from: "from",
675
1022
  take: 1,
676
1023
  audience: "audience",
@@ -2140,6 +2487,7 @@ To search by checkpoint, use the following parameters:
2140
2487
 
2141
2488
  ```typescript
2142
2489
  const pageableResponse = await client.connections.list({
2490
+ include_totals: true,
2143
2491
  from: "from",
2144
2492
  take: 1,
2145
2493
  strategy: ["ad"],
@@ -2153,6 +2501,7 @@ for await (const item of pageableResponse) {
2153
2501
 
2154
2502
  // Or you can manually iterate page-by-page
2155
2503
  let page = await client.connections.list({
2504
+ include_totals: true,
2156
2505
  from: "from",
2157
2506
  take: 1,
2158
2507
  strategy: ["ad"],
@@ -4907,6 +5256,7 @@ const pageableResponse = await client.groups.list({
4907
5256
  search: "search",
4908
5257
  fields: "fields",
4909
5258
  include_fields: true,
5259
+ include_totals: true,
4910
5260
  from: "from",
4911
5261
  take: 1,
4912
5262
  });
@@ -4922,6 +5272,7 @@ let page = await client.groups.list({
4922
5272
  search: "search",
4923
5273
  fields: "fields",
4924
5274
  include_fields: true,
5275
+ include_totals: true,
4925
5276
  from: "from",
4926
5277
  take: 1,
4927
5278
  });
@@ -7005,9 +7356,11 @@ To search by checkpoint, use the following parameters:
7005
7356
 
7006
7357
  ```typescript
7007
7358
  const pageableResponse = await client.organizations.list({
7359
+ include_totals: true,
7008
7360
  from: "from",
7009
7361
  take: 1,
7010
7362
  sort: "sort",
7363
+ include_client_association_for: "include_client_association_for",
7011
7364
  });
7012
7365
  for await (const item of pageableResponse) {
7013
7366
  console.log(item);
@@ -7015,9 +7368,11 @@ for await (const item of pageableResponse) {
7015
7368
 
7016
7369
  // Or you can manually iterate page-by-page
7017
7370
  let page = await client.organizations.list({
7371
+ include_totals: true,
7018
7372
  from: "from",
7019
7373
  take: 1,
7020
7374
  sort: "sort",
7375
+ include_client_association_for: "include_client_association_for",
7021
7376
  });
7022
7377
  while (page.hasNextPage()) {
7023
7378
  page = page.getNextPage();
@@ -8540,6 +8895,8 @@ const pageableResponse = await client.roles.list({
8540
8895
  page: 1,
8541
8896
  include_totals: true,
8542
8897
  name_filter: "name_filter",
8898
+ type: "tenant",
8899
+ owner_id: "owner_id",
8543
8900
  });
8544
8901
  for await (const item of pageableResponse) {
8545
8902
  console.log(item);
@@ -8551,6 +8908,8 @@ let page = await client.roles.list({
8551
8908
  page: 1,
8552
8909
  include_totals: true,
8553
8910
  name_filter: "name_filter",
8911
+ type: "tenant",
8912
+ owner_id: "owner_id",
8554
8913
  });
8555
8914
  while (page.hasNextPage()) {
8556
8915
  page = page.getNextPage();
@@ -15706,6 +16065,7 @@ await client.branding.phone.templates.test("id", {
15706
16065
 
15707
16066
  ```typescript
15708
16067
  const pageableResponse = await client.clientGrants.organizations.list("id", {
16068
+ include_totals: true,
15709
16069
  from: "from",
15710
16070
  take: 1,
15711
16071
  });
@@ -15715,6 +16075,7 @@ for await (const item of pageableResponse) {
15715
16075
 
15716
16076
  // Or you can manually iterate page-by-page
15717
16077
  let page = await client.clientGrants.organizations.list("id", {
16078
+ include_totals: true,
15718
16079
  from: "from",
15719
16080
  take: 1,
15720
16081
  });
@@ -16728,6 +17089,7 @@ Retrieve the configured synchronized groups for a connection directory provision
16728
17089
  const pageableResponse = await client.connections.directoryProvisioning.listSynchronizedGroups("id", {
16729
17090
  from: "from",
16730
17091
  take: 1,
17092
+ q: "q",
16731
17093
  });
16732
17094
  for await (const item of pageableResponse) {
16733
17095
  console.log(item);
@@ -16737,6 +17099,7 @@ for await (const item of pageableResponse) {
16737
17099
  let page = await client.connections.directoryProvisioning.listSynchronizedGroups("id", {
16738
17100
  from: "from",
16739
17101
  take: 1,
17102
+ q: "q",
16740
17103
  });
16741
17104
  while (page.hasNextPage()) {
16742
17105
  page = page.getNextPage();
@@ -16786,6 +17149,83 @@ const response = page.response;
16786
17149
  </dl>
16787
17150
  </details>
16788
17151
 
17152
+ <details><summary><code>client.connections.directoryProvisioning.<a href="/src/management/api/resources/connections/resources/directoryProvisioning/client/Client.ts">addSynchronizedGroupSelections</a>(id, { ...params }) -> void</code></summary>
17153
+ <dl>
17154
+ <dd>
17155
+
17156
+ #### 📝 Description
17157
+
17158
+ <dl>
17159
+ <dd>
17160
+
17161
+ <dl>
17162
+ <dd>
17163
+
17164
+ Add synchronized group selections to a directory provisioning configuration.
17165
+
17166
+ </dd>
17167
+ </dl>
17168
+ </dd>
17169
+ </dl>
17170
+
17171
+ #### 🔌 Usage
17172
+
17173
+ <dl>
17174
+ <dd>
17175
+
17176
+ <dl>
17177
+ <dd>
17178
+
17179
+ ```typescript
17180
+ await client.connections.directoryProvisioning.addSynchronizedGroupSelections("id", {
17181
+ groups: [
17182
+ {
17183
+ id: "id",
17184
+ },
17185
+ ],
17186
+ });
17187
+ ```
17188
+
17189
+ </dd>
17190
+ </dl>
17191
+ </dd>
17192
+ </dl>
17193
+
17194
+ #### ⚙️ Parameters
17195
+
17196
+ <dl>
17197
+ <dd>
17198
+
17199
+ <dl>
17200
+ <dd>
17201
+
17202
+ **id:** `string` — The id of the connection to add synchronized groups to
17203
+
17204
+ </dd>
17205
+ </dl>
17206
+
17207
+ <dl>
17208
+ <dd>
17209
+
17210
+ **request:** `Management.AddSynchronizedGroupsRequestContent`
17211
+
17212
+ </dd>
17213
+ </dl>
17214
+
17215
+ <dl>
17216
+ <dd>
17217
+
17218
+ **requestOptions:** `DirectoryProvisioningClient.RequestOptions`
17219
+
17220
+ </dd>
17221
+ </dl>
17222
+ </dd>
17223
+ </dl>
17224
+
17225
+ </dd>
17226
+ </dl>
17227
+ </details>
17228
+
16789
17229
  <details><summary><code>client.connections.directoryProvisioning.<a href="/src/management/api/resources/connections/resources/directoryProvisioning/client/Client.ts">set</a>(id, { ...params }) -> void</code></summary>
16790
17230
  <dl>
16791
17231
  <dd>
@@ -16863,6 +17303,83 @@ await client.connections.directoryProvisioning.set("id", {
16863
17303
  </dl>
16864
17304
  </details>
16865
17305
 
17306
+ <details><summary><code>client.connections.directoryProvisioning.<a href="/src/management/api/resources/connections/resources/directoryProvisioning/client/Client.ts">deleteSynchronizedGroupSelections</a>(id, { ...params }) -> void</code></summary>
17307
+ <dl>
17308
+ <dd>
17309
+
17310
+ #### 📝 Description
17311
+
17312
+ <dl>
17313
+ <dd>
17314
+
17315
+ <dl>
17316
+ <dd>
17317
+
17318
+ Delete synchronized group selections for a directory provisioning configuration
17319
+
17320
+ </dd>
17321
+ </dl>
17322
+ </dd>
17323
+ </dl>
17324
+
17325
+ #### 🔌 Usage
17326
+
17327
+ <dl>
17328
+ <dd>
17329
+
17330
+ <dl>
17331
+ <dd>
17332
+
17333
+ ```typescript
17334
+ await client.connections.directoryProvisioning.deleteSynchronizedGroupSelections("id", {
17335
+ groups: [
17336
+ {
17337
+ id: "id",
17338
+ },
17339
+ ],
17340
+ });
17341
+ ```
17342
+
17343
+ </dd>
17344
+ </dl>
17345
+ </dd>
17346
+ </dl>
17347
+
17348
+ #### ⚙️ Parameters
17349
+
17350
+ <dl>
17351
+ <dd>
17352
+
17353
+ <dl>
17354
+ <dd>
17355
+
17356
+ **id:** `string` — The id of the connection to delete synchronized group selections for
17357
+
17358
+ </dd>
17359
+ </dl>
17360
+
17361
+ <dl>
17362
+ <dd>
17363
+
17364
+ **request:** `Management.DeleteSynchronizedGroupsRequestContent`
17365
+
17366
+ </dd>
17367
+ </dl>
17368
+
17369
+ <dl>
17370
+ <dd>
17371
+
17372
+ **requestOptions:** `DirectoryProvisioningClient.RequestOptions`
17373
+
17374
+ </dd>
17375
+ </dl>
17376
+ </dd>
17377
+ </dl>
17378
+
17379
+ </dd>
17380
+ </dl>
17381
+ </details>
17382
+
16866
17383
  ## Connections ScimConfiguration
16867
17384
 
16868
17385
  <details><summary><code>client.connections.scimConfiguration.<a href="/src/management/api/resources/connections/resources/scimConfiguration/client/Client.ts">list</a>({ ...params }) -> core.Page&lt;Management.ScimConfiguration, Management.ListScimConfigurationsResponseContent&gt;</code></summary>
@@ -18289,7 +18806,7 @@ await client.emails.provider.update();
18289
18806
 
18290
18807
  ## EventStreams Deliveries
18291
18808
 
18292
- <details><summary><code>client.eventStreams.deliveries.<a href="/src/management/api/resources/eventStreams/resources/deliveries/client/Client.ts">list</a>(id, { ...params }) -> Management.EventStreamDelivery[]</code></summary>
18809
+ <details><summary><code>client.eventStreams.deliveries.<a href="/src/management/api/resources/eventStreams/resources/deliveries/client/Client.ts">list</a>(id, { ...params }) -> core.Page&lt;Management.EventStreamDelivery, Management.ListEventStreamDeliveriesResponseContent&gt;</code></summary>
18293
18810
  <dl>
18294
18811
  <dd>
18295
18812
 
@@ -18302,7 +18819,20 @@ await client.emails.provider.update();
18302
18819
  <dd>
18303
18820
 
18304
18821
  ```typescript
18305
- await client.eventStreams.deliveries.list("id", {
18822
+ const pageableResponse = await client.eventStreams.deliveries.list("id", {
18823
+ statuses: "statuses",
18824
+ event_types: "event_types",
18825
+ date_from: "date_from",
18826
+ date_to: "date_to",
18827
+ from: "from",
18828
+ take: 1,
18829
+ });
18830
+ for await (const item of pageableResponse) {
18831
+ console.log(item);
18832
+ }
18833
+
18834
+ // Or you can manually iterate page-by-page
18835
+ let page = await client.eventStreams.deliveries.list("id", {
18306
18836
  statuses: "statuses",
18307
18837
  event_types: "event_types",
18308
18838
  date_from: "date_from",
@@ -18310,6 +18840,12 @@ await client.eventStreams.deliveries.list("id", {
18310
18840
  from: "from",
18311
18841
  take: 1,
18312
18842
  });
18843
+ while (page.hasNextPage()) {
18844
+ page = page.getNextPage();
18845
+ }
18846
+
18847
+ // You can also access the underlying response
18848
+ const response = page.response;
18313
18849
  ```
18314
18850
 
18315
18851
  </dd>
@@ -18538,6 +19074,7 @@ await client.eventStreams.redeliveries.createById("id", "event_id");
18538
19074
 
18539
19075
  ```typescript
18540
19076
  const pageableResponse = await client.flows.executions.list("flow_id", {
19077
+ include_totals: true,
18541
19078
  from: "from",
18542
19079
  take: 1,
18543
19080
  });
@@ -18547,6 +19084,7 @@ for await (const item of pageableResponse) {
18547
19084
 
18548
19085
  // Or you can manually iterate page-by-page
18549
19086
  let page = await client.flows.executions.list("flow_id", {
19087
+ include_totals: true,
18550
19088
  from: "from",
18551
19089
  take: 1,
18552
19090
  });
@@ -20322,7 +20860,259 @@ await client.guardian.factors.pushNotification.getApnsProvider();
20322
20860
  <dl>
20323
20861
  <dd>
20324
20862
 
20325
- Overwrite all configuration details of the multi-factor authentication APNS provider associated with your tenant.
20863
+ Overwrite all configuration details of the multi-factor authentication APNS provider associated with your tenant.
20864
+
20865
+ </dd>
20866
+ </dl>
20867
+ </dd>
20868
+ </dl>
20869
+
20870
+ #### 🔌 Usage
20871
+
20872
+ <dl>
20873
+ <dd>
20874
+
20875
+ <dl>
20876
+ <dd>
20877
+
20878
+ ```typescript
20879
+ await client.guardian.factors.pushNotification.setApnsProvider();
20880
+ ```
20881
+
20882
+ </dd>
20883
+ </dl>
20884
+ </dd>
20885
+ </dl>
20886
+
20887
+ #### ⚙️ Parameters
20888
+
20889
+ <dl>
20890
+ <dd>
20891
+
20892
+ <dl>
20893
+ <dd>
20894
+
20895
+ **request:** `Management.SetGuardianFactorsProviderPushNotificationApnsRequestContent`
20896
+
20897
+ </dd>
20898
+ </dl>
20899
+
20900
+ <dl>
20901
+ <dd>
20902
+
20903
+ **requestOptions:** `PushNotificationClient.RequestOptions`
20904
+
20905
+ </dd>
20906
+ </dl>
20907
+ </dd>
20908
+ </dl>
20909
+
20910
+ </dd>
20911
+ </dl>
20912
+ </details>
20913
+
20914
+ <details><summary><code>client.guardian.factors.pushNotification.<a href="/src/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.ts">updateApnsProvider</a>({ ...params }) -> Management.UpdateGuardianFactorsProviderPushNotificationApnsResponseContent</code></summary>
20915
+ <dl>
20916
+ <dd>
20917
+
20918
+ #### 📝 Description
20919
+
20920
+ <dl>
20921
+ <dd>
20922
+
20923
+ <dl>
20924
+ <dd>
20925
+
20926
+ Modify configuration details of the multi-factor authentication APNS provider associated with your tenant.
20927
+
20928
+ </dd>
20929
+ </dl>
20930
+ </dd>
20931
+ </dl>
20932
+
20933
+ #### 🔌 Usage
20934
+
20935
+ <dl>
20936
+ <dd>
20937
+
20938
+ <dl>
20939
+ <dd>
20940
+
20941
+ ```typescript
20942
+ await client.guardian.factors.pushNotification.updateApnsProvider();
20943
+ ```
20944
+
20945
+ </dd>
20946
+ </dl>
20947
+ </dd>
20948
+ </dl>
20949
+
20950
+ #### ⚙️ Parameters
20951
+
20952
+ <dl>
20953
+ <dd>
20954
+
20955
+ <dl>
20956
+ <dd>
20957
+
20958
+ **request:** `Management.UpdateGuardianFactorsProviderPushNotificationApnsRequestContent`
20959
+
20960
+ </dd>
20961
+ </dl>
20962
+
20963
+ <dl>
20964
+ <dd>
20965
+
20966
+ **requestOptions:** `PushNotificationClient.RequestOptions`
20967
+
20968
+ </dd>
20969
+ </dl>
20970
+ </dd>
20971
+ </dl>
20972
+
20973
+ </dd>
20974
+ </dl>
20975
+ </details>
20976
+
20977
+ <details><summary><code>client.guardian.factors.pushNotification.<a href="/src/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.ts">setFcmProvider</a>({ ...params }) -> Management.SetGuardianFactorsProviderPushNotificationFcmResponseContent</code></summary>
20978
+ <dl>
20979
+ <dd>
20980
+
20981
+ #### 📝 Description
20982
+
20983
+ <dl>
20984
+ <dd>
20985
+
20986
+ <dl>
20987
+ <dd>
20988
+
20989
+ Overwrite all configuration details of the multi-factor authentication FCM provider associated with your tenant.
20990
+
20991
+ </dd>
20992
+ </dl>
20993
+ </dd>
20994
+ </dl>
20995
+
20996
+ #### 🔌 Usage
20997
+
20998
+ <dl>
20999
+ <dd>
21000
+
21001
+ <dl>
21002
+ <dd>
21003
+
21004
+ ```typescript
21005
+ await client.guardian.factors.pushNotification.setFcmProvider();
21006
+ ```
21007
+
21008
+ </dd>
21009
+ </dl>
21010
+ </dd>
21011
+ </dl>
21012
+
21013
+ #### ⚙️ Parameters
21014
+
21015
+ <dl>
21016
+ <dd>
21017
+
21018
+ <dl>
21019
+ <dd>
21020
+
21021
+ **request:** `Management.SetGuardianFactorsProviderPushNotificationFcmRequestContent`
21022
+
21023
+ </dd>
21024
+ </dl>
21025
+
21026
+ <dl>
21027
+ <dd>
21028
+
21029
+ **requestOptions:** `PushNotificationClient.RequestOptions`
21030
+
21031
+ </dd>
21032
+ </dl>
21033
+ </dd>
21034
+ </dl>
21035
+
21036
+ </dd>
21037
+ </dl>
21038
+ </details>
21039
+
21040
+ <details><summary><code>client.guardian.factors.pushNotification.<a href="/src/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.ts">updateFcmProvider</a>({ ...params }) -> Management.UpdateGuardianFactorsProviderPushNotificationFcmResponseContent</code></summary>
21041
+ <dl>
21042
+ <dd>
21043
+
21044
+ #### 📝 Description
21045
+
21046
+ <dl>
21047
+ <dd>
21048
+
21049
+ <dl>
21050
+ <dd>
21051
+
21052
+ Modify configuration details of the multi-factor authentication FCM provider associated with your tenant.
21053
+
21054
+ </dd>
21055
+ </dl>
21056
+ </dd>
21057
+ </dl>
21058
+
21059
+ #### 🔌 Usage
21060
+
21061
+ <dl>
21062
+ <dd>
21063
+
21064
+ <dl>
21065
+ <dd>
21066
+
21067
+ ```typescript
21068
+ await client.guardian.factors.pushNotification.updateFcmProvider();
21069
+ ```
21070
+
21071
+ </dd>
21072
+ </dl>
21073
+ </dd>
21074
+ </dl>
21075
+
21076
+ #### ⚙️ Parameters
21077
+
21078
+ <dl>
21079
+ <dd>
21080
+
21081
+ <dl>
21082
+ <dd>
21083
+
21084
+ **request:** `Management.UpdateGuardianFactorsProviderPushNotificationFcmRequestContent`
21085
+
21086
+ </dd>
21087
+ </dl>
21088
+
21089
+ <dl>
21090
+ <dd>
21091
+
21092
+ **requestOptions:** `PushNotificationClient.RequestOptions`
21093
+
21094
+ </dd>
21095
+ </dl>
21096
+ </dd>
21097
+ </dl>
21098
+
21099
+ </dd>
21100
+ </dl>
21101
+ </details>
21102
+
21103
+ <details><summary><code>client.guardian.factors.pushNotification.<a href="/src/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.ts">setFcmv1Provider</a>({ ...params }) -> Management.SetGuardianFactorsProviderPushNotificationFcmv1ResponseContent</code></summary>
21104
+ <dl>
21105
+ <dd>
21106
+
21107
+ #### 📝 Description
21108
+
21109
+ <dl>
21110
+ <dd>
21111
+
21112
+ <dl>
21113
+ <dd>
21114
+
21115
+ Overwrite all configuration details of the multi-factor authentication FCMV1 provider associated with your tenant.
20326
21116
 
20327
21117
  </dd>
20328
21118
  </dl>
@@ -20338,7 +21128,7 @@ Overwrite all configuration details of the multi-factor authentication APNS prov
20338
21128
  <dd>
20339
21129
 
20340
21130
  ```typescript
20341
- await client.guardian.factors.pushNotification.setApnsProvider();
21131
+ await client.guardian.factors.pushNotification.setFcmv1Provider();
20342
21132
  ```
20343
21133
 
20344
21134
  </dd>
@@ -20354,7 +21144,7 @@ await client.guardian.factors.pushNotification.setApnsProvider();
20354
21144
  <dl>
20355
21145
  <dd>
20356
21146
 
20357
- **request:** `Management.SetGuardianFactorsProviderPushNotificationApnsRequestContent`
21147
+ **request:** `Management.SetGuardianFactorsProviderPushNotificationFcmv1RequestContent`
20358
21148
 
20359
21149
  </dd>
20360
21150
  </dl>
@@ -20373,7 +21163,7 @@ await client.guardian.factors.pushNotification.setApnsProvider();
20373
21163
  </dl>
20374
21164
  </details>
20375
21165
 
20376
- <details><summary><code>client.guardian.factors.pushNotification.<a href="/src/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.ts">updateApnsProvider</a>({ ...params }) -> Management.UpdateGuardianFactorsProviderPushNotificationApnsResponseContent</code></summary>
21166
+ <details><summary><code>client.guardian.factors.pushNotification.<a href="/src/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.ts">updateFcmv1Provider</a>({ ...params }) -> Management.UpdateGuardianFactorsProviderPushNotificationFcmv1ResponseContent</code></summary>
20377
21167
  <dl>
20378
21168
  <dd>
20379
21169
 
@@ -20385,7 +21175,7 @@ await client.guardian.factors.pushNotification.setApnsProvider();
20385
21175
  <dl>
20386
21176
  <dd>
20387
21177
 
20388
- Modify configuration details of the multi-factor authentication APNS provider associated with your tenant.
21178
+ Modify configuration details of the multi-factor authentication FCMV1 provider associated with your tenant.
20389
21179
 
20390
21180
  </dd>
20391
21181
  </dl>
@@ -20401,7 +21191,7 @@ Modify configuration details of the multi-factor authentication APNS provider as
20401
21191
  <dd>
20402
21192
 
20403
21193
  ```typescript
20404
- await client.guardian.factors.pushNotification.updateApnsProvider();
21194
+ await client.guardian.factors.pushNotification.updateFcmv1Provider();
20405
21195
  ```
20406
21196
 
20407
21197
  </dd>
@@ -20417,7 +21207,7 @@ await client.guardian.factors.pushNotification.updateApnsProvider();
20417
21207
  <dl>
20418
21208
  <dd>
20419
21209
 
20420
- **request:** `Management.UpdateGuardianFactorsProviderPushNotificationApnsRequestContent`
21210
+ **request:** `Management.UpdateGuardianFactorsProviderPushNotificationFcmv1RequestContent`
20421
21211
 
20422
21212
  </dd>
20423
21213
  </dl>
@@ -20436,7 +21226,7 @@ await client.guardian.factors.pushNotification.updateApnsProvider();
20436
21226
  </dl>
20437
21227
  </details>
20438
21228
 
20439
- <details><summary><code>client.guardian.factors.pushNotification.<a href="/src/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.ts">setFcmProvider</a>({ ...params }) -> Management.SetGuardianFactorsProviderPushNotificationFcmResponseContent</code></summary>
21229
+ <details><summary><code>client.guardian.factors.pushNotification.<a href="/src/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.ts">getSnsProvider</a>() -> Management.GetGuardianFactorsProviderSnsResponseContent</code></summary>
20440
21230
  <dl>
20441
21231
  <dd>
20442
21232
 
@@ -20448,7 +21238,7 @@ await client.guardian.factors.pushNotification.updateApnsProvider();
20448
21238
  <dl>
20449
21239
  <dd>
20450
21240
 
20451
- Overwrite all configuration details of the multi-factor authentication FCM provider associated with your tenant.
21241
+ Retrieve configuration details for an AWS SNS push notification provider that has been enabled for MFA. To learn more, review [Configure Push Notifications for MFA](https://auth0.com/docs/secure/multi-factor-authentication/multi-factor-authentication-factors/configure-push-notifications-for-mfa).
20452
21242
 
20453
21243
  </dd>
20454
21244
  </dl>
@@ -20464,7 +21254,7 @@ Overwrite all configuration details of the multi-factor authentication FCM provi
20464
21254
  <dd>
20465
21255
 
20466
21256
  ```typescript
20467
- await client.guardian.factors.pushNotification.setFcmProvider();
21257
+ await client.guardian.factors.pushNotification.getSnsProvider();
20468
21258
  ```
20469
21259
 
20470
21260
  </dd>
@@ -20480,14 +21270,6 @@ await client.guardian.factors.pushNotification.setFcmProvider();
20480
21270
  <dl>
20481
21271
  <dd>
20482
21272
 
20483
- **request:** `Management.SetGuardianFactorsProviderPushNotificationFcmRequestContent`
20484
-
20485
- </dd>
20486
- </dl>
20487
-
20488
- <dl>
20489
- <dd>
20490
-
20491
21273
  **requestOptions:** `PushNotificationClient.RequestOptions`
20492
21274
 
20493
21275
  </dd>
@@ -20499,7 +21281,7 @@ await client.guardian.factors.pushNotification.setFcmProvider();
20499
21281
  </dl>
20500
21282
  </details>
20501
21283
 
20502
- <details><summary><code>client.guardian.factors.pushNotification.<a href="/src/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.ts">updateFcmProvider</a>({ ...params }) -> Management.UpdateGuardianFactorsProviderPushNotificationFcmResponseContent</code></summary>
21284
+ <details><summary><code>client.guardian.factors.pushNotification.<a href="/src/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.ts">setSnsProvider</a>({ ...params }) -> Management.SetGuardianFactorsProviderPushNotificationSnsResponseContent</code></summary>
20503
21285
  <dl>
20504
21286
  <dd>
20505
21287
 
@@ -20511,7 +21293,7 @@ await client.guardian.factors.pushNotification.setFcmProvider();
20511
21293
  <dl>
20512
21294
  <dd>
20513
21295
 
20514
- Modify configuration details of the multi-factor authentication FCM provider associated with your tenant.
21296
+ Configure the [AWS SNS push notification provider configuration](https://auth0.com/docs/multifactor-authentication/developer/sns-configuration) (subscription required).
20515
21297
 
20516
21298
  </dd>
20517
21299
  </dl>
@@ -20527,7 +21309,7 @@ Modify configuration details of the multi-factor authentication FCM provider ass
20527
21309
  <dd>
20528
21310
 
20529
21311
  ```typescript
20530
- await client.guardian.factors.pushNotification.updateFcmProvider();
21312
+ await client.guardian.factors.pushNotification.setSnsProvider();
20531
21313
  ```
20532
21314
 
20533
21315
  </dd>
@@ -20543,7 +21325,7 @@ await client.guardian.factors.pushNotification.updateFcmProvider();
20543
21325
  <dl>
20544
21326
  <dd>
20545
21327
 
20546
- **request:** `Management.UpdateGuardianFactorsProviderPushNotificationFcmRequestContent`
21328
+ **request:** `Management.SetGuardianFactorsProviderPushNotificationSnsRequestContent`
20547
21329
 
20548
21330
  </dd>
20549
21331
  </dl>
@@ -20562,7 +21344,7 @@ await client.guardian.factors.pushNotification.updateFcmProvider();
20562
21344
  </dl>
20563
21345
  </details>
20564
21346
 
20565
- <details><summary><code>client.guardian.factors.pushNotification.<a href="/src/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.ts">setFcmv1Provider</a>({ ...params }) -> Management.SetGuardianFactorsProviderPushNotificationFcmv1ResponseContent</code></summary>
21347
+ <details><summary><code>client.guardian.factors.pushNotification.<a href="/src/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.ts">updateSnsProvider</a>({ ...params }) -> Management.UpdateGuardianFactorsProviderPushNotificationSnsResponseContent</code></summary>
20566
21348
  <dl>
20567
21349
  <dd>
20568
21350
 
@@ -20574,7 +21356,7 @@ await client.guardian.factors.pushNotification.updateFcmProvider();
20574
21356
  <dl>
20575
21357
  <dd>
20576
21358
 
20577
- Overwrite all configuration details of the multi-factor authentication FCMV1 provider associated with your tenant.
21359
+ Configure the [AWS SNS push notification provider configuration](https://auth0.com/docs/multifactor-authentication/developer/sns-configuration) (subscription required).
20578
21360
 
20579
21361
  </dd>
20580
21362
  </dl>
@@ -20590,7 +21372,7 @@ Overwrite all configuration details of the multi-factor authentication FCMV1 pro
20590
21372
  <dd>
20591
21373
 
20592
21374
  ```typescript
20593
- await client.guardian.factors.pushNotification.setFcmv1Provider();
21375
+ await client.guardian.factors.pushNotification.updateSnsProvider();
20594
21376
  ```
20595
21377
 
20596
21378
  </dd>
@@ -20606,7 +21388,7 @@ await client.guardian.factors.pushNotification.setFcmv1Provider();
20606
21388
  <dl>
20607
21389
  <dd>
20608
21390
 
20609
- **request:** `Management.SetGuardianFactorsProviderPushNotificationFcmv1RequestContent`
21391
+ **request:** `Management.UpdateGuardianFactorsProviderPushNotificationSnsRequestContent`
20610
21392
 
20611
21393
  </dd>
20612
21394
  </dl>
@@ -20625,7 +21407,7 @@ await client.guardian.factors.pushNotification.setFcmv1Provider();
20625
21407
  </dl>
20626
21408
  </details>
20627
21409
 
20628
- <details><summary><code>client.guardian.factors.pushNotification.<a href="/src/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.ts">updateFcmv1Provider</a>({ ...params }) -> Management.UpdateGuardianFactorsProviderPushNotificationFcmv1ResponseContent</code></summary>
21410
+ <details><summary><code>client.guardian.factors.pushNotification.<a href="/src/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.ts">getSelectedProvider</a>() -> Management.GetGuardianFactorsProviderPushNotificationResponseContent</code></summary>
20629
21411
  <dl>
20630
21412
  <dd>
20631
21413
 
@@ -20637,7 +21419,7 @@ await client.guardian.factors.pushNotification.setFcmv1Provider();
20637
21419
  <dl>
20638
21420
  <dd>
20639
21421
 
20640
- Modify configuration details of the multi-factor authentication FCMV1 provider associated with your tenant.
21422
+ Modify the push notification provider configured for your tenant. For more information, review <a href="https://auth0.com/docs/secure/multi-factor-authentication/multi-factor-authentication-factors/configure-push-notifications-for-mfa">Configure Push Notifications for MFA</a>.
20641
21423
 
20642
21424
  </dd>
20643
21425
  </dl>
@@ -20653,7 +21435,7 @@ Modify configuration details of the multi-factor authentication FCMV1 provider a
20653
21435
  <dd>
20654
21436
 
20655
21437
  ```typescript
20656
- await client.guardian.factors.pushNotification.updateFcmv1Provider();
21438
+ await client.guardian.factors.pushNotification.getSelectedProvider();
20657
21439
  ```
20658
21440
 
20659
21441
  </dd>
@@ -20669,14 +21451,6 @@ await client.guardian.factors.pushNotification.updateFcmv1Provider();
20669
21451
  <dl>
20670
21452
  <dd>
20671
21453
 
20672
- **request:** `Management.UpdateGuardianFactorsProviderPushNotificationFcmv1RequestContent`
20673
-
20674
- </dd>
20675
- </dl>
20676
-
20677
- <dl>
20678
- <dd>
20679
-
20680
21454
  **requestOptions:** `PushNotificationClient.RequestOptions`
20681
21455
 
20682
21456
  </dd>
@@ -20688,7 +21462,7 @@ await client.guardian.factors.pushNotification.updateFcmv1Provider();
20688
21462
  </dl>
20689
21463
  </details>
20690
21464
 
20691
- <details><summary><code>client.guardian.factors.pushNotification.<a href="/src/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.ts">getSnsProvider</a>() -> Management.GetGuardianFactorsProviderSnsResponseContent</code></summary>
21465
+ <details><summary><code>client.guardian.factors.pushNotification.<a href="/src/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.ts">setProvider</a>({ ...params }) -> Management.SetGuardianFactorsProviderPushNotificationResponseContent</code></summary>
20692
21466
  <dl>
20693
21467
  <dd>
20694
21468
 
@@ -20700,7 +21474,7 @@ await client.guardian.factors.pushNotification.updateFcmv1Provider();
20700
21474
  <dl>
20701
21475
  <dd>
20702
21476
 
20703
- Retrieve configuration details for an AWS SNS push notification provider that has been enabled for MFA. To learn more, review [Configure Push Notifications for MFA](https://auth0.com/docs/secure/multi-factor-authentication/multi-factor-authentication-factors/configure-push-notifications-for-mfa).
21477
+ Modify the push notification provider configured for your tenant. For more information, review <a href="https://auth0.com/docs/secure/multi-factor-authentication/multi-factor-authentication-factors/configure-push-notifications-for-mfa">Configure Push Notifications for MFA</a>.
20704
21478
 
20705
21479
  </dd>
20706
21480
  </dl>
@@ -20716,7 +21490,9 @@ Retrieve configuration details for an AWS SNS push notification provider that ha
20716
21490
  <dd>
20717
21491
 
20718
21492
  ```typescript
20719
- await client.guardian.factors.pushNotification.getSnsProvider();
21493
+ await client.guardian.factors.pushNotification.setProvider({
21494
+ provider: "guardian",
21495
+ });
20720
21496
  ```
20721
21497
 
20722
21498
  </dd>
@@ -20732,6 +21508,14 @@ await client.guardian.factors.pushNotification.getSnsProvider();
20732
21508
  <dl>
20733
21509
  <dd>
20734
21510
 
21511
+ **request:** `Management.SetGuardianFactorsProviderPushNotificationRequestContent`
21512
+
21513
+ </dd>
21514
+ </dl>
21515
+
21516
+ <dl>
21517
+ <dd>
21518
+
20735
21519
  **requestOptions:** `PushNotificationClient.RequestOptions`
20736
21520
 
20737
21521
  </dd>
@@ -20743,7 +21527,9 @@ await client.guardian.factors.pushNotification.getSnsProvider();
20743
21527
  </dl>
20744
21528
  </details>
20745
21529
 
20746
- <details><summary><code>client.guardian.factors.pushNotification.<a href="/src/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.ts">setSnsProvider</a>({ ...params }) -> Management.SetGuardianFactorsProviderPushNotificationSnsResponseContent</code></summary>
21530
+ ## Guardian Factors Sms
21531
+
21532
+ <details><summary><code>client.guardian.factors.sms.<a href="/src/management/api/resources/guardian/resources/factors/resources/sms/client/Client.ts">getTwilioProvider</a>() -> Management.GetGuardianFactorsProviderSmsTwilioResponseContent</code></summary>
20747
21533
  <dl>
20748
21534
  <dd>
20749
21535
 
@@ -20755,7 +21541,9 @@ await client.guardian.factors.pushNotification.getSnsProvider();
20755
21541
  <dl>
20756
21542
  <dd>
20757
21543
 
20758
- Configure the [AWS SNS push notification provider configuration](https://auth0.com/docs/multifactor-authentication/developer/sns-configuration) (subscription required).
21544
+ Retrieve the <a href="https://auth0.com/docs/multifactor-authentication/twilio-configuration">Twilio SMS provider configuration</a> (subscription required).
21545
+
21546
+ A new endpoint is available to retrieve the Twilio configuration related to phone factors (<a href='https://auth0.com/docs/api/management/v2/#!/Guardian/get_twilio'>phone Twilio configuration</a>). It has the same payload as this one. Please use it instead.
20759
21547
 
20760
21548
  </dd>
20761
21549
  </dl>
@@ -20771,7 +21559,7 @@ Configure the [AWS SNS push notification provider configuration](https://auth0.c
20771
21559
  <dd>
20772
21560
 
20773
21561
  ```typescript
20774
- await client.guardian.factors.pushNotification.setSnsProvider();
21562
+ await client.guardian.factors.sms.getTwilioProvider();
20775
21563
  ```
20776
21564
 
20777
21565
  </dd>
@@ -20787,15 +21575,7 @@ await client.guardian.factors.pushNotification.setSnsProvider();
20787
21575
  <dl>
20788
21576
  <dd>
20789
21577
 
20790
- **request:** `Management.SetGuardianFactorsProviderPushNotificationSnsRequestContent`
20791
-
20792
- </dd>
20793
- </dl>
20794
-
20795
- <dl>
20796
- <dd>
20797
-
20798
- **requestOptions:** `PushNotificationClient.RequestOptions`
21578
+ **requestOptions:** `SmsClient.RequestOptions`
20799
21579
 
20800
21580
  </dd>
20801
21581
  </dl>
@@ -20806,7 +21586,7 @@ await client.guardian.factors.pushNotification.setSnsProvider();
20806
21586
  </dl>
20807
21587
  </details>
20808
21588
 
20809
- <details><summary><code>client.guardian.factors.pushNotification.<a href="/src/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.ts">updateSnsProvider</a>({ ...params }) -> Management.UpdateGuardianFactorsProviderPushNotificationSnsResponseContent</code></summary>
21589
+ <details><summary><code>client.guardian.factors.sms.<a href="/src/management/api/resources/guardian/resources/factors/resources/sms/client/Client.ts">setTwilioProvider</a>({ ...params }) -> Management.SetGuardianFactorsProviderSmsTwilioResponseContent</code></summary>
20810
21590
  <dl>
20811
21591
  <dd>
20812
21592
 
@@ -20818,7 +21598,9 @@ await client.guardian.factors.pushNotification.setSnsProvider();
20818
21598
  <dl>
20819
21599
  <dd>
20820
21600
 
20821
- Configure the [AWS SNS push notification provider configuration](https://auth0.com/docs/multifactor-authentication/developer/sns-configuration) (subscription required).
21601
+ This endpoint has been deprecated. To complete this action, use the <a href="https://auth0.com/docs/api/management/v2/guardian/put-twilio">Update Twilio phone configuration</a> endpoint.
21602
+
21603
+ <b>Previous functionality</b>: Update the Twilio SMS provider configuration.
20822
21604
 
20823
21605
  </dd>
20824
21606
  </dl>
@@ -20834,7 +21616,7 @@ Configure the [AWS SNS push notification provider configuration](https://auth0.c
20834
21616
  <dd>
20835
21617
 
20836
21618
  ```typescript
20837
- await client.guardian.factors.pushNotification.updateSnsProvider();
21619
+ await client.guardian.factors.sms.setTwilioProvider();
20838
21620
  ```
20839
21621
 
20840
21622
  </dd>
@@ -20850,7 +21632,7 @@ await client.guardian.factors.pushNotification.updateSnsProvider();
20850
21632
  <dl>
20851
21633
  <dd>
20852
21634
 
20853
- **request:** `Management.UpdateGuardianFactorsProviderPushNotificationSnsRequestContent`
21635
+ **request:** `Management.SetGuardianFactorsProviderSmsTwilioRequestContent`
20854
21636
 
20855
21637
  </dd>
20856
21638
  </dl>
@@ -20858,7 +21640,7 @@ await client.guardian.factors.pushNotification.updateSnsProvider();
20858
21640
  <dl>
20859
21641
  <dd>
20860
21642
 
20861
- **requestOptions:** `PushNotificationClient.RequestOptions`
21643
+ **requestOptions:** `SmsClient.RequestOptions`
20862
21644
 
20863
21645
  </dd>
20864
21646
  </dl>
@@ -20869,7 +21651,7 @@ await client.guardian.factors.pushNotification.updateSnsProvider();
20869
21651
  </dl>
20870
21652
  </details>
20871
21653
 
20872
- <details><summary><code>client.guardian.factors.pushNotification.<a href="/src/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.ts">getSelectedProvider</a>() -> Management.GetGuardianFactorsProviderPushNotificationResponseContent</code></summary>
21654
+ <details><summary><code>client.guardian.factors.sms.<a href="/src/management/api/resources/guardian/resources/factors/resources/sms/client/Client.ts">getSelectedProvider</a>() -> Management.GetGuardianFactorsProviderSmsResponseContent</code></summary>
20873
21655
  <dl>
20874
21656
  <dd>
20875
21657
 
@@ -20881,7 +21663,9 @@ await client.guardian.factors.pushNotification.updateSnsProvider();
20881
21663
  <dl>
20882
21664
  <dd>
20883
21665
 
20884
- Modify the push notification provider configured for your tenant. For more information, review <a href="https://auth0.com/docs/secure/multi-factor-authentication/multi-factor-authentication-factors/configure-push-notifications-for-mfa">Configure Push Notifications for MFA</a>.
21666
+ This endpoint has been deprecated. To complete this action, use the <a href="https://auth0.com/docs/api/management/v2/guardian/get-phone-providers">Retrieve phone configuration</a> endpoint instead.
21667
+
21668
+ <b>Previous functionality</b>: Retrieve details for the multi-factor authentication SMS provider configured for your tenant.
20885
21669
 
20886
21670
  </dd>
20887
21671
  </dl>
@@ -20897,7 +21681,7 @@ Modify the push notification provider configured for your tenant. For more infor
20897
21681
  <dd>
20898
21682
 
20899
21683
  ```typescript
20900
- await client.guardian.factors.pushNotification.getSelectedProvider();
21684
+ await client.guardian.factors.sms.getSelectedProvider();
20901
21685
  ```
20902
21686
 
20903
21687
  </dd>
@@ -20913,7 +21697,7 @@ await client.guardian.factors.pushNotification.getSelectedProvider();
20913
21697
  <dl>
20914
21698
  <dd>
20915
21699
 
20916
- **requestOptions:** `PushNotificationClient.RequestOptions`
21700
+ **requestOptions:** `SmsClient.RequestOptions`
20917
21701
 
20918
21702
  </dd>
20919
21703
  </dl>
@@ -20924,7 +21708,7 @@ await client.guardian.factors.pushNotification.getSelectedProvider();
20924
21708
  </dl>
20925
21709
  </details>
20926
21710
 
20927
- <details><summary><code>client.guardian.factors.pushNotification.<a href="/src/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.ts">setProvider</a>({ ...params }) -> Management.SetGuardianFactorsProviderPushNotificationResponseContent</code></summary>
21711
+ <details><summary><code>client.guardian.factors.sms.<a href="/src/management/api/resources/guardian/resources/factors/resources/sms/client/Client.ts">setProvider</a>({ ...params }) -> Management.SetGuardianFactorsProviderSmsResponseContent</code></summary>
20928
21712
  <dl>
20929
21713
  <dd>
20930
21714
 
@@ -20936,7 +21720,9 @@ await client.guardian.factors.pushNotification.getSelectedProvider();
20936
21720
  <dl>
20937
21721
  <dd>
20938
21722
 
20939
- Modify the push notification provider configured for your tenant. For more information, review <a href="https://auth0.com/docs/secure/multi-factor-authentication/multi-factor-authentication-factors/configure-push-notifications-for-mfa">Configure Push Notifications for MFA</a>.
21723
+ This endpoint has been deprecated. To complete this action, use the <a href="https://auth0.com/docs/api/management/v2/guardian/put-phone-providers">Update phone configuration</a> endpoint instead.
21724
+
21725
+ <b>Previous functionality</b>: Update the multi-factor authentication SMS provider configuration in your tenant.
20940
21726
 
20941
21727
  </dd>
20942
21728
  </dl>
@@ -20952,8 +21738,8 @@ Modify the push notification provider configured for your tenant. For more infor
20952
21738
  <dd>
20953
21739
 
20954
21740
  ```typescript
20955
- await client.guardian.factors.pushNotification.setProvider({
20956
- provider: "guardian",
21741
+ await client.guardian.factors.sms.setProvider({
21742
+ provider: "auth0",
20957
21743
  });
20958
21744
  ```
20959
21745
 
@@ -20970,7 +21756,7 @@ await client.guardian.factors.pushNotification.setProvider({
20970
21756
  <dl>
20971
21757
  <dd>
20972
21758
 
20973
- **request:** `Management.SetGuardianFactorsProviderPushNotificationRequestContent`
21759
+ **request:** `Management.SetGuardianFactorsProviderSmsRequestContent`
20974
21760
 
20975
21761
  </dd>
20976
21762
  </dl>
@@ -20978,7 +21764,7 @@ await client.guardian.factors.pushNotification.setProvider({
20978
21764
  <dl>
20979
21765
  <dd>
20980
21766
 
20981
- **requestOptions:** `PushNotificationClient.RequestOptions`
21767
+ **requestOptions:** `SmsClient.RequestOptions`
20982
21768
 
20983
21769
  </dd>
20984
21770
  </dl>
@@ -20989,9 +21775,7 @@ await client.guardian.factors.pushNotification.setProvider({
20989
21775
  </dl>
20990
21776
  </details>
20991
21777
 
20992
- ## Guardian Factors Sms
20993
-
20994
- <details><summary><code>client.guardian.factors.sms.<a href="/src/management/api/resources/guardian/resources/factors/resources/sms/client/Client.ts">getTwilioProvider</a>() -> Management.GetGuardianFactorsProviderSmsTwilioResponseContent</code></summary>
21778
+ <details><summary><code>client.guardian.factors.sms.<a href="/src/management/api/resources/guardian/resources/factors/resources/sms/client/Client.ts">getTemplates</a>() -> Management.GetGuardianFactorSmsTemplatesResponseContent | undefined</code></summary>
20995
21779
  <dl>
20996
21780
  <dd>
20997
21781
 
@@ -21003,9 +21787,9 @@ await client.guardian.factors.pushNotification.setProvider({
21003
21787
  <dl>
21004
21788
  <dd>
21005
21789
 
21006
- Retrieve the <a href="https://auth0.com/docs/multifactor-authentication/twilio-configuration">Twilio SMS provider configuration</a> (subscription required).
21790
+ This endpoint has been deprecated. To complete this action, use the <a href="https://auth0.com/docs/api/management/v2/guardian/get-factor-phone-templates">Retrieve enrollment and verification phone templates</a> endpoint instead.
21007
21791
 
21008
- A new endpoint is available to retrieve the Twilio configuration related to phone factors (<a href='https://auth0.com/docs/api/management/v2/#!/Guardian/get_twilio'>phone Twilio configuration</a>). It has the same payload as this one. Please use it instead.
21792
+ <b>Previous function</b>: Retrieve details of SMS enrollment and verification templates configured for your tenant.
21009
21793
 
21010
21794
  </dd>
21011
21795
  </dl>
@@ -21021,7 +21805,7 @@ Retrieve the <a href="https://auth0.com/docs/multifactor-authentication/twilio-c
21021
21805
  <dd>
21022
21806
 
21023
21807
  ```typescript
21024
- await client.guardian.factors.sms.getTwilioProvider();
21808
+ await client.guardian.factors.sms.getTemplates();
21025
21809
  ```
21026
21810
 
21027
21811
  </dd>
@@ -21048,7 +21832,7 @@ await client.guardian.factors.sms.getTwilioProvider();
21048
21832
  </dl>
21049
21833
  </details>
21050
21834
 
21051
- <details><summary><code>client.guardian.factors.sms.<a href="/src/management/api/resources/guardian/resources/factors/resources/sms/client/Client.ts">setTwilioProvider</a>({ ...params }) -> Management.SetGuardianFactorsProviderSmsTwilioResponseContent</code></summary>
21835
+ <details><summary><code>client.guardian.factors.sms.<a href="/src/management/api/resources/guardian/resources/factors/resources/sms/client/Client.ts">setTemplates</a>({ ...params }) -> Management.SetGuardianFactorSmsTemplatesResponseContent</code></summary>
21052
21836
  <dl>
21053
21837
  <dd>
21054
21838
 
@@ -21060,9 +21844,9 @@ await client.guardian.factors.sms.getTwilioProvider();
21060
21844
  <dl>
21061
21845
  <dd>
21062
21846
 
21063
- This endpoint has been deprecated. To complete this action, use the <a href="https://auth0.com/docs/api/management/v2/guardian/put-twilio">Update Twilio phone configuration</a> endpoint.
21847
+ This endpoint has been deprecated. To complete this action, use the <a href="https://auth0.com/docs/api/management/v2/guardian/put-factor-phone-templates">Update enrollment and verification phone templates</a> endpoint instead.
21064
21848
 
21065
- <b>Previous functionality</b>: Update the Twilio SMS provider configuration.
21849
+ <b>Previous functionality</b>: Customize the messages sent to complete SMS enrollment and verification.
21066
21850
 
21067
21851
  </dd>
21068
21852
  </dl>
@@ -21078,7 +21862,10 @@ This endpoint has been deprecated. To complete this action, use the <a href="htt
21078
21862
  <dd>
21079
21863
 
21080
21864
  ```typescript
21081
- await client.guardian.factors.sms.setTwilioProvider();
21865
+ await client.guardian.factors.sms.setTemplates({
21866
+ enrollment_message: "enrollment_message",
21867
+ verification_message: "verification_message",
21868
+ });
21082
21869
  ```
21083
21870
 
21084
21871
  </dd>
@@ -21094,7 +21881,7 @@ await client.guardian.factors.sms.setTwilioProvider();
21094
21881
  <dl>
21095
21882
  <dd>
21096
21883
 
21097
- **request:** `Management.SetGuardianFactorsProviderSmsTwilioRequestContent`
21884
+ **request:** `Management.SetGuardianFactorSmsTemplatesRequestContent`
21098
21885
 
21099
21886
  </dd>
21100
21887
  </dl>
@@ -21113,7 +21900,9 @@ await client.guardian.factors.sms.setTwilioProvider();
21113
21900
  </dl>
21114
21901
  </details>
21115
21902
 
21116
- <details><summary><code>client.guardian.factors.sms.<a href="/src/management/api/resources/guardian/resources/factors/resources/sms/client/Client.ts">getSelectedProvider</a>() -> Management.GetGuardianFactorsProviderSmsResponseContent</code></summary>
21903
+ ## Guardian Factors Duo Settings
21904
+
21905
+ <details><summary><code>client.guardian.factors.duo.settings.<a href="/src/management/api/resources/guardian/resources/factors/resources/duo/resources/settings/client/Client.ts">get</a>() -> Management.GetGuardianFactorDuoSettingsResponseContent</code></summary>
21117
21906
  <dl>
21118
21907
  <dd>
21119
21908
 
@@ -21125,9 +21914,7 @@ await client.guardian.factors.sms.setTwilioProvider();
21125
21914
  <dl>
21126
21915
  <dd>
21127
21916
 
21128
- This endpoint has been deprecated. To complete this action, use the <a href="https://auth0.com/docs/api/management/v2/guardian/get-phone-providers">Retrieve phone configuration</a> endpoint instead.
21129
-
21130
- <b>Previous functionality</b>: Retrieve details for the multi-factor authentication SMS provider configured for your tenant.
21917
+ Retrieves the DUO account and factor configuration.
21131
21918
 
21132
21919
  </dd>
21133
21920
  </dl>
@@ -21143,7 +21930,7 @@ This endpoint has been deprecated. To complete this action, use the <a href="htt
21143
21930
  <dd>
21144
21931
 
21145
21932
  ```typescript
21146
- await client.guardian.factors.sms.getSelectedProvider();
21933
+ await client.guardian.factors.duo.settings.get();
21147
21934
  ```
21148
21935
 
21149
21936
  </dd>
@@ -21159,7 +21946,7 @@ await client.guardian.factors.sms.getSelectedProvider();
21159
21946
  <dl>
21160
21947
  <dd>
21161
21948
 
21162
- **requestOptions:** `SmsClient.RequestOptions`
21949
+ **requestOptions:** `SettingsClient.RequestOptions`
21163
21950
 
21164
21951
  </dd>
21165
21952
  </dl>
@@ -21170,7 +21957,7 @@ await client.guardian.factors.sms.getSelectedProvider();
21170
21957
  </dl>
21171
21958
  </details>
21172
21959
 
21173
- <details><summary><code>client.guardian.factors.sms.<a href="/src/management/api/resources/guardian/resources/factors/resources/sms/client/Client.ts">setProvider</a>({ ...params }) -> Management.SetGuardianFactorsProviderSmsResponseContent</code></summary>
21960
+ <details><summary><code>client.guardian.factors.duo.settings.<a href="/src/management/api/resources/guardian/resources/factors/resources/duo/resources/settings/client/Client.ts">set</a>({ ...params }) -> Management.SetGuardianFactorDuoSettingsResponseContent</code></summary>
21174
21961
  <dl>
21175
21962
  <dd>
21176
21963
 
@@ -21182,15 +21969,61 @@ await client.guardian.factors.sms.getSelectedProvider();
21182
21969
  <dl>
21183
21970
  <dd>
21184
21971
 
21185
- This endpoint has been deprecated. To complete this action, use the <a href="https://auth0.com/docs/api/management/v2/guardian/put-phone-providers">Update phone configuration</a> endpoint instead.
21972
+ Set the DUO account configuration and other properties specific to this factor.
21186
21973
 
21187
- <b>Previous functionality</b>: Update the multi-factor authentication SMS provider configuration in your tenant.
21974
+ </dd>
21975
+ </dl>
21976
+ </dd>
21977
+ </dl>
21978
+
21979
+ #### 🔌 Usage
21980
+
21981
+ <dl>
21982
+ <dd>
21983
+
21984
+ <dl>
21985
+ <dd>
21986
+
21987
+ ```typescript
21988
+ await client.guardian.factors.duo.settings.set();
21989
+ ```
21990
+
21991
+ </dd>
21992
+ </dl>
21993
+ </dd>
21994
+ </dl>
21995
+
21996
+ #### ⚙️ Parameters
21997
+
21998
+ <dl>
21999
+ <dd>
22000
+
22001
+ <dl>
22002
+ <dd>
22003
+
22004
+ **request:** `Management.SetGuardianFactorDuoSettingsRequestContent`
22005
+
22006
+ </dd>
22007
+ </dl>
22008
+
22009
+ <dl>
22010
+ <dd>
22011
+
22012
+ **requestOptions:** `SettingsClient.RequestOptions`
21188
22013
 
21189
22014
  </dd>
21190
22015
  </dl>
21191
22016
  </dd>
21192
22017
  </dl>
21193
22018
 
22019
+ </dd>
22020
+ </dl>
22021
+ </details>
22022
+
22023
+ <details><summary><code>client.guardian.factors.duo.settings.<a href="/src/management/api/resources/guardian/resources/factors/resources/duo/resources/settings/client/Client.ts">update</a>({ ...params }) -> Management.UpdateGuardianFactorDuoSettingsResponseContent</code></summary>
22024
+ <dl>
22025
+ <dd>
22026
+
21194
22027
  #### 🔌 Usage
21195
22028
 
21196
22029
  <dl>
@@ -21200,9 +22033,7 @@ This endpoint has been deprecated. To complete this action, use the <a href="htt
21200
22033
  <dd>
21201
22034
 
21202
22035
  ```typescript
21203
- await client.guardian.factors.sms.setProvider({
21204
- provider: "auth0",
21205
- });
22036
+ await client.guardian.factors.duo.settings.update();
21206
22037
  ```
21207
22038
 
21208
22039
  </dd>
@@ -21218,7 +22049,7 @@ await client.guardian.factors.sms.setProvider({
21218
22049
  <dl>
21219
22050
  <dd>
21220
22051
 
21221
- **request:** `Management.SetGuardianFactorsProviderSmsRequestContent`
22052
+ **request:** `Management.UpdateGuardianFactorDuoSettingsRequestContent`
21222
22053
 
21223
22054
  </dd>
21224
22055
  </dl>
@@ -21226,7 +22057,7 @@ await client.guardian.factors.sms.setProvider({
21226
22057
  <dl>
21227
22058
  <dd>
21228
22059
 
21229
- **requestOptions:** `SmsClient.RequestOptions`
22060
+ **requestOptions:** `SettingsClient.RequestOptions`
21230
22061
 
21231
22062
  </dd>
21232
22063
  </dl>
@@ -21237,7 +22068,9 @@ await client.guardian.factors.sms.setProvider({
21237
22068
  </dl>
21238
22069
  </details>
21239
22070
 
21240
- <details><summary><code>client.guardian.factors.sms.<a href="/src/management/api/resources/guardian/resources/factors/resources/sms/client/Client.ts">getTemplates</a>() -> Management.GetGuardianFactorSmsTemplatesResponseContent | undefined</code></summary>
22071
+ ## Hooks Secrets
22072
+
22073
+ <details><summary><code>client.hooks.secrets.<a href="/src/management/api/resources/hooks/resources/secrets/client/Client.ts">get</a>(id) -> Management.GetHookSecretResponseContent</code></summary>
21241
22074
  <dl>
21242
22075
  <dd>
21243
22076
 
@@ -21249,9 +22082,7 @@ await client.guardian.factors.sms.setProvider({
21249
22082
  <dl>
21250
22083
  <dd>
21251
22084
 
21252
- This endpoint has been deprecated. To complete this action, use the <a href="https://auth0.com/docs/api/management/v2/guardian/get-factor-phone-templates">Retrieve enrollment and verification phone templates</a> endpoint instead.
21253
-
21254
- <b>Previous function</b>: Retrieve details of SMS enrollment and verification templates configured for your tenant.
22085
+ Retrieve a hook's secrets by the ID of the hook.
21255
22086
 
21256
22087
  </dd>
21257
22088
  </dl>
@@ -21267,7 +22098,7 @@ This endpoint has been deprecated. To complete this action, use the <a href="htt
21267
22098
  <dd>
21268
22099
 
21269
22100
  ```typescript
21270
- await client.guardian.factors.sms.getTemplates();
22101
+ await client.hooks.secrets.get("id");
21271
22102
  ```
21272
22103
 
21273
22104
  </dd>
@@ -21283,7 +22114,15 @@ await client.guardian.factors.sms.getTemplates();
21283
22114
  <dl>
21284
22115
  <dd>
21285
22116
 
21286
- **requestOptions:** `SmsClient.RequestOptions`
22117
+ **id:** `string` — ID of the hook to retrieve secrets from.
22118
+
22119
+ </dd>
22120
+ </dl>
22121
+
22122
+ <dl>
22123
+ <dd>
22124
+
22125
+ **requestOptions:** `SecretsClient.RequestOptions`
21287
22126
 
21288
22127
  </dd>
21289
22128
  </dl>
@@ -21294,7 +22133,7 @@ await client.guardian.factors.sms.getTemplates();
21294
22133
  </dl>
21295
22134
  </details>
21296
22135
 
21297
- <details><summary><code>client.guardian.factors.sms.<a href="/src/management/api/resources/guardian/resources/factors/resources/sms/client/Client.ts">setTemplates</a>({ ...params }) -> Management.SetGuardianFactorSmsTemplatesResponseContent</code></summary>
22136
+ <details><summary><code>client.hooks.secrets.<a href="/src/management/api/resources/hooks/resources/secrets/client/Client.ts">create</a>(id, { ...params }) -> void</code></summary>
21298
22137
  <dl>
21299
22138
  <dd>
21300
22139
 
@@ -21306,9 +22145,7 @@ await client.guardian.factors.sms.getTemplates();
21306
22145
  <dl>
21307
22146
  <dd>
21308
22147
 
21309
- This endpoint has been deprecated. To complete this action, use the <a href="https://auth0.com/docs/api/management/v2/guardian/put-factor-phone-templates">Update enrollment and verification phone templates</a> endpoint instead.
21310
-
21311
- <b>Previous functionality</b>: Customize the messages sent to complete SMS enrollment and verification.
22148
+ Add one or more secrets to an existing hook. Accepts an object of key-value pairs, where the key is the name of the secret. A hook can have a maximum of 20 secrets.
21312
22149
 
21313
22150
  </dd>
21314
22151
  </dl>
@@ -21322,11 +22159,10 @@ This endpoint has been deprecated. To complete this action, use the <a href="htt
21322
22159
 
21323
22160
  <dl>
21324
22161
  <dd>
21325
-
21326
- ```typescript
21327
- await client.guardian.factors.sms.setTemplates({
21328
- enrollment_message: "enrollment_message",
21329
- verification_message: "verification_message",
22162
+
22163
+ ```typescript
22164
+ await client.hooks.secrets.create("id", {
22165
+ key: "value",
21330
22166
  });
21331
22167
  ```
21332
22168
 
@@ -21343,7 +22179,7 @@ await client.guardian.factors.sms.setTemplates({
21343
22179
  <dl>
21344
22180
  <dd>
21345
22181
 
21346
- **request:** `Management.SetGuardianFactorSmsTemplatesRequestContent`
22182
+ **id:** `string` — The id of the hook to retrieve
21347
22183
 
21348
22184
  </dd>
21349
22185
  </dl>
@@ -21351,7 +22187,15 @@ await client.guardian.factors.sms.setTemplates({
21351
22187
  <dl>
21352
22188
  <dd>
21353
22189
 
21354
- **requestOptions:** `SmsClient.RequestOptions`
22190
+ **request:** `Management.CreateHookSecretRequestContent`
22191
+
22192
+ </dd>
22193
+ </dl>
22194
+
22195
+ <dl>
22196
+ <dd>
22197
+
22198
+ **requestOptions:** `SecretsClient.RequestOptions`
21355
22199
 
21356
22200
  </dd>
21357
22201
  </dl>
@@ -21362,9 +22206,7 @@ await client.guardian.factors.sms.setTemplates({
21362
22206
  </dl>
21363
22207
  </details>
21364
22208
 
21365
- ## Guardian Factors Duo Settings
21366
-
21367
- <details><summary><code>client.guardian.factors.duo.settings.<a href="/src/management/api/resources/guardian/resources/factors/resources/duo/resources/settings/client/Client.ts">get</a>() -> Management.GetGuardianFactorDuoSettingsResponseContent</code></summary>
22209
+ <details><summary><code>client.hooks.secrets.<a href="/src/management/api/resources/hooks/resources/secrets/client/Client.ts">delete</a>(id, { ...params }) -> void</code></summary>
21368
22210
  <dl>
21369
22211
  <dd>
21370
22212
 
@@ -21376,7 +22218,7 @@ await client.guardian.factors.sms.setTemplates({
21376
22218
  <dl>
21377
22219
  <dd>
21378
22220
 
21379
- Retrieves the DUO account and factor configuration.
22221
+ Delete one or more existing secrets for a given hook. Accepts an array of secret names to delete.
21380
22222
 
21381
22223
  </dd>
21382
22224
  </dl>
@@ -21392,7 +22234,7 @@ Retrieves the DUO account and factor configuration.
21392
22234
  <dd>
21393
22235
 
21394
22236
  ```typescript
21395
- await client.guardian.factors.duo.settings.get();
22237
+ await client.hooks.secrets.delete("id", ["string"]);
21396
22238
  ```
21397
22239
 
21398
22240
  </dd>
@@ -21408,7 +22250,23 @@ await client.guardian.factors.duo.settings.get();
21408
22250
  <dl>
21409
22251
  <dd>
21410
22252
 
21411
- **requestOptions:** `SettingsClient.RequestOptions`
22253
+ **id:** `string` — ID of the hook whose secrets to delete.
22254
+
22255
+ </dd>
22256
+ </dl>
22257
+
22258
+ <dl>
22259
+ <dd>
22260
+
22261
+ **request:** `Management.DeleteHookSecretRequestContent`
22262
+
22263
+ </dd>
22264
+ </dl>
22265
+
22266
+ <dl>
22267
+ <dd>
22268
+
22269
+ **requestOptions:** `SecretsClient.RequestOptions`
21412
22270
 
21413
22271
  </dd>
21414
22272
  </dl>
@@ -21419,7 +22277,7 @@ await client.guardian.factors.duo.settings.get();
21419
22277
  </dl>
21420
22278
  </details>
21421
22279
 
21422
- <details><summary><code>client.guardian.factors.duo.settings.<a href="/src/management/api/resources/guardian/resources/factors/resources/duo/resources/settings/client/Client.ts">set</a>({ ...params }) -> Management.SetGuardianFactorDuoSettingsResponseContent</code></summary>
22280
+ <details><summary><code>client.hooks.secrets.<a href="/src/management/api/resources/hooks/resources/secrets/client/Client.ts">update</a>(id, { ...params }) -> void</code></summary>
21423
22281
  <dl>
21424
22282
  <dd>
21425
22283
 
@@ -21431,7 +22289,7 @@ await client.guardian.factors.duo.settings.get();
21431
22289
  <dl>
21432
22290
  <dd>
21433
22291
 
21434
- Set the DUO account configuration and other properties specific to this factor.
22292
+ Update one or more existing secrets for an existing hook. Accepts an object of key-value pairs, where the key is the name of the existing secret.
21435
22293
 
21436
22294
  </dd>
21437
22295
  </dl>
@@ -21447,7 +22305,9 @@ Set the DUO account configuration and other properties specific to this factor.
21447
22305
  <dd>
21448
22306
 
21449
22307
  ```typescript
21450
- await client.guardian.factors.duo.settings.set();
22308
+ await client.hooks.secrets.update("id", {
22309
+ key: "value",
22310
+ });
21451
22311
  ```
21452
22312
 
21453
22313
  </dd>
@@ -21463,7 +22323,7 @@ await client.guardian.factors.duo.settings.set();
21463
22323
  <dl>
21464
22324
  <dd>
21465
22325
 
21466
- **request:** `Management.SetGuardianFactorDuoSettingsRequestContent`
22326
+ **id:** `string` — ID of the hook whose secrets to update.
21467
22327
 
21468
22328
  </dd>
21469
22329
  </dl>
@@ -21471,7 +22331,15 @@ await client.guardian.factors.duo.settings.set();
21471
22331
  <dl>
21472
22332
  <dd>
21473
22333
 
21474
- **requestOptions:** `SettingsClient.RequestOptions`
22334
+ **request:** `Management.UpdateHookSecretRequestContent`
22335
+
22336
+ </dd>
22337
+ </dl>
22338
+
22339
+ <dl>
22340
+ <dd>
22341
+
22342
+ **requestOptions:** `SecretsClient.RequestOptions`
21475
22343
 
21476
22344
  </dd>
21477
22345
  </dl>
@@ -21482,10 +22350,27 @@ await client.guardian.factors.duo.settings.set();
21482
22350
  </dl>
21483
22351
  </details>
21484
22352
 
21485
- <details><summary><code>client.guardian.factors.duo.settings.<a href="/src/management/api/resources/guardian/resources/factors/resources/duo/resources/settings/client/Client.ts">update</a>({ ...params }) -> Management.UpdateGuardianFactorDuoSettingsResponseContent</code></summary>
22353
+ ## Jobs UsersExports
22354
+
22355
+ <details><summary><code>client.jobs.usersExports.<a href="/src/management/api/resources/jobs/resources/usersExports/client/Client.ts">create</a>({ ...params }) -> Management.CreateExportUsersResponseContent</code></summary>
22356
+ <dl>
22357
+ <dd>
22358
+
22359
+ #### 📝 Description
22360
+
22361
+ <dl>
22362
+ <dd>
22363
+
21486
22364
  <dl>
21487
22365
  <dd>
21488
22366
 
22367
+ Export all users to a file via a long-running job.
22368
+
22369
+ </dd>
22370
+ </dl>
22371
+ </dd>
22372
+ </dl>
22373
+
21489
22374
  #### 🔌 Usage
21490
22375
 
21491
22376
  <dl>
@@ -21495,7 +22380,7 @@ await client.guardian.factors.duo.settings.set();
21495
22380
  <dd>
21496
22381
 
21497
22382
  ```typescript
21498
- await client.guardian.factors.duo.settings.update();
22383
+ await client.jobs.usersExports.create();
21499
22384
  ```
21500
22385
 
21501
22386
  </dd>
@@ -21511,7 +22396,7 @@ await client.guardian.factors.duo.settings.update();
21511
22396
  <dl>
21512
22397
  <dd>
21513
22398
 
21514
- **request:** `Management.UpdateGuardianFactorDuoSettingsRequestContent`
22399
+ **request:** `Management.CreateExportUsersRequestContent`
21515
22400
 
21516
22401
  </dd>
21517
22402
  </dl>
@@ -21519,7 +22404,7 @@ await client.guardian.factors.duo.settings.update();
21519
22404
  <dl>
21520
22405
  <dd>
21521
22406
 
21522
- **requestOptions:** `SettingsClient.RequestOptions`
22407
+ **requestOptions:** `UsersExportsClient.RequestOptions`
21523
22408
 
21524
22409
  </dd>
21525
22410
  </dl>
@@ -21530,9 +22415,9 @@ await client.guardian.factors.duo.settings.update();
21530
22415
  </dl>
21531
22416
  </details>
21532
22417
 
21533
- ## Hooks Secrets
22418
+ ## Jobs UsersImports
21534
22419
 
21535
- <details><summary><code>client.hooks.secrets.<a href="/src/management/api/resources/hooks/resources/secrets/client/Client.ts">get</a>(id) -> Management.GetHookSecretResponseContent</code></summary>
22420
+ <details><summary><code>client.jobs.usersImports.<a href="/src/management/api/resources/jobs/resources/usersImports/client/Client.ts">create</a>({ ...params }) -> Management.CreateImportUsersResponseContent</code></summary>
21536
22421
  <dl>
21537
22422
  <dd>
21538
22423
 
@@ -21544,7 +22429,7 @@ await client.guardian.factors.duo.settings.update();
21544
22429
  <dl>
21545
22430
  <dd>
21546
22431
 
21547
- Retrieve a hook's secrets by the ID of the hook.
22432
+ Import users from a <a href="https://auth0.com/docs/users/references/bulk-import-database-schema-examples">formatted file</a> into a connection via a long-running job. When importing users, with or without upsert, the `email_verified` is set to `false` when the email address is added or updated. Users must verify their email address. To avoid this behavior, set `email_verified` to `true` in the imported data.
21548
22433
 
21549
22434
  </dd>
21550
22435
  </dl>
@@ -21560,7 +22445,10 @@ Retrieve a hook's secrets by the ID of the hook.
21560
22445
  <dd>
21561
22446
 
21562
22447
  ```typescript
21563
- await client.hooks.secrets.get("id");
22448
+ await client.jobs.usersImports.create({
22449
+ users: fs.createReadStream("/path/to/your/file"),
22450
+ connection_id: "connection_id",
22451
+ });
21564
22452
  ```
21565
22453
 
21566
22454
  </dd>
@@ -21576,7 +22464,7 @@ await client.hooks.secrets.get("id");
21576
22464
  <dl>
21577
22465
  <dd>
21578
22466
 
21579
- **id:** `string` — ID of the hook to retrieve secrets from.
22467
+ **request:** `Management.CreateImportUsersRequestContent`
21580
22468
 
21581
22469
  </dd>
21582
22470
  </dl>
@@ -21584,7 +22472,7 @@ await client.hooks.secrets.get("id");
21584
22472
  <dl>
21585
22473
  <dd>
21586
22474
 
21587
- **requestOptions:** `SecretsClient.RequestOptions`
22475
+ **requestOptions:** `UsersImportsClient.RequestOptions`
21588
22476
 
21589
22477
  </dd>
21590
22478
  </dl>
@@ -21595,7 +22483,9 @@ await client.hooks.secrets.get("id");
21595
22483
  </dl>
21596
22484
  </details>
21597
22485
 
21598
- <details><summary><code>client.hooks.secrets.<a href="/src/management/api/resources/hooks/resources/secrets/client/Client.ts">create</a>(id, { ...params }) -> void</code></summary>
22486
+ ## Jobs VerificationEmail
22487
+
22488
+ <details><summary><code>client.jobs.verificationEmail.<a href="/src/management/api/resources/jobs/resources/verificationEmail/client/Client.ts">create</a>({ ...params }) -> Management.CreateVerificationEmailResponseContent</code></summary>
21599
22489
  <dl>
21600
22490
  <dd>
21601
22491
 
@@ -21607,7 +22497,9 @@ await client.hooks.secrets.get("id");
21607
22497
  <dl>
21608
22498
  <dd>
21609
22499
 
21610
- Add one or more secrets to an existing hook. Accepts an object of key-value pairs, where the key is the name of the secret. A hook can have a maximum of 20 secrets.
22500
+ Send an email to the specified user that asks them to click a link to [verify their email address](https://auth0.com/docs/email/custom#verification-email).
22501
+
22502
+ Note: You must have the `Status` toggle enabled for the verification email template for the email to be sent.
21611
22503
 
21612
22504
  </dd>
21613
22505
  </dl>
@@ -21623,8 +22515,8 @@ Add one or more secrets to an existing hook. Accepts an object of key-value pair
21623
22515
  <dd>
21624
22516
 
21625
22517
  ```typescript
21626
- await client.hooks.secrets.create("id", {
21627
- key: "value",
22518
+ await client.jobs.verificationEmail.create({
22519
+ user_id: "user_id",
21628
22520
  });
21629
22521
  ```
21630
22522
 
@@ -21641,15 +22533,7 @@ await client.hooks.secrets.create("id", {
21641
22533
  <dl>
21642
22534
  <dd>
21643
22535
 
21644
- **id:** `string` — The id of the hook to retrieve
21645
-
21646
- </dd>
21647
- </dl>
21648
-
21649
- <dl>
21650
- <dd>
21651
-
21652
- **request:** `Management.CreateHookSecretRequestContent`
22536
+ **request:** `Management.CreateVerificationEmailRequestContent`
21653
22537
 
21654
22538
  </dd>
21655
22539
  </dl>
@@ -21657,7 +22541,7 @@ await client.hooks.secrets.create("id", {
21657
22541
  <dl>
21658
22542
  <dd>
21659
22543
 
21660
- **requestOptions:** `SecretsClient.RequestOptions`
22544
+ **requestOptions:** `VerificationEmailClient.RequestOptions`
21661
22545
 
21662
22546
  </dd>
21663
22547
  </dl>
@@ -21668,7 +22552,9 @@ await client.hooks.secrets.create("id", {
21668
22552
  </dl>
21669
22553
  </details>
21670
22554
 
21671
- <details><summary><code>client.hooks.secrets.<a href="/src/management/api/resources/hooks/resources/secrets/client/Client.ts">delete</a>(id, { ...params }) -> void</code></summary>
22555
+ ## Jobs Errors
22556
+
22557
+ <details><summary><code>client.jobs.errors.<a href="/src/management/api/resources/jobs/resources/errors/client/Client.ts">get</a>(id) -> Management.ErrorsGetResponse | undefined</code></summary>
21672
22558
  <dl>
21673
22559
  <dd>
21674
22560
 
@@ -21680,7 +22566,7 @@ await client.hooks.secrets.create("id", {
21680
22566
  <dl>
21681
22567
  <dd>
21682
22568
 
21683
- Delete one or more existing secrets for a given hook. Accepts an array of secret names to delete.
22569
+ Retrieve error details of a failed job.
21684
22570
 
21685
22571
  </dd>
21686
22572
  </dl>
@@ -21696,7 +22582,7 @@ Delete one or more existing secrets for a given hook. Accepts an array of secret
21696
22582
  <dd>
21697
22583
 
21698
22584
  ```typescript
21699
- await client.hooks.secrets.delete("id", ["string"]);
22585
+ await client.jobs.errors.get("id");
21700
22586
  ```
21701
22587
 
21702
22588
  </dd>
@@ -21712,15 +22598,7 @@ await client.hooks.secrets.delete("id", ["string"]);
21712
22598
  <dl>
21713
22599
  <dd>
21714
22600
 
21715
- **id:** `string` — ID of the hook whose secrets to delete.
21716
-
21717
- </dd>
21718
- </dl>
21719
-
21720
- <dl>
21721
- <dd>
21722
-
21723
- **request:** `Management.DeleteHookSecretRequestContent`
22601
+ **id:** `string` — ID of the job.
21724
22602
 
21725
22603
  </dd>
21726
22604
  </dl>
@@ -21728,7 +22606,7 @@ await client.hooks.secrets.delete("id", ["string"]);
21728
22606
  <dl>
21729
22607
  <dd>
21730
22608
 
21731
- **requestOptions:** `SecretsClient.RequestOptions`
22609
+ **requestOptions:** `ErrorsClient.RequestOptions`
21732
22610
 
21733
22611
  </dd>
21734
22612
  </dl>
@@ -21739,7 +22617,9 @@ await client.hooks.secrets.delete("id", ["string"]);
21739
22617
  </dl>
21740
22618
  </details>
21741
22619
 
21742
- <details><summary><code>client.hooks.secrets.<a href="/src/management/api/resources/hooks/resources/secrets/client/Client.ts">update</a>(id, { ...params }) -> void</code></summary>
22620
+ ## Keys CustomSigning
22621
+
22622
+ <details><summary><code>client.keys.customSigning.<a href="/src/management/api/resources/keys/resources/customSigning/client/Client.ts">get</a>() -> Management.GetCustomSigningKeysResponseContent</code></summary>
21743
22623
  <dl>
21744
22624
  <dd>
21745
22625
 
@@ -21751,7 +22631,7 @@ await client.hooks.secrets.delete("id", ["string"]);
21751
22631
  <dl>
21752
22632
  <dd>
21753
22633
 
21754
- Update one or more existing secrets for an existing hook. Accepts an object of key-value pairs, where the key is the name of the existing secret.
22634
+ Get entire jwks representation of custom signing keys.
21755
22635
 
21756
22636
  </dd>
21757
22637
  </dl>
@@ -21767,9 +22647,7 @@ Update one or more existing secrets for an existing hook. Accepts an object of k
21767
22647
  <dd>
21768
22648
 
21769
22649
  ```typescript
21770
- await client.hooks.secrets.update("id", {
21771
- key: "value",
21772
- });
22650
+ await client.keys.customSigning.get();
21773
22651
  ```
21774
22652
 
21775
22653
  </dd>
@@ -21785,23 +22663,7 @@ await client.hooks.secrets.update("id", {
21785
22663
  <dl>
21786
22664
  <dd>
21787
22665
 
21788
- **id:** `string` — ID of the hook whose secrets to update.
21789
-
21790
- </dd>
21791
- </dl>
21792
-
21793
- <dl>
21794
- <dd>
21795
-
21796
- **request:** `Management.UpdateHookSecretRequestContent`
21797
-
21798
- </dd>
21799
- </dl>
21800
-
21801
- <dl>
21802
- <dd>
21803
-
21804
- **requestOptions:** `SecretsClient.RequestOptions`
22666
+ **requestOptions:** `CustomSigningClient.RequestOptions`
21805
22667
 
21806
22668
  </dd>
21807
22669
  </dl>
@@ -21812,9 +22674,7 @@ await client.hooks.secrets.update("id", {
21812
22674
  </dl>
21813
22675
  </details>
21814
22676
 
21815
- ## Jobs UsersExports
21816
-
21817
- <details><summary><code>client.jobs.usersExports.<a href="/src/management/api/resources/jobs/resources/usersExports/client/Client.ts">create</a>({ ...params }) -> Management.CreateExportUsersResponseContent</code></summary>
22677
+ <details><summary><code>client.keys.customSigning.<a href="/src/management/api/resources/keys/resources/customSigning/client/Client.ts">set</a>({ ...params }) -> Management.SetCustomSigningKeysResponseContent</code></summary>
21818
22678
  <dl>
21819
22679
  <dd>
21820
22680
 
@@ -21826,7 +22686,7 @@ await client.hooks.secrets.update("id", {
21826
22686
  <dl>
21827
22687
  <dd>
21828
22688
 
21829
- Export all users to a file via a long-running job.
22689
+ Create or replace entire jwks representation of custom signing keys.
21830
22690
 
21831
22691
  </dd>
21832
22692
  </dl>
@@ -21842,7 +22702,13 @@ Export all users to a file via a long-running job.
21842
22702
  <dd>
21843
22703
 
21844
22704
  ```typescript
21845
- await client.jobs.usersExports.create();
22705
+ await client.keys.customSigning.set({
22706
+ keys: [
22707
+ {
22708
+ kty: "EC",
22709
+ },
22710
+ ],
22711
+ });
21846
22712
  ```
21847
22713
 
21848
22714
  </dd>
@@ -21858,7 +22724,7 @@ await client.jobs.usersExports.create();
21858
22724
  <dl>
21859
22725
  <dd>
21860
22726
 
21861
- **request:** `Management.CreateExportUsersRequestContent`
22727
+ **request:** `Management.SetCustomSigningKeysRequestContent`
21862
22728
 
21863
22729
  </dd>
21864
22730
  </dl>
@@ -21866,7 +22732,7 @@ await client.jobs.usersExports.create();
21866
22732
  <dl>
21867
22733
  <dd>
21868
22734
 
21869
- **requestOptions:** `UsersExportsClient.RequestOptions`
22735
+ **requestOptions:** `CustomSigningClient.RequestOptions`
21870
22736
 
21871
22737
  </dd>
21872
22738
  </dl>
@@ -21877,9 +22743,7 @@ await client.jobs.usersExports.create();
21877
22743
  </dl>
21878
22744
  </details>
21879
22745
 
21880
- ## Jobs UsersImports
21881
-
21882
- <details><summary><code>client.jobs.usersImports.<a href="/src/management/api/resources/jobs/resources/usersImports/client/Client.ts">create</a>({ ...params }) -> Management.CreateImportUsersResponseContent</code></summary>
22746
+ <details><summary><code>client.keys.customSigning.<a href="/src/management/api/resources/keys/resources/customSigning/client/Client.ts">delete</a>() -> void</code></summary>
21883
22747
  <dl>
21884
22748
  <dd>
21885
22749
 
@@ -21891,7 +22755,7 @@ await client.jobs.usersExports.create();
21891
22755
  <dl>
21892
22756
  <dd>
21893
22757
 
21894
- Import users from a <a href="https://auth0.com/docs/users/references/bulk-import-database-schema-examples">formatted file</a> into a connection via a long-running job. When importing users, with or without upsert, the `email_verified` is set to `false` when the email address is added or updated. Users must verify their email address. To avoid this behavior, set `email_verified` to `true` in the imported data.
22758
+ Delete entire jwks representation of custom signing keys.
21895
22759
 
21896
22760
  </dd>
21897
22761
  </dl>
@@ -21907,10 +22771,7 @@ Import users from a <a href="https://auth0.com/docs/users/references/bulk-import
21907
22771
  <dd>
21908
22772
 
21909
22773
  ```typescript
21910
- await client.jobs.usersImports.create({
21911
- users: fs.createReadStream("/path/to/your/file"),
21912
- connection_id: "connection_id",
21913
- });
22774
+ await client.keys.customSigning.delete();
21914
22775
  ```
21915
22776
 
21916
22777
  </dd>
@@ -21926,15 +22787,7 @@ await client.jobs.usersImports.create({
21926
22787
  <dl>
21927
22788
  <dd>
21928
22789
 
21929
- **request:** `Management.CreateImportUsersRequestContent`
21930
-
21931
- </dd>
21932
- </dl>
21933
-
21934
- <dl>
21935
- <dd>
21936
-
21937
- **requestOptions:** `UsersImportsClient.RequestOptions`
22790
+ **requestOptions:** `CustomSigningClient.RequestOptions`
21938
22791
 
21939
22792
  </dd>
21940
22793
  </dl>
@@ -21945,9 +22798,9 @@ await client.jobs.usersImports.create({
21945
22798
  </dl>
21946
22799
  </details>
21947
22800
 
21948
- ## Jobs VerificationEmail
22801
+ ## Keys Encryption
21949
22802
 
21950
- <details><summary><code>client.jobs.verificationEmail.<a href="/src/management/api/resources/jobs/resources/verificationEmail/client/Client.ts">create</a>({ ...params }) -> Management.CreateVerificationEmailResponseContent</code></summary>
22803
+ <details><summary><code>client.keys.encryption.<a href="/src/management/api/resources/keys/resources/encryption/client/Client.ts">list</a>({ ...params }) -> core.Page&lt;Management.EncryptionKey, Management.ListEncryptionKeyOffsetPaginatedResponseContent&gt;</code></summary>
21951
22804
  <dl>
21952
22805
  <dd>
21953
22806
 
@@ -21959,9 +22812,7 @@ await client.jobs.usersImports.create({
21959
22812
  <dl>
21960
22813
  <dd>
21961
22814
 
21962
- Send an email to the specified user that asks them to click a link to [verify their email address](https://auth0.com/docs/email/custom#verification-email).
21963
-
21964
- Note: You must have the `Status` toggle enabled for the verification email template for the email to be sent.
22815
+ Retrieve details of all the encryption keys associated with your tenant.
21965
22816
 
21966
22817
  </dd>
21967
22818
  </dl>
@@ -21977,9 +22828,27 @@ Note: You must have the `Status` toggle enabled for the verification email templ
21977
22828
  <dd>
21978
22829
 
21979
22830
  ```typescript
21980
- await client.jobs.verificationEmail.create({
21981
- user_id: "user_id",
22831
+ const pageableResponse = await client.keys.encryption.list({
22832
+ page: 1,
22833
+ per_page: 1,
22834
+ include_totals: true,
22835
+ });
22836
+ for await (const item of pageableResponse) {
22837
+ console.log(item);
22838
+ }
22839
+
22840
+ // Or you can manually iterate page-by-page
22841
+ let page = await client.keys.encryption.list({
22842
+ page: 1,
22843
+ per_page: 1,
22844
+ include_totals: true,
21982
22845
  });
22846
+ while (page.hasNextPage()) {
22847
+ page = page.getNextPage();
22848
+ }
22849
+
22850
+ // You can also access the underlying response
22851
+ const response = page.response;
21983
22852
  ```
21984
22853
 
21985
22854
  </dd>
@@ -21995,7 +22864,7 @@ await client.jobs.verificationEmail.create({
21995
22864
  <dl>
21996
22865
  <dd>
21997
22866
 
21998
- **request:** `Management.CreateVerificationEmailRequestContent`
22867
+ **request:** `Management.ListEncryptionKeysRequestParameters`
21999
22868
 
22000
22869
  </dd>
22001
22870
  </dl>
@@ -22003,7 +22872,7 @@ await client.jobs.verificationEmail.create({
22003
22872
  <dl>
22004
22873
  <dd>
22005
22874
 
22006
- **requestOptions:** `VerificationEmailClient.RequestOptions`
22875
+ **requestOptions:** `EncryptionClient.RequestOptions`
22007
22876
 
22008
22877
  </dd>
22009
22878
  </dl>
@@ -22014,9 +22883,7 @@ await client.jobs.verificationEmail.create({
22014
22883
  </dl>
22015
22884
  </details>
22016
22885
 
22017
- ## Jobs Errors
22018
-
22019
- <details><summary><code>client.jobs.errors.<a href="/src/management/api/resources/jobs/resources/errors/client/Client.ts">get</a>(id) -> Management.ErrorsGetResponse | undefined</code></summary>
22886
+ <details><summary><code>client.keys.encryption.<a href="/src/management/api/resources/keys/resources/encryption/client/Client.ts">create</a>({ ...params }) -> Management.CreateEncryptionKeyResponseContent</code></summary>
22020
22887
  <dl>
22021
22888
  <dd>
22022
22889
 
@@ -22028,7 +22895,7 @@ await client.jobs.verificationEmail.create({
22028
22895
  <dl>
22029
22896
  <dd>
22030
22897
 
22031
- Retrieve error details of a failed job.
22898
+ Create the new, pre-activated encryption key, without the key material.
22032
22899
 
22033
22900
  </dd>
22034
22901
  </dl>
@@ -22044,7 +22911,9 @@ Retrieve error details of a failed job.
22044
22911
  <dd>
22045
22912
 
22046
22913
  ```typescript
22047
- await client.jobs.errors.get("id");
22914
+ await client.keys.encryption.create({
22915
+ type: "customer-provided-root-key",
22916
+ });
22048
22917
  ```
22049
22918
 
22050
22919
  </dd>
@@ -22060,7 +22929,7 @@ await client.jobs.errors.get("id");
22060
22929
  <dl>
22061
22930
  <dd>
22062
22931
 
22063
- **id:** `string` — ID of the job.
22932
+ **request:** `Management.CreateEncryptionKeyRequestContent`
22064
22933
 
22065
22934
  </dd>
22066
22935
  </dl>
@@ -22068,7 +22937,7 @@ await client.jobs.errors.get("id");
22068
22937
  <dl>
22069
22938
  <dd>
22070
22939
 
22071
- **requestOptions:** `ErrorsClient.RequestOptions`
22940
+ **requestOptions:** `EncryptionClient.RequestOptions`
22072
22941
 
22073
22942
  </dd>
22074
22943
  </dl>
@@ -22079,9 +22948,7 @@ await client.jobs.errors.get("id");
22079
22948
  </dl>
22080
22949
  </details>
22081
22950
 
22082
- ## Keys CustomSigning
22083
-
22084
- <details><summary><code>client.keys.customSigning.<a href="/src/management/api/resources/keys/resources/customSigning/client/Client.ts">get</a>() -> Management.GetCustomSigningKeysResponseContent</code></summary>
22951
+ <details><summary><code>client.keys.encryption.<a href="/src/management/api/resources/keys/resources/encryption/client/Client.ts">rekey</a>() -> void</code></summary>
22085
22952
  <dl>
22086
22953
  <dd>
22087
22954
 
@@ -22093,7 +22960,7 @@ await client.jobs.errors.get("id");
22093
22960
  <dl>
22094
22961
  <dd>
22095
22962
 
22096
- Get entire jwks representation of custom signing keys.
22963
+ Perform rekeying operation on the key hierarchy.
22097
22964
 
22098
22965
  </dd>
22099
22966
  </dl>
@@ -22109,7 +22976,7 @@ Get entire jwks representation of custom signing keys.
22109
22976
  <dd>
22110
22977
 
22111
22978
  ```typescript
22112
- await client.keys.customSigning.get();
22979
+ await client.keys.encryption.rekey();
22113
22980
  ```
22114
22981
 
22115
22982
  </dd>
@@ -22125,7 +22992,7 @@ await client.keys.customSigning.get();
22125
22992
  <dl>
22126
22993
  <dd>
22127
22994
 
22128
- **requestOptions:** `CustomSigningClient.RequestOptions`
22995
+ **requestOptions:** `EncryptionClient.RequestOptions`
22129
22996
 
22130
22997
  </dd>
22131
22998
  </dl>
@@ -22136,7 +23003,7 @@ await client.keys.customSigning.get();
22136
23003
  </dl>
22137
23004
  </details>
22138
23005
 
22139
- <details><summary><code>client.keys.customSigning.<a href="/src/management/api/resources/keys/resources/customSigning/client/Client.ts">set</a>({ ...params }) -> Management.SetCustomSigningKeysResponseContent</code></summary>
23006
+ <details><summary><code>client.keys.encryption.<a href="/src/management/api/resources/keys/resources/encryption/client/Client.ts">get</a>(kid) -> Management.GetEncryptionKeyResponseContent</code></summary>
22140
23007
  <dl>
22141
23008
  <dd>
22142
23009
 
@@ -22148,7 +23015,7 @@ await client.keys.customSigning.get();
22148
23015
  <dl>
22149
23016
  <dd>
22150
23017
 
22151
- Create or replace entire jwks representation of custom signing keys.
23018
+ Retrieve details of the encryption key with the given ID.
22152
23019
 
22153
23020
  </dd>
22154
23021
  </dl>
@@ -22164,13 +23031,7 @@ Create or replace entire jwks representation of custom signing keys.
22164
23031
  <dd>
22165
23032
 
22166
23033
  ```typescript
22167
- await client.keys.customSigning.set({
22168
- keys: [
22169
- {
22170
- kty: "EC",
22171
- },
22172
- ],
22173
- });
23034
+ await client.keys.encryption.get("kid");
22174
23035
  ```
22175
23036
 
22176
23037
  </dd>
@@ -22186,7 +23047,7 @@ await client.keys.customSigning.set({
22186
23047
  <dl>
22187
23048
  <dd>
22188
23049
 
22189
- **request:** `Management.SetCustomSigningKeysRequestContent`
23050
+ **kid:** `string` — Encryption key ID
22190
23051
 
22191
23052
  </dd>
22192
23053
  </dl>
@@ -22194,7 +23055,7 @@ await client.keys.customSigning.set({
22194
23055
  <dl>
22195
23056
  <dd>
22196
23057
 
22197
- **requestOptions:** `CustomSigningClient.RequestOptions`
23058
+ **requestOptions:** `EncryptionClient.RequestOptions`
22198
23059
 
22199
23060
  </dd>
22200
23061
  </dl>
@@ -22205,7 +23066,7 @@ await client.keys.customSigning.set({
22205
23066
  </dl>
22206
23067
  </details>
22207
23068
 
22208
- <details><summary><code>client.keys.customSigning.<a href="/src/management/api/resources/keys/resources/customSigning/client/Client.ts">delete</a>() -> void</code></summary>
23069
+ <details><summary><code>client.keys.encryption.<a href="/src/management/api/resources/keys/resources/encryption/client/Client.ts">import</a>(kid, { ...params }) -> Management.ImportEncryptionKeyResponseContent</code></summary>
22209
23070
  <dl>
22210
23071
  <dd>
22211
23072
 
@@ -22217,7 +23078,7 @@ await client.keys.customSigning.set({
22217
23078
  <dl>
22218
23079
  <dd>
22219
23080
 
22220
- Delete entire jwks representation of custom signing keys.
23081
+ Import wrapped key material and activate encryption key.
22221
23082
 
22222
23083
  </dd>
22223
23084
  </dl>
@@ -22233,7 +23094,9 @@ Delete entire jwks representation of custom signing keys.
22233
23094
  <dd>
22234
23095
 
22235
23096
  ```typescript
22236
- await client.keys.customSigning.delete();
23097
+ await client.keys.encryption.import("kid", {
23098
+ wrapped_key: "wrapped_key",
23099
+ });
22237
23100
  ```
22238
23101
 
22239
23102
  </dd>
@@ -22249,7 +23112,23 @@ await client.keys.customSigning.delete();
22249
23112
  <dl>
22250
23113
  <dd>
22251
23114
 
22252
- **requestOptions:** `CustomSigningClient.RequestOptions`
23115
+ **kid:** `string` — Encryption key ID
23116
+
23117
+ </dd>
23118
+ </dl>
23119
+
23120
+ <dl>
23121
+ <dd>
23122
+
23123
+ **request:** `Management.ImportEncryptionKeyRequestContent`
23124
+
23125
+ </dd>
23126
+ </dl>
23127
+
23128
+ <dl>
23129
+ <dd>
23130
+
23131
+ **requestOptions:** `EncryptionClient.RequestOptions`
22253
23132
 
22254
23133
  </dd>
22255
23134
  </dl>
@@ -22260,9 +23139,7 @@ await client.keys.customSigning.delete();
22260
23139
  </dl>
22261
23140
  </details>
22262
23141
 
22263
- ## Keys Encryption
22264
-
22265
- <details><summary><code>client.keys.encryption.<a href="/src/management/api/resources/keys/resources/encryption/client/Client.ts">list</a>({ ...params }) -> core.Page&lt;Management.EncryptionKey, Management.ListEncryptionKeyOffsetPaginatedResponseContent&gt;</code></summary>
23142
+ <details><summary><code>client.keys.encryption.<a href="/src/management/api/resources/keys/resources/encryption/client/Client.ts">delete</a>(kid) -> void</code></summary>
22266
23143
  <dl>
22267
23144
  <dd>
22268
23145
 
@@ -22274,7 +23151,7 @@ await client.keys.customSigning.delete();
22274
23151
  <dl>
22275
23152
  <dd>
22276
23153
 
22277
- Retrieve details of all the encryption keys associated with your tenant.
23154
+ Delete the custom provided encryption key with the given ID and move back to using native encryption key.
22278
23155
 
22279
23156
  </dd>
22280
23157
  </dl>
@@ -22290,27 +23167,7 @@ Retrieve details of all the encryption keys associated with your tenant.
22290
23167
  <dd>
22291
23168
 
22292
23169
  ```typescript
22293
- const pageableResponse = await client.keys.encryption.list({
22294
- page: 1,
22295
- per_page: 1,
22296
- include_totals: true,
22297
- });
22298
- for await (const item of pageableResponse) {
22299
- console.log(item);
22300
- }
22301
-
22302
- // Or you can manually iterate page-by-page
22303
- let page = await client.keys.encryption.list({
22304
- page: 1,
22305
- per_page: 1,
22306
- include_totals: true,
22307
- });
22308
- while (page.hasNextPage()) {
22309
- page = page.getNextPage();
22310
- }
22311
-
22312
- // You can also access the underlying response
22313
- const response = page.response;
23170
+ await client.keys.encryption.delete("kid");
22314
23171
  ```
22315
23172
 
22316
23173
  </dd>
@@ -22326,7 +23183,7 @@ const response = page.response;
22326
23183
  <dl>
22327
23184
  <dd>
22328
23185
 
22329
- **request:** `Management.ListEncryptionKeysRequestParameters`
23186
+ **kid:** `string` — Encryption key ID
22330
23187
 
22331
23188
  </dd>
22332
23189
  </dl>
@@ -22345,7 +23202,7 @@ const response = page.response;
22345
23202
  </dl>
22346
23203
  </details>
22347
23204
 
22348
- <details><summary><code>client.keys.encryption.<a href="/src/management/api/resources/keys/resources/encryption/client/Client.ts">create</a>({ ...params }) -> Management.CreateEncryptionKeyResponseContent</code></summary>
23205
+ <details><summary><code>client.keys.encryption.<a href="/src/management/api/resources/keys/resources/encryption/client/Client.ts">createPublicWrappingKey</a>(kid) -> Management.CreateEncryptionKeyPublicWrappingResponseContent</code></summary>
22349
23206
  <dl>
22350
23207
  <dd>
22351
23208
 
@@ -22357,7 +23214,7 @@ const response = page.response;
22357
23214
  <dl>
22358
23215
  <dd>
22359
23216
 
22360
- Create the new, pre-activated encryption key, without the key material.
23217
+ Create the public wrapping key to wrap your own encryption key material.
22361
23218
 
22362
23219
  </dd>
22363
23220
  </dl>
@@ -22373,9 +23230,7 @@ Create the new, pre-activated encryption key, without the key material.
22373
23230
  <dd>
22374
23231
 
22375
23232
  ```typescript
22376
- await client.keys.encryption.create({
22377
- type: "customer-provided-root-key",
22378
- });
23233
+ await client.keys.encryption.createPublicWrappingKey("kid");
22379
23234
  ```
22380
23235
 
22381
23236
  </dd>
@@ -22391,7 +23246,7 @@ await client.keys.encryption.create({
22391
23246
  <dl>
22392
23247
  <dd>
22393
23248
 
22394
- **request:** `Management.CreateEncryptionKeyRequestContent`
23249
+ **kid:** `string` — Encryption key ID
22395
23250
 
22396
23251
  </dd>
22397
23252
  </dl>
@@ -22410,7 +23265,9 @@ await client.keys.encryption.create({
22410
23265
  </dl>
22411
23266
  </details>
22412
23267
 
22413
- <details><summary><code>client.keys.encryption.<a href="/src/management/api/resources/keys/resources/encryption/client/Client.ts">rekey</a>() -> void</code></summary>
23268
+ ## Keys Signing
23269
+
23270
+ <details><summary><code>client.keys.signing.<a href="/src/management/api/resources/keys/resources/signing/client/Client.ts">list</a>() -> Management.SigningKeys[]</code></summary>
22414
23271
  <dl>
22415
23272
  <dd>
22416
23273
 
@@ -22422,7 +23279,7 @@ await client.keys.encryption.create({
22422
23279
  <dl>
22423
23280
  <dd>
22424
23281
 
22425
- Perform rekeying operation on the key hierarchy.
23282
+ Retrieve details of all the application signing keys associated with your tenant.
22426
23283
 
22427
23284
  </dd>
22428
23285
  </dl>
@@ -22438,7 +23295,7 @@ Perform rekeying operation on the key hierarchy.
22438
23295
  <dd>
22439
23296
 
22440
23297
  ```typescript
22441
- await client.keys.encryption.rekey();
23298
+ await client.keys.signing.list();
22442
23299
  ```
22443
23300
 
22444
23301
  </dd>
@@ -22454,7 +23311,7 @@ await client.keys.encryption.rekey();
22454
23311
  <dl>
22455
23312
  <dd>
22456
23313
 
22457
- **requestOptions:** `EncryptionClient.RequestOptions`
23314
+ **requestOptions:** `SigningClient.RequestOptions`
22458
23315
 
22459
23316
  </dd>
22460
23317
  </dl>
@@ -22465,7 +23322,7 @@ await client.keys.encryption.rekey();
22465
23322
  </dl>
22466
23323
  </details>
22467
23324
 
22468
- <details><summary><code>client.keys.encryption.<a href="/src/management/api/resources/keys/resources/encryption/client/Client.ts">get</a>(kid) -> Management.GetEncryptionKeyResponseContent</code></summary>
23325
+ <details><summary><code>client.keys.signing.<a href="/src/management/api/resources/keys/resources/signing/client/Client.ts">rotate</a>() -> Management.RotateSigningKeysResponseContent</code></summary>
22469
23326
  <dl>
22470
23327
  <dd>
22471
23328
 
@@ -22477,7 +23334,7 @@ await client.keys.encryption.rekey();
22477
23334
  <dl>
22478
23335
  <dd>
22479
23336
 
22480
- Retrieve details of the encryption key with the given ID.
23337
+ Rotate the application signing key of your tenant.
22481
23338
 
22482
23339
  </dd>
22483
23340
  </dl>
@@ -22493,7 +23350,7 @@ Retrieve details of the encryption key with the given ID.
22493
23350
  <dd>
22494
23351
 
22495
23352
  ```typescript
22496
- await client.keys.encryption.get("kid");
23353
+ await client.keys.signing.rotate();
22497
23354
  ```
22498
23355
 
22499
23356
  </dd>
@@ -22509,15 +23366,7 @@ await client.keys.encryption.get("kid");
22509
23366
  <dl>
22510
23367
  <dd>
22511
23368
 
22512
- **kid:** `string` — Encryption key ID
22513
-
22514
- </dd>
22515
- </dl>
22516
-
22517
- <dl>
22518
- <dd>
22519
-
22520
- **requestOptions:** `EncryptionClient.RequestOptions`
23369
+ **requestOptions:** `SigningClient.RequestOptions`
22521
23370
 
22522
23371
  </dd>
22523
23372
  </dl>
@@ -22528,7 +23377,7 @@ await client.keys.encryption.get("kid");
22528
23377
  </dl>
22529
23378
  </details>
22530
23379
 
22531
- <details><summary><code>client.keys.encryption.<a href="/src/management/api/resources/keys/resources/encryption/client/Client.ts">import</a>(kid, { ...params }) -> Management.ImportEncryptionKeyResponseContent</code></summary>
23380
+ <details><summary><code>client.keys.signing.<a href="/src/management/api/resources/keys/resources/signing/client/Client.ts">get</a>(kid) -> Management.GetSigningKeysResponseContent</code></summary>
22532
23381
  <dl>
22533
23382
  <dd>
22534
23383
 
@@ -22540,7 +23389,7 @@ await client.keys.encryption.get("kid");
22540
23389
  <dl>
22541
23390
  <dd>
22542
23391
 
22543
- Import wrapped key material and activate encryption key.
23392
+ Retrieve details of the application signing key with the given ID.
22544
23393
 
22545
23394
  </dd>
22546
23395
  </dl>
@@ -22556,9 +23405,7 @@ Import wrapped key material and activate encryption key.
22556
23405
  <dd>
22557
23406
 
22558
23407
  ```typescript
22559
- await client.keys.encryption.import("kid", {
22560
- wrapped_key: "wrapped_key",
22561
- });
23408
+ await client.keys.signing.get("kid");
22562
23409
  ```
22563
23410
 
22564
23411
  </dd>
@@ -22574,15 +23421,7 @@ await client.keys.encryption.import("kid", {
22574
23421
  <dl>
22575
23422
  <dd>
22576
23423
 
22577
- **kid:** `string` — Encryption key ID
22578
-
22579
- </dd>
22580
- </dl>
22581
-
22582
- <dl>
22583
- <dd>
22584
-
22585
- **request:** `Management.ImportEncryptionKeyRequestContent`
23424
+ **kid:** `string` — Key id of the key to retrieve
22586
23425
 
22587
23426
  </dd>
22588
23427
  </dl>
@@ -22590,7 +23429,7 @@ await client.keys.encryption.import("kid", {
22590
23429
  <dl>
22591
23430
  <dd>
22592
23431
 
22593
- **requestOptions:** `EncryptionClient.RequestOptions`
23432
+ **requestOptions:** `SigningClient.RequestOptions`
22594
23433
 
22595
23434
  </dd>
22596
23435
  </dl>
@@ -22601,7 +23440,7 @@ await client.keys.encryption.import("kid", {
22601
23440
  </dl>
22602
23441
  </details>
22603
23442
 
22604
- <details><summary><code>client.keys.encryption.<a href="/src/management/api/resources/keys/resources/encryption/client/Client.ts">delete</a>(kid) -> void</code></summary>
23443
+ <details><summary><code>client.keys.signing.<a href="/src/management/api/resources/keys/resources/signing/client/Client.ts">revoke</a>(kid) -> Management.RevokedSigningKeysResponseContent</code></summary>
22605
23444
  <dl>
22606
23445
  <dd>
22607
23446
 
@@ -22613,7 +23452,7 @@ await client.keys.encryption.import("kid", {
22613
23452
  <dl>
22614
23453
  <dd>
22615
23454
 
22616
- Delete the custom provided encryption key with the given ID and move back to using native encryption key.
23455
+ Revoke the application signing key with the given ID.
22617
23456
 
22618
23457
  </dd>
22619
23458
  </dl>
@@ -22629,7 +23468,7 @@ Delete the custom provided encryption key with the given ID and move back to usi
22629
23468
  <dd>
22630
23469
 
22631
23470
  ```typescript
22632
- await client.keys.encryption.delete("kid");
23471
+ await client.keys.signing.revoke("kid");
22633
23472
  ```
22634
23473
 
22635
23474
  </dd>
@@ -22645,7 +23484,7 @@ await client.keys.encryption.delete("kid");
22645
23484
  <dl>
22646
23485
  <dd>
22647
23486
 
22648
- **kid:** `string` — Encryption key ID
23487
+ **kid:** `string` — Key id of the key to revoke
22649
23488
 
22650
23489
  </dd>
22651
23490
  </dl>
@@ -22653,7 +23492,7 @@ await client.keys.encryption.delete("kid");
22653
23492
  <dl>
22654
23493
  <dd>
22655
23494
 
22656
- **requestOptions:** `EncryptionClient.RequestOptions`
23495
+ **requestOptions:** `SigningClient.RequestOptions`
22657
23496
 
22658
23497
  </dd>
22659
23498
  </dl>
@@ -22664,11 +23503,13 @@ await client.keys.encryption.delete("kid");
22664
23503
  </dl>
22665
23504
  </details>
22666
23505
 
22667
- <details><summary><code>client.keys.encryption.<a href="/src/management/api/resources/keys/resources/encryption/client/Client.ts">createPublicWrappingKey</a>(kid) -> Management.CreateEncryptionKeyPublicWrappingResponseContent</code></summary>
23506
+ ## Organizations ClientGrants
23507
+
23508
+ <details><summary><code>client.organizations.clientGrants.<a href="/src/management/api/resources/organizations/resources/clientGrants/client/Client.ts">list</a>(id, { ...params }) -> core.Page&lt;Management.OrganizationClientGrant, Management.ListOrganizationClientGrantsOffsetPaginatedResponseContent&gt;</code></summary>
22668
23509
  <dl>
22669
23510
  <dd>
22670
23511
 
22671
- #### 📝 Description
23512
+ #### 🔌 Usage
22672
23513
 
22673
23514
  <dl>
22674
23515
  <dd>
@@ -22676,14 +23517,42 @@ await client.keys.encryption.delete("kid");
22676
23517
  <dl>
22677
23518
  <dd>
22678
23519
 
22679
- Create the public wrapping key to wrap your own encryption key material.
23520
+ ```typescript
23521
+ const pageableResponse = await client.organizations.clientGrants.list("id", {
23522
+ audience: "audience",
23523
+ client_id: "client_id",
23524
+ grant_ids: ["grant_ids"],
23525
+ page: 1,
23526
+ per_page: 1,
23527
+ include_totals: true,
23528
+ });
23529
+ for await (const item of pageableResponse) {
23530
+ console.log(item);
23531
+ }
23532
+
23533
+ // Or you can manually iterate page-by-page
23534
+ let page = await client.organizations.clientGrants.list("id", {
23535
+ audience: "audience",
23536
+ client_id: "client_id",
23537
+ grant_ids: ["grant_ids"],
23538
+ page: 1,
23539
+ per_page: 1,
23540
+ include_totals: true,
23541
+ });
23542
+ while (page.hasNextPage()) {
23543
+ page = page.getNextPage();
23544
+ }
23545
+
23546
+ // You can also access the underlying response
23547
+ const response = page.response;
23548
+ ```
22680
23549
 
22681
23550
  </dd>
22682
23551
  </dl>
22683
23552
  </dd>
22684
23553
  </dl>
22685
23554
 
22686
- #### 🔌 Usage
23555
+ #### ⚙️ Parameters
22687
23556
 
22688
23557
  <dl>
22689
23558
  <dd>
@@ -22691,24 +23560,15 @@ Create the public wrapping key to wrap your own encryption key material.
22691
23560
  <dl>
22692
23561
  <dd>
22693
23562
 
22694
- ```typescript
22695
- await client.keys.encryption.createPublicWrappingKey("kid");
22696
- ```
23563
+ **id:** `string` — Organization identifier.
22697
23564
 
22698
23565
  </dd>
22699
23566
  </dl>
22700
- </dd>
22701
- </dl>
22702
-
22703
- #### ⚙️ Parameters
22704
-
22705
- <dl>
22706
- <dd>
22707
23567
 
22708
23568
  <dl>
22709
23569
  <dd>
22710
23570
 
22711
- **kid:** `string` — Encryption key ID
23571
+ **request:** `Management.ListOrganizationClientGrantsRequestParameters`
22712
23572
 
22713
23573
  </dd>
22714
23574
  </dl>
@@ -22716,7 +23576,7 @@ await client.keys.encryption.createPublicWrappingKey("kid");
22716
23576
  <dl>
22717
23577
  <dd>
22718
23578
 
22719
- **requestOptions:** `EncryptionClient.RequestOptions`
23579
+ **requestOptions:** `ClientGrantsClient.RequestOptions`
22720
23580
 
22721
23581
  </dd>
22722
23582
  </dl>
@@ -22727,13 +23587,11 @@ await client.keys.encryption.createPublicWrappingKey("kid");
22727
23587
  </dl>
22728
23588
  </details>
22729
23589
 
22730
- ## Keys Signing
22731
-
22732
- <details><summary><code>client.keys.signing.<a href="/src/management/api/resources/keys/resources/signing/client/Client.ts">list</a>() -> Management.SigningKeys[]</code></summary>
23590
+ <details><summary><code>client.organizations.clientGrants.<a href="/src/management/api/resources/organizations/resources/clientGrants/client/Client.ts">create</a>(id, { ...params }) -> Management.AssociateOrganizationClientGrantResponseContent</code></summary>
22733
23591
  <dl>
22734
23592
  <dd>
22735
23593
 
22736
- #### 📝 Description
23594
+ #### 🔌 Usage
22737
23595
 
22738
23596
  <dl>
22739
23597
  <dd>
@@ -22741,14 +23599,18 @@ await client.keys.encryption.createPublicWrappingKey("kid");
22741
23599
  <dl>
22742
23600
  <dd>
22743
23601
 
22744
- Retrieve details of all the application signing keys associated with your tenant.
23602
+ ```typescript
23603
+ await client.organizations.clientGrants.create("id", {
23604
+ grant_id: "grant_id",
23605
+ });
23606
+ ```
22745
23607
 
22746
23608
  </dd>
22747
23609
  </dl>
22748
23610
  </dd>
22749
23611
  </dl>
22750
23612
 
22751
- #### 🔌 Usage
23613
+ #### ⚙️ Parameters
22752
23614
 
22753
23615
  <dl>
22754
23616
  <dd>
@@ -22756,24 +23618,23 @@ Retrieve details of all the application signing keys associated with your tenant
22756
23618
  <dl>
22757
23619
  <dd>
22758
23620
 
22759
- ```typescript
22760
- await client.keys.signing.list();
22761
- ```
23621
+ **id:** `string` — Organization identifier.
22762
23622
 
22763
23623
  </dd>
22764
23624
  </dl>
22765
- </dd>
22766
- </dl>
22767
-
22768
- #### ⚙️ Parameters
22769
23625
 
22770
23626
  <dl>
22771
23627
  <dd>
22772
23628
 
23629
+ **request:** `Management.AssociateOrganizationClientGrantRequestContent`
23630
+
23631
+ </dd>
23632
+ </dl>
23633
+
22773
23634
  <dl>
22774
23635
  <dd>
22775
23636
 
22776
- **requestOptions:** `SigningClient.RequestOptions`
23637
+ **requestOptions:** `ClientGrantsClient.RequestOptions`
22777
23638
 
22778
23639
  </dd>
22779
23640
  </dl>
@@ -22784,11 +23645,11 @@ await client.keys.signing.list();
22784
23645
  </dl>
22785
23646
  </details>
22786
23647
 
22787
- <details><summary><code>client.keys.signing.<a href="/src/management/api/resources/keys/resources/signing/client/Client.ts">rotate</a>() -> Management.RotateSigningKeysResponseContent</code></summary>
23648
+ <details><summary><code>client.organizations.clientGrants.<a href="/src/management/api/resources/organizations/resources/clientGrants/client/Client.ts">delete</a>(id, grant_id) -> void</code></summary>
22788
23649
  <dl>
22789
23650
  <dd>
22790
23651
 
22791
- #### 📝 Description
23652
+ #### 🔌 Usage
22792
23653
 
22793
23654
  <dl>
22794
23655
  <dd>
@@ -22796,14 +23657,16 @@ await client.keys.signing.list();
22796
23657
  <dl>
22797
23658
  <dd>
22798
23659
 
22799
- Rotate the application signing key of your tenant.
23660
+ ```typescript
23661
+ await client.organizations.clientGrants.delete("id", "grant_id");
23662
+ ```
22800
23663
 
22801
23664
  </dd>
22802
23665
  </dl>
22803
23666
  </dd>
22804
23667
  </dl>
22805
23668
 
22806
- #### 🔌 Usage
23669
+ #### ⚙️ Parameters
22807
23670
 
22808
23671
  <dl>
22809
23672
  <dd>
@@ -22811,24 +23674,23 @@ Rotate the application signing key of your tenant.
22811
23674
  <dl>
22812
23675
  <dd>
22813
23676
 
22814
- ```typescript
22815
- await client.keys.signing.rotate();
22816
- ```
23677
+ **id:** `string` — Organization identifier.
22817
23678
 
22818
23679
  </dd>
22819
23680
  </dl>
22820
- </dd>
22821
- </dl>
22822
-
22823
- #### ⚙️ Parameters
22824
23681
 
22825
23682
  <dl>
22826
23683
  <dd>
22827
23684
 
23685
+ **grant_id:** `string` — The Client Grant ID to remove from the organization
23686
+
23687
+ </dd>
23688
+ </dl>
23689
+
22828
23690
  <dl>
22829
23691
  <dd>
22830
23692
 
22831
- **requestOptions:** `SigningClient.RequestOptions`
23693
+ **requestOptions:** `ClientGrantsClient.RequestOptions`
22832
23694
 
22833
23695
  </dd>
22834
23696
  </dl>
@@ -22839,7 +23701,9 @@ await client.keys.signing.rotate();
22839
23701
  </dl>
22840
23702
  </details>
22841
23703
 
22842
- <details><summary><code>client.keys.signing.<a href="/src/management/api/resources/keys/resources/signing/client/Client.ts">get</a>(kid) -> Management.GetSigningKeysResponseContent</code></summary>
23704
+ ## Organizations Clients
23705
+
23706
+ <details><summary><code>client.organizations.clients.<a href="/src/management/api/resources/organizations/resources/clients/client/Client.ts">list</a>(id, { ...params }) -> core.Page&lt;Management.OrganizationClient, Management.ListOrganizationClientsResponseContent&gt;</code></summary>
22843
23707
  <dl>
22844
23708
  <dd>
22845
23709
 
@@ -22851,8 +23715,13 @@ await client.keys.signing.rotate();
22851
23715
  <dl>
22852
23716
  <dd>
22853
23717
 
22854
- Retrieve details of the application signing key with the given ID.
23718
+ List all clients associated with an organization, using checkpoint pagination.
22855
23719
 
23720
+ <ul>
23721
+ <li>
23722
+ <b>Note</b>: The first time you call this endpoint, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no further results are remaining.
23723
+ </li>
23724
+ </ul>
22856
23725
  </dd>
22857
23726
  </dl>
22858
23727
  </dd>
@@ -22867,7 +23736,25 @@ Retrieve details of the application signing key with the given ID.
22867
23736
  <dd>
22868
23737
 
22869
23738
  ```typescript
22870
- await client.keys.signing.get("kid");
23739
+ const pageableResponse = await client.organizations.clients.list("id", {
23740
+ from: "from",
23741
+ take: 1,
23742
+ });
23743
+ for await (const item of pageableResponse) {
23744
+ console.log(item);
23745
+ }
23746
+
23747
+ // Or you can manually iterate page-by-page
23748
+ let page = await client.organizations.clients.list("id", {
23749
+ from: "from",
23750
+ take: 1,
23751
+ });
23752
+ while (page.hasNextPage()) {
23753
+ page = page.getNextPage();
23754
+ }
23755
+
23756
+ // You can also access the underlying response
23757
+ const response = page.response;
22871
23758
  ```
22872
23759
 
22873
23760
  </dd>
@@ -22883,7 +23770,7 @@ await client.keys.signing.get("kid");
22883
23770
  <dl>
22884
23771
  <dd>
22885
23772
 
22886
- **kid:** `string` — Key id of the key to retrieve
23773
+ **id:** `string` — ID of the organization.
22887
23774
 
22888
23775
  </dd>
22889
23776
  </dl>
@@ -22891,7 +23778,15 @@ await client.keys.signing.get("kid");
22891
23778
  <dl>
22892
23779
  <dd>
22893
23780
 
22894
- **requestOptions:** `SigningClient.RequestOptions`
23781
+ **request:** `Management.ListOrganizationClientsRequestParameters`
23782
+
23783
+ </dd>
23784
+ </dl>
23785
+
23786
+ <dl>
23787
+ <dd>
23788
+
23789
+ **requestOptions:** `ClientsClient.RequestOptions`
22895
23790
 
22896
23791
  </dd>
22897
23792
  </dl>
@@ -22902,7 +23797,7 @@ await client.keys.signing.get("kid");
22902
23797
  </dl>
22903
23798
  </details>
22904
23799
 
22905
- <details><summary><code>client.keys.signing.<a href="/src/management/api/resources/keys/resources/signing/client/Client.ts">revoke</a>(kid) -> Management.RevokedSigningKeysResponseContent</code></summary>
23800
+ <details><summary><code>client.organizations.clients.<a href="/src/management/api/resources/organizations/resources/clients/client/Client.ts">create</a>(id, { ...params }) -> Management.CreateOrganizationClientsResponseContent</code></summary>
22906
23801
  <dl>
22907
23802
  <dd>
22908
23803
 
@@ -22914,7 +23809,7 @@ await client.keys.signing.get("kid");
22914
23809
  <dl>
22915
23810
  <dd>
22916
23811
 
22917
- Revoke the application signing key with the given ID.
23812
+ Associate one or more clients with an organization.
22918
23813
 
22919
23814
  </dd>
22920
23815
  </dl>
@@ -22930,7 +23825,14 @@ Revoke the application signing key with the given ID.
22930
23825
  <dd>
22931
23826
 
22932
23827
  ```typescript
22933
- await client.keys.signing.revoke("kid");
23828
+ await client.organizations.clients.create("id", {
23829
+ clients: [
23830
+ {
23831
+ client_id: "client_id",
23832
+ use_for_member_access: true,
23833
+ },
23834
+ ],
23835
+ });
22934
23836
  ```
22935
23837
 
22936
23838
  </dd>
@@ -22946,7 +23848,7 @@ await client.keys.signing.revoke("kid");
22946
23848
  <dl>
22947
23849
  <dd>
22948
23850
 
22949
- **kid:** `string` — Key id of the key to revoke
23851
+ **id:** `string` — ID of the organization.
22950
23852
 
22951
23853
  </dd>
22952
23854
  </dl>
@@ -22954,7 +23856,15 @@ await client.keys.signing.revoke("kid");
22954
23856
  <dl>
22955
23857
  <dd>
22956
23858
 
22957
- **requestOptions:** `SigningClient.RequestOptions`
23859
+ **request:** `Management.CreateOrganizationClientsRequestContent`
23860
+
23861
+ </dd>
23862
+ </dl>
23863
+
23864
+ <dl>
23865
+ <dd>
23866
+
23867
+ **requestOptions:** `ClientsClient.RequestOptions`
22958
23868
 
22959
23869
  </dd>
22960
23870
  </dl>
@@ -22965,12 +23875,25 @@ await client.keys.signing.revoke("kid");
22965
23875
  </dl>
22966
23876
  </details>
22967
23877
 
22968
- ## Organizations ClientGrants
23878
+ <details><summary><code>client.organizations.clients.<a href="/src/management/api/resources/organizations/resources/clients/client/Client.ts">delete</a>(id, { ...params }) -> void</code></summary>
23879
+ <dl>
23880
+ <dd>
23881
+
23882
+ #### 📝 Description
22969
23883
 
22970
- <details><summary><code>client.organizations.clientGrants.<a href="/src/management/api/resources/organizations/resources/clientGrants/client/Client.ts">list</a>(id, { ...params }) -> core.Page&lt;Management.OrganizationClientGrant, Management.ListOrganizationClientGrantsOffsetPaginatedResponseContent&gt;</code></summary>
22971
23884
  <dl>
22972
23885
  <dd>
22973
23886
 
23887
+ <dl>
23888
+ <dd>
23889
+
23890
+ Remove one or more client associations from an organization.
23891
+
23892
+ </dd>
23893
+ </dl>
23894
+ </dd>
23895
+ </dl>
23896
+
22974
23897
  #### 🔌 Usage
22975
23898
 
22976
23899
  <dl>
@@ -22980,33 +23903,9 @@ await client.keys.signing.revoke("kid");
22980
23903
  <dd>
22981
23904
 
22982
23905
  ```typescript
22983
- const pageableResponse = await client.organizations.clientGrants.list("id", {
22984
- audience: "audience",
22985
- client_id: "client_id",
22986
- grant_ids: ["grant_ids"],
22987
- page: 1,
22988
- per_page: 1,
22989
- include_totals: true,
22990
- });
22991
- for await (const item of pageableResponse) {
22992
- console.log(item);
22993
- }
22994
-
22995
- // Or you can manually iterate page-by-page
22996
- let page = await client.organizations.clientGrants.list("id", {
22997
- audience: "audience",
22998
- client_id: "client_id",
22999
- grant_ids: ["grant_ids"],
23000
- page: 1,
23001
- per_page: 1,
23002
- include_totals: true,
23906
+ await client.organizations.clients.delete("id", {
23907
+ clients: ["clients"],
23003
23908
  });
23004
- while (page.hasNextPage()) {
23005
- page = page.getNextPage();
23006
- }
23007
-
23008
- // You can also access the underlying response
23009
- const response = page.response;
23010
23909
  ```
23011
23910
 
23012
23911
  </dd>
@@ -23022,7 +23921,7 @@ const response = page.response;
23022
23921
  <dl>
23023
23922
  <dd>
23024
23923
 
23025
- **id:** `string` — Organization identifier.
23924
+ **id:** `string` — ID of the organization.
23026
23925
 
23027
23926
  </dd>
23028
23927
  </dl>
@@ -23030,7 +23929,7 @@ const response = page.response;
23030
23929
  <dl>
23031
23930
  <dd>
23032
23931
 
23033
- **request:** `Management.ListOrganizationClientGrantsRequestParameters`
23932
+ **request:** `Management.DeleteOrganizationClientsRequestContent`
23034
23933
 
23035
23934
  </dd>
23036
23935
  </dl>
@@ -23038,7 +23937,7 @@ const response = page.response;
23038
23937
  <dl>
23039
23938
  <dd>
23040
23939
 
23041
- **requestOptions:** `ClientGrantsClient.RequestOptions`
23940
+ **requestOptions:** `ClientsClient.RequestOptions`
23042
23941
 
23043
23942
  </dd>
23044
23943
  </dl>
@@ -23049,10 +23948,25 @@ const response = page.response;
23049
23948
  </dl>
23050
23949
  </details>
23051
23950
 
23052
- <details><summary><code>client.organizations.clientGrants.<a href="/src/management/api/resources/organizations/resources/clientGrants/client/Client.ts">create</a>(id, { ...params }) -> Management.AssociateOrganizationClientGrantResponseContent</code></summary>
23951
+ <details><summary><code>client.organizations.clients.<a href="/src/management/api/resources/organizations/resources/clients/client/Client.ts">get</a>(id, client_id) -> Management.GetOrganizationClientResponseContent</code></summary>
23952
+ <dl>
23953
+ <dd>
23954
+
23955
+ #### 📝 Description
23956
+
23957
+ <dl>
23958
+ <dd>
23959
+
23053
23960
  <dl>
23054
23961
  <dd>
23055
23962
 
23963
+ Get a specific client association for an organization.
23964
+
23965
+ </dd>
23966
+ </dl>
23967
+ </dd>
23968
+ </dl>
23969
+
23056
23970
  #### 🔌 Usage
23057
23971
 
23058
23972
  <dl>
@@ -23062,9 +23976,7 @@ const response = page.response;
23062
23976
  <dd>
23063
23977
 
23064
23978
  ```typescript
23065
- await client.organizations.clientGrants.create("id", {
23066
- grant_id: "grant_id",
23067
- });
23979
+ await client.organizations.clients.get("id", "client_id");
23068
23980
  ```
23069
23981
 
23070
23982
  </dd>
@@ -23080,7 +23992,7 @@ await client.organizations.clientGrants.create("id", {
23080
23992
  <dl>
23081
23993
  <dd>
23082
23994
 
23083
- **id:** `string` — Organization identifier.
23995
+ **id:** `string` — ID of the organization.
23084
23996
 
23085
23997
  </dd>
23086
23998
  </dl>
@@ -23088,7 +24000,7 @@ await client.organizations.clientGrants.create("id", {
23088
24000
  <dl>
23089
24001
  <dd>
23090
24002
 
23091
- **request:** `Management.AssociateOrganizationClientGrantRequestContent`
24003
+ **client_id:** `string` — ID of the client association to retrieve.
23092
24004
 
23093
24005
  </dd>
23094
24006
  </dl>
@@ -23096,7 +24008,7 @@ await client.organizations.clientGrants.create("id", {
23096
24008
  <dl>
23097
24009
  <dd>
23098
24010
 
23099
- **requestOptions:** `ClientGrantsClient.RequestOptions`
24011
+ **requestOptions:** `ClientsClient.RequestOptions`
23100
24012
 
23101
24013
  </dd>
23102
24014
  </dl>
@@ -23107,10 +24019,25 @@ await client.organizations.clientGrants.create("id", {
23107
24019
  </dl>
23108
24020
  </details>
23109
24021
 
23110
- <details><summary><code>client.organizations.clientGrants.<a href="/src/management/api/resources/organizations/resources/clientGrants/client/Client.ts">delete</a>(id, grant_id) -> void</code></summary>
24022
+ <details><summary><code>client.organizations.clients.<a href="/src/management/api/resources/organizations/resources/clients/client/Client.ts">update</a>(id, client_id, { ...params }) -> Management.UpdateOrganizationClientResponseContent</code></summary>
24023
+ <dl>
24024
+ <dd>
24025
+
24026
+ #### 📝 Description
24027
+
24028
+ <dl>
24029
+ <dd>
24030
+
23111
24031
  <dl>
23112
24032
  <dd>
23113
24033
 
24034
+ Update an organization client association.
24035
+
24036
+ </dd>
24037
+ </dl>
24038
+ </dd>
24039
+ </dl>
24040
+
23114
24041
  #### 🔌 Usage
23115
24042
 
23116
24043
  <dl>
@@ -23120,7 +24047,7 @@ await client.organizations.clientGrants.create("id", {
23120
24047
  <dd>
23121
24048
 
23122
24049
  ```typescript
23123
- await client.organizations.clientGrants.delete("id", "grant_id");
24050
+ await client.organizations.clients.update("id", "client_id");
23124
24051
  ```
23125
24052
 
23126
24053
  </dd>
@@ -23136,7 +24063,7 @@ await client.organizations.clientGrants.delete("id", "grant_id");
23136
24063
  <dl>
23137
24064
  <dd>
23138
24065
 
23139
- **id:** `string` — Organization identifier.
24066
+ **id:** `string` — ID of the organization.
23140
24067
 
23141
24068
  </dd>
23142
24069
  </dl>
@@ -23144,7 +24071,7 @@ await client.organizations.clientGrants.delete("id", "grant_id");
23144
24071
  <dl>
23145
24072
  <dd>
23146
24073
 
23147
- **grant_id:** `string` — The Client Grant ID to remove from the organization
24074
+ **client_id:** `string` — ID of the client association to update.
23148
24075
 
23149
24076
  </dd>
23150
24077
  </dl>
@@ -23152,7 +24079,15 @@ await client.organizations.clientGrants.delete("id", "grant_id");
23152
24079
  <dl>
23153
24080
  <dd>
23154
24081
 
23155
- **requestOptions:** `ClientGrantsClient.RequestOptions`
24082
+ **request:** `Management.UpdateOrganizationClientRequestContent`
24083
+
24084
+ </dd>
24085
+ </dl>
24086
+
24087
+ <dl>
24088
+ <dd>
24089
+
24090
+ **requestOptions:** `ClientsClient.RequestOptions`
23156
24091
 
23157
24092
  </dd>
23158
24093
  </dl>
@@ -24646,7 +25581,7 @@ List organization members.
24646
25581
  This endpoint is subject to eventual consistency. New users may not be immediately included in the response and deleted users may not be immediately removed from it.
24647
25582
 
24648
25583
  - Use the `fields` parameter to optionally define the specific member details retrieved. If `fields` is left blank, all fields (except roles) are returned.
24649
- - Member roles are not sent by default. Use `fields=roles` to retrieve the roles assigned to each listed member. To use this parameter, you must include the `read:organization_member_roles` scope in the token.
25584
+ - Member roles are not sent by default. Use `fields=roles` to retrieve the roles assigned to each listed member. To use this parameter, you must include the `read:organization_member_roles` scope in the token. Only directly assigned roles are returned. To also include group-based role assignments, use `GET /api/v2/organizations/{id}/members/{user_id}/effective-roles`.
24650
25585
 
24651
25586
  This endpoint supports two types of pagination:
24652
25587
 
@@ -24674,6 +25609,7 @@ To search by checkpoint, use the following parameters: - from: Optional id from
24674
25609
 
24675
25610
  ```typescript
24676
25611
  const pageableResponse = await client.organizations.members.list("id", {
25612
+ include_totals: true,
24677
25613
  from: "from",
24678
25614
  take: 1,
24679
25615
  fields: "fields",
@@ -24685,6 +25621,7 @@ for await (const item of pageableResponse) {
24685
25621
 
24686
25622
  // Or you can manually iterate page-by-page
24687
25623
  let page = await client.organizations.members.list("id", {
25624
+ include_totals: true,
24688
25625
  from: "from",
24689
25626
  take: 1,
24690
25627
  fields: "fields",
@@ -25340,6 +26277,8 @@ Retrieve detailed list of roles assigned to a given user within the context of a
25340
26277
 
25341
26278
  Users can be members of multiple Organizations with unique roles assigned for each membership. This action only returns the roles associated with the specified Organization; any roles assigned to the user within other Organizations are not included.
25342
26279
 
26280
+ **Note**: Returns only direct role assignments for this member. To also include group-based role assignments, use `GET /api/v2/organizations/{id}/members/{user_id}/effective-roles`.
26281
+
25343
26282
  </dd>
25344
26283
  </dl>
25345
26284
  </dd>
@@ -25708,6 +26647,11 @@ const response = page.response;
25708
26647
 
25709
26648
  List the organization members assigned a specific role within the context of an organization.
25710
26649
 
26650
+ <ul>
26651
+ <li>
26652
+ <b>Note</b>: Returns only members with direct role assignments. For groups assigned to this role within the organization, use <code>GET /api/v2/organizations/{organization_id}/roles/{role_id}/groups</code>.
26653
+ </li>
26654
+ </ul>
25711
26655
  </dd>
25712
26656
  </dl>
25713
26657
  </dd>
@@ -25795,6 +26739,105 @@ const response = page.response;
25795
26739
  </dl>
25796
26740
  </details>
25797
26741
 
26742
+ ## Organizations Roles Groups
26743
+
26744
+ <details><summary><code>client.organizations.roles.groups.<a href="/src/management/api/resources/organizations/resources/roles/resources/groups/client/Client.ts">list</a>(organization_id, role_id, { ...params }) -> core.Page&lt;Management.RoleGroup, Management.ListOrganizationRoleGroupsResponseContent&gt;</code></summary>
26745
+ <dl>
26746
+ <dd>
26747
+
26748
+ #### 📝 Description
26749
+
26750
+ <dl>
26751
+ <dd>
26752
+
26753
+ <dl>
26754
+ <dd>
26755
+
26756
+ Retrieve the list of groups assigned to a role in the context of an organization.
26757
+
26758
+ </dd>
26759
+ </dl>
26760
+ </dd>
26761
+ </dl>
26762
+
26763
+ #### 🔌 Usage
26764
+
26765
+ <dl>
26766
+ <dd>
26767
+
26768
+ <dl>
26769
+ <dd>
26770
+
26771
+ ```typescript
26772
+ const pageableResponse = await client.organizations.roles.groups.list("organization_id", "role_id", {
26773
+ from: "from",
26774
+ take: 1,
26775
+ });
26776
+ for await (const item of pageableResponse) {
26777
+ console.log(item);
26778
+ }
26779
+
26780
+ // Or you can manually iterate page-by-page
26781
+ let page = await client.organizations.roles.groups.list("organization_id", "role_id", {
26782
+ from: "from",
26783
+ take: 1,
26784
+ });
26785
+ while (page.hasNextPage()) {
26786
+ page = page.getNextPage();
26787
+ }
26788
+
26789
+ // You can also access the underlying response
26790
+ const response = page.response;
26791
+ ```
26792
+
26793
+ </dd>
26794
+ </dl>
26795
+ </dd>
26796
+ </dl>
26797
+
26798
+ #### ⚙️ Parameters
26799
+
26800
+ <dl>
26801
+ <dd>
26802
+
26803
+ <dl>
26804
+ <dd>
26805
+
26806
+ **organization_id:** `string` — ID of the organization.
26807
+
26808
+ </dd>
26809
+ </dl>
26810
+
26811
+ <dl>
26812
+ <dd>
26813
+
26814
+ **role_id:** `string` — ID of the role.
26815
+
26816
+ </dd>
26817
+ </dl>
26818
+
26819
+ <dl>
26820
+ <dd>
26821
+
26822
+ **request:** `Management.ListOrganizationRoleGroupsRequestParameters`
26823
+
26824
+ </dd>
26825
+ </dl>
26826
+
26827
+ <dl>
26828
+ <dd>
26829
+
26830
+ **requestOptions:** `GroupsClient.RequestOptions`
26831
+
26832
+ </dd>
26833
+ </dl>
26834
+ </dd>
26835
+ </dl>
26836
+
26837
+ </dd>
26838
+ </dl>
26839
+ </details>
26840
+
25798
26841
  ## Prompts Rendering
25799
26842
 
25800
26843
  <details><summary><code>client.prompts.rendering.<a href="/src/management/api/resources/prompts/resources/rendering/client/Client.ts">list</a>({ ...params }) -> core.Page&lt;Management.ListAculsResponseContentItem, Management.ListAculsOffsetPaginatedResponseContent&gt;</code></summary>
@@ -27148,6 +28191,8 @@ await client.roles.permissions.delete("id", {
27148
28191
 
27149
28192
  Retrieve list of users associated with a specific role. For Dashboard instructions, review [View Users Assigned to Roles](https://auth0.com/docs/manage-users/access-control/configure-core-rbac/roles/view-users-assigned-to-roles).
27150
28193
 
28194
+ **Note**: Returns only users with direct role assignments. For groups assigned to this role, use `GET /api/v2/roles/{id}/groups`.
28195
+
27151
28196
  This endpoint supports two types of pagination:
27152
28197
 
27153
28198
  - Offset pagination
@@ -27179,6 +28224,7 @@ To search by checkpoint, use the following parameters:
27179
28224
 
27180
28225
  ```typescript
27181
28226
  const pageableResponse = await client.roles.users.list("id", {
28227
+ include_totals: true,
27182
28228
  from: "from",
27183
28229
  take: 1,
27184
28230
  });
@@ -27188,6 +28234,7 @@ for await (const item of pageableResponse) {
27188
28234
 
27189
28235
  // Or you can manually iterate page-by-page
27190
28236
  let page = await client.roles.users.list("id", {
28237
+ include_totals: true,
27191
28238
  from: "from",
27192
28239
  take: 1,
27193
28240
  });
@@ -28710,6 +29757,7 @@ List all groups to which this user belongs.
28710
29757
  const pageableResponse = await client.users.groups.get("id", {
28711
29758
  fields: "fields",
28712
29759
  include_fields: true,
29760
+ include_totals: true,
28713
29761
  from: "from",
28714
29762
  take: 1,
28715
29763
  });
@@ -28721,6 +29769,7 @@ for await (const item of pageableResponse) {
28721
29769
  let page = await client.users.groups.get("id", {
28722
29770
  fields: "fields",
28723
29771
  include_fields: true,
29772
+ include_totals: true,
28724
29773
  from: "from",
28725
29774
  take: 1,
28726
29775
  });
@@ -29299,6 +30348,8 @@ const response = page.response;
29299
30348
 
29300
30349
  Retrieve all permissions associated with the user.
29301
30350
 
30351
+ **Note**: Returns only permissions from direct assignments and directly assigned roles. For permissions a user has via group-based role assignments, use `GET /api/v2/users/{id}/effective-permissions`.
30352
+
29302
30353
  </dd>
29303
30354
  </dl>
29304
30355
  </dd>
@@ -29626,6 +30677,8 @@ Retrieve detailed list of all user roles currently assigned to a user.
29626
30677
 
29627
30678
  **Note**: This action retrieves all roles assigned to a user in the context of your whole tenant. To retrieve Organization-specific roles, use the following endpoint: [Get user roles assigned to an Organization member](https://auth0.com/docs/api/management/v2/organizations/get-organization-member-roles).
29628
30679
 
30680
+ **Note**: Returns only direct role assignments. To also include group-based role assignments, use `GET /api/v2/users/{id}/effective-roles`.
30681
+
29629
30682
  </dd>
29630
30683
  </dl>
29631
30684
  </dd>
@@ -29884,6 +30937,7 @@ Retrieve details for a user's refresh tokens.
29884
30937
 
29885
30938
  ```typescript
29886
30939
  const pageableResponse = await client.users.refreshToken.list("user_id", {
30940
+ include_totals: true,
29887
30941
  from: "from",
29888
30942
  take: 1,
29889
30943
  });
@@ -29893,6 +30947,7 @@ for await (const item of pageableResponse) {
29893
30947
 
29894
30948
  // Or you can manually iterate page-by-page
29895
30949
  let page = await client.users.refreshToken.list("user_id", {
30950
+ include_totals: true,
29896
30951
  from: "from",
29897
30952
  take: 1,
29898
30953
  });
@@ -30038,6 +31093,7 @@ Retrieve details for a user's sessions.
30038
31093
 
30039
31094
  ```typescript
30040
31095
  const pageableResponse = await client.users.sessions.list("user_id", {
31096
+ include_totals: true,
30041
31097
  from: "from",
30042
31098
  take: 1,
30043
31099
  });
@@ -30047,6 +31103,7 @@ for await (const item of pageableResponse) {
30047
31103
 
30048
31104
  // Or you can manually iterate page-by-page
30049
31105
  let page = await client.users.sessions.list("user_id", {
31106
+ include_totals: true,
30050
31107
  from: "from",
30051
31108
  take: 1,
30052
31109
  });