sailpoint-api-client 1.6.4 → 1.6.6
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.
- package/beta/README.md +2 -2
- package/beta/api.ts +424 -250
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/dist/beta/api.d.ts +337 -178
- package/dist/beta/api.js +345 -201
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/common.js +1 -1
- package/dist/v2024/api.d.ts +69 -118
- package/dist/v2024/api.js +75 -151
- package/dist/v2024/api.js.map +1 -1
- package/dist/v2024/common.js +1 -1
- package/dist/v2025/api.d.ts +123 -146
- package/dist/v2025/api.js +104 -189
- package/dist/v2025/api.js.map +1 -1
- package/dist/v2025/common.js +1 -1
- package/dist/v3/api.d.ts +382 -59
- package/dist/v3/api.js +56 -38
- package/dist/v3/api.js.map +1 -1
- package/dist/v3/common.js +1 -1
- package/package.json +1 -1
- package/v2024/README.md +2 -2
- package/v2024/api.ts +108 -232
- package/v2024/common.ts +2 -2
- package/v2024/package.json +1 -1
- package/v2025/README.md +2 -2
- package/v2025/api.ts +177 -282
- package/v2025/common.ts +2 -2
- package/v2025/package.json +1 -1
- package/v3/README.md +2 -2
- package/v3/api.ts +401 -67
- package/v3/common.ts +2 -2
- package/v3/package.json +1 -1
package/v3/api.ts
CHANGED
|
@@ -189,7 +189,7 @@ export interface AccessCriteria {
|
|
|
189
189
|
*/
|
|
190
190
|
export interface AccessCriteriaCriteriaListInner {
|
|
191
191
|
/**
|
|
192
|
-
* Type of the
|
|
192
|
+
* Type of the property to which this reference applies to
|
|
193
193
|
* @type {string}
|
|
194
194
|
* @memberof AccessCriteriaCriteriaListInner
|
|
195
195
|
*/
|
|
@@ -214,6 +214,51 @@ export const AccessCriteriaCriteriaListInnerTypeV3 = {
|
|
|
214
214
|
|
|
215
215
|
export type AccessCriteriaCriteriaListInnerTypeV3 = typeof AccessCriteriaCriteriaListInnerTypeV3[keyof typeof AccessCriteriaCriteriaListInnerTypeV3];
|
|
216
216
|
|
|
217
|
+
/**
|
|
218
|
+
*
|
|
219
|
+
* @export
|
|
220
|
+
* @interface AccessCriteriaRequest
|
|
221
|
+
*/
|
|
222
|
+
export interface AccessCriteriaRequest {
|
|
223
|
+
/**
|
|
224
|
+
* Business name for the access construct list
|
|
225
|
+
* @type {string}
|
|
226
|
+
* @memberof AccessCriteriaRequest
|
|
227
|
+
*/
|
|
228
|
+
'name'?: string;
|
|
229
|
+
/**
|
|
230
|
+
* List of criteria. There is a min of 1 and max of 50 items in the list.
|
|
231
|
+
* @type {Array<AccessCriteriaRequestCriteriaListInner>}
|
|
232
|
+
* @memberof AccessCriteriaRequest
|
|
233
|
+
*/
|
|
234
|
+
'criteriaList'?: Array<AccessCriteriaRequestCriteriaListInner>;
|
|
235
|
+
}
|
|
236
|
+
/**
|
|
237
|
+
*
|
|
238
|
+
* @export
|
|
239
|
+
* @interface AccessCriteriaRequestCriteriaListInner
|
|
240
|
+
*/
|
|
241
|
+
export interface AccessCriteriaRequestCriteriaListInner {
|
|
242
|
+
/**
|
|
243
|
+
* Type of the property to which this reference applies to
|
|
244
|
+
* @type {string}
|
|
245
|
+
* @memberof AccessCriteriaRequestCriteriaListInner
|
|
246
|
+
*/
|
|
247
|
+
'type'?: AccessCriteriaRequestCriteriaListInnerTypeV3;
|
|
248
|
+
/**
|
|
249
|
+
* ID of the object to which this reference applies to
|
|
250
|
+
* @type {string}
|
|
251
|
+
* @memberof AccessCriteriaRequestCriteriaListInner
|
|
252
|
+
*/
|
|
253
|
+
'id'?: string;
|
|
254
|
+
}
|
|
255
|
+
|
|
256
|
+
export const AccessCriteriaRequestCriteriaListInnerTypeV3 = {
|
|
257
|
+
Entitlement: 'ENTITLEMENT'
|
|
258
|
+
} as const;
|
|
259
|
+
|
|
260
|
+
export type AccessCriteriaRequestCriteriaListInnerTypeV3 = typeof AccessCriteriaRequestCriteriaListInnerTypeV3[keyof typeof AccessCriteriaRequestCriteriaListInnerTypeV3];
|
|
261
|
+
|
|
217
262
|
/**
|
|
218
263
|
* Identity the access item is requested for.
|
|
219
264
|
* @export
|
|
@@ -4972,8 +5017,7 @@ export interface CampaignAllOfFilter {
|
|
|
4972
5017
|
}
|
|
4973
5018
|
|
|
4974
5019
|
export const CampaignAllOfFilterTypeV3 = {
|
|
4975
|
-
CampaignFilter: 'CAMPAIGN_FILTER'
|
|
4976
|
-
Rule: 'RULE'
|
|
5020
|
+
CampaignFilter: 'CAMPAIGN_FILTER'
|
|
4977
5021
|
} as const;
|
|
4978
5022
|
|
|
4979
5023
|
export type CampaignAllOfFilterTypeV3 = typeof CampaignAllOfFilterTypeV3[keyof typeof CampaignAllOfFilterTypeV3];
|
|
@@ -6519,6 +6563,25 @@ export interface ConflictingAccessCriteria {
|
|
|
6519
6563
|
*/
|
|
6520
6564
|
'rightCriteria'?: AccessCriteria;
|
|
6521
6565
|
}
|
|
6566
|
+
/**
|
|
6567
|
+
*
|
|
6568
|
+
* @export
|
|
6569
|
+
* @interface ConflictingAccessCriteriaRequest
|
|
6570
|
+
*/
|
|
6571
|
+
export interface ConflictingAccessCriteriaRequest {
|
|
6572
|
+
/**
|
|
6573
|
+
*
|
|
6574
|
+
* @type {AccessCriteriaRequest}
|
|
6575
|
+
* @memberof ConflictingAccessCriteriaRequest
|
|
6576
|
+
*/
|
|
6577
|
+
'leftCriteria'?: AccessCriteriaRequest;
|
|
6578
|
+
/**
|
|
6579
|
+
*
|
|
6580
|
+
* @type {AccessCriteriaRequest}
|
|
6581
|
+
* @memberof ConflictingAccessCriteriaRequest
|
|
6582
|
+
*/
|
|
6583
|
+
'rightCriteria'?: AccessCriteriaRequest;
|
|
6584
|
+
}
|
|
6522
6585
|
/**
|
|
6523
6586
|
*
|
|
6524
6587
|
* @export
|
|
@@ -21495,12 +21558,6 @@ export interface SodPolicy {
|
|
|
21495
21558
|
* @memberof SodPolicy
|
|
21496
21559
|
*/
|
|
21497
21560
|
'type'?: SodPolicyTypeV3;
|
|
21498
|
-
/**
|
|
21499
|
-
*
|
|
21500
|
-
* @type {SodPolicyConflictingAccessCriteria}
|
|
21501
|
-
* @memberof SodPolicy
|
|
21502
|
-
*/
|
|
21503
|
-
'conflictingAccessCriteria'?: SodPolicyConflictingAccessCriteria;
|
|
21504
21561
|
}
|
|
21505
21562
|
|
|
21506
21563
|
export const SodPolicyStateV3 = {
|
|
@@ -21516,25 +21573,6 @@ export const SodPolicyTypeV3 = {
|
|
|
21516
21573
|
|
|
21517
21574
|
export type SodPolicyTypeV3 = typeof SodPolicyTypeV3[keyof typeof SodPolicyTypeV3];
|
|
21518
21575
|
|
|
21519
|
-
/**
|
|
21520
|
-
*
|
|
21521
|
-
* @export
|
|
21522
|
-
* @interface SodPolicyConflictingAccessCriteria
|
|
21523
|
-
*/
|
|
21524
|
-
export interface SodPolicyConflictingAccessCriteria {
|
|
21525
|
-
/**
|
|
21526
|
-
*
|
|
21527
|
-
* @type {AccessCriteria}
|
|
21528
|
-
* @memberof SodPolicyConflictingAccessCriteria
|
|
21529
|
-
*/
|
|
21530
|
-
'leftCriteria'?: AccessCriteria;
|
|
21531
|
-
/**
|
|
21532
|
-
*
|
|
21533
|
-
* @type {AccessCriteria}
|
|
21534
|
-
* @memberof SodPolicyConflictingAccessCriteria
|
|
21535
|
-
*/
|
|
21536
|
-
'rightCriteria'?: AccessCriteria;
|
|
21537
|
-
}
|
|
21538
21576
|
/**
|
|
21539
21577
|
* SOD policy.
|
|
21540
21578
|
* @export
|
|
@@ -21600,6 +21638,302 @@ export const SodPolicyOwnerRefTypeV3 = {
|
|
|
21600
21638
|
|
|
21601
21639
|
export type SodPolicyOwnerRefTypeV3 = typeof SodPolicyOwnerRefTypeV3[keyof typeof SodPolicyOwnerRefTypeV3];
|
|
21602
21640
|
|
|
21641
|
+
/**
|
|
21642
|
+
*
|
|
21643
|
+
* @export
|
|
21644
|
+
* @interface SodPolicyRead
|
|
21645
|
+
*/
|
|
21646
|
+
export interface SodPolicyRead {
|
|
21647
|
+
/**
|
|
21648
|
+
* Policy id
|
|
21649
|
+
* @type {string}
|
|
21650
|
+
* @memberof SodPolicyRead
|
|
21651
|
+
*/
|
|
21652
|
+
'id'?: string;
|
|
21653
|
+
/**
|
|
21654
|
+
* Policy Business Name
|
|
21655
|
+
* @type {string}
|
|
21656
|
+
* @memberof SodPolicyRead
|
|
21657
|
+
*/
|
|
21658
|
+
'name'?: string;
|
|
21659
|
+
/**
|
|
21660
|
+
* The time when this SOD policy is created.
|
|
21661
|
+
* @type {string}
|
|
21662
|
+
* @memberof SodPolicyRead
|
|
21663
|
+
*/
|
|
21664
|
+
'created'?: string;
|
|
21665
|
+
/**
|
|
21666
|
+
* The time when this SOD policy is modified.
|
|
21667
|
+
* @type {string}
|
|
21668
|
+
* @memberof SodPolicyRead
|
|
21669
|
+
*/
|
|
21670
|
+
'modified'?: string;
|
|
21671
|
+
/**
|
|
21672
|
+
* Optional description of the SOD policy
|
|
21673
|
+
* @type {string}
|
|
21674
|
+
* @memberof SodPolicyRead
|
|
21675
|
+
*/
|
|
21676
|
+
'description'?: string | null;
|
|
21677
|
+
/**
|
|
21678
|
+
*
|
|
21679
|
+
* @type {SodPolicyOwnerRef}
|
|
21680
|
+
* @memberof SodPolicyRead
|
|
21681
|
+
*/
|
|
21682
|
+
'ownerRef'?: SodPolicyOwnerRef;
|
|
21683
|
+
/**
|
|
21684
|
+
* Optional External Policy Reference
|
|
21685
|
+
* @type {string}
|
|
21686
|
+
* @memberof SodPolicyRead
|
|
21687
|
+
*/
|
|
21688
|
+
'externalPolicyReference'?: string | null;
|
|
21689
|
+
/**
|
|
21690
|
+
* Search query of the SOD policy
|
|
21691
|
+
* @type {string}
|
|
21692
|
+
* @memberof SodPolicyRead
|
|
21693
|
+
*/
|
|
21694
|
+
'policyQuery'?: string;
|
|
21695
|
+
/**
|
|
21696
|
+
* Optional compensating controls(Mitigating Controls)
|
|
21697
|
+
* @type {string}
|
|
21698
|
+
* @memberof SodPolicyRead
|
|
21699
|
+
*/
|
|
21700
|
+
'compensatingControls'?: string | null;
|
|
21701
|
+
/**
|
|
21702
|
+
* Optional correction advice
|
|
21703
|
+
* @type {string}
|
|
21704
|
+
* @memberof SodPolicyRead
|
|
21705
|
+
*/
|
|
21706
|
+
'correctionAdvice'?: string | null;
|
|
21707
|
+
/**
|
|
21708
|
+
* whether the policy is enforced or not
|
|
21709
|
+
* @type {string}
|
|
21710
|
+
* @memberof SodPolicyRead
|
|
21711
|
+
*/
|
|
21712
|
+
'state'?: SodPolicyReadStateV3;
|
|
21713
|
+
/**
|
|
21714
|
+
* tags for this policy object
|
|
21715
|
+
* @type {Array<string>}
|
|
21716
|
+
* @memberof SodPolicyRead
|
|
21717
|
+
*/
|
|
21718
|
+
'tags'?: Array<string>;
|
|
21719
|
+
/**
|
|
21720
|
+
* Policy\'s creator ID
|
|
21721
|
+
* @type {string}
|
|
21722
|
+
* @memberof SodPolicyRead
|
|
21723
|
+
*/
|
|
21724
|
+
'creatorId'?: string;
|
|
21725
|
+
/**
|
|
21726
|
+
* Policy\'s modifier ID
|
|
21727
|
+
* @type {string}
|
|
21728
|
+
* @memberof SodPolicyRead
|
|
21729
|
+
*/
|
|
21730
|
+
'modifierId'?: string | null;
|
|
21731
|
+
/**
|
|
21732
|
+
*
|
|
21733
|
+
* @type {ViolationOwnerAssignmentConfig}
|
|
21734
|
+
* @memberof SodPolicyRead
|
|
21735
|
+
*/
|
|
21736
|
+
'violationOwnerAssignmentConfig'?: ViolationOwnerAssignmentConfig;
|
|
21737
|
+
/**
|
|
21738
|
+
* defines whether a policy has been scheduled or not
|
|
21739
|
+
* @type {boolean}
|
|
21740
|
+
* @memberof SodPolicyRead
|
|
21741
|
+
*/
|
|
21742
|
+
'scheduled'?: boolean;
|
|
21743
|
+
/**
|
|
21744
|
+
* whether a policy is query based or conflicting access based
|
|
21745
|
+
* @type {string}
|
|
21746
|
+
* @memberof SodPolicyRead
|
|
21747
|
+
*/
|
|
21748
|
+
'type'?: SodPolicyReadTypeV3;
|
|
21749
|
+
/**
|
|
21750
|
+
*
|
|
21751
|
+
* @type {SodPolicyReadAllOfConflictingAccessCriteria}
|
|
21752
|
+
* @memberof SodPolicyRead
|
|
21753
|
+
*/
|
|
21754
|
+
'conflictingAccessCriteria'?: SodPolicyReadAllOfConflictingAccessCriteria;
|
|
21755
|
+
}
|
|
21756
|
+
|
|
21757
|
+
export const SodPolicyReadStateV3 = {
|
|
21758
|
+
Enforced: 'ENFORCED',
|
|
21759
|
+
NotEnforced: 'NOT_ENFORCED'
|
|
21760
|
+
} as const;
|
|
21761
|
+
|
|
21762
|
+
export type SodPolicyReadStateV3 = typeof SodPolicyReadStateV3[keyof typeof SodPolicyReadStateV3];
|
|
21763
|
+
export const SodPolicyReadTypeV3 = {
|
|
21764
|
+
General: 'GENERAL',
|
|
21765
|
+
ConflictingAccessBased: 'CONFLICTING_ACCESS_BASED'
|
|
21766
|
+
} as const;
|
|
21767
|
+
|
|
21768
|
+
export type SodPolicyReadTypeV3 = typeof SodPolicyReadTypeV3[keyof typeof SodPolicyReadTypeV3];
|
|
21769
|
+
|
|
21770
|
+
/**
|
|
21771
|
+
*
|
|
21772
|
+
* @export
|
|
21773
|
+
* @interface SodPolicyReadAllOfConflictingAccessCriteria
|
|
21774
|
+
*/
|
|
21775
|
+
export interface SodPolicyReadAllOfConflictingAccessCriteria {
|
|
21776
|
+
/**
|
|
21777
|
+
*
|
|
21778
|
+
* @type {AccessCriteria}
|
|
21779
|
+
* @memberof SodPolicyReadAllOfConflictingAccessCriteria
|
|
21780
|
+
*/
|
|
21781
|
+
'leftCriteria'?: AccessCriteria;
|
|
21782
|
+
/**
|
|
21783
|
+
*
|
|
21784
|
+
* @type {AccessCriteria}
|
|
21785
|
+
* @memberof SodPolicyReadAllOfConflictingAccessCriteria
|
|
21786
|
+
*/
|
|
21787
|
+
'rightCriteria'?: AccessCriteria;
|
|
21788
|
+
}
|
|
21789
|
+
/**
|
|
21790
|
+
*
|
|
21791
|
+
* @export
|
|
21792
|
+
* @interface SodPolicyRequest
|
|
21793
|
+
*/
|
|
21794
|
+
export interface SodPolicyRequest {
|
|
21795
|
+
/**
|
|
21796
|
+
* Policy id
|
|
21797
|
+
* @type {string}
|
|
21798
|
+
* @memberof SodPolicyRequest
|
|
21799
|
+
*/
|
|
21800
|
+
'id'?: string;
|
|
21801
|
+
/**
|
|
21802
|
+
* Policy Business Name
|
|
21803
|
+
* @type {string}
|
|
21804
|
+
* @memberof SodPolicyRequest
|
|
21805
|
+
*/
|
|
21806
|
+
'name'?: string;
|
|
21807
|
+
/**
|
|
21808
|
+
* The time when this SOD policy is created.
|
|
21809
|
+
* @type {string}
|
|
21810
|
+
* @memberof SodPolicyRequest
|
|
21811
|
+
*/
|
|
21812
|
+
'created'?: string;
|
|
21813
|
+
/**
|
|
21814
|
+
* The time when this SOD policy is modified.
|
|
21815
|
+
* @type {string}
|
|
21816
|
+
* @memberof SodPolicyRequest
|
|
21817
|
+
*/
|
|
21818
|
+
'modified'?: string;
|
|
21819
|
+
/**
|
|
21820
|
+
* Optional description of the SOD policy
|
|
21821
|
+
* @type {string}
|
|
21822
|
+
* @memberof SodPolicyRequest
|
|
21823
|
+
*/
|
|
21824
|
+
'description'?: string | null;
|
|
21825
|
+
/**
|
|
21826
|
+
*
|
|
21827
|
+
* @type {SodPolicyOwnerRef}
|
|
21828
|
+
* @memberof SodPolicyRequest
|
|
21829
|
+
*/
|
|
21830
|
+
'ownerRef'?: SodPolicyOwnerRef;
|
|
21831
|
+
/**
|
|
21832
|
+
* Optional External Policy Reference
|
|
21833
|
+
* @type {string}
|
|
21834
|
+
* @memberof SodPolicyRequest
|
|
21835
|
+
*/
|
|
21836
|
+
'externalPolicyReference'?: string | null;
|
|
21837
|
+
/**
|
|
21838
|
+
* Search query of the SOD policy
|
|
21839
|
+
* @type {string}
|
|
21840
|
+
* @memberof SodPolicyRequest
|
|
21841
|
+
*/
|
|
21842
|
+
'policyQuery'?: string;
|
|
21843
|
+
/**
|
|
21844
|
+
* Optional compensating controls(Mitigating Controls)
|
|
21845
|
+
* @type {string}
|
|
21846
|
+
* @memberof SodPolicyRequest
|
|
21847
|
+
*/
|
|
21848
|
+
'compensatingControls'?: string | null;
|
|
21849
|
+
/**
|
|
21850
|
+
* Optional correction advice
|
|
21851
|
+
* @type {string}
|
|
21852
|
+
* @memberof SodPolicyRequest
|
|
21853
|
+
*/
|
|
21854
|
+
'correctionAdvice'?: string | null;
|
|
21855
|
+
/**
|
|
21856
|
+
* whether the policy is enforced or not
|
|
21857
|
+
* @type {string}
|
|
21858
|
+
* @memberof SodPolicyRequest
|
|
21859
|
+
*/
|
|
21860
|
+
'state'?: SodPolicyRequestStateV3;
|
|
21861
|
+
/**
|
|
21862
|
+
* tags for this policy object
|
|
21863
|
+
* @type {Array<string>}
|
|
21864
|
+
* @memberof SodPolicyRequest
|
|
21865
|
+
*/
|
|
21866
|
+
'tags'?: Array<string>;
|
|
21867
|
+
/**
|
|
21868
|
+
* Policy\'s creator ID
|
|
21869
|
+
* @type {string}
|
|
21870
|
+
* @memberof SodPolicyRequest
|
|
21871
|
+
*/
|
|
21872
|
+
'creatorId'?: string;
|
|
21873
|
+
/**
|
|
21874
|
+
* Policy\'s modifier ID
|
|
21875
|
+
* @type {string}
|
|
21876
|
+
* @memberof SodPolicyRequest
|
|
21877
|
+
*/
|
|
21878
|
+
'modifierId'?: string | null;
|
|
21879
|
+
/**
|
|
21880
|
+
*
|
|
21881
|
+
* @type {ViolationOwnerAssignmentConfig}
|
|
21882
|
+
* @memberof SodPolicyRequest
|
|
21883
|
+
*/
|
|
21884
|
+
'violationOwnerAssignmentConfig'?: ViolationOwnerAssignmentConfig;
|
|
21885
|
+
/**
|
|
21886
|
+
* defines whether a policy has been scheduled or not
|
|
21887
|
+
* @type {boolean}
|
|
21888
|
+
* @memberof SodPolicyRequest
|
|
21889
|
+
*/
|
|
21890
|
+
'scheduled'?: boolean;
|
|
21891
|
+
/**
|
|
21892
|
+
* whether a policy is query based or conflicting access based
|
|
21893
|
+
* @type {string}
|
|
21894
|
+
* @memberof SodPolicyRequest
|
|
21895
|
+
*/
|
|
21896
|
+
'type'?: SodPolicyRequestTypeV3;
|
|
21897
|
+
/**
|
|
21898
|
+
*
|
|
21899
|
+
* @type {SodPolicyRequestAllOfConflictingAccessCriteria}
|
|
21900
|
+
* @memberof SodPolicyRequest
|
|
21901
|
+
*/
|
|
21902
|
+
'conflictingAccessCriteria'?: SodPolicyRequestAllOfConflictingAccessCriteria;
|
|
21903
|
+
}
|
|
21904
|
+
|
|
21905
|
+
export const SodPolicyRequestStateV3 = {
|
|
21906
|
+
Enforced: 'ENFORCED',
|
|
21907
|
+
NotEnforced: 'NOT_ENFORCED'
|
|
21908
|
+
} as const;
|
|
21909
|
+
|
|
21910
|
+
export type SodPolicyRequestStateV3 = typeof SodPolicyRequestStateV3[keyof typeof SodPolicyRequestStateV3];
|
|
21911
|
+
export const SodPolicyRequestTypeV3 = {
|
|
21912
|
+
General: 'GENERAL',
|
|
21913
|
+
ConflictingAccessBased: 'CONFLICTING_ACCESS_BASED'
|
|
21914
|
+
} as const;
|
|
21915
|
+
|
|
21916
|
+
export type SodPolicyRequestTypeV3 = typeof SodPolicyRequestTypeV3[keyof typeof SodPolicyRequestTypeV3];
|
|
21917
|
+
|
|
21918
|
+
/**
|
|
21919
|
+
*
|
|
21920
|
+
* @export
|
|
21921
|
+
* @interface SodPolicyRequestAllOfConflictingAccessCriteria
|
|
21922
|
+
*/
|
|
21923
|
+
export interface SodPolicyRequestAllOfConflictingAccessCriteria {
|
|
21924
|
+
/**
|
|
21925
|
+
*
|
|
21926
|
+
* @type {AccessCriteriaRequest}
|
|
21927
|
+
* @memberof SodPolicyRequestAllOfConflictingAccessCriteria
|
|
21928
|
+
*/
|
|
21929
|
+
'leftCriteria'?: AccessCriteriaRequest;
|
|
21930
|
+
/**
|
|
21931
|
+
*
|
|
21932
|
+
* @type {AccessCriteriaRequest}
|
|
21933
|
+
* @memberof SodPolicyRequestAllOfConflictingAccessCriteria
|
|
21934
|
+
*/
|
|
21935
|
+
'rightCriteria'?: AccessCriteriaRequest;
|
|
21936
|
+
}
|
|
21603
21937
|
/**
|
|
21604
21938
|
*
|
|
21605
21939
|
* @export
|
|
@@ -26983,7 +27317,7 @@ export const AccessRequestsApiAxiosParamCreator = function (configuration?: Conf
|
|
|
26983
27317
|
};
|
|
26984
27318
|
},
|
|
26985
27319
|
/**
|
|
26986
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn\'t return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It\'s best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. *
|
|
27320
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token’s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn\'t return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It\'s best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests.
|
|
26987
27321
|
* @summary Submit access request
|
|
26988
27322
|
* @param {AccessRequest} accessRequest
|
|
26989
27323
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -27074,7 +27408,7 @@ export const AccessRequestsApiAxiosParamCreator = function (configuration?: Conf
|
|
|
27074
27408
|
* @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored.
|
|
27075
27409
|
* @param {number} [limit] Max number of results to return.
|
|
27076
27410
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.
|
|
27077
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
27411
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *eq, in, ge, gt, le, lt, ne, sw* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
27078
27412
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name**
|
|
27079
27413
|
* @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*.
|
|
27080
27414
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -27220,7 +27554,7 @@ export const AccessRequestsApiFp = function(configuration?: Configuration) {
|
|
|
27220
27554
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
27221
27555
|
},
|
|
27222
27556
|
/**
|
|
27223
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn\'t return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It\'s best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. *
|
|
27557
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token’s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn\'t return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It\'s best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests.
|
|
27224
27558
|
* @summary Submit access request
|
|
27225
27559
|
* @param {AccessRequest} accessRequest
|
|
27226
27560
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -27254,7 +27588,7 @@ export const AccessRequestsApiFp = function(configuration?: Configuration) {
|
|
|
27254
27588
|
* @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored.
|
|
27255
27589
|
* @param {number} [limit] Max number of results to return.
|
|
27256
27590
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.
|
|
27257
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
27591
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *eq, in, ge, gt, le, lt, ne, sw* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
27258
27592
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name**
|
|
27259
27593
|
* @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*.
|
|
27260
27594
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -27300,7 +27634,7 @@ export const AccessRequestsApiFactory = function (configuration?: Configuration,
|
|
|
27300
27634
|
return localVarFp.cancelAccessRequest(requestParameters.cancelAccessRequest, axiosOptions).then((request) => request(axios, basePath));
|
|
27301
27635
|
},
|
|
27302
27636
|
/**
|
|
27303
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn\'t return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It\'s best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. *
|
|
27637
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token’s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn\'t return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It\'s best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests.
|
|
27304
27638
|
* @summary Submit access request
|
|
27305
27639
|
* @param {AccessRequestsApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
27306
27640
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -27425,7 +27759,7 @@ export interface AccessRequestsApiListAccessRequestStatusRequest {
|
|
|
27425
27759
|
readonly offset?: number
|
|
27426
27760
|
|
|
27427
27761
|
/**
|
|
27428
|
-
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
27762
|
+
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *eq, in, ge, gt, le, lt, ne, sw* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
27429
27763
|
* @type {string}
|
|
27430
27764
|
* @memberof AccessRequestsApiListAccessRequestStatus
|
|
27431
27765
|
*/
|
|
@@ -27480,7 +27814,7 @@ export class AccessRequestsApi extends BaseAPI {
|
|
|
27480
27814
|
}
|
|
27481
27815
|
|
|
27482
27816
|
/**
|
|
27483
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn\'t return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It\'s best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. *
|
|
27817
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token’s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn\'t return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It\'s best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests.
|
|
27484
27818
|
* @summary Submit access request
|
|
27485
27819
|
* @param {AccessRequestsApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
27486
27820
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -51239,13 +51573,13 @@ export const SODPoliciesApiAxiosParamCreator = function (configuration?: Configu
|
|
|
51239
51573
|
/**
|
|
51240
51574
|
* This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN.
|
|
51241
51575
|
* @summary Create sod policy
|
|
51242
|
-
* @param {
|
|
51576
|
+
* @param {SodPolicyRequest} sodPolicyRequest
|
|
51243
51577
|
* @param {*} [axiosOptions] Override http request option.
|
|
51244
51578
|
* @throws {RequiredError}
|
|
51245
51579
|
*/
|
|
51246
|
-
createSodPolicy: async (
|
|
51247
|
-
// verify required parameter '
|
|
51248
|
-
assertParamExists('createSodPolicy', '
|
|
51580
|
+
createSodPolicy: async (sodPolicyRequest: SodPolicyRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
51581
|
+
// verify required parameter 'sodPolicyRequest' is not null or undefined
|
|
51582
|
+
assertParamExists('createSodPolicy', 'sodPolicyRequest', sodPolicyRequest)
|
|
51249
51583
|
const localVarPath = `/sod-policies`;
|
|
51250
51584
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
51251
51585
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -51273,7 +51607,7 @@ export const SODPoliciesApiAxiosParamCreator = function (configuration?: Configu
|
|
|
51273
51607
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
51274
51608
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
51275
51609
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
51276
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
51610
|
+
localVarRequestOptions.data = serializeDataIfNeeded(sodPolicyRequest, localVarRequestOptions, configuration)
|
|
51277
51611
|
|
|
51278
51612
|
return {
|
|
51279
51613
|
url: toPathString(localVarUrlObj),
|
|
@@ -51826,15 +52160,15 @@ export const SODPoliciesApiAxiosParamCreator = function (configuration?: Configu
|
|
|
51826
52160
|
* This updates a specified SOD policy. Requires role of ORG_ADMIN.
|
|
51827
52161
|
* @summary Update sod policy by id
|
|
51828
52162
|
* @param {string} id The ID of the SOD policy to update.
|
|
51829
|
-
* @param {
|
|
52163
|
+
* @param {SodPolicyRead} sodPolicyRead
|
|
51830
52164
|
* @param {*} [axiosOptions] Override http request option.
|
|
51831
52165
|
* @throws {RequiredError}
|
|
51832
52166
|
*/
|
|
51833
|
-
putSodPolicy: async (id: string,
|
|
52167
|
+
putSodPolicy: async (id: string, sodPolicyRead: SodPolicyRead, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
51834
52168
|
// verify required parameter 'id' is not null or undefined
|
|
51835
52169
|
assertParamExists('putSodPolicy', 'id', id)
|
|
51836
|
-
// verify required parameter '
|
|
51837
|
-
assertParamExists('putSodPolicy', '
|
|
52170
|
+
// verify required parameter 'sodPolicyRead' is not null or undefined
|
|
52171
|
+
assertParamExists('putSodPolicy', 'sodPolicyRead', sodPolicyRead)
|
|
51838
52172
|
const localVarPath = `/sod-policies/{id}`
|
|
51839
52173
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
51840
52174
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -51863,7 +52197,7 @@ export const SODPoliciesApiAxiosParamCreator = function (configuration?: Configu
|
|
|
51863
52197
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
51864
52198
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
51865
52199
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
51866
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
52200
|
+
localVarRequestOptions.data = serializeDataIfNeeded(sodPolicyRead, localVarRequestOptions, configuration)
|
|
51867
52201
|
|
|
51868
52202
|
return {
|
|
51869
52203
|
url: toPathString(localVarUrlObj),
|
|
@@ -52009,12 +52343,12 @@ export const SODPoliciesApiFp = function(configuration?: Configuration) {
|
|
|
52009
52343
|
/**
|
|
52010
52344
|
* This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN.
|
|
52011
52345
|
* @summary Create sod policy
|
|
52012
|
-
* @param {
|
|
52346
|
+
* @param {SodPolicyRequest} sodPolicyRequest
|
|
52013
52347
|
* @param {*} [axiosOptions] Override http request option.
|
|
52014
52348
|
* @throws {RequiredError}
|
|
52015
52349
|
*/
|
|
52016
|
-
async createSodPolicy(
|
|
52017
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createSodPolicy(
|
|
52350
|
+
async createSodPolicy(sodPolicyRequest: SodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SodPolicyRead>> {
|
|
52351
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createSodPolicy(sodPolicyRequest, axiosOptions);
|
|
52018
52352
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
52019
52353
|
const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.createSodPolicy']?.[localVarOperationServerIndex]?.url;
|
|
52020
52354
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -52092,7 +52426,7 @@ export const SODPoliciesApiFp = function(configuration?: Configuration) {
|
|
|
52092
52426
|
* @param {*} [axiosOptions] Override http request option.
|
|
52093
52427
|
* @throws {RequiredError}
|
|
52094
52428
|
*/
|
|
52095
|
-
async getSodPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
52429
|
+
async getSodPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SodPolicyRead>> {
|
|
52096
52430
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getSodPolicy(id, axiosOptions);
|
|
52097
52431
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
52098
52432
|
const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.getSodPolicy']?.[localVarOperationServerIndex]?.url;
|
|
@@ -52148,7 +52482,7 @@ export const SODPoliciesApiFp = function(configuration?: Configuration) {
|
|
|
52148
52482
|
* @param {*} [axiosOptions] Override http request option.
|
|
52149
52483
|
* @throws {RequiredError}
|
|
52150
52484
|
*/
|
|
52151
|
-
async listSodPolicies(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
52485
|
+
async listSodPolicies(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SodPolicyRead>>> {
|
|
52152
52486
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listSodPolicies(limit, offset, count, filters, sorters, axiosOptions);
|
|
52153
52487
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
52154
52488
|
const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.listSodPolicies']?.[localVarOperationServerIndex]?.url;
|
|
@@ -52162,7 +52496,7 @@ export const SODPoliciesApiFp = function(configuration?: Configuration) {
|
|
|
52162
52496
|
* @param {*} [axiosOptions] Override http request option.
|
|
52163
52497
|
* @throws {RequiredError}
|
|
52164
52498
|
*/
|
|
52165
|
-
async patchSodPolicy(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
52499
|
+
async patchSodPolicy(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SodPolicyRead>> {
|
|
52166
52500
|
const localVarAxiosArgs = await localVarAxiosParamCreator.patchSodPolicy(id, jsonPatchOperation, axiosOptions);
|
|
52167
52501
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
52168
52502
|
const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.patchSodPolicy']?.[localVarOperationServerIndex]?.url;
|
|
@@ -52186,12 +52520,12 @@ export const SODPoliciesApiFp = function(configuration?: Configuration) {
|
|
|
52186
52520
|
* This updates a specified SOD policy. Requires role of ORG_ADMIN.
|
|
52187
52521
|
* @summary Update sod policy by id
|
|
52188
52522
|
* @param {string} id The ID of the SOD policy to update.
|
|
52189
|
-
* @param {
|
|
52523
|
+
* @param {SodPolicyRead} sodPolicyRead
|
|
52190
52524
|
* @param {*} [axiosOptions] Override http request option.
|
|
52191
52525
|
* @throws {RequiredError}
|
|
52192
52526
|
*/
|
|
52193
|
-
async putSodPolicy(id: string,
|
|
52194
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.putSodPolicy(id,
|
|
52527
|
+
async putSodPolicy(id: string, sodPolicyRead: SodPolicyRead, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SodPolicyRead>> {
|
|
52528
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.putSodPolicy(id, sodPolicyRead, axiosOptions);
|
|
52195
52529
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
52196
52530
|
const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.putSodPolicy']?.[localVarOperationServerIndex]?.url;
|
|
52197
52531
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -52252,8 +52586,8 @@ export const SODPoliciesApiFactory = function (configuration?: Configuration, ba
|
|
|
52252
52586
|
* @param {*} [axiosOptions] Override http request option.
|
|
52253
52587
|
* @throws {RequiredError}
|
|
52254
52588
|
*/
|
|
52255
|
-
createSodPolicy(requestParameters: SODPoliciesApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<
|
|
52256
|
-
return localVarFp.createSodPolicy(requestParameters.
|
|
52589
|
+
createSodPolicy(requestParameters: SODPoliciesApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SodPolicyRead> {
|
|
52590
|
+
return localVarFp.createSodPolicy(requestParameters.sodPolicyRequest, axiosOptions).then((request) => request(axios, basePath));
|
|
52257
52591
|
},
|
|
52258
52592
|
/**
|
|
52259
52593
|
* This deletes a specified SOD policy. Requires role of ORG_ADMIN.
|
|
@@ -52311,7 +52645,7 @@ export const SODPoliciesApiFactory = function (configuration?: Configuration, ba
|
|
|
52311
52645
|
* @param {*} [axiosOptions] Override http request option.
|
|
52312
52646
|
* @throws {RequiredError}
|
|
52313
52647
|
*/
|
|
52314
|
-
getSodPolicy(requestParameters: SODPoliciesApiGetSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<
|
|
52648
|
+
getSodPolicy(requestParameters: SODPoliciesApiGetSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SodPolicyRead> {
|
|
52315
52649
|
return localVarFp.getSodPolicy(requestParameters.id, axiosOptions).then((request) => request(axios, basePath));
|
|
52316
52650
|
},
|
|
52317
52651
|
/**
|
|
@@ -52351,7 +52685,7 @@ export const SODPoliciesApiFactory = function (configuration?: Configuration, ba
|
|
|
52351
52685
|
* @param {*} [axiosOptions] Override http request option.
|
|
52352
52686
|
* @throws {RequiredError}
|
|
52353
52687
|
*/
|
|
52354
|
-
listSodPolicies(requestParameters: SODPoliciesApiListSodPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
52688
|
+
listSodPolicies(requestParameters: SODPoliciesApiListSodPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<SodPolicyRead>> {
|
|
52355
52689
|
return localVarFp.listSodPolicies(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath));
|
|
52356
52690
|
},
|
|
52357
52691
|
/**
|
|
@@ -52361,7 +52695,7 @@ export const SODPoliciesApiFactory = function (configuration?: Configuration, ba
|
|
|
52361
52695
|
* @param {*} [axiosOptions] Override http request option.
|
|
52362
52696
|
* @throws {RequiredError}
|
|
52363
52697
|
*/
|
|
52364
|
-
patchSodPolicy(requestParameters: SODPoliciesApiPatchSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<
|
|
52698
|
+
patchSodPolicy(requestParameters: SODPoliciesApiPatchSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SodPolicyRead> {
|
|
52365
52699
|
return localVarFp.patchSodPolicy(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath));
|
|
52366
52700
|
},
|
|
52367
52701
|
/**
|
|
@@ -52381,8 +52715,8 @@ export const SODPoliciesApiFactory = function (configuration?: Configuration, ba
|
|
|
52381
52715
|
* @param {*} [axiosOptions] Override http request option.
|
|
52382
52716
|
* @throws {RequiredError}
|
|
52383
52717
|
*/
|
|
52384
|
-
putSodPolicy(requestParameters: SODPoliciesApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<
|
|
52385
|
-
return localVarFp.putSodPolicy(requestParameters.id, requestParameters.
|
|
52718
|
+
putSodPolicy(requestParameters: SODPoliciesApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SodPolicyRead> {
|
|
52719
|
+
return localVarFp.putSodPolicy(requestParameters.id, requestParameters.sodPolicyRead, axiosOptions).then((request) => request(axios, basePath));
|
|
52386
52720
|
},
|
|
52387
52721
|
/**
|
|
52388
52722
|
* Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID.
|
|
@@ -52425,10 +52759,10 @@ export const SODPoliciesApiFactory = function (configuration?: Configuration, ba
|
|
|
52425
52759
|
export interface SODPoliciesApiCreateSodPolicyRequest {
|
|
52426
52760
|
/**
|
|
52427
52761
|
*
|
|
52428
|
-
* @type {
|
|
52762
|
+
* @type {SodPolicyRequest}
|
|
52429
52763
|
* @memberof SODPoliciesApiCreateSodPolicy
|
|
52430
52764
|
*/
|
|
52431
|
-
readonly
|
|
52765
|
+
readonly sodPolicyRequest: SodPolicyRequest
|
|
52432
52766
|
}
|
|
52433
52767
|
|
|
52434
52768
|
/**
|
|
@@ -52656,10 +52990,10 @@ export interface SODPoliciesApiPutSodPolicyRequest {
|
|
|
52656
52990
|
|
|
52657
52991
|
/**
|
|
52658
52992
|
*
|
|
52659
|
-
* @type {
|
|
52993
|
+
* @type {SodPolicyRead}
|
|
52660
52994
|
* @memberof SODPoliciesApiPutSodPolicy
|
|
52661
52995
|
*/
|
|
52662
|
-
readonly
|
|
52996
|
+
readonly sodPolicyRead: SodPolicyRead
|
|
52663
52997
|
}
|
|
52664
52998
|
|
|
52665
52999
|
/**
|
|
@@ -52720,7 +53054,7 @@ export class SODPoliciesApi extends BaseAPI {
|
|
|
52720
53054
|
* @memberof SODPoliciesApi
|
|
52721
53055
|
*/
|
|
52722
53056
|
public createSodPolicy(requestParameters: SODPoliciesApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) {
|
|
52723
|
-
return SODPoliciesApiFp(this.configuration).createSodPolicy(requestParameters.
|
|
53057
|
+
return SODPoliciesApiFp(this.configuration).createSodPolicy(requestParameters.sodPolicyRequest, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
52724
53058
|
}
|
|
52725
53059
|
|
|
52726
53060
|
/**
|
|
@@ -52875,7 +53209,7 @@ export class SODPoliciesApi extends BaseAPI {
|
|
|
52875
53209
|
* @memberof SODPoliciesApi
|
|
52876
53210
|
*/
|
|
52877
53211
|
public putSodPolicy(requestParameters: SODPoliciesApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) {
|
|
52878
|
-
return SODPoliciesApiFp(this.configuration).putSodPolicy(requestParameters.id, requestParameters.
|
|
53212
|
+
return SODPoliciesApiFp(this.configuration).putSodPolicy(requestParameters.id, requestParameters.sodPolicyRead, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
52879
53213
|
}
|
|
52880
53214
|
|
|
52881
53215
|
/**
|