sailpoint-api-client 1.6.4 → 1.6.5
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 +7 -7
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/dist/beta/api.d.ts +7 -7
- package/dist/beta/api.js +6 -6
- package/dist/beta/common.js +1 -1
- package/dist/v2024/api.d.ts +7 -7
- package/dist/v2024/api.js +6 -6
- package/dist/v2024/common.js +1 -1
- package/dist/v2025/api.d.ts +7 -7
- package/dist/v2025/api.js +6 -6
- package/dist/v2025/common.js +1 -1
- package/dist/v3/api.d.ts +382 -58
- package/dist/v3/api.js +55 -36
- 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 +7 -7
- package/v2024/common.ts +2 -2
- package/v2024/package.json +1 -1
- package/v2025/README.md +2 -2
- package/v2025/api.ts +7 -7
- package/v2025/common.ts +2 -2
- package/v2025/package.json +1 -1
- package/v3/README.md +2 -2
- package/v3/api.ts +400 -65
- 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
|
|
@@ -6519,6 +6564,25 @@ export interface ConflictingAccessCriteria {
|
|
|
6519
6564
|
*/
|
|
6520
6565
|
'rightCriteria'?: AccessCriteria;
|
|
6521
6566
|
}
|
|
6567
|
+
/**
|
|
6568
|
+
*
|
|
6569
|
+
* @export
|
|
6570
|
+
* @interface ConflictingAccessCriteriaRequest
|
|
6571
|
+
*/
|
|
6572
|
+
export interface ConflictingAccessCriteriaRequest {
|
|
6573
|
+
/**
|
|
6574
|
+
*
|
|
6575
|
+
* @type {AccessCriteriaRequest}
|
|
6576
|
+
* @memberof ConflictingAccessCriteriaRequest
|
|
6577
|
+
*/
|
|
6578
|
+
'leftCriteria'?: AccessCriteriaRequest;
|
|
6579
|
+
/**
|
|
6580
|
+
*
|
|
6581
|
+
* @type {AccessCriteriaRequest}
|
|
6582
|
+
* @memberof ConflictingAccessCriteriaRequest
|
|
6583
|
+
*/
|
|
6584
|
+
'rightCriteria'?: AccessCriteriaRequest;
|
|
6585
|
+
}
|
|
6522
6586
|
/**
|
|
6523
6587
|
*
|
|
6524
6588
|
* @export
|
|
@@ -21495,12 +21559,6 @@ export interface SodPolicy {
|
|
|
21495
21559
|
* @memberof SodPolicy
|
|
21496
21560
|
*/
|
|
21497
21561
|
'type'?: SodPolicyTypeV3;
|
|
21498
|
-
/**
|
|
21499
|
-
*
|
|
21500
|
-
* @type {SodPolicyConflictingAccessCriteria}
|
|
21501
|
-
* @memberof SodPolicy
|
|
21502
|
-
*/
|
|
21503
|
-
'conflictingAccessCriteria'?: SodPolicyConflictingAccessCriteria;
|
|
21504
21562
|
}
|
|
21505
21563
|
|
|
21506
21564
|
export const SodPolicyStateV3 = {
|
|
@@ -21516,25 +21574,6 @@ export const SodPolicyTypeV3 = {
|
|
|
21516
21574
|
|
|
21517
21575
|
export type SodPolicyTypeV3 = typeof SodPolicyTypeV3[keyof typeof SodPolicyTypeV3];
|
|
21518
21576
|
|
|
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
21577
|
/**
|
|
21539
21578
|
* SOD policy.
|
|
21540
21579
|
* @export
|
|
@@ -21600,6 +21639,302 @@ export const SodPolicyOwnerRefTypeV3 = {
|
|
|
21600
21639
|
|
|
21601
21640
|
export type SodPolicyOwnerRefTypeV3 = typeof SodPolicyOwnerRefTypeV3[keyof typeof SodPolicyOwnerRefTypeV3];
|
|
21602
21641
|
|
|
21642
|
+
/**
|
|
21643
|
+
*
|
|
21644
|
+
* @export
|
|
21645
|
+
* @interface SodPolicyRead
|
|
21646
|
+
*/
|
|
21647
|
+
export interface SodPolicyRead {
|
|
21648
|
+
/**
|
|
21649
|
+
* Policy id
|
|
21650
|
+
* @type {string}
|
|
21651
|
+
* @memberof SodPolicyRead
|
|
21652
|
+
*/
|
|
21653
|
+
'id'?: string;
|
|
21654
|
+
/**
|
|
21655
|
+
* Policy Business Name
|
|
21656
|
+
* @type {string}
|
|
21657
|
+
* @memberof SodPolicyRead
|
|
21658
|
+
*/
|
|
21659
|
+
'name'?: string;
|
|
21660
|
+
/**
|
|
21661
|
+
* The time when this SOD policy is created.
|
|
21662
|
+
* @type {string}
|
|
21663
|
+
* @memberof SodPolicyRead
|
|
21664
|
+
*/
|
|
21665
|
+
'created'?: string;
|
|
21666
|
+
/**
|
|
21667
|
+
* The time when this SOD policy is modified.
|
|
21668
|
+
* @type {string}
|
|
21669
|
+
* @memberof SodPolicyRead
|
|
21670
|
+
*/
|
|
21671
|
+
'modified'?: string;
|
|
21672
|
+
/**
|
|
21673
|
+
* Optional description of the SOD policy
|
|
21674
|
+
* @type {string}
|
|
21675
|
+
* @memberof SodPolicyRead
|
|
21676
|
+
*/
|
|
21677
|
+
'description'?: string | null;
|
|
21678
|
+
/**
|
|
21679
|
+
*
|
|
21680
|
+
* @type {SodPolicyOwnerRef}
|
|
21681
|
+
* @memberof SodPolicyRead
|
|
21682
|
+
*/
|
|
21683
|
+
'ownerRef'?: SodPolicyOwnerRef;
|
|
21684
|
+
/**
|
|
21685
|
+
* Optional External Policy Reference
|
|
21686
|
+
* @type {string}
|
|
21687
|
+
* @memberof SodPolicyRead
|
|
21688
|
+
*/
|
|
21689
|
+
'externalPolicyReference'?: string | null;
|
|
21690
|
+
/**
|
|
21691
|
+
* Search query of the SOD policy
|
|
21692
|
+
* @type {string}
|
|
21693
|
+
* @memberof SodPolicyRead
|
|
21694
|
+
*/
|
|
21695
|
+
'policyQuery'?: string;
|
|
21696
|
+
/**
|
|
21697
|
+
* Optional compensating controls(Mitigating Controls)
|
|
21698
|
+
* @type {string}
|
|
21699
|
+
* @memberof SodPolicyRead
|
|
21700
|
+
*/
|
|
21701
|
+
'compensatingControls'?: string | null;
|
|
21702
|
+
/**
|
|
21703
|
+
* Optional correction advice
|
|
21704
|
+
* @type {string}
|
|
21705
|
+
* @memberof SodPolicyRead
|
|
21706
|
+
*/
|
|
21707
|
+
'correctionAdvice'?: string | null;
|
|
21708
|
+
/**
|
|
21709
|
+
* whether the policy is enforced or not
|
|
21710
|
+
* @type {string}
|
|
21711
|
+
* @memberof SodPolicyRead
|
|
21712
|
+
*/
|
|
21713
|
+
'state'?: SodPolicyReadStateV3;
|
|
21714
|
+
/**
|
|
21715
|
+
* tags for this policy object
|
|
21716
|
+
* @type {Array<string>}
|
|
21717
|
+
* @memberof SodPolicyRead
|
|
21718
|
+
*/
|
|
21719
|
+
'tags'?: Array<string>;
|
|
21720
|
+
/**
|
|
21721
|
+
* Policy\'s creator ID
|
|
21722
|
+
* @type {string}
|
|
21723
|
+
* @memberof SodPolicyRead
|
|
21724
|
+
*/
|
|
21725
|
+
'creatorId'?: string;
|
|
21726
|
+
/**
|
|
21727
|
+
* Policy\'s modifier ID
|
|
21728
|
+
* @type {string}
|
|
21729
|
+
* @memberof SodPolicyRead
|
|
21730
|
+
*/
|
|
21731
|
+
'modifierId'?: string | null;
|
|
21732
|
+
/**
|
|
21733
|
+
*
|
|
21734
|
+
* @type {ViolationOwnerAssignmentConfig}
|
|
21735
|
+
* @memberof SodPolicyRead
|
|
21736
|
+
*/
|
|
21737
|
+
'violationOwnerAssignmentConfig'?: ViolationOwnerAssignmentConfig;
|
|
21738
|
+
/**
|
|
21739
|
+
* defines whether a policy has been scheduled or not
|
|
21740
|
+
* @type {boolean}
|
|
21741
|
+
* @memberof SodPolicyRead
|
|
21742
|
+
*/
|
|
21743
|
+
'scheduled'?: boolean;
|
|
21744
|
+
/**
|
|
21745
|
+
* whether a policy is query based or conflicting access based
|
|
21746
|
+
* @type {string}
|
|
21747
|
+
* @memberof SodPolicyRead
|
|
21748
|
+
*/
|
|
21749
|
+
'type'?: SodPolicyReadTypeV3;
|
|
21750
|
+
/**
|
|
21751
|
+
*
|
|
21752
|
+
* @type {SodPolicyReadAllOfConflictingAccessCriteria}
|
|
21753
|
+
* @memberof SodPolicyRead
|
|
21754
|
+
*/
|
|
21755
|
+
'conflictingAccessCriteria'?: SodPolicyReadAllOfConflictingAccessCriteria;
|
|
21756
|
+
}
|
|
21757
|
+
|
|
21758
|
+
export const SodPolicyReadStateV3 = {
|
|
21759
|
+
Enforced: 'ENFORCED',
|
|
21760
|
+
NotEnforced: 'NOT_ENFORCED'
|
|
21761
|
+
} as const;
|
|
21762
|
+
|
|
21763
|
+
export type SodPolicyReadStateV3 = typeof SodPolicyReadStateV3[keyof typeof SodPolicyReadStateV3];
|
|
21764
|
+
export const SodPolicyReadTypeV3 = {
|
|
21765
|
+
General: 'GENERAL',
|
|
21766
|
+
ConflictingAccessBased: 'CONFLICTING_ACCESS_BASED'
|
|
21767
|
+
} as const;
|
|
21768
|
+
|
|
21769
|
+
export type SodPolicyReadTypeV3 = typeof SodPolicyReadTypeV3[keyof typeof SodPolicyReadTypeV3];
|
|
21770
|
+
|
|
21771
|
+
/**
|
|
21772
|
+
*
|
|
21773
|
+
* @export
|
|
21774
|
+
* @interface SodPolicyReadAllOfConflictingAccessCriteria
|
|
21775
|
+
*/
|
|
21776
|
+
export interface SodPolicyReadAllOfConflictingAccessCriteria {
|
|
21777
|
+
/**
|
|
21778
|
+
*
|
|
21779
|
+
* @type {AccessCriteria}
|
|
21780
|
+
* @memberof SodPolicyReadAllOfConflictingAccessCriteria
|
|
21781
|
+
*/
|
|
21782
|
+
'leftCriteria'?: AccessCriteria;
|
|
21783
|
+
/**
|
|
21784
|
+
*
|
|
21785
|
+
* @type {AccessCriteria}
|
|
21786
|
+
* @memberof SodPolicyReadAllOfConflictingAccessCriteria
|
|
21787
|
+
*/
|
|
21788
|
+
'rightCriteria'?: AccessCriteria;
|
|
21789
|
+
}
|
|
21790
|
+
/**
|
|
21791
|
+
*
|
|
21792
|
+
* @export
|
|
21793
|
+
* @interface SodPolicyRequest
|
|
21794
|
+
*/
|
|
21795
|
+
export interface SodPolicyRequest {
|
|
21796
|
+
/**
|
|
21797
|
+
* Policy id
|
|
21798
|
+
* @type {string}
|
|
21799
|
+
* @memberof SodPolicyRequest
|
|
21800
|
+
*/
|
|
21801
|
+
'id'?: string;
|
|
21802
|
+
/**
|
|
21803
|
+
* Policy Business Name
|
|
21804
|
+
* @type {string}
|
|
21805
|
+
* @memberof SodPolicyRequest
|
|
21806
|
+
*/
|
|
21807
|
+
'name'?: string;
|
|
21808
|
+
/**
|
|
21809
|
+
* The time when this SOD policy is created.
|
|
21810
|
+
* @type {string}
|
|
21811
|
+
* @memberof SodPolicyRequest
|
|
21812
|
+
*/
|
|
21813
|
+
'created'?: string;
|
|
21814
|
+
/**
|
|
21815
|
+
* The time when this SOD policy is modified.
|
|
21816
|
+
* @type {string}
|
|
21817
|
+
* @memberof SodPolicyRequest
|
|
21818
|
+
*/
|
|
21819
|
+
'modified'?: string;
|
|
21820
|
+
/**
|
|
21821
|
+
* Optional description of the SOD policy
|
|
21822
|
+
* @type {string}
|
|
21823
|
+
* @memberof SodPolicyRequest
|
|
21824
|
+
*/
|
|
21825
|
+
'description'?: string | null;
|
|
21826
|
+
/**
|
|
21827
|
+
*
|
|
21828
|
+
* @type {SodPolicyOwnerRef}
|
|
21829
|
+
* @memberof SodPolicyRequest
|
|
21830
|
+
*/
|
|
21831
|
+
'ownerRef'?: SodPolicyOwnerRef;
|
|
21832
|
+
/**
|
|
21833
|
+
* Optional External Policy Reference
|
|
21834
|
+
* @type {string}
|
|
21835
|
+
* @memberof SodPolicyRequest
|
|
21836
|
+
*/
|
|
21837
|
+
'externalPolicyReference'?: string | null;
|
|
21838
|
+
/**
|
|
21839
|
+
* Search query of the SOD policy
|
|
21840
|
+
* @type {string}
|
|
21841
|
+
* @memberof SodPolicyRequest
|
|
21842
|
+
*/
|
|
21843
|
+
'policyQuery'?: string;
|
|
21844
|
+
/**
|
|
21845
|
+
* Optional compensating controls(Mitigating Controls)
|
|
21846
|
+
* @type {string}
|
|
21847
|
+
* @memberof SodPolicyRequest
|
|
21848
|
+
*/
|
|
21849
|
+
'compensatingControls'?: string | null;
|
|
21850
|
+
/**
|
|
21851
|
+
* Optional correction advice
|
|
21852
|
+
* @type {string}
|
|
21853
|
+
* @memberof SodPolicyRequest
|
|
21854
|
+
*/
|
|
21855
|
+
'correctionAdvice'?: string | null;
|
|
21856
|
+
/**
|
|
21857
|
+
* whether the policy is enforced or not
|
|
21858
|
+
* @type {string}
|
|
21859
|
+
* @memberof SodPolicyRequest
|
|
21860
|
+
*/
|
|
21861
|
+
'state'?: SodPolicyRequestStateV3;
|
|
21862
|
+
/**
|
|
21863
|
+
* tags for this policy object
|
|
21864
|
+
* @type {Array<string>}
|
|
21865
|
+
* @memberof SodPolicyRequest
|
|
21866
|
+
*/
|
|
21867
|
+
'tags'?: Array<string>;
|
|
21868
|
+
/**
|
|
21869
|
+
* Policy\'s creator ID
|
|
21870
|
+
* @type {string}
|
|
21871
|
+
* @memberof SodPolicyRequest
|
|
21872
|
+
*/
|
|
21873
|
+
'creatorId'?: string;
|
|
21874
|
+
/**
|
|
21875
|
+
* Policy\'s modifier ID
|
|
21876
|
+
* @type {string}
|
|
21877
|
+
* @memberof SodPolicyRequest
|
|
21878
|
+
*/
|
|
21879
|
+
'modifierId'?: string | null;
|
|
21880
|
+
/**
|
|
21881
|
+
*
|
|
21882
|
+
* @type {ViolationOwnerAssignmentConfig}
|
|
21883
|
+
* @memberof SodPolicyRequest
|
|
21884
|
+
*/
|
|
21885
|
+
'violationOwnerAssignmentConfig'?: ViolationOwnerAssignmentConfig;
|
|
21886
|
+
/**
|
|
21887
|
+
* defines whether a policy has been scheduled or not
|
|
21888
|
+
* @type {boolean}
|
|
21889
|
+
* @memberof SodPolicyRequest
|
|
21890
|
+
*/
|
|
21891
|
+
'scheduled'?: boolean;
|
|
21892
|
+
/**
|
|
21893
|
+
* whether a policy is query based or conflicting access based
|
|
21894
|
+
* @type {string}
|
|
21895
|
+
* @memberof SodPolicyRequest
|
|
21896
|
+
*/
|
|
21897
|
+
'type'?: SodPolicyRequestTypeV3;
|
|
21898
|
+
/**
|
|
21899
|
+
*
|
|
21900
|
+
* @type {SodPolicyRequestAllOfConflictingAccessCriteria}
|
|
21901
|
+
* @memberof SodPolicyRequest
|
|
21902
|
+
*/
|
|
21903
|
+
'conflictingAccessCriteria'?: SodPolicyRequestAllOfConflictingAccessCriteria;
|
|
21904
|
+
}
|
|
21905
|
+
|
|
21906
|
+
export const SodPolicyRequestStateV3 = {
|
|
21907
|
+
Enforced: 'ENFORCED',
|
|
21908
|
+
NotEnforced: 'NOT_ENFORCED'
|
|
21909
|
+
} as const;
|
|
21910
|
+
|
|
21911
|
+
export type SodPolicyRequestStateV3 = typeof SodPolicyRequestStateV3[keyof typeof SodPolicyRequestStateV3];
|
|
21912
|
+
export const SodPolicyRequestTypeV3 = {
|
|
21913
|
+
General: 'GENERAL',
|
|
21914
|
+
ConflictingAccessBased: 'CONFLICTING_ACCESS_BASED'
|
|
21915
|
+
} as const;
|
|
21916
|
+
|
|
21917
|
+
export type SodPolicyRequestTypeV3 = typeof SodPolicyRequestTypeV3[keyof typeof SodPolicyRequestTypeV3];
|
|
21918
|
+
|
|
21919
|
+
/**
|
|
21920
|
+
*
|
|
21921
|
+
* @export
|
|
21922
|
+
* @interface SodPolicyRequestAllOfConflictingAccessCriteria
|
|
21923
|
+
*/
|
|
21924
|
+
export interface SodPolicyRequestAllOfConflictingAccessCriteria {
|
|
21925
|
+
/**
|
|
21926
|
+
*
|
|
21927
|
+
* @type {AccessCriteriaRequest}
|
|
21928
|
+
* @memberof SodPolicyRequestAllOfConflictingAccessCriteria
|
|
21929
|
+
*/
|
|
21930
|
+
'leftCriteria'?: AccessCriteriaRequest;
|
|
21931
|
+
/**
|
|
21932
|
+
*
|
|
21933
|
+
* @type {AccessCriteriaRequest}
|
|
21934
|
+
* @memberof SodPolicyRequestAllOfConflictingAccessCriteria
|
|
21935
|
+
*/
|
|
21936
|
+
'rightCriteria'?: AccessCriteriaRequest;
|
|
21937
|
+
}
|
|
21603
21938
|
/**
|
|
21604
21939
|
*
|
|
21605
21940
|
* @export
|
|
@@ -26983,7 +27318,7 @@ export const AccessRequestsApiAxiosParamCreator = function (configuration?: Conf
|
|
|
26983
27318
|
};
|
|
26984
27319
|
},
|
|
26985
27320
|
/**
|
|
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. *
|
|
27321
|
+
* 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
27322
|
* @summary Submit access request
|
|
26988
27323
|
* @param {AccessRequest} accessRequest
|
|
26989
27324
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -27074,7 +27409,7 @@ export const AccessRequestsApiAxiosParamCreator = function (configuration?: Conf
|
|
|
27074
27409
|
* @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
27410
|
* @param {number} [limit] Max number of results to return.
|
|
27076
27411
|
* @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*
|
|
27412
|
+
* @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
27413
|
* @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
27414
|
* @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*.
|
|
27080
27415
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -27220,7 +27555,7 @@ export const AccessRequestsApiFp = function(configuration?: Configuration) {
|
|
|
27220
27555
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
27221
27556
|
},
|
|
27222
27557
|
/**
|
|
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. *
|
|
27558
|
+
* 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
27559
|
* @summary Submit access request
|
|
27225
27560
|
* @param {AccessRequest} accessRequest
|
|
27226
27561
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -27254,7 +27589,7 @@ export const AccessRequestsApiFp = function(configuration?: Configuration) {
|
|
|
27254
27589
|
* @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
27590
|
* @param {number} [limit] Max number of results to return.
|
|
27256
27591
|
* @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*
|
|
27592
|
+
* @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
27593
|
* @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
27594
|
* @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*.
|
|
27260
27595
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -27300,7 +27635,7 @@ export const AccessRequestsApiFactory = function (configuration?: Configuration,
|
|
|
27300
27635
|
return localVarFp.cancelAccessRequest(requestParameters.cancelAccessRequest, axiosOptions).then((request) => request(axios, basePath));
|
|
27301
27636
|
},
|
|
27302
27637
|
/**
|
|
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. *
|
|
27638
|
+
* 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
27639
|
* @summary Submit access request
|
|
27305
27640
|
* @param {AccessRequestsApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
27306
27641
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -27425,7 +27760,7 @@ export interface AccessRequestsApiListAccessRequestStatusRequest {
|
|
|
27425
27760
|
readonly offset?: number
|
|
27426
27761
|
|
|
27427
27762
|
/**
|
|
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*
|
|
27763
|
+
* 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
27764
|
* @type {string}
|
|
27430
27765
|
* @memberof AccessRequestsApiListAccessRequestStatus
|
|
27431
27766
|
*/
|
|
@@ -27480,7 +27815,7 @@ export class AccessRequestsApi extends BaseAPI {
|
|
|
27480
27815
|
}
|
|
27481
27816
|
|
|
27482
27817
|
/**
|
|
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. *
|
|
27818
|
+
* 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
27819
|
* @summary Submit access request
|
|
27485
27820
|
* @param {AccessRequestsApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
27486
27821
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -51239,13 +51574,13 @@ export const SODPoliciesApiAxiosParamCreator = function (configuration?: Configu
|
|
|
51239
51574
|
/**
|
|
51240
51575
|
* 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
51576
|
* @summary Create sod policy
|
|
51242
|
-
* @param {
|
|
51577
|
+
* @param {SodPolicyRequest} sodPolicyRequest
|
|
51243
51578
|
* @param {*} [axiosOptions] Override http request option.
|
|
51244
51579
|
* @throws {RequiredError}
|
|
51245
51580
|
*/
|
|
51246
|
-
createSodPolicy: async (
|
|
51247
|
-
// verify required parameter '
|
|
51248
|
-
assertParamExists('createSodPolicy', '
|
|
51581
|
+
createSodPolicy: async (sodPolicyRequest: SodPolicyRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
51582
|
+
// verify required parameter 'sodPolicyRequest' is not null or undefined
|
|
51583
|
+
assertParamExists('createSodPolicy', 'sodPolicyRequest', sodPolicyRequest)
|
|
51249
51584
|
const localVarPath = `/sod-policies`;
|
|
51250
51585
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
51251
51586
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -51273,7 +51608,7 @@ export const SODPoliciesApiAxiosParamCreator = function (configuration?: Configu
|
|
|
51273
51608
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
51274
51609
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
51275
51610
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
51276
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
51611
|
+
localVarRequestOptions.data = serializeDataIfNeeded(sodPolicyRequest, localVarRequestOptions, configuration)
|
|
51277
51612
|
|
|
51278
51613
|
return {
|
|
51279
51614
|
url: toPathString(localVarUrlObj),
|
|
@@ -51826,15 +52161,15 @@ export const SODPoliciesApiAxiosParamCreator = function (configuration?: Configu
|
|
|
51826
52161
|
* This updates a specified SOD policy. Requires role of ORG_ADMIN.
|
|
51827
52162
|
* @summary Update sod policy by id
|
|
51828
52163
|
* @param {string} id The ID of the SOD policy to update.
|
|
51829
|
-
* @param {
|
|
52164
|
+
* @param {SodPolicyRead} sodPolicyRead
|
|
51830
52165
|
* @param {*} [axiosOptions] Override http request option.
|
|
51831
52166
|
* @throws {RequiredError}
|
|
51832
52167
|
*/
|
|
51833
|
-
putSodPolicy: async (id: string,
|
|
52168
|
+
putSodPolicy: async (id: string, sodPolicyRead: SodPolicyRead, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
51834
52169
|
// verify required parameter 'id' is not null or undefined
|
|
51835
52170
|
assertParamExists('putSodPolicy', 'id', id)
|
|
51836
|
-
// verify required parameter '
|
|
51837
|
-
assertParamExists('putSodPolicy', '
|
|
52171
|
+
// verify required parameter 'sodPolicyRead' is not null or undefined
|
|
52172
|
+
assertParamExists('putSodPolicy', 'sodPolicyRead', sodPolicyRead)
|
|
51838
52173
|
const localVarPath = `/sod-policies/{id}`
|
|
51839
52174
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
51840
52175
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -51863,7 +52198,7 @@ export const SODPoliciesApiAxiosParamCreator = function (configuration?: Configu
|
|
|
51863
52198
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
51864
52199
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
51865
52200
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
51866
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
52201
|
+
localVarRequestOptions.data = serializeDataIfNeeded(sodPolicyRead, localVarRequestOptions, configuration)
|
|
51867
52202
|
|
|
51868
52203
|
return {
|
|
51869
52204
|
url: toPathString(localVarUrlObj),
|
|
@@ -52009,12 +52344,12 @@ export const SODPoliciesApiFp = function(configuration?: Configuration) {
|
|
|
52009
52344
|
/**
|
|
52010
52345
|
* 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
52346
|
* @summary Create sod policy
|
|
52012
|
-
* @param {
|
|
52347
|
+
* @param {SodPolicyRequest} sodPolicyRequest
|
|
52013
52348
|
* @param {*} [axiosOptions] Override http request option.
|
|
52014
52349
|
* @throws {RequiredError}
|
|
52015
52350
|
*/
|
|
52016
|
-
async createSodPolicy(
|
|
52017
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createSodPolicy(
|
|
52351
|
+
async createSodPolicy(sodPolicyRequest: SodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SodPolicyRead>> {
|
|
52352
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createSodPolicy(sodPolicyRequest, axiosOptions);
|
|
52018
52353
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
52019
52354
|
const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.createSodPolicy']?.[localVarOperationServerIndex]?.url;
|
|
52020
52355
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -52092,7 +52427,7 @@ export const SODPoliciesApiFp = function(configuration?: Configuration) {
|
|
|
52092
52427
|
* @param {*} [axiosOptions] Override http request option.
|
|
52093
52428
|
* @throws {RequiredError}
|
|
52094
52429
|
*/
|
|
52095
|
-
async getSodPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
52430
|
+
async getSodPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SodPolicyRead>> {
|
|
52096
52431
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getSodPolicy(id, axiosOptions);
|
|
52097
52432
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
52098
52433
|
const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.getSodPolicy']?.[localVarOperationServerIndex]?.url;
|
|
@@ -52148,7 +52483,7 @@ export const SODPoliciesApiFp = function(configuration?: Configuration) {
|
|
|
52148
52483
|
* @param {*} [axiosOptions] Override http request option.
|
|
52149
52484
|
* @throws {RequiredError}
|
|
52150
52485
|
*/
|
|
52151
|
-
async listSodPolicies(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
52486
|
+
async listSodPolicies(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SodPolicyRead>>> {
|
|
52152
52487
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listSodPolicies(limit, offset, count, filters, sorters, axiosOptions);
|
|
52153
52488
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
52154
52489
|
const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.listSodPolicies']?.[localVarOperationServerIndex]?.url;
|
|
@@ -52162,7 +52497,7 @@ export const SODPoliciesApiFp = function(configuration?: Configuration) {
|
|
|
52162
52497
|
* @param {*} [axiosOptions] Override http request option.
|
|
52163
52498
|
* @throws {RequiredError}
|
|
52164
52499
|
*/
|
|
52165
|
-
async patchSodPolicy(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
52500
|
+
async patchSodPolicy(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SodPolicyRead>> {
|
|
52166
52501
|
const localVarAxiosArgs = await localVarAxiosParamCreator.patchSodPolicy(id, jsonPatchOperation, axiosOptions);
|
|
52167
52502
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
52168
52503
|
const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.patchSodPolicy']?.[localVarOperationServerIndex]?.url;
|
|
@@ -52186,12 +52521,12 @@ export const SODPoliciesApiFp = function(configuration?: Configuration) {
|
|
|
52186
52521
|
* This updates a specified SOD policy. Requires role of ORG_ADMIN.
|
|
52187
52522
|
* @summary Update sod policy by id
|
|
52188
52523
|
* @param {string} id The ID of the SOD policy to update.
|
|
52189
|
-
* @param {
|
|
52524
|
+
* @param {SodPolicyRead} sodPolicyRead
|
|
52190
52525
|
* @param {*} [axiosOptions] Override http request option.
|
|
52191
52526
|
* @throws {RequiredError}
|
|
52192
52527
|
*/
|
|
52193
|
-
async putSodPolicy(id: string,
|
|
52194
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.putSodPolicy(id,
|
|
52528
|
+
async putSodPolicy(id: string, sodPolicyRead: SodPolicyRead, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SodPolicyRead>> {
|
|
52529
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.putSodPolicy(id, sodPolicyRead, axiosOptions);
|
|
52195
52530
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
52196
52531
|
const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.putSodPolicy']?.[localVarOperationServerIndex]?.url;
|
|
52197
52532
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -52252,8 +52587,8 @@ export const SODPoliciesApiFactory = function (configuration?: Configuration, ba
|
|
|
52252
52587
|
* @param {*} [axiosOptions] Override http request option.
|
|
52253
52588
|
* @throws {RequiredError}
|
|
52254
52589
|
*/
|
|
52255
|
-
createSodPolicy(requestParameters: SODPoliciesApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<
|
|
52256
|
-
return localVarFp.createSodPolicy(requestParameters.
|
|
52590
|
+
createSodPolicy(requestParameters: SODPoliciesApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SodPolicyRead> {
|
|
52591
|
+
return localVarFp.createSodPolicy(requestParameters.sodPolicyRequest, axiosOptions).then((request) => request(axios, basePath));
|
|
52257
52592
|
},
|
|
52258
52593
|
/**
|
|
52259
52594
|
* This deletes a specified SOD policy. Requires role of ORG_ADMIN.
|
|
@@ -52311,7 +52646,7 @@ export const SODPoliciesApiFactory = function (configuration?: Configuration, ba
|
|
|
52311
52646
|
* @param {*} [axiosOptions] Override http request option.
|
|
52312
52647
|
* @throws {RequiredError}
|
|
52313
52648
|
*/
|
|
52314
|
-
getSodPolicy(requestParameters: SODPoliciesApiGetSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<
|
|
52649
|
+
getSodPolicy(requestParameters: SODPoliciesApiGetSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SodPolicyRead> {
|
|
52315
52650
|
return localVarFp.getSodPolicy(requestParameters.id, axiosOptions).then((request) => request(axios, basePath));
|
|
52316
52651
|
},
|
|
52317
52652
|
/**
|
|
@@ -52351,7 +52686,7 @@ export const SODPoliciesApiFactory = function (configuration?: Configuration, ba
|
|
|
52351
52686
|
* @param {*} [axiosOptions] Override http request option.
|
|
52352
52687
|
* @throws {RequiredError}
|
|
52353
52688
|
*/
|
|
52354
|
-
listSodPolicies(requestParameters: SODPoliciesApiListSodPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
52689
|
+
listSodPolicies(requestParameters: SODPoliciesApiListSodPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<SodPolicyRead>> {
|
|
52355
52690
|
return localVarFp.listSodPolicies(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath));
|
|
52356
52691
|
},
|
|
52357
52692
|
/**
|
|
@@ -52361,7 +52696,7 @@ export const SODPoliciesApiFactory = function (configuration?: Configuration, ba
|
|
|
52361
52696
|
* @param {*} [axiosOptions] Override http request option.
|
|
52362
52697
|
* @throws {RequiredError}
|
|
52363
52698
|
*/
|
|
52364
|
-
patchSodPolicy(requestParameters: SODPoliciesApiPatchSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<
|
|
52699
|
+
patchSodPolicy(requestParameters: SODPoliciesApiPatchSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SodPolicyRead> {
|
|
52365
52700
|
return localVarFp.patchSodPolicy(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath));
|
|
52366
52701
|
},
|
|
52367
52702
|
/**
|
|
@@ -52381,8 +52716,8 @@ export const SODPoliciesApiFactory = function (configuration?: Configuration, ba
|
|
|
52381
52716
|
* @param {*} [axiosOptions] Override http request option.
|
|
52382
52717
|
* @throws {RequiredError}
|
|
52383
52718
|
*/
|
|
52384
|
-
putSodPolicy(requestParameters: SODPoliciesApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<
|
|
52385
|
-
return localVarFp.putSodPolicy(requestParameters.id, requestParameters.
|
|
52719
|
+
putSodPolicy(requestParameters: SODPoliciesApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SodPolicyRead> {
|
|
52720
|
+
return localVarFp.putSodPolicy(requestParameters.id, requestParameters.sodPolicyRead, axiosOptions).then((request) => request(axios, basePath));
|
|
52386
52721
|
},
|
|
52387
52722
|
/**
|
|
52388
52723
|
* 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 +52760,10 @@ export const SODPoliciesApiFactory = function (configuration?: Configuration, ba
|
|
|
52425
52760
|
export interface SODPoliciesApiCreateSodPolicyRequest {
|
|
52426
52761
|
/**
|
|
52427
52762
|
*
|
|
52428
|
-
* @type {
|
|
52763
|
+
* @type {SodPolicyRequest}
|
|
52429
52764
|
* @memberof SODPoliciesApiCreateSodPolicy
|
|
52430
52765
|
*/
|
|
52431
|
-
readonly
|
|
52766
|
+
readonly sodPolicyRequest: SodPolicyRequest
|
|
52432
52767
|
}
|
|
52433
52768
|
|
|
52434
52769
|
/**
|
|
@@ -52656,10 +52991,10 @@ export interface SODPoliciesApiPutSodPolicyRequest {
|
|
|
52656
52991
|
|
|
52657
52992
|
/**
|
|
52658
52993
|
*
|
|
52659
|
-
* @type {
|
|
52994
|
+
* @type {SodPolicyRead}
|
|
52660
52995
|
* @memberof SODPoliciesApiPutSodPolicy
|
|
52661
52996
|
*/
|
|
52662
|
-
readonly
|
|
52997
|
+
readonly sodPolicyRead: SodPolicyRead
|
|
52663
52998
|
}
|
|
52664
52999
|
|
|
52665
53000
|
/**
|
|
@@ -52720,7 +53055,7 @@ export class SODPoliciesApi extends BaseAPI {
|
|
|
52720
53055
|
* @memberof SODPoliciesApi
|
|
52721
53056
|
*/
|
|
52722
53057
|
public createSodPolicy(requestParameters: SODPoliciesApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) {
|
|
52723
|
-
return SODPoliciesApiFp(this.configuration).createSodPolicy(requestParameters.
|
|
53058
|
+
return SODPoliciesApiFp(this.configuration).createSodPolicy(requestParameters.sodPolicyRequest, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
52724
53059
|
}
|
|
52725
53060
|
|
|
52726
53061
|
/**
|
|
@@ -52875,7 +53210,7 @@ export class SODPoliciesApi extends BaseAPI {
|
|
|
52875
53210
|
* @memberof SODPoliciesApi
|
|
52876
53211
|
*/
|
|
52877
53212
|
public putSodPolicy(requestParameters: SODPoliciesApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) {
|
|
52878
|
-
return SODPoliciesApiFp(this.configuration).putSodPolicy(requestParameters.id, requestParameters.
|
|
53213
|
+
return SODPoliciesApiFp(this.configuration).putSodPolicy(requestParameters.id, requestParameters.sodPolicyRead, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
52879
53214
|
}
|
|
52880
53215
|
|
|
52881
53216
|
/**
|