@sailpoint/api-client 2.2.50 → 2.2.52

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 (216) hide show
  1. package/dist/access_profiles/api.d.ts +1110 -3
  2. package/dist/access_profiles/api.js +964 -6
  3. package/dist/access_profiles/api.js.map +1 -1
  4. package/dist/approvals/api.d.ts +121 -46
  5. package/dist/approvals/api.js +37 -24
  6. package/dist/approvals/api.js.map +1 -1
  7. package/dist/capabilities/api.d.ts +2 -2
  8. package/dist/capabilities/api.js +2 -2
  9. package/dist/capabilities/api.js.map +1 -1
  10. package/dist/capabilities/base.d.ts +2 -2
  11. package/dist/capabilities/base.js +2 -2
  12. package/dist/capabilities/base.js.map +1 -1
  13. package/dist/capabilities/common.d.ts +2 -2
  14. package/dist/capabilities/common.js +2 -2
  15. package/dist/capabilities/common.js.map +1 -1
  16. package/dist/capabilities/configuration.d.ts +2 -2
  17. package/dist/capabilities/configuration.js +2 -2
  18. package/dist/capabilities/configuration.js.map +1 -1
  19. package/dist/capabilities/index.d.ts +2 -2
  20. package/dist/capabilities/index.js +2 -2
  21. package/dist/capabilities/index.js.map +1 -1
  22. package/dist/credentials/api.d.ts +2 -2
  23. package/dist/credentials/api.js +2 -2
  24. package/dist/credentials/api.js.map +1 -1
  25. package/dist/credentials/base.d.ts +2 -2
  26. package/dist/credentials/base.js +2 -2
  27. package/dist/credentials/base.js.map +1 -1
  28. package/dist/credentials/common.d.ts +2 -2
  29. package/dist/credentials/common.js +2 -2
  30. package/dist/credentials/common.js.map +1 -1
  31. package/dist/credentials/configuration.d.ts +2 -2
  32. package/dist/credentials/configuration.js +2 -2
  33. package/dist/credentials/configuration.js.map +1 -1
  34. package/dist/credentials/index.d.ts +2 -2
  35. package/dist/credentials/index.js +2 -2
  36. package/dist/credentials/index.js.map +1 -1
  37. package/dist/data_access_security/api.d.ts +10 -10
  38. package/dist/data_access_security/api.js +8 -8
  39. package/dist/data_access_security/api.js.map +1 -1
  40. package/dist/devices/api.d.ts +2 -2
  41. package/dist/devices/api.js +2 -2
  42. package/dist/devices/api.js.map +1 -1
  43. package/dist/devices/base.d.ts +2 -2
  44. package/dist/devices/base.js +2 -2
  45. package/dist/devices/base.js.map +1 -1
  46. package/dist/devices/common.d.ts +2 -2
  47. package/dist/devices/common.js +2 -2
  48. package/dist/devices/common.js.map +1 -1
  49. package/dist/devices/configuration.d.ts +2 -2
  50. package/dist/devices/configuration.js +2 -2
  51. package/dist/devices/configuration.js.map +1 -1
  52. package/dist/devices/index.d.ts +2 -2
  53. package/dist/devices/index.js +2 -2
  54. package/dist/devices/index.js.map +1 -1
  55. package/dist/esm/access_profiles/api.js +963 -5
  56. package/dist/esm/approvals/api.js +36 -23
  57. package/dist/esm/capabilities/api.js +2 -2
  58. package/dist/esm/capabilities/base.js +2 -2
  59. package/dist/esm/capabilities/common.js +2 -2
  60. package/dist/esm/capabilities/configuration.js +2 -2
  61. package/dist/esm/capabilities/index.js +2 -2
  62. package/dist/esm/credentials/api.js +2 -2
  63. package/dist/esm/credentials/base.js +2 -2
  64. package/dist/esm/credentials/common.js +2 -2
  65. package/dist/esm/credentials/configuration.js +2 -2
  66. package/dist/esm/credentials/index.js +2 -2
  67. package/dist/esm/data_access_security/api.js +8 -8
  68. package/dist/esm/devices/api.js +2 -2
  69. package/dist/esm/devices/base.js +2 -2
  70. package/dist/esm/devices/common.js +2 -2
  71. package/dist/esm/devices/configuration.js +2 -2
  72. package/dist/esm/devices/index.js +2 -2
  73. package/dist/esm/generic_request_approval_config/api.js +2 -2
  74. package/dist/esm/generic_request_approval_config/base.js +2 -2
  75. package/dist/esm/generic_request_approval_config/common.js +2 -2
  76. package/dist/esm/generic_request_approval_config/configuration.js +2 -2
  77. package/dist/esm/generic_request_approval_config/index.js +2 -2
  78. package/dist/esm/index.js +6 -0
  79. package/dist/esm/machine_account_recommendation/api.js +2 -2
  80. package/dist/esm/machine_account_recommendation/base.js +2 -2
  81. package/dist/esm/machine_account_recommendation/common.js +2 -2
  82. package/dist/esm/machine_account_recommendation/configuration.js +2 -2
  83. package/dist/esm/machine_account_recommendation/index.js +2 -2
  84. package/dist/esm/machine_identities_lifecycle_actions/api.js +35 -32
  85. package/dist/esm/machine_identity_metadata/api.js +2 -2
  86. package/dist/esm/machine_identity_metadata/base.js +2 -2
  87. package/dist/esm/machine_identity_metadata/common.js +2 -2
  88. package/dist/esm/machine_identity_metadata/configuration.js +2 -2
  89. package/dist/esm/machine_identity_metadata/index.js +2 -2
  90. package/dist/esm/machine_mapping_metadata/api.js +2 -2
  91. package/dist/esm/machine_mapping_metadata/base.js +2 -2
  92. package/dist/esm/machine_mapping_metadata/common.js +2 -2
  93. package/dist/esm/machine_mapping_metadata/configuration.js +2 -2
  94. package/dist/esm/machine_mapping_metadata/index.js +2 -2
  95. package/dist/esm/nerm/common.js +2 -2
  96. package/dist/esm/nermv2025/common.js +2 -2
  97. package/dist/esm/reminder_escalations/api.js +522 -0
  98. package/dist/esm/reminder_escalations/base.js +83 -0
  99. package/dist/esm/reminder_escalations/common.js +287 -0
  100. package/dist/esm/reminder_escalations/configuration.js +42 -0
  101. package/dist/esm/reminder_escalations/index.js +15 -0
  102. package/dist/esm/roles/api.js +529 -2
  103. package/dist/esm/sources/api.js +2 -1
  104. package/dist/esm/ui_plugins/api.js +1657 -0
  105. package/dist/esm/ui_plugins/base.js +83 -0
  106. package/dist/esm/ui_plugins/common.js +287 -0
  107. package/dist/esm/ui_plugins/configuration.js +42 -0
  108. package/dist/esm/ui_plugins/index.js +15 -0
  109. package/dist/generic_request_approval_config/api.d.ts +2 -2
  110. package/dist/generic_request_approval_config/api.js +2 -2
  111. package/dist/generic_request_approval_config/api.js.map +1 -1
  112. package/dist/generic_request_approval_config/base.d.ts +2 -2
  113. package/dist/generic_request_approval_config/base.js +2 -2
  114. package/dist/generic_request_approval_config/base.js.map +1 -1
  115. package/dist/generic_request_approval_config/common.d.ts +2 -2
  116. package/dist/generic_request_approval_config/common.js +2 -2
  117. package/dist/generic_request_approval_config/common.js.map +1 -1
  118. package/dist/generic_request_approval_config/configuration.d.ts +2 -2
  119. package/dist/generic_request_approval_config/configuration.js +2 -2
  120. package/dist/generic_request_approval_config/configuration.js.map +1 -1
  121. package/dist/generic_request_approval_config/index.d.ts +2 -2
  122. package/dist/generic_request_approval_config/index.js +2 -2
  123. package/dist/generic_request_approval_config/index.js.map +1 -1
  124. package/dist/index.d.ts +6 -0
  125. package/dist/index.js +103 -97
  126. package/dist/index.js.map +1 -1
  127. package/dist/machine_account_recommendation/api.d.ts +2 -2
  128. package/dist/machine_account_recommendation/api.js +2 -2
  129. package/dist/machine_account_recommendation/api.js.map +1 -1
  130. package/dist/machine_account_recommendation/base.d.ts +2 -2
  131. package/dist/machine_account_recommendation/base.js +2 -2
  132. package/dist/machine_account_recommendation/base.js.map +1 -1
  133. package/dist/machine_account_recommendation/common.d.ts +2 -2
  134. package/dist/machine_account_recommendation/common.js +2 -2
  135. package/dist/machine_account_recommendation/common.js.map +1 -1
  136. package/dist/machine_account_recommendation/configuration.d.ts +2 -2
  137. package/dist/machine_account_recommendation/configuration.js +2 -2
  138. package/dist/machine_account_recommendation/configuration.js.map +1 -1
  139. package/dist/machine_account_recommendation/index.d.ts +2 -2
  140. package/dist/machine_account_recommendation/index.js +2 -2
  141. package/dist/machine_account_recommendation/index.js.map +1 -1
  142. package/dist/machine_identities_lifecycle_actions/api.d.ts +67 -63
  143. package/dist/machine_identities_lifecycle_actions/api.js +36 -33
  144. package/dist/machine_identities_lifecycle_actions/api.js.map +1 -1
  145. package/dist/machine_identity_metadata/api.d.ts +2 -2
  146. package/dist/machine_identity_metadata/api.js +2 -2
  147. package/dist/machine_identity_metadata/api.js.map +1 -1
  148. package/dist/machine_identity_metadata/base.d.ts +2 -2
  149. package/dist/machine_identity_metadata/base.js +2 -2
  150. package/dist/machine_identity_metadata/base.js.map +1 -1
  151. package/dist/machine_identity_metadata/common.d.ts +2 -2
  152. package/dist/machine_identity_metadata/common.js +2 -2
  153. package/dist/machine_identity_metadata/common.js.map +1 -1
  154. package/dist/machine_identity_metadata/configuration.d.ts +2 -2
  155. package/dist/machine_identity_metadata/configuration.js +2 -2
  156. package/dist/machine_identity_metadata/configuration.js.map +1 -1
  157. package/dist/machine_identity_metadata/index.d.ts +2 -2
  158. package/dist/machine_identity_metadata/index.js +2 -2
  159. package/dist/machine_identity_metadata/index.js.map +1 -1
  160. package/dist/machine_mapping_metadata/api.d.ts +2 -2
  161. package/dist/machine_mapping_metadata/api.js +2 -2
  162. package/dist/machine_mapping_metadata/api.js.map +1 -1
  163. package/dist/machine_mapping_metadata/base.d.ts +2 -2
  164. package/dist/machine_mapping_metadata/base.js +2 -2
  165. package/dist/machine_mapping_metadata/base.js.map +1 -1
  166. package/dist/machine_mapping_metadata/common.d.ts +2 -2
  167. package/dist/machine_mapping_metadata/common.js +2 -2
  168. package/dist/machine_mapping_metadata/common.js.map +1 -1
  169. package/dist/machine_mapping_metadata/configuration.d.ts +2 -2
  170. package/dist/machine_mapping_metadata/configuration.js +2 -2
  171. package/dist/machine_mapping_metadata/configuration.js.map +1 -1
  172. package/dist/machine_mapping_metadata/index.d.ts +2 -2
  173. package/dist/machine_mapping_metadata/index.js +2 -2
  174. package/dist/machine_mapping_metadata/index.js.map +1 -1
  175. package/dist/nerm/common.js +2 -2
  176. package/dist/nerm/common.js.map +1 -1
  177. package/dist/nermv2025/common.js +2 -2
  178. package/dist/nermv2025/common.js.map +1 -1
  179. package/dist/reminder_escalations/api.d.ts +665 -0
  180. package/dist/reminder_escalations/api.js +532 -0
  181. package/dist/reminder_escalations/api.js.map +1 -0
  182. package/dist/reminder_escalations/base.d.ts +66 -0
  183. package/dist/reminder_escalations/base.js +90 -0
  184. package/dist/reminder_escalations/base.js.map +1 -0
  185. package/dist/reminder_escalations/common.d.ts +65 -0
  186. package/dist/reminder_escalations/common.js +300 -0
  187. package/dist/reminder_escalations/common.js.map +1 -0
  188. package/dist/reminder_escalations/configuration.d.ts +91 -0
  189. package/dist/reminder_escalations/configuration.js +46 -0
  190. package/dist/reminder_escalations/configuration.js.map +1 -0
  191. package/dist/reminder_escalations/index.d.ts +13 -0
  192. package/dist/reminder_escalations/index.js +32 -0
  193. package/dist/reminder_escalations/index.js.map +1 -0
  194. package/dist/roles/api.d.ts +972 -88
  195. package/dist/roles/api.js +530 -3
  196. package/dist/roles/api.js.map +1 -1
  197. package/dist/sources/api.d.ts +2 -1
  198. package/dist/sources/api.js +2 -1
  199. package/dist/sources/api.js.map +1 -1
  200. package/dist/ui_plugins/api.d.ts +1514 -0
  201. package/dist/ui_plugins/api.js +1667 -0
  202. package/dist/ui_plugins/api.js.map +1 -0
  203. package/dist/ui_plugins/base.d.ts +66 -0
  204. package/dist/ui_plugins/base.js +90 -0
  205. package/dist/ui_plugins/base.js.map +1 -0
  206. package/dist/ui_plugins/common.d.ts +65 -0
  207. package/dist/ui_plugins/common.js +300 -0
  208. package/dist/ui_plugins/common.js.map +1 -0
  209. package/dist/ui_plugins/configuration.d.ts +91 -0
  210. package/dist/ui_plugins/configuration.js +46 -0
  211. package/dist/ui_plugins/configuration.js.map +1 -0
  212. package/dist/ui_plugins/index.d.ts +13 -0
  213. package/dist/ui_plugins/index.js +32 -0
  214. package/dist/ui_plugins/index.js.map +1 -0
  215. package/package.json +1 -1
  216. package/sailpoint-scopes.json +487 -18
@@ -490,10 +490,10 @@ export interface Entitlement {
490
490
  'requestable'?: boolean;
491
491
  /**
492
492
  *
493
- * @type {EntitlementOwner}
493
+ * @type {EntitlementV2Owner}
494
494
  * @memberof Entitlement
495
495
  */
496
- 'owner'?: EntitlementOwner | null;
496
+ 'owner'?: EntitlementV2Owner | null;
497
497
  /**
498
498
  * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP).
499
499
  * @type {Array<AdditionalOwnerRef>}
@@ -510,10 +510,10 @@ export interface Entitlement {
510
510
  } | null;
511
511
  /**
512
512
  *
513
- * @type {EntitlementAccessModelMetadata}
513
+ * @type {EntitlementV2AccessModelMetadata}
514
514
  * @memberof Entitlement
515
515
  */
516
- 'accessModelMetadata'?: EntitlementAccessModelMetadata;
516
+ 'accessModelMetadata'?: EntitlementV2AccessModelMetadata;
517
517
  /**
518
518
  * Time when the entitlement was created
519
519
  * @type {string}
@@ -554,47 +554,70 @@ export interface Entitlement {
554
554
  'directPermissions'?: Array<PermissionDTO>;
555
555
  }
556
556
  /**
557
- * Additional data to classify the entitlement
557
+ *
558
558
  * @export
559
- * @interface EntitlementAccessModelMetadata
559
+ * @interface EntitlementPrivilegeLevel
560
560
  */
561
- export interface EntitlementAccessModelMetadata {
561
+ export interface EntitlementPrivilegeLevel {
562
562
  /**
563
- *
564
- * @type {Array<AccessModelMetadata>}
565
- * @memberof EntitlementAccessModelMetadata
563
+ * Direct privilege level assigned to the entitlement
564
+ * @type {string}
565
+ * @memberof EntitlementPrivilegeLevel
566
566
  */
567
- 'attributes'?: Array<AccessModelMetadata>;
568
- }
569
- /**
570
- * The identity that owns the entitlement
571
- * @export
572
- * @interface EntitlementOwner
573
- */
574
- export interface EntitlementOwner {
567
+ 'direct'?: EntitlementPrivilegeLevelDirectEnum;
575
568
  /**
576
- * The identity ID
569
+ * User or process that set the privilege level
577
570
  * @type {string}
578
- * @memberof EntitlementOwner
571
+ * @memberof EntitlementPrivilegeLevel
579
572
  */
580
- 'id'?: string;
573
+ 'setBy'?: string;
581
574
  /**
582
- * The type of object
575
+ * Method by which the privilege level was set
583
576
  * @type {string}
584
- * @memberof EntitlementOwner
577
+ * @memberof EntitlementPrivilegeLevel
585
578
  */
586
- 'type'?: EntitlementOwnerTypeEnum;
579
+ 'setByType'?: EntitlementPrivilegeLevelSetByTypeEnum | null;
587
580
  /**
588
- * The display name of the identity
581
+ * Inherited privilege level on the entitlement, if any
589
582
  * @type {string}
590
- * @memberof EntitlementOwner
583
+ * @memberof EntitlementPrivilegeLevel
591
584
  */
592
- 'name'?: string;
585
+ 'inherited'?: EntitlementPrivilegeLevelInheritedEnum | null;
586
+ /**
587
+ * Effective privilege level assigned to the entitlement
588
+ * @type {string}
589
+ * @memberof EntitlementPrivilegeLevel
590
+ */
591
+ 'effective'?: EntitlementPrivilegeLevelEffectiveEnum;
593
592
  }
594
- export declare const EntitlementOwnerTypeEnum: {
595
- readonly Identity: "IDENTITY";
593
+ export declare const EntitlementPrivilegeLevelDirectEnum: {
594
+ readonly High: "HIGH";
595
+ readonly Low: "LOW";
596
+ readonly Medium: "MEDIUM";
597
+ readonly None: "NONE";
596
598
  };
597
- export type EntitlementOwnerTypeEnum = typeof EntitlementOwnerTypeEnum[keyof typeof EntitlementOwnerTypeEnum];
599
+ export type EntitlementPrivilegeLevelDirectEnum = typeof EntitlementPrivilegeLevelDirectEnum[keyof typeof EntitlementPrivilegeLevelDirectEnum];
600
+ export declare const EntitlementPrivilegeLevelSetByTypeEnum: {
601
+ readonly Override: "OVERRIDE";
602
+ readonly CustomCriteria: "CUSTOM_CRITERIA";
603
+ readonly ConnectorCriteria: "CONNECTOR_CRITERIA";
604
+ readonly SingleLevelCriteria: "SINGLE_LEVEL_CRITERIA";
605
+ };
606
+ export type EntitlementPrivilegeLevelSetByTypeEnum = typeof EntitlementPrivilegeLevelSetByTypeEnum[keyof typeof EntitlementPrivilegeLevelSetByTypeEnum];
607
+ export declare const EntitlementPrivilegeLevelInheritedEnum: {
608
+ readonly High: "HIGH";
609
+ readonly Low: "LOW";
610
+ readonly Medium: "MEDIUM";
611
+ readonly None: "NONE";
612
+ };
613
+ export type EntitlementPrivilegeLevelInheritedEnum = typeof EntitlementPrivilegeLevelInheritedEnum[keyof typeof EntitlementPrivilegeLevelInheritedEnum];
614
+ export declare const EntitlementPrivilegeLevelEffectiveEnum: {
615
+ readonly High: "HIGH";
616
+ readonly Low: "LOW";
617
+ readonly Medium: "MEDIUM";
618
+ readonly None: "NONE";
619
+ };
620
+ export type EntitlementPrivilegeLevelEffectiveEnum = typeof EntitlementPrivilegeLevelEffectiveEnum[keyof typeof EntitlementPrivilegeLevelEffectiveEnum];
598
621
  /**
599
622
  * Entitlement including a specific set of access.
600
623
  * @export
@@ -649,6 +672,263 @@ export interface EntitlementSource {
649
672
  */
650
673
  'name'?: string;
651
674
  }
675
+ /**
676
+ *
677
+ * @export
678
+ * @interface EntitlementV2
679
+ */
680
+ export interface EntitlementV2 {
681
+ /**
682
+ * The entitlement id
683
+ * @type {string}
684
+ * @memberof EntitlementV2
685
+ */
686
+ 'id'?: string;
687
+ /**
688
+ * The entitlement name
689
+ * @type {string}
690
+ * @memberof EntitlementV2
691
+ */
692
+ 'name'?: string;
693
+ /**
694
+ * The entitlement attribute name
695
+ * @type {string}
696
+ * @memberof EntitlementV2
697
+ */
698
+ 'attribute'?: string;
699
+ /**
700
+ * The value of the entitlement
701
+ * @type {string}
702
+ * @memberof EntitlementV2
703
+ */
704
+ 'value'?: string;
705
+ /**
706
+ * The object type of the entitlement from the source schema
707
+ * @type {string}
708
+ * @memberof EntitlementV2
709
+ */
710
+ 'sourceSchemaObjectType'?: string;
711
+ /**
712
+ * The description of the entitlement
713
+ * @type {string}
714
+ * @memberof EntitlementV2
715
+ */
716
+ 'description'?: string | null;
717
+ /**
718
+ *
719
+ * @type {EntitlementV2PrivilegeLevel}
720
+ * @memberof EntitlementV2
721
+ */
722
+ 'privilegeLevel'?: EntitlementV2PrivilegeLevel;
723
+ /**
724
+ * List of tags assigned to the entitlement
725
+ * @type {Array<string>}
726
+ * @memberof EntitlementV2
727
+ */
728
+ 'tags'?: Array<string> | null;
729
+ /**
730
+ * True if the entitlement is cloud governed
731
+ * @type {boolean}
732
+ * @memberof EntitlementV2
733
+ */
734
+ 'cloudGoverned'?: boolean;
735
+ /**
736
+ * True if the entitlement is able to be directly requested
737
+ * @type {boolean}
738
+ * @memberof EntitlementV2
739
+ */
740
+ 'requestable'?: boolean;
741
+ /**
742
+ *
743
+ * @type {EntitlementV2Owner}
744
+ * @memberof EntitlementV2
745
+ */
746
+ 'owner'?: EntitlementV2Owner | null;
747
+ /**
748
+ * A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated.
749
+ * @type {{ [key: string]: any; }}
750
+ * @memberof EntitlementV2
751
+ */
752
+ 'manuallyUpdatedFields'?: {
753
+ [key: string]: any;
754
+ } | null;
755
+ /**
756
+ *
757
+ * @type {EntitlementV2AccessModelMetadata}
758
+ * @memberof EntitlementV2
759
+ */
760
+ 'accessModelMetadata'?: EntitlementV2AccessModelMetadata;
761
+ /**
762
+ * Time when the entitlement was created
763
+ * @type {string}
764
+ * @memberof EntitlementV2
765
+ */
766
+ 'created'?: string;
767
+ /**
768
+ * Time when the entitlement was last modified
769
+ * @type {string}
770
+ * @memberof EntitlementV2
771
+ */
772
+ 'modified'?: string;
773
+ /**
774
+ *
775
+ * @type {EntitlementV2Source}
776
+ * @memberof EntitlementV2
777
+ */
778
+ 'source'?: EntitlementV2Source;
779
+ /**
780
+ * A map of free-form key-value pairs from the source system
781
+ * @type {{ [key: string]: any; }}
782
+ * @memberof EntitlementV2
783
+ */
784
+ 'attributes'?: {
785
+ [key: string]: any;
786
+ };
787
+ /**
788
+ * List of IDs of segments, if any, to which this Entitlement is assigned.
789
+ * @type {Array<string>}
790
+ * @memberof EntitlementV2
791
+ */
792
+ 'segments'?: Array<string> | null;
793
+ /**
794
+ *
795
+ * @type {Array<PermissionDTO>}
796
+ * @memberof EntitlementV2
797
+ */
798
+ 'directPermissions'?: Array<PermissionDTO>;
799
+ }
800
+ /**
801
+ * Additional data to classify the entitlement
802
+ * @export
803
+ * @interface EntitlementV2AccessModelMetadata
804
+ */
805
+ export interface EntitlementV2AccessModelMetadata {
806
+ /**
807
+ *
808
+ * @type {Array<AccessModelMetadata>}
809
+ * @memberof EntitlementV2AccessModelMetadata
810
+ */
811
+ 'attributes'?: Array<AccessModelMetadata>;
812
+ }
813
+ /**
814
+ * The identity that owns the entitlement
815
+ * @export
816
+ * @interface EntitlementV2Owner
817
+ */
818
+ export interface EntitlementV2Owner {
819
+ /**
820
+ * The identity ID
821
+ * @type {string}
822
+ * @memberof EntitlementV2Owner
823
+ */
824
+ 'id'?: string;
825
+ /**
826
+ * The type of object
827
+ * @type {string}
828
+ * @memberof EntitlementV2Owner
829
+ */
830
+ 'type'?: EntitlementV2OwnerTypeEnum;
831
+ /**
832
+ * The display name of the identity
833
+ * @type {string}
834
+ * @memberof EntitlementV2Owner
835
+ */
836
+ 'name'?: string;
837
+ }
838
+ export declare const EntitlementV2OwnerTypeEnum: {
839
+ readonly Identity: "IDENTITY";
840
+ };
841
+ export type EntitlementV2OwnerTypeEnum = typeof EntitlementV2OwnerTypeEnum[keyof typeof EntitlementV2OwnerTypeEnum];
842
+ /**
843
+ *
844
+ * @export
845
+ * @interface EntitlementV2PrivilegeLevel
846
+ */
847
+ export interface EntitlementV2PrivilegeLevel {
848
+ /**
849
+ * Direct privilege level assigned to the entitlement
850
+ * @type {string}
851
+ * @memberof EntitlementV2PrivilegeLevel
852
+ */
853
+ 'direct'?: EntitlementV2PrivilegeLevelDirectEnum;
854
+ /**
855
+ * User or process that set the privilege level
856
+ * @type {string}
857
+ * @memberof EntitlementV2PrivilegeLevel
858
+ */
859
+ 'setBy'?: string;
860
+ /**
861
+ * Method by which the privilege level was set
862
+ * @type {string}
863
+ * @memberof EntitlementV2PrivilegeLevel
864
+ */
865
+ 'setByType'?: EntitlementV2PrivilegeLevelSetByTypeEnum | null;
866
+ /**
867
+ * Inherited privilege level on the entitlement, if any
868
+ * @type {string}
869
+ * @memberof EntitlementV2PrivilegeLevel
870
+ */
871
+ 'inherited'?: EntitlementV2PrivilegeLevelInheritedEnum | null;
872
+ /**
873
+ * Effective privilege level assigned to the entitlement
874
+ * @type {string}
875
+ * @memberof EntitlementV2PrivilegeLevel
876
+ */
877
+ 'effective'?: EntitlementV2PrivilegeLevelEffectiveEnum;
878
+ }
879
+ export declare const EntitlementV2PrivilegeLevelDirectEnum: {
880
+ readonly High: "HIGH";
881
+ readonly Low: "LOW";
882
+ readonly Medium: "MEDIUM";
883
+ readonly None: "NONE";
884
+ };
885
+ export type EntitlementV2PrivilegeLevelDirectEnum = typeof EntitlementV2PrivilegeLevelDirectEnum[keyof typeof EntitlementV2PrivilegeLevelDirectEnum];
886
+ export declare const EntitlementV2PrivilegeLevelSetByTypeEnum: {
887
+ readonly Override: "OVERRIDE";
888
+ readonly CustomCriteria: "CUSTOM_CRITERIA";
889
+ readonly ConnectorCriteria: "CONNECTOR_CRITERIA";
890
+ readonly SingleLevelCriteria: "SINGLE_LEVEL_CRITERIA";
891
+ };
892
+ export type EntitlementV2PrivilegeLevelSetByTypeEnum = typeof EntitlementV2PrivilegeLevelSetByTypeEnum[keyof typeof EntitlementV2PrivilegeLevelSetByTypeEnum];
893
+ export declare const EntitlementV2PrivilegeLevelInheritedEnum: {
894
+ readonly High: "HIGH";
895
+ readonly Low: "LOW";
896
+ readonly Medium: "MEDIUM";
897
+ readonly None: "NONE";
898
+ };
899
+ export type EntitlementV2PrivilegeLevelInheritedEnum = typeof EntitlementV2PrivilegeLevelInheritedEnum[keyof typeof EntitlementV2PrivilegeLevelInheritedEnum];
900
+ export declare const EntitlementV2PrivilegeLevelEffectiveEnum: {
901
+ readonly High: "HIGH";
902
+ readonly Low: "LOW";
903
+ readonly Medium: "MEDIUM";
904
+ readonly None: "NONE";
905
+ };
906
+ export type EntitlementV2PrivilegeLevelEffectiveEnum = typeof EntitlementV2PrivilegeLevelEffectiveEnum[keyof typeof EntitlementV2PrivilegeLevelEffectiveEnum];
907
+ /**
908
+ *
909
+ * @export
910
+ * @interface EntitlementV2Source
911
+ */
912
+ export interface EntitlementV2Source {
913
+ /**
914
+ * The source ID
915
+ * @type {string}
916
+ * @memberof EntitlementV2Source
917
+ */
918
+ 'id'?: string;
919
+ /**
920
+ * The source type, will always be \"SOURCE\"
921
+ * @type {string}
922
+ * @memberof EntitlementV2Source
923
+ */
924
+ 'type'?: string;
925
+ /**
926
+ * The source name
927
+ * @type {string}
928
+ * @memberof EntitlementV2Source
929
+ */
930
+ 'name'?: string;
931
+ }
652
932
  /**
653
933
  *
654
934
  * @export
@@ -748,26 +1028,26 @@ export type JsonPatchOperationValue = Array<ArrayInner> | boolean | number | obj
748
1028
  /**
749
1029
  *
750
1030
  * @export
751
- * @interface ListRolesV1401Response
1031
+ * @interface ListRolesV2401Response
752
1032
  */
753
- export interface ListRolesV1401Response {
1033
+ export interface ListRolesV2401Response {
754
1034
  /**
755
1035
  * A message describing the error
756
1036
  * @type {any}
757
- * @memberof ListRolesV1401Response
1037
+ * @memberof ListRolesV2401Response
758
1038
  */
759
1039
  'error'?: any;
760
1040
  }
761
1041
  /**
762
1042
  *
763
1043
  * @export
764
- * @interface ListRolesV1429Response
1044
+ * @interface ListRolesV2429Response
765
1045
  */
766
- export interface ListRolesV1429Response {
1046
+ export interface ListRolesV2429Response {
767
1047
  /**
768
1048
  * A message describing the error
769
1049
  * @type {any}
770
- * @memberof ListRolesV1429Response
1050
+ * @memberof ListRolesV2429Response
771
1051
  */
772
1052
  'message'?: any;
773
1053
  }
@@ -1609,77 +1889,265 @@ export interface RoleMetadataBulkUpdateByQueryRequestValuesInner {
1609
1889
  'attributeValue'?: Array<string>;
1610
1890
  }
1611
1891
  /**
1612
- * Task result.
1892
+ * Privilege level of the role. The effective level is the highest effective privilege level among the entitlements assigned directly to the role and the entitlements included in the role\'s access profiles.
1613
1893
  * @export
1614
- * @interface TaskResultDto
1894
+ * @interface RolePrivilegeLevel
1615
1895
  */
1616
- export interface TaskResultDto {
1617
- /**
1618
- * Task result DTO type.
1619
- * @type {string}
1620
- * @memberof TaskResultDto
1621
- */
1622
- 'type'?: TaskResultDtoTypeEnum;
1623
- /**
1624
- * Task result ID.
1625
- * @type {string}
1626
- * @memberof TaskResultDto
1627
- */
1628
- 'id'?: string;
1896
+ export interface RolePrivilegeLevel {
1629
1897
  /**
1630
- * Task result display name.
1898
+ * Effective privilege level of the role. **UNDETERMINED** means the privilege level could not be calculated for the role\'s entitlements.
1631
1899
  * @type {string}
1632
- * @memberof TaskResultDto
1900
+ * @memberof RolePrivilegeLevel
1633
1901
  */
1634
- 'name'?: string | null;
1902
+ 'effective'?: RolePrivilegeLevelEffectiveEnum;
1635
1903
  }
1636
- export declare const TaskResultDtoTypeEnum: {
1637
- readonly TaskResult: "TASK_RESULT";
1904
+ export declare const RolePrivilegeLevelEffectiveEnum: {
1905
+ readonly None: "NONE";
1906
+ readonly Low: "LOW";
1907
+ readonly Medium: "MEDIUM";
1908
+ readonly High: "HIGH";
1909
+ readonly Undetermined: "UNDETERMINED";
1638
1910
  };
1639
- export type TaskResultDtoTypeEnum = typeof TaskResultDtoTypeEnum[keyof typeof TaskResultDtoTypeEnum];
1911
+ export type RolePrivilegeLevelEffectiveEnum = typeof RolePrivilegeLevelEffectiveEnum[keyof typeof RolePrivilegeLevelEffectiveEnum];
1640
1912
  /**
1641
- * RolesApi - axios parameter creator
1913
+ * A Role, including its effective privilege level.
1642
1914
  * @export
1915
+ * @interface RoleV2
1643
1916
  */
1644
- export declare const RolesApiAxiosParamCreator: (configuration?: Configuration) => {
1917
+ export interface RoleV2 {
1645
1918
  /**
1646
- * This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.
1647
- * @summary Create a role
1648
- * @param {Role} role
1649
- * @param {*} [axiosOptions] Override http request option.
1650
- * @throws {RequiredError}
1919
+ * The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.
1920
+ * @type {string}
1921
+ * @memberof RoleV2
1651
1922
  */
1652
- createRoleV1: (role: Role, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1923
+ 'id'?: string;
1653
1924
  /**
1654
- * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
1655
- * @summary Delete role(s)
1656
- * @param {RoleBulkDeleteRequest} roleBulkDeleteRequest
1657
- * @param {*} [axiosOptions] Override http request option.
1658
- * @throws {RequiredError}
1925
+ * The human-readable display name of the Role
1926
+ * @type {string}
1927
+ * @memberof RoleV2
1659
1928
  */
1660
- deleteBulkRolesV1: (roleBulkDeleteRequest: RoleBulkDeleteRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1929
+ 'name': string;
1661
1930
  /**
1662
- * This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API.
1663
- * @summary Remove a metadata from role.
1664
- * @param {string} id The role\&#39;s id.
1665
- * @param {string} attributeKey Technical name of the Attribute.
1666
- * @param {string} attributeValue Technical name of the Attribute Value.
1667
- * @param {*} [axiosOptions] Override http request option.
1668
- * @throws {RequiredError}
1931
+ * Date the Role was created
1932
+ * @type {string}
1933
+ * @memberof RoleV2
1669
1934
  */
1670
- deleteMetadataFromRoleByKeyAndValueV1: (id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1935
+ 'created'?: string;
1671
1936
  /**
1672
- * This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
1673
- * @summary Delete a role
1674
- * @param {string} id ID of the Role
1675
- * @param {*} [axiosOptions] Override http request option.
1676
- * @throws {RequiredError}
1937
+ * Date the Role was last modified.
1938
+ * @type {string}
1939
+ * @memberof RoleV2
1677
1940
  */
1678
- deleteRoleV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1941
+ 'modified'?: string;
1679
1942
  /**
1680
- * This API initial a request for one bulk update\'s status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API.
1681
- * @summary Get bulk-update status by id
1682
- * @param {string} id The Id of the bulk update task.
1943
+ * A human-readable description of the Role
1944
+ * @type {string}
1945
+ * @memberof RoleV2
1946
+ */
1947
+ 'description'?: string | null;
1948
+ /**
1949
+ *
1950
+ * @type {OwnerReference}
1951
+ * @memberof RoleV2
1952
+ */
1953
+ 'owner': OwnerReference | null;
1954
+ /**
1955
+ * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP).
1956
+ * @type {Array<AdditionalOwnerRef>}
1957
+ * @memberof RoleV2
1958
+ */
1959
+ 'additionalOwners'?: Array<AdditionalOwnerRef> | null;
1960
+ /**
1961
+ *
1962
+ * @type {Array<AccessProfileRef>}
1963
+ * @memberof RoleV2
1964
+ */
1965
+ 'accessProfiles'?: Array<AccessProfileRef> | null;
1966
+ /**
1967
+ *
1968
+ * @type {Array<EntitlementRef>}
1969
+ * @memberof RoleV2
1970
+ */
1971
+ 'entitlements'?: Array<EntitlementRef>;
1972
+ /**
1973
+ *
1974
+ * @type {RoleMembershipSelector}
1975
+ * @memberof RoleV2
1976
+ */
1977
+ 'membership'?: RoleMembershipSelector | null;
1978
+ /**
1979
+ * This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.
1980
+ * @type {{ [key: string]: any; }}
1981
+ * @memberof RoleV2
1982
+ */
1983
+ 'legacyMembershipInfo'?: {
1984
+ [key: string]: any;
1985
+ } | null;
1986
+ /**
1987
+ * Whether the Role is enabled or not.
1988
+ * @type {boolean}
1989
+ * @memberof RoleV2
1990
+ */
1991
+ 'enabled'?: boolean;
1992
+ /**
1993
+ * Whether the Role can be the target of access requests.
1994
+ * @type {boolean}
1995
+ * @memberof RoleV2
1996
+ */
1997
+ 'requestable'?: boolean;
1998
+ /**
1999
+ *
2000
+ * @type {RequestabilityForRole}
2001
+ * @memberof RoleV2
2002
+ */
2003
+ 'accessRequestConfig'?: RequestabilityForRole;
2004
+ /**
2005
+ *
2006
+ * @type {RevocabilityForRole}
2007
+ * @memberof RoleV2
2008
+ */
2009
+ 'revocationRequestConfig'?: RevocabilityForRole;
2010
+ /**
2011
+ * List of IDs of segments, if any, to which this Role is assigned.
2012
+ * @type {Array<string>}
2013
+ * @memberof RoleV2
2014
+ */
2015
+ 'segments'?: Array<string> | null;
2016
+ /**
2017
+ * Whether the Role is dimensional.
2018
+ * @type {boolean}
2019
+ * @memberof RoleV2
2020
+ */
2021
+ 'dimensional'?: boolean | null;
2022
+ /**
2023
+ * List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional.
2024
+ * @type {Array<DimensionRef>}
2025
+ * @memberof RoleV2
2026
+ */
2027
+ 'dimensionRefs'?: Array<DimensionRef> | null;
2028
+ /**
2029
+ *
2030
+ * @type {AttributeDTOList}
2031
+ * @memberof RoleV2
2032
+ */
2033
+ 'accessModelMetadata'?: AttributeDTOList;
2034
+ /**
2035
+ *
2036
+ * @type {RolePrivilegeLevel}
2037
+ * @memberof RoleV2
2038
+ */
2039
+ 'privilegeLevel'?: RolePrivilegeLevel | null;
2040
+ }
2041
+ /**
2042
+ * Request body for filtering roles by metadata and filter expression, including privilegeLevel.effective.
2043
+ * @export
2044
+ * @interface Rolelistfilterdtov2
2045
+ */
2046
+ export interface Rolelistfilterdtov2 {
2047
+ /**
2048
+ * Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw, co* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **type**: *eq, in* **owner.id**: *eq, in* **additionalOwners.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, sw, co* **accessProfile.id**: *eq, in* **accessProfile.name**: *eq, sw, co* **privilegeLevel.effective**: *eq, in* Supported composite operators are *and, or*
2049
+ * @type {string}
2050
+ * @memberof Rolelistfilterdtov2
2051
+ */
2052
+ 'filters'?: string;
2053
+ /**
2054
+ *
2055
+ * @type {Array<Rolelistfilterdtov2AmmKeyValuesInner>}
2056
+ * @memberof Rolelistfilterdtov2
2057
+ */
2058
+ 'ammKeyValues'?: Array<Rolelistfilterdtov2AmmKeyValuesInner>;
2059
+ }
2060
+ /**
2061
+ *
2062
+ * @export
2063
+ * @interface Rolelistfilterdtov2AmmKeyValuesInner
2064
+ */
2065
+ export interface Rolelistfilterdtov2AmmKeyValuesInner {
2066
+ /**
2067
+ * attribute key of a metadata. A blank value is rejected with a 400 error.
2068
+ * @type {string}
2069
+ * @memberof Rolelistfilterdtov2AmmKeyValuesInner
2070
+ */
2071
+ 'attribute': string;
2072
+ /**
2073
+ * A list of attribute key names to filter roles. If the values is empty, will only filter by attribute key.
2074
+ * @type {Array<string>}
2075
+ * @memberof Rolelistfilterdtov2AmmKeyValuesInner
2076
+ */
2077
+ 'values'?: Array<string>;
2078
+ }
2079
+ /**
2080
+ * Task result.
2081
+ * @export
2082
+ * @interface TaskResultDto
2083
+ */
2084
+ export interface TaskResultDto {
2085
+ /**
2086
+ * Task result DTO type.
2087
+ * @type {string}
2088
+ * @memberof TaskResultDto
2089
+ */
2090
+ 'type'?: TaskResultDtoTypeEnum;
2091
+ /**
2092
+ * Task result ID.
2093
+ * @type {string}
2094
+ * @memberof TaskResultDto
2095
+ */
2096
+ 'id'?: string;
2097
+ /**
2098
+ * Task result display name.
2099
+ * @type {string}
2100
+ * @memberof TaskResultDto
2101
+ */
2102
+ 'name'?: string | null;
2103
+ }
2104
+ export declare const TaskResultDtoTypeEnum: {
2105
+ readonly TaskResult: "TASK_RESULT";
2106
+ };
2107
+ export type TaskResultDtoTypeEnum = typeof TaskResultDtoTypeEnum[keyof typeof TaskResultDtoTypeEnum];
2108
+ /**
2109
+ * RolesApi - axios parameter creator
2110
+ * @export
2111
+ */
2112
+ export declare const RolesApiAxiosParamCreator: (configuration?: Configuration) => {
2113
+ /**
2114
+ * This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.
2115
+ * @summary Create a role
2116
+ * @param {Role} role
2117
+ * @param {*} [axiosOptions] Override http request option.
2118
+ * @throws {RequiredError}
2119
+ */
2120
+ createRoleV1: (role: Role, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2121
+ /**
2122
+ * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
2123
+ * @summary Delete role(s)
2124
+ * @param {RoleBulkDeleteRequest} roleBulkDeleteRequest
2125
+ * @param {*} [axiosOptions] Override http request option.
2126
+ * @throws {RequiredError}
2127
+ */
2128
+ deleteBulkRolesV1: (roleBulkDeleteRequest: RoleBulkDeleteRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2129
+ /**
2130
+ * This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API.
2131
+ * @summary Remove a metadata from role.
2132
+ * @param {string} id The role\&#39;s id.
2133
+ * @param {string} attributeKey Technical name of the Attribute.
2134
+ * @param {string} attributeValue Technical name of the Attribute Value.
2135
+ * @param {*} [axiosOptions] Override http request option.
2136
+ * @throws {RequiredError}
2137
+ */
2138
+ deleteMetadataFromRoleByKeyAndValueV1: (id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2139
+ /**
2140
+ * This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
2141
+ * @summary Delete a role
2142
+ * @param {string} id ID of the Role
2143
+ * @param {*} [axiosOptions] Override http request option.
2144
+ * @throws {RequiredError}
2145
+ */
2146
+ deleteRoleV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2147
+ /**
2148
+ * This API initial a request for one bulk update\'s status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API.
2149
+ * @summary Get bulk-update status by id
2150
+ * @param {string} id The Id of the bulk update task.
1683
2151
  * @param {*} [axiosOptions] Override http request option.
1684
2152
  * @throws {RequiredError}
1685
2153
  */
@@ -1717,6 +2185,24 @@ export declare const RolesApiAxiosParamCreator: (configuration?: Configuration)
1717
2185
  * @throws {RequiredError}
1718
2186
  */
1719
2187
  getRoleEntitlementsV1: (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2188
+ /**
2189
+ * Get a list of entitlements assigned directly to a specified Role. Each entitlement includes its privilege level in `privilegeLevel`, with the direct, inherited, and effective levels. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000.
2190
+ * @summary List role\'s entitlements
2191
+ * @param {string} id Containing role\&#39;s ID.
2192
+ * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
2193
+ * @param {number} [limit] Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
2194
+ * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 or omitted when *cursor* is specified. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
2195
+ * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
2196
+ * @param {string} [cursor] Opaque cursor returned in the &#x60;x-next-cursor&#x60; response header of the previous page. Pass it with the same &#x60;sorters&#x60; to get the next page of results. Can\&#39;t be used with an *offset* greater than 0.
2197
+ * @param {string} [filters] Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw, co* **attribute**: *eq, sw, co* **value**: *eq, sw, co* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **privilegeLevel.effective**: *eq, in*
2198
+ * @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, attribute, value, created, modified, privilegeLevel.effective** The default sort is **created**. **id** is always added as the final sort field so that cursor pagination is stable.
2199
+ * @param {string} [forSegmentIds] If present and not empty, filters entitlements to those assigned to the segment(s) with the specified IDs. Can\&#39;t be used with *segmented-for-identity*.
2200
+ * @param {string} [segmentedForIdentity] If present, filters entitlements to those in the segments visible to the specified identity. The value must be the calling identity\&#39;s ID or the special value **me**. Can\&#39;t be used with *for-segment-ids*.
2201
+ * @param {boolean} [includeUnsegmented] Whether the response list should contain unsegmented entitlements. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
2202
+ * @param {*} [axiosOptions] Override http request option.
2203
+ * @throws {RequiredError}
2204
+ */
2205
+ getRoleEntitlementsV2: (id: string, xSailPointExperimental?: string, limit?: number, offset?: number, count?: boolean, cursor?: string, filters?: string, sorters?: string, forSegmentIds?: string, segmentedForIdentity?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1720
2206
  /**
1721
2207
  * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
1722
2208
  * @summary Get a role
@@ -1725,6 +2211,15 @@ export declare const RolesApiAxiosParamCreator: (configuration?: Configuration)
1725
2211
  * @throws {RequiredError}
1726
2212
  */
1727
2213
  getRoleV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2214
+ /**
2215
+ * This API returns a Role by its ID. The response includes the Role\'s effective privilege level in `privilegeLevel.effective`, which is the highest effective privilege level among the entitlements assigned directly to the Role and the entitlements included in the Role\'s access profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
2216
+ * @summary Get a role
2217
+ * @param {string} id ID of the Role
2218
+ * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
2219
+ * @param {*} [axiosOptions] Override http request option.
2220
+ * @throws {RequiredError}
2221
+ */
2222
+ getRoleV2: (id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1728
2223
  /**
1729
2224
  * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
1730
2225
  * @summary List roles
@@ -1740,6 +2235,23 @@ export declare const RolesApiAxiosParamCreator: (configuration?: Configuration)
1740
2235
  * @throws {RequiredError}
1741
2236
  */
1742
2237
  listRolesV1: (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2238
+ /**
2239
+ * This API returns a list of Roles. Each Role includes its effective privilege level in `privilegeLevel.effective`, which is the highest effective privilege level among the entitlements assigned directly to the Role and the entitlements included in the Role\'s access profiles. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. Send that value in the `cursor` query parameter, with the same `sorters`, to get the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000. Use cursor pagination to page beyond 10,000 results. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
2240
+ * @summary List roles
2241
+ * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
2242
+ * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\&#39;s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.
2243
+ * @param {number} [limit] Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
2244
+ * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 or omitted when *cursor* is specified. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
2245
+ * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
2246
+ * @param {string} [cursor] Opaque cursor returned in the &#x60;x-next-cursor&#x60; response header of the previous page. Pass it with the same &#x60;sorters&#x60; to get the next page of results. Can\&#39;t be used with an *offset* greater than 0.
2247
+ * @param {string} [filters] Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw, co* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **type**: *eq, in* **owner.id**: *eq, in* **additionalOwners.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, sw, co* **accessProfile.id**: *eq, in* **accessProfile.name**: *eq, sw, co* **privilegeLevel.effective**: *eq, in* Supported composite operators are *and, or*
2248
+ * @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, privilegeLevel.effective** The default sort is **name**. **id** is always added as the final sort field so that cursor pagination is stable.
2249
+ * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
2250
+ * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
2251
+ * @param {*} [axiosOptions] Override http request option.
2252
+ * @throws {RequiredError}
2253
+ */
2254
+ listRolesV2: (xSailPointExperimental?: string, forSubadmin?: string, limit?: number, offset?: number, count?: boolean, cursor?: string, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1743
2255
  /**
1744
2256
  * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
1745
2257
  * @summary Patch a specified role
@@ -1764,6 +2276,23 @@ export declare const RolesApiAxiosParamCreator: (configuration?: Configuration)
1764
2276
  * @throws {RequiredError}
1765
2277
  */
1766
2278
  searchRolesByFilterV1: (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, roleListFilterDTO?: RoleListFilterDTO, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2279
+ /**
2280
+ * This API returns a list of Roles filtered by Access Model Metadata and by filter expression. Filtering is supported by filter expression, by metadata attribute key and values, or by both together. Each Role includes its effective privilege level in `privilegeLevel.effective`. The `filters` expression in the request body supports the same fields and operators as the `filters` query parameter of [List roles](#operation/listRolesV2), including **privilegeLevel.effective**: *eq, in*. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. Send that value in the `cursor` query parameter, with the same request body and `sorters`, to get the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000.
2281
+ * @summary Filter roles by metadata
2282
+ * @param {Rolelistfilterdtov2} rolelistfilterdtov2
2283
+ * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
2284
+ * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\&#39;s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.
2285
+ * @param {number} [limit] Max number of results to return See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
2286
+ * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 or omitted when *cursor* is specified. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
2287
+ * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
2288
+ * @param {string} [cursor] Opaque cursor returned in the &#x60;x-next-cursor&#x60; response header of the previous page. Pass it with the same request body and &#x60;sorters&#x60; to get the next page of results. Can\&#39;t be used with an *offset* greater than 0.
2289
+ * @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, privilegeLevel.effective** The default sort is **name**. **id** is always added as the final sort field so that cursor pagination is stable.
2290
+ * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
2291
+ * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
2292
+ * @param {*} [axiosOptions] Override http request option.
2293
+ * @throws {RequiredError}
2294
+ */
2295
+ searchRolesByFilterV2: (rolelistfilterdtov2: Rolelistfilterdtov2, xSailPointExperimental?: string, forSubadmin?: string, limit?: number, offset?: number, count?: boolean, cursor?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1767
2296
  /**
1768
2297
  * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed.
1769
2298
  * @summary Add a metadata to role.
@@ -1879,6 +2408,24 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
1879
2408
  * @throws {RequiredError}
1880
2409
  */
1881
2410
  getRoleEntitlementsV1(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Entitlement>>>;
2411
+ /**
2412
+ * Get a list of entitlements assigned directly to a specified Role. Each entitlement includes its privilege level in `privilegeLevel`, with the direct, inherited, and effective levels. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000.
2413
+ * @summary List role\'s entitlements
2414
+ * @param {string} id Containing role\&#39;s ID.
2415
+ * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
2416
+ * @param {number} [limit] Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
2417
+ * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 or omitted when *cursor* is specified. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
2418
+ * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
2419
+ * @param {string} [cursor] Opaque cursor returned in the &#x60;x-next-cursor&#x60; response header of the previous page. Pass it with the same &#x60;sorters&#x60; to get the next page of results. Can\&#39;t be used with an *offset* greater than 0.
2420
+ * @param {string} [filters] Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw, co* **attribute**: *eq, sw, co* **value**: *eq, sw, co* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **privilegeLevel.effective**: *eq, in*
2421
+ * @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, attribute, value, created, modified, privilegeLevel.effective** The default sort is **created**. **id** is always added as the final sort field so that cursor pagination is stable.
2422
+ * @param {string} [forSegmentIds] If present and not empty, filters entitlements to those assigned to the segment(s) with the specified IDs. Can\&#39;t be used with *segmented-for-identity*.
2423
+ * @param {string} [segmentedForIdentity] If present, filters entitlements to those in the segments visible to the specified identity. The value must be the calling identity\&#39;s ID or the special value **me**. Can\&#39;t be used with *for-segment-ids*.
2424
+ * @param {boolean} [includeUnsegmented] Whether the response list should contain unsegmented entitlements. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
2425
+ * @param {*} [axiosOptions] Override http request option.
2426
+ * @throws {RequiredError}
2427
+ */
2428
+ getRoleEntitlementsV2(id: string, xSailPointExperimental?: string, limit?: number, offset?: number, count?: boolean, cursor?: string, filters?: string, sorters?: string, forSegmentIds?: string, segmentedForIdentity?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EntitlementV2>>>;
1882
2429
  /**
1883
2430
  * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
1884
2431
  * @summary Get a role
@@ -1887,6 +2434,15 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
1887
2434
  * @throws {RequiredError}
1888
2435
  */
1889
2436
  getRoleV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Role>>;
2437
+ /**
2438
+ * This API returns a Role by its ID. The response includes the Role\'s effective privilege level in `privilegeLevel.effective`, which is the highest effective privilege level among the entitlements assigned directly to the Role and the entitlements included in the Role\'s access profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
2439
+ * @summary Get a role
2440
+ * @param {string} id ID of the Role
2441
+ * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
2442
+ * @param {*} [axiosOptions] Override http request option.
2443
+ * @throws {RequiredError}
2444
+ */
2445
+ getRoleV2(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RoleV2>>;
1890
2446
  /**
1891
2447
  * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
1892
2448
  * @summary List roles
@@ -1902,6 +2458,23 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
1902
2458
  * @throws {RequiredError}
1903
2459
  */
1904
2460
  listRolesV1(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Role>>>;
2461
+ /**
2462
+ * This API returns a list of Roles. Each Role includes its effective privilege level in `privilegeLevel.effective`, which is the highest effective privilege level among the entitlements assigned directly to the Role and the entitlements included in the Role\'s access profiles. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. Send that value in the `cursor` query parameter, with the same `sorters`, to get the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000. Use cursor pagination to page beyond 10,000 results. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
2463
+ * @summary List roles
2464
+ * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
2465
+ * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\&#39;s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.
2466
+ * @param {number} [limit] Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
2467
+ * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 or omitted when *cursor* is specified. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
2468
+ * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
2469
+ * @param {string} [cursor] Opaque cursor returned in the &#x60;x-next-cursor&#x60; response header of the previous page. Pass it with the same &#x60;sorters&#x60; to get the next page of results. Can\&#39;t be used with an *offset* greater than 0.
2470
+ * @param {string} [filters] Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw, co* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **type**: *eq, in* **owner.id**: *eq, in* **additionalOwners.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, sw, co* **accessProfile.id**: *eq, in* **accessProfile.name**: *eq, sw, co* **privilegeLevel.effective**: *eq, in* Supported composite operators are *and, or*
2471
+ * @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, privilegeLevel.effective** The default sort is **name**. **id** is always added as the final sort field so that cursor pagination is stable.
2472
+ * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
2473
+ * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
2474
+ * @param {*} [axiosOptions] Override http request option.
2475
+ * @throws {RequiredError}
2476
+ */
2477
+ listRolesV2(xSailPointExperimental?: string, forSubadmin?: string, limit?: number, offset?: number, count?: boolean, cursor?: string, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RoleV2>>>;
1905
2478
  /**
1906
2479
  * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
1907
2480
  * @summary Patch a specified role
@@ -1926,6 +2499,23 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
1926
2499
  * @throws {RequiredError}
1927
2500
  */
1928
2501
  searchRolesByFilterV1(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, roleListFilterDTO?: RoleListFilterDTO, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Role>>>;
2502
+ /**
2503
+ * This API returns a list of Roles filtered by Access Model Metadata and by filter expression. Filtering is supported by filter expression, by metadata attribute key and values, or by both together. Each Role includes its effective privilege level in `privilegeLevel.effective`. The `filters` expression in the request body supports the same fields and operators as the `filters` query parameter of [List roles](#operation/listRolesV2), including **privilegeLevel.effective**: *eq, in*. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. Send that value in the `cursor` query parameter, with the same request body and `sorters`, to get the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000.
2504
+ * @summary Filter roles by metadata
2505
+ * @param {Rolelistfilterdtov2} rolelistfilterdtov2
2506
+ * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
2507
+ * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\&#39;s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.
2508
+ * @param {number} [limit] Max number of results to return See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
2509
+ * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 or omitted when *cursor* is specified. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
2510
+ * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
2511
+ * @param {string} [cursor] Opaque cursor returned in the &#x60;x-next-cursor&#x60; response header of the previous page. Pass it with the same request body and &#x60;sorters&#x60; to get the next page of results. Can\&#39;t be used with an *offset* greater than 0.
2512
+ * @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, privilegeLevel.effective** The default sort is **name**. **id** is always added as the final sort field so that cursor pagination is stable.
2513
+ * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
2514
+ * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
2515
+ * @param {*} [axiosOptions] Override http request option.
2516
+ * @throws {RequiredError}
2517
+ */
2518
+ searchRolesByFilterV2(rolelistfilterdtov2: Rolelistfilterdtov2, xSailPointExperimental?: string, forSubadmin?: string, limit?: number, offset?: number, count?: boolean, cursor?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RoleV2>>>;
1929
2519
  /**
1930
2520
  * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed.
1931
2521
  * @summary Add a metadata to role.
@@ -2029,6 +2619,14 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
2029
2619
  * @throws {RequiredError}
2030
2620
  */
2031
2621
  getRoleEntitlementsV1(requestParameters: RolesApiGetRoleEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Entitlement>>;
2622
+ /**
2623
+ * Get a list of entitlements assigned directly to a specified Role. Each entitlement includes its privilege level in `privilegeLevel`, with the direct, inherited, and effective levels. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000.
2624
+ * @summary List role\'s entitlements
2625
+ * @param {RolesApiGetRoleEntitlementsV2Request} requestParameters Request parameters.
2626
+ * @param {*} [axiosOptions] Override http request option.
2627
+ * @throws {RequiredError}
2628
+ */
2629
+ getRoleEntitlementsV2(requestParameters: RolesApiGetRoleEntitlementsV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<EntitlementV2>>;
2032
2630
  /**
2033
2631
  * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
2034
2632
  * @summary Get a role
@@ -2037,6 +2635,14 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
2037
2635
  * @throws {RequiredError}
2038
2636
  */
2039
2637
  getRoleV1(requestParameters: RolesApiGetRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Role>;
2638
+ /**
2639
+ * This API returns a Role by its ID. The response includes the Role\'s effective privilege level in `privilegeLevel.effective`, which is the highest effective privilege level among the entitlements assigned directly to the Role and the entitlements included in the Role\'s access profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
2640
+ * @summary Get a role
2641
+ * @param {RolesApiGetRoleV2Request} requestParameters Request parameters.
2642
+ * @param {*} [axiosOptions] Override http request option.
2643
+ * @throws {RequiredError}
2644
+ */
2645
+ getRoleV2(requestParameters: RolesApiGetRoleV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<RoleV2>;
2040
2646
  /**
2041
2647
  * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
2042
2648
  * @summary List roles
@@ -2045,6 +2651,14 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
2045
2651
  * @throws {RequiredError}
2046
2652
  */
2047
2653
  listRolesV1(requestParameters?: RolesApiListRolesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Role>>;
2654
+ /**
2655
+ * This API returns a list of Roles. Each Role includes its effective privilege level in `privilegeLevel.effective`, which is the highest effective privilege level among the entitlements assigned directly to the Role and the entitlements included in the Role\'s access profiles. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. Send that value in the `cursor` query parameter, with the same `sorters`, to get the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000. Use cursor pagination to page beyond 10,000 results. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
2656
+ * @summary List roles
2657
+ * @param {RolesApiListRolesV2Request} requestParameters Request parameters.
2658
+ * @param {*} [axiosOptions] Override http request option.
2659
+ * @throws {RequiredError}
2660
+ */
2661
+ listRolesV2(requestParameters?: RolesApiListRolesV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<RoleV2>>;
2048
2662
  /**
2049
2663
  * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
2050
2664
  * @summary Patch a specified role
@@ -2061,6 +2675,14 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
2061
2675
  * @throws {RequiredError}
2062
2676
  */
2063
2677
  searchRolesByFilterV1(requestParameters?: RolesApiSearchRolesByFilterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Role>>;
2678
+ /**
2679
+ * This API returns a list of Roles filtered by Access Model Metadata and by filter expression. Filtering is supported by filter expression, by metadata attribute key and values, or by both together. Each Role includes its effective privilege level in `privilegeLevel.effective`. The `filters` expression in the request body supports the same fields and operators as the `filters` query parameter of [List roles](#operation/listRolesV2), including **privilegeLevel.effective**: *eq, in*. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. Send that value in the `cursor` query parameter, with the same request body and `sorters`, to get the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000.
2680
+ * @summary Filter roles by metadata
2681
+ * @param {RolesApiSearchRolesByFilterV2Request} requestParameters Request parameters.
2682
+ * @param {*} [axiosOptions] Override http request option.
2683
+ * @throws {RequiredError}
2684
+ */
2685
+ searchRolesByFilterV2(requestParameters: RolesApiSearchRolesByFilterV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<RoleV2>>;
2064
2686
  /**
2065
2687
  * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed.
2066
2688
  * @summary Add a metadata to role.
@@ -2257,6 +2879,79 @@ export interface RolesApiGetRoleEntitlementsV1Request {
2257
2879
  */
2258
2880
  readonly sorters?: string;
2259
2881
  }
2882
+ /**
2883
+ * Request parameters for getRoleEntitlementsV2 operation in RolesApi.
2884
+ * @export
2885
+ * @interface RolesApiGetRoleEntitlementsV2Request
2886
+ */
2887
+ export interface RolesApiGetRoleEntitlementsV2Request {
2888
+ /**
2889
+ * Containing role\&#39;s ID.
2890
+ * @type {string}
2891
+ * @memberof RolesApiGetRoleEntitlementsV2
2892
+ */
2893
+ readonly id: string;
2894
+ /**
2895
+ * Use this header to enable this experimental API.
2896
+ * @type {string}
2897
+ * @memberof RolesApiGetRoleEntitlementsV2
2898
+ */
2899
+ readonly xSailPointExperimental?: string;
2900
+ /**
2901
+ * Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
2902
+ * @type {number}
2903
+ * @memberof RolesApiGetRoleEntitlementsV2
2904
+ */
2905
+ readonly limit?: number;
2906
+ /**
2907
+ * Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 or omitted when *cursor* is specified. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
2908
+ * @type {number}
2909
+ * @memberof RolesApiGetRoleEntitlementsV2
2910
+ */
2911
+ readonly offset?: number;
2912
+ /**
2913
+ * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
2914
+ * @type {boolean}
2915
+ * @memberof RolesApiGetRoleEntitlementsV2
2916
+ */
2917
+ readonly count?: boolean;
2918
+ /**
2919
+ * Opaque cursor returned in the &#x60;x-next-cursor&#x60; response header of the previous page. Pass it with the same &#x60;sorters&#x60; to get the next page of results. Can\&#39;t be used with an *offset* greater than 0.
2920
+ * @type {string}
2921
+ * @memberof RolesApiGetRoleEntitlementsV2
2922
+ */
2923
+ readonly cursor?: string;
2924
+ /**
2925
+ * Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw, co* **attribute**: *eq, sw, co* **value**: *eq, sw, co* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **privilegeLevel.effective**: *eq, in*
2926
+ * @type {string}
2927
+ * @memberof RolesApiGetRoleEntitlementsV2
2928
+ */
2929
+ readonly filters?: string;
2930
+ /**
2931
+ * Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, attribute, value, created, modified, privilegeLevel.effective** The default sort is **created**. **id** is always added as the final sort field so that cursor pagination is stable.
2932
+ * @type {string}
2933
+ * @memberof RolesApiGetRoleEntitlementsV2
2934
+ */
2935
+ readonly sorters?: string;
2936
+ /**
2937
+ * If present and not empty, filters entitlements to those assigned to the segment(s) with the specified IDs. Can\&#39;t be used with *segmented-for-identity*.
2938
+ * @type {string}
2939
+ * @memberof RolesApiGetRoleEntitlementsV2
2940
+ */
2941
+ readonly forSegmentIds?: string;
2942
+ /**
2943
+ * If present, filters entitlements to those in the segments visible to the specified identity. The value must be the calling identity\&#39;s ID or the special value **me**. Can\&#39;t be used with *for-segment-ids*.
2944
+ * @type {string}
2945
+ * @memberof RolesApiGetRoleEntitlementsV2
2946
+ */
2947
+ readonly segmentedForIdentity?: string;
2948
+ /**
2949
+ * Whether the response list should contain unsegmented entitlements. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
2950
+ * @type {boolean}
2951
+ * @memberof RolesApiGetRoleEntitlementsV2
2952
+ */
2953
+ readonly includeUnsegmented?: boolean;
2954
+ }
2260
2955
  /**
2261
2956
  * Request parameters for getRoleV1 operation in RolesApi.
2262
2957
  * @export
@@ -2270,6 +2965,25 @@ export interface RolesApiGetRoleV1Request {
2270
2965
  */
2271
2966
  readonly id: string;
2272
2967
  }
2968
+ /**
2969
+ * Request parameters for getRoleV2 operation in RolesApi.
2970
+ * @export
2971
+ * @interface RolesApiGetRoleV2Request
2972
+ */
2973
+ export interface RolesApiGetRoleV2Request {
2974
+ /**
2975
+ * ID of the Role
2976
+ * @type {string}
2977
+ * @memberof RolesApiGetRoleV2
2978
+ */
2979
+ readonly id: string;
2980
+ /**
2981
+ * Use this header to enable this experimental API.
2982
+ * @type {string}
2983
+ * @memberof RolesApiGetRoleV2
2984
+ */
2985
+ readonly xSailPointExperimental?: string;
2986
+ }
2273
2987
  /**
2274
2988
  * Request parameters for listRolesV1 operation in RolesApi.
2275
2989
  * @export
@@ -2325,6 +3039,73 @@ export interface RolesApiListRolesV1Request {
2325
3039
  */
2326
3040
  readonly includeUnsegmented?: boolean;
2327
3041
  }
3042
+ /**
3043
+ * Request parameters for listRolesV2 operation in RolesApi.
3044
+ * @export
3045
+ * @interface RolesApiListRolesV2Request
3046
+ */
3047
+ export interface RolesApiListRolesV2Request {
3048
+ /**
3049
+ * Use this header to enable this experimental API.
3050
+ * @type {string}
3051
+ * @memberof RolesApiListRolesV2
3052
+ */
3053
+ readonly xSailPointExperimental?: string;
3054
+ /**
3055
+ * If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\&#39;s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.
3056
+ * @type {string}
3057
+ * @memberof RolesApiListRolesV2
3058
+ */
3059
+ readonly forSubadmin?: string;
3060
+ /**
3061
+ * Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
3062
+ * @type {number}
3063
+ * @memberof RolesApiListRolesV2
3064
+ */
3065
+ readonly limit?: number;
3066
+ /**
3067
+ * Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 or omitted when *cursor* is specified. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
3068
+ * @type {number}
3069
+ * @memberof RolesApiListRolesV2
3070
+ */
3071
+ readonly offset?: number;
3072
+ /**
3073
+ * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
3074
+ * @type {boolean}
3075
+ * @memberof RolesApiListRolesV2
3076
+ */
3077
+ readonly count?: boolean;
3078
+ /**
3079
+ * Opaque cursor returned in the &#x60;x-next-cursor&#x60; response header of the previous page. Pass it with the same &#x60;sorters&#x60; to get the next page of results. Can\&#39;t be used with an *offset* greater than 0.
3080
+ * @type {string}
3081
+ * @memberof RolesApiListRolesV2
3082
+ */
3083
+ readonly cursor?: string;
3084
+ /**
3085
+ * Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw, co* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **type**: *eq, in* **owner.id**: *eq, in* **additionalOwners.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, sw, co* **accessProfile.id**: *eq, in* **accessProfile.name**: *eq, sw, co* **privilegeLevel.effective**: *eq, in* Supported composite operators are *and, or*
3086
+ * @type {string}
3087
+ * @memberof RolesApiListRolesV2
3088
+ */
3089
+ readonly filters?: string;
3090
+ /**
3091
+ * Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, privilegeLevel.effective** The default sort is **name**. **id** is always added as the final sort field so that cursor pagination is stable.
3092
+ * @type {string}
3093
+ * @memberof RolesApiListRolesV2
3094
+ */
3095
+ readonly sorters?: string;
3096
+ /**
3097
+ * If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
3098
+ * @type {string}
3099
+ * @memberof RolesApiListRolesV2
3100
+ */
3101
+ readonly forSegmentIds?: string;
3102
+ /**
3103
+ * Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
3104
+ * @type {boolean}
3105
+ * @memberof RolesApiListRolesV2
3106
+ */
3107
+ readonly includeUnsegmented?: boolean;
3108
+ }
2328
3109
  /**
2329
3110
  * Request parameters for patchRoleV1 operation in RolesApi.
2330
3111
  * @export
@@ -2399,6 +3180,73 @@ export interface RolesApiSearchRolesByFilterV1Request {
2399
3180
  */
2400
3181
  readonly roleListFilterDTO?: RoleListFilterDTO;
2401
3182
  }
3183
+ /**
3184
+ * Request parameters for searchRolesByFilterV2 operation in RolesApi.
3185
+ * @export
3186
+ * @interface RolesApiSearchRolesByFilterV2Request
3187
+ */
3188
+ export interface RolesApiSearchRolesByFilterV2Request {
3189
+ /**
3190
+ *
3191
+ * @type {Rolelistfilterdtov2}
3192
+ * @memberof RolesApiSearchRolesByFilterV2
3193
+ */
3194
+ readonly rolelistfilterdtov2: Rolelistfilterdtov2;
3195
+ /**
3196
+ * Use this header to enable this experimental API.
3197
+ * @type {string}
3198
+ * @memberof RolesApiSearchRolesByFilterV2
3199
+ */
3200
+ readonly xSailPointExperimental?: string;
3201
+ /**
3202
+ * If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\&#39;s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.
3203
+ * @type {string}
3204
+ * @memberof RolesApiSearchRolesByFilterV2
3205
+ */
3206
+ readonly forSubadmin?: string;
3207
+ /**
3208
+ * Max number of results to return See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
3209
+ * @type {number}
3210
+ * @memberof RolesApiSearchRolesByFilterV2
3211
+ */
3212
+ readonly limit?: number;
3213
+ /**
3214
+ * Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 or omitted when *cursor* is specified. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
3215
+ * @type {number}
3216
+ * @memberof RolesApiSearchRolesByFilterV2
3217
+ */
3218
+ readonly offset?: number;
3219
+ /**
3220
+ * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
3221
+ * @type {boolean}
3222
+ * @memberof RolesApiSearchRolesByFilterV2
3223
+ */
3224
+ readonly count?: boolean;
3225
+ /**
3226
+ * Opaque cursor returned in the &#x60;x-next-cursor&#x60; response header of the previous page. Pass it with the same request body and &#x60;sorters&#x60; to get the next page of results. Can\&#39;t be used with an *offset* greater than 0.
3227
+ * @type {string}
3228
+ * @memberof RolesApiSearchRolesByFilterV2
3229
+ */
3230
+ readonly cursor?: string;
3231
+ /**
3232
+ * Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, privilegeLevel.effective** The default sort is **name**. **id** is always added as the final sort field so that cursor pagination is stable.
3233
+ * @type {string}
3234
+ * @memberof RolesApiSearchRolesByFilterV2
3235
+ */
3236
+ readonly sorters?: string;
3237
+ /**
3238
+ * If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
3239
+ * @type {string}
3240
+ * @memberof RolesApiSearchRolesByFilterV2
3241
+ */
3242
+ readonly forSegmentIds?: string;
3243
+ /**
3244
+ * Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
3245
+ * @type {boolean}
3246
+ * @memberof RolesApiSearchRolesByFilterV2
3247
+ */
3248
+ readonly includeUnsegmented?: boolean;
3249
+ }
2402
3250
  /**
2403
3251
  * Request parameters for updateAttributeKeyAndValueToRoleV1 operation in RolesApi.
2404
3252
  * @export
@@ -2541,6 +3389,15 @@ export declare class RolesApi extends BaseAPI {
2541
3389
  * @memberof RolesApi
2542
3390
  */
2543
3391
  getRoleEntitlementsV1(requestParameters: RolesApiGetRoleEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Entitlement[], any>>;
3392
+ /**
3393
+ * Get a list of entitlements assigned directly to a specified Role. Each entitlement includes its privilege level in `privilegeLevel`, with the direct, inherited, and effective levels. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000.
3394
+ * @summary List role\'s entitlements
3395
+ * @param {RolesApiGetRoleEntitlementsV2Request} requestParameters Request parameters.
3396
+ * @param {*} [axiosOptions] Override http request option.
3397
+ * @throws {RequiredError}
3398
+ * @memberof RolesApi
3399
+ */
3400
+ getRoleEntitlementsV2(requestParameters: RolesApiGetRoleEntitlementsV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementV2[], any>>;
2544
3401
  /**
2545
3402
  * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
2546
3403
  * @summary Get a role
@@ -2550,6 +3407,15 @@ export declare class RolesApi extends BaseAPI {
2550
3407
  * @memberof RolesApi
2551
3408
  */
2552
3409
  getRoleV1(requestParameters: RolesApiGetRoleV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Role, any>>;
3410
+ /**
3411
+ * This API returns a Role by its ID. The response includes the Role\'s effective privilege level in `privilegeLevel.effective`, which is the highest effective privilege level among the entitlements assigned directly to the Role and the entitlements included in the Role\'s access profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
3412
+ * @summary Get a role
3413
+ * @param {RolesApiGetRoleV2Request} requestParameters Request parameters.
3414
+ * @param {*} [axiosOptions] Override http request option.
3415
+ * @throws {RequiredError}
3416
+ * @memberof RolesApi
3417
+ */
3418
+ getRoleV2(requestParameters: RolesApiGetRoleV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RoleV2, any>>;
2553
3419
  /**
2554
3420
  * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
2555
3421
  * @summary List roles
@@ -2559,6 +3425,15 @@ export declare class RolesApi extends BaseAPI {
2559
3425
  * @memberof RolesApi
2560
3426
  */
2561
3427
  listRolesV1(requestParameters?: RolesApiListRolesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Role[], any>>;
3428
+ /**
3429
+ * This API returns a list of Roles. Each Role includes its effective privilege level in `privilegeLevel.effective`, which is the highest effective privilege level among the entitlements assigned directly to the Role and the entitlements included in the Role\'s access profiles. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. Send that value in the `cursor` query parameter, with the same `sorters`, to get the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000. Use cursor pagination to page beyond 10,000 results. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
3430
+ * @summary List roles
3431
+ * @param {RolesApiListRolesV2Request} requestParameters Request parameters.
3432
+ * @param {*} [axiosOptions] Override http request option.
3433
+ * @throws {RequiredError}
3434
+ * @memberof RolesApi
3435
+ */
3436
+ listRolesV2(requestParameters?: RolesApiListRolesV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RoleV2[], any>>;
2562
3437
  /**
2563
3438
  * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
2564
3439
  * @summary Patch a specified role
@@ -2577,6 +3452,15 @@ export declare class RolesApi extends BaseAPI {
2577
3452
  * @memberof RolesApi
2578
3453
  */
2579
3454
  searchRolesByFilterV1(requestParameters?: RolesApiSearchRolesByFilterV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Role[], any>>;
3455
+ /**
3456
+ * This API returns a list of Roles filtered by Access Model Metadata and by filter expression. Filtering is supported by filter expression, by metadata attribute key and values, or by both together. Each Role includes its effective privilege level in `privilegeLevel.effective`. The `filters` expression in the request body supports the same fields and operators as the `filters` query parameter of [List roles](#operation/listRolesV2), including **privilegeLevel.effective**: *eq, in*. Use either offset pagination (`offset` and `limit`) or cursor pagination (`cursor` and `limit`). When more results are available, the `x-next-cursor` response header contains the cursor for the next page. Send that value in the `cursor` query parameter, with the same request body and `sorters`, to get the next page. You can\'t use `cursor` together with an `offset` greater than 0, and `offset` plus `limit` can\'t be greater than 10,000.
3457
+ * @summary Filter roles by metadata
3458
+ * @param {RolesApiSearchRolesByFilterV2Request} requestParameters Request parameters.
3459
+ * @param {*} [axiosOptions] Override http request option.
3460
+ * @throws {RequiredError}
3461
+ * @memberof RolesApi
3462
+ */
3463
+ searchRolesByFilterV2(requestParameters: RolesApiSearchRolesByFilterV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RoleV2[], any>>;
2580
3464
  /**
2581
3465
  * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed.
2582
3466
  * @summary Add a metadata to role.