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/dist/v3/api.d.ts
CHANGED
|
@@ -172,7 +172,7 @@ export interface AccessCriteria {
|
|
|
172
172
|
*/
|
|
173
173
|
export interface AccessCriteriaCriteriaListInner {
|
|
174
174
|
/**
|
|
175
|
-
* Type of the
|
|
175
|
+
* Type of the property to which this reference applies to
|
|
176
176
|
* @type {string}
|
|
177
177
|
* @memberof AccessCriteriaCriteriaListInner
|
|
178
178
|
*/
|
|
@@ -194,6 +194,48 @@ export declare const AccessCriteriaCriteriaListInnerTypeV3: {
|
|
|
194
194
|
readonly Entitlement: "ENTITLEMENT";
|
|
195
195
|
};
|
|
196
196
|
export type AccessCriteriaCriteriaListInnerTypeV3 = typeof AccessCriteriaCriteriaListInnerTypeV3[keyof typeof AccessCriteriaCriteriaListInnerTypeV3];
|
|
197
|
+
/**
|
|
198
|
+
*
|
|
199
|
+
* @export
|
|
200
|
+
* @interface AccessCriteriaRequest
|
|
201
|
+
*/
|
|
202
|
+
export interface AccessCriteriaRequest {
|
|
203
|
+
/**
|
|
204
|
+
* Business name for the access construct list
|
|
205
|
+
* @type {string}
|
|
206
|
+
* @memberof AccessCriteriaRequest
|
|
207
|
+
*/
|
|
208
|
+
'name'?: string;
|
|
209
|
+
/**
|
|
210
|
+
* List of criteria. There is a min of 1 and max of 50 items in the list.
|
|
211
|
+
* @type {Array<AccessCriteriaRequestCriteriaListInner>}
|
|
212
|
+
* @memberof AccessCriteriaRequest
|
|
213
|
+
*/
|
|
214
|
+
'criteriaList'?: Array<AccessCriteriaRequestCriteriaListInner>;
|
|
215
|
+
}
|
|
216
|
+
/**
|
|
217
|
+
*
|
|
218
|
+
* @export
|
|
219
|
+
* @interface AccessCriteriaRequestCriteriaListInner
|
|
220
|
+
*/
|
|
221
|
+
export interface AccessCriteriaRequestCriteriaListInner {
|
|
222
|
+
/**
|
|
223
|
+
* Type of the property to which this reference applies to
|
|
224
|
+
* @type {string}
|
|
225
|
+
* @memberof AccessCriteriaRequestCriteriaListInner
|
|
226
|
+
*/
|
|
227
|
+
'type'?: AccessCriteriaRequestCriteriaListInnerTypeV3;
|
|
228
|
+
/**
|
|
229
|
+
* ID of the object to which this reference applies to
|
|
230
|
+
* @type {string}
|
|
231
|
+
* @memberof AccessCriteriaRequestCriteriaListInner
|
|
232
|
+
*/
|
|
233
|
+
'id'?: string;
|
|
234
|
+
}
|
|
235
|
+
export declare const AccessCriteriaRequestCriteriaListInnerTypeV3: {
|
|
236
|
+
readonly Entitlement: "ENTITLEMENT";
|
|
237
|
+
};
|
|
238
|
+
export type AccessCriteriaRequestCriteriaListInnerTypeV3 = typeof AccessCriteriaRequestCriteriaListInnerTypeV3[keyof typeof AccessCriteriaRequestCriteriaListInnerTypeV3];
|
|
197
239
|
/**
|
|
198
240
|
* Identity the access item is requested for.
|
|
199
241
|
* @export
|
|
@@ -4817,7 +4859,6 @@ export interface CampaignAllOfFilter {
|
|
|
4817
4859
|
}
|
|
4818
4860
|
export declare const CampaignAllOfFilterTypeV3: {
|
|
4819
4861
|
readonly CampaignFilter: "CAMPAIGN_FILTER";
|
|
4820
|
-
readonly Rule: "RULE";
|
|
4821
4862
|
};
|
|
4822
4863
|
export type CampaignAllOfFilterTypeV3 = typeof CampaignAllOfFilterTypeV3[keyof typeof CampaignAllOfFilterTypeV3];
|
|
4823
4864
|
/**
|
|
@@ -6294,6 +6335,25 @@ export interface ConflictingAccessCriteria {
|
|
|
6294
6335
|
*/
|
|
6295
6336
|
'rightCriteria'?: AccessCriteria;
|
|
6296
6337
|
}
|
|
6338
|
+
/**
|
|
6339
|
+
*
|
|
6340
|
+
* @export
|
|
6341
|
+
* @interface ConflictingAccessCriteriaRequest
|
|
6342
|
+
*/
|
|
6343
|
+
export interface ConflictingAccessCriteriaRequest {
|
|
6344
|
+
/**
|
|
6345
|
+
*
|
|
6346
|
+
* @type {AccessCriteriaRequest}
|
|
6347
|
+
* @memberof ConflictingAccessCriteriaRequest
|
|
6348
|
+
*/
|
|
6349
|
+
'leftCriteria'?: AccessCriteriaRequest;
|
|
6350
|
+
/**
|
|
6351
|
+
*
|
|
6352
|
+
* @type {AccessCriteriaRequest}
|
|
6353
|
+
* @memberof ConflictingAccessCriteriaRequest
|
|
6354
|
+
*/
|
|
6355
|
+
'rightCriteria'?: AccessCriteriaRequest;
|
|
6356
|
+
}
|
|
6297
6357
|
/**
|
|
6298
6358
|
*
|
|
6299
6359
|
* @export
|
|
@@ -20911,12 +20971,6 @@ export interface SodPolicy {
|
|
|
20911
20971
|
* @memberof SodPolicy
|
|
20912
20972
|
*/
|
|
20913
20973
|
'type'?: SodPolicyTypeV3;
|
|
20914
|
-
/**
|
|
20915
|
-
*
|
|
20916
|
-
* @type {SodPolicyConflictingAccessCriteria}
|
|
20917
|
-
* @memberof SodPolicy
|
|
20918
|
-
*/
|
|
20919
|
-
'conflictingAccessCriteria'?: SodPolicyConflictingAccessCriteria;
|
|
20920
20974
|
}
|
|
20921
20975
|
export declare const SodPolicyStateV3: {
|
|
20922
20976
|
readonly Enforced: "ENFORCED";
|
|
@@ -20928,25 +20982,6 @@ export declare const SodPolicyTypeV3: {
|
|
|
20928
20982
|
readonly ConflictingAccessBased: "CONFLICTING_ACCESS_BASED";
|
|
20929
20983
|
};
|
|
20930
20984
|
export type SodPolicyTypeV3 = typeof SodPolicyTypeV3[keyof typeof SodPolicyTypeV3];
|
|
20931
|
-
/**
|
|
20932
|
-
*
|
|
20933
|
-
* @export
|
|
20934
|
-
* @interface SodPolicyConflictingAccessCriteria
|
|
20935
|
-
*/
|
|
20936
|
-
export interface SodPolicyConflictingAccessCriteria {
|
|
20937
|
-
/**
|
|
20938
|
-
*
|
|
20939
|
-
* @type {AccessCriteria}
|
|
20940
|
-
* @memberof SodPolicyConflictingAccessCriteria
|
|
20941
|
-
*/
|
|
20942
|
-
'leftCriteria'?: AccessCriteria;
|
|
20943
|
-
/**
|
|
20944
|
-
*
|
|
20945
|
-
* @type {AccessCriteria}
|
|
20946
|
-
* @memberof SodPolicyConflictingAccessCriteria
|
|
20947
|
-
*/
|
|
20948
|
-
'rightCriteria'?: AccessCriteria;
|
|
20949
|
-
}
|
|
20950
20985
|
/**
|
|
20951
20986
|
* SOD policy.
|
|
20952
20987
|
* @export
|
|
@@ -21006,6 +21041,294 @@ export declare const SodPolicyOwnerRefTypeV3: {
|
|
|
21006
21041
|
readonly GovernanceGroup: "GOVERNANCE_GROUP";
|
|
21007
21042
|
};
|
|
21008
21043
|
export type SodPolicyOwnerRefTypeV3 = typeof SodPolicyOwnerRefTypeV3[keyof typeof SodPolicyOwnerRefTypeV3];
|
|
21044
|
+
/**
|
|
21045
|
+
*
|
|
21046
|
+
* @export
|
|
21047
|
+
* @interface SodPolicyRead
|
|
21048
|
+
*/
|
|
21049
|
+
export interface SodPolicyRead {
|
|
21050
|
+
/**
|
|
21051
|
+
* Policy id
|
|
21052
|
+
* @type {string}
|
|
21053
|
+
* @memberof SodPolicyRead
|
|
21054
|
+
*/
|
|
21055
|
+
'id'?: string;
|
|
21056
|
+
/**
|
|
21057
|
+
* Policy Business Name
|
|
21058
|
+
* @type {string}
|
|
21059
|
+
* @memberof SodPolicyRead
|
|
21060
|
+
*/
|
|
21061
|
+
'name'?: string;
|
|
21062
|
+
/**
|
|
21063
|
+
* The time when this SOD policy is created.
|
|
21064
|
+
* @type {string}
|
|
21065
|
+
* @memberof SodPolicyRead
|
|
21066
|
+
*/
|
|
21067
|
+
'created'?: string;
|
|
21068
|
+
/**
|
|
21069
|
+
* The time when this SOD policy is modified.
|
|
21070
|
+
* @type {string}
|
|
21071
|
+
* @memberof SodPolicyRead
|
|
21072
|
+
*/
|
|
21073
|
+
'modified'?: string;
|
|
21074
|
+
/**
|
|
21075
|
+
* Optional description of the SOD policy
|
|
21076
|
+
* @type {string}
|
|
21077
|
+
* @memberof SodPolicyRead
|
|
21078
|
+
*/
|
|
21079
|
+
'description'?: string | null;
|
|
21080
|
+
/**
|
|
21081
|
+
*
|
|
21082
|
+
* @type {SodPolicyOwnerRef}
|
|
21083
|
+
* @memberof SodPolicyRead
|
|
21084
|
+
*/
|
|
21085
|
+
'ownerRef'?: SodPolicyOwnerRef;
|
|
21086
|
+
/**
|
|
21087
|
+
* Optional External Policy Reference
|
|
21088
|
+
* @type {string}
|
|
21089
|
+
* @memberof SodPolicyRead
|
|
21090
|
+
*/
|
|
21091
|
+
'externalPolicyReference'?: string | null;
|
|
21092
|
+
/**
|
|
21093
|
+
* Search query of the SOD policy
|
|
21094
|
+
* @type {string}
|
|
21095
|
+
* @memberof SodPolicyRead
|
|
21096
|
+
*/
|
|
21097
|
+
'policyQuery'?: string;
|
|
21098
|
+
/**
|
|
21099
|
+
* Optional compensating controls(Mitigating Controls)
|
|
21100
|
+
* @type {string}
|
|
21101
|
+
* @memberof SodPolicyRead
|
|
21102
|
+
*/
|
|
21103
|
+
'compensatingControls'?: string | null;
|
|
21104
|
+
/**
|
|
21105
|
+
* Optional correction advice
|
|
21106
|
+
* @type {string}
|
|
21107
|
+
* @memberof SodPolicyRead
|
|
21108
|
+
*/
|
|
21109
|
+
'correctionAdvice'?: string | null;
|
|
21110
|
+
/**
|
|
21111
|
+
* whether the policy is enforced or not
|
|
21112
|
+
* @type {string}
|
|
21113
|
+
* @memberof SodPolicyRead
|
|
21114
|
+
*/
|
|
21115
|
+
'state'?: SodPolicyReadStateV3;
|
|
21116
|
+
/**
|
|
21117
|
+
* tags for this policy object
|
|
21118
|
+
* @type {Array<string>}
|
|
21119
|
+
* @memberof SodPolicyRead
|
|
21120
|
+
*/
|
|
21121
|
+
'tags'?: Array<string>;
|
|
21122
|
+
/**
|
|
21123
|
+
* Policy\'s creator ID
|
|
21124
|
+
* @type {string}
|
|
21125
|
+
* @memberof SodPolicyRead
|
|
21126
|
+
*/
|
|
21127
|
+
'creatorId'?: string;
|
|
21128
|
+
/**
|
|
21129
|
+
* Policy\'s modifier ID
|
|
21130
|
+
* @type {string}
|
|
21131
|
+
* @memberof SodPolicyRead
|
|
21132
|
+
*/
|
|
21133
|
+
'modifierId'?: string | null;
|
|
21134
|
+
/**
|
|
21135
|
+
*
|
|
21136
|
+
* @type {ViolationOwnerAssignmentConfig}
|
|
21137
|
+
* @memberof SodPolicyRead
|
|
21138
|
+
*/
|
|
21139
|
+
'violationOwnerAssignmentConfig'?: ViolationOwnerAssignmentConfig;
|
|
21140
|
+
/**
|
|
21141
|
+
* defines whether a policy has been scheduled or not
|
|
21142
|
+
* @type {boolean}
|
|
21143
|
+
* @memberof SodPolicyRead
|
|
21144
|
+
*/
|
|
21145
|
+
'scheduled'?: boolean;
|
|
21146
|
+
/**
|
|
21147
|
+
* whether a policy is query based or conflicting access based
|
|
21148
|
+
* @type {string}
|
|
21149
|
+
* @memberof SodPolicyRead
|
|
21150
|
+
*/
|
|
21151
|
+
'type'?: SodPolicyReadTypeV3;
|
|
21152
|
+
/**
|
|
21153
|
+
*
|
|
21154
|
+
* @type {SodPolicyReadAllOfConflictingAccessCriteria}
|
|
21155
|
+
* @memberof SodPolicyRead
|
|
21156
|
+
*/
|
|
21157
|
+
'conflictingAccessCriteria'?: SodPolicyReadAllOfConflictingAccessCriteria;
|
|
21158
|
+
}
|
|
21159
|
+
export declare const SodPolicyReadStateV3: {
|
|
21160
|
+
readonly Enforced: "ENFORCED";
|
|
21161
|
+
readonly NotEnforced: "NOT_ENFORCED";
|
|
21162
|
+
};
|
|
21163
|
+
export type SodPolicyReadStateV3 = typeof SodPolicyReadStateV3[keyof typeof SodPolicyReadStateV3];
|
|
21164
|
+
export declare const SodPolicyReadTypeV3: {
|
|
21165
|
+
readonly General: "GENERAL";
|
|
21166
|
+
readonly ConflictingAccessBased: "CONFLICTING_ACCESS_BASED";
|
|
21167
|
+
};
|
|
21168
|
+
export type SodPolicyReadTypeV3 = typeof SodPolicyReadTypeV3[keyof typeof SodPolicyReadTypeV3];
|
|
21169
|
+
/**
|
|
21170
|
+
*
|
|
21171
|
+
* @export
|
|
21172
|
+
* @interface SodPolicyReadAllOfConflictingAccessCriteria
|
|
21173
|
+
*/
|
|
21174
|
+
export interface SodPolicyReadAllOfConflictingAccessCriteria {
|
|
21175
|
+
/**
|
|
21176
|
+
*
|
|
21177
|
+
* @type {AccessCriteria}
|
|
21178
|
+
* @memberof SodPolicyReadAllOfConflictingAccessCriteria
|
|
21179
|
+
*/
|
|
21180
|
+
'leftCriteria'?: AccessCriteria;
|
|
21181
|
+
/**
|
|
21182
|
+
*
|
|
21183
|
+
* @type {AccessCriteria}
|
|
21184
|
+
* @memberof SodPolicyReadAllOfConflictingAccessCriteria
|
|
21185
|
+
*/
|
|
21186
|
+
'rightCriteria'?: AccessCriteria;
|
|
21187
|
+
}
|
|
21188
|
+
/**
|
|
21189
|
+
*
|
|
21190
|
+
* @export
|
|
21191
|
+
* @interface SodPolicyRequest
|
|
21192
|
+
*/
|
|
21193
|
+
export interface SodPolicyRequest {
|
|
21194
|
+
/**
|
|
21195
|
+
* Policy id
|
|
21196
|
+
* @type {string}
|
|
21197
|
+
* @memberof SodPolicyRequest
|
|
21198
|
+
*/
|
|
21199
|
+
'id'?: string;
|
|
21200
|
+
/**
|
|
21201
|
+
* Policy Business Name
|
|
21202
|
+
* @type {string}
|
|
21203
|
+
* @memberof SodPolicyRequest
|
|
21204
|
+
*/
|
|
21205
|
+
'name'?: string;
|
|
21206
|
+
/**
|
|
21207
|
+
* The time when this SOD policy is created.
|
|
21208
|
+
* @type {string}
|
|
21209
|
+
* @memberof SodPolicyRequest
|
|
21210
|
+
*/
|
|
21211
|
+
'created'?: string;
|
|
21212
|
+
/**
|
|
21213
|
+
* The time when this SOD policy is modified.
|
|
21214
|
+
* @type {string}
|
|
21215
|
+
* @memberof SodPolicyRequest
|
|
21216
|
+
*/
|
|
21217
|
+
'modified'?: string;
|
|
21218
|
+
/**
|
|
21219
|
+
* Optional description of the SOD policy
|
|
21220
|
+
* @type {string}
|
|
21221
|
+
* @memberof SodPolicyRequest
|
|
21222
|
+
*/
|
|
21223
|
+
'description'?: string | null;
|
|
21224
|
+
/**
|
|
21225
|
+
*
|
|
21226
|
+
* @type {SodPolicyOwnerRef}
|
|
21227
|
+
* @memberof SodPolicyRequest
|
|
21228
|
+
*/
|
|
21229
|
+
'ownerRef'?: SodPolicyOwnerRef;
|
|
21230
|
+
/**
|
|
21231
|
+
* Optional External Policy Reference
|
|
21232
|
+
* @type {string}
|
|
21233
|
+
* @memberof SodPolicyRequest
|
|
21234
|
+
*/
|
|
21235
|
+
'externalPolicyReference'?: string | null;
|
|
21236
|
+
/**
|
|
21237
|
+
* Search query of the SOD policy
|
|
21238
|
+
* @type {string}
|
|
21239
|
+
* @memberof SodPolicyRequest
|
|
21240
|
+
*/
|
|
21241
|
+
'policyQuery'?: string;
|
|
21242
|
+
/**
|
|
21243
|
+
* Optional compensating controls(Mitigating Controls)
|
|
21244
|
+
* @type {string}
|
|
21245
|
+
* @memberof SodPolicyRequest
|
|
21246
|
+
*/
|
|
21247
|
+
'compensatingControls'?: string | null;
|
|
21248
|
+
/**
|
|
21249
|
+
* Optional correction advice
|
|
21250
|
+
* @type {string}
|
|
21251
|
+
* @memberof SodPolicyRequest
|
|
21252
|
+
*/
|
|
21253
|
+
'correctionAdvice'?: string | null;
|
|
21254
|
+
/**
|
|
21255
|
+
* whether the policy is enforced or not
|
|
21256
|
+
* @type {string}
|
|
21257
|
+
* @memberof SodPolicyRequest
|
|
21258
|
+
*/
|
|
21259
|
+
'state'?: SodPolicyRequestStateV3;
|
|
21260
|
+
/**
|
|
21261
|
+
* tags for this policy object
|
|
21262
|
+
* @type {Array<string>}
|
|
21263
|
+
* @memberof SodPolicyRequest
|
|
21264
|
+
*/
|
|
21265
|
+
'tags'?: Array<string>;
|
|
21266
|
+
/**
|
|
21267
|
+
* Policy\'s creator ID
|
|
21268
|
+
* @type {string}
|
|
21269
|
+
* @memberof SodPolicyRequest
|
|
21270
|
+
*/
|
|
21271
|
+
'creatorId'?: string;
|
|
21272
|
+
/**
|
|
21273
|
+
* Policy\'s modifier ID
|
|
21274
|
+
* @type {string}
|
|
21275
|
+
* @memberof SodPolicyRequest
|
|
21276
|
+
*/
|
|
21277
|
+
'modifierId'?: string | null;
|
|
21278
|
+
/**
|
|
21279
|
+
*
|
|
21280
|
+
* @type {ViolationOwnerAssignmentConfig}
|
|
21281
|
+
* @memberof SodPolicyRequest
|
|
21282
|
+
*/
|
|
21283
|
+
'violationOwnerAssignmentConfig'?: ViolationOwnerAssignmentConfig;
|
|
21284
|
+
/**
|
|
21285
|
+
* defines whether a policy has been scheduled or not
|
|
21286
|
+
* @type {boolean}
|
|
21287
|
+
* @memberof SodPolicyRequest
|
|
21288
|
+
*/
|
|
21289
|
+
'scheduled'?: boolean;
|
|
21290
|
+
/**
|
|
21291
|
+
* whether a policy is query based or conflicting access based
|
|
21292
|
+
* @type {string}
|
|
21293
|
+
* @memberof SodPolicyRequest
|
|
21294
|
+
*/
|
|
21295
|
+
'type'?: SodPolicyRequestTypeV3;
|
|
21296
|
+
/**
|
|
21297
|
+
*
|
|
21298
|
+
* @type {SodPolicyRequestAllOfConflictingAccessCriteria}
|
|
21299
|
+
* @memberof SodPolicyRequest
|
|
21300
|
+
*/
|
|
21301
|
+
'conflictingAccessCriteria'?: SodPolicyRequestAllOfConflictingAccessCriteria;
|
|
21302
|
+
}
|
|
21303
|
+
export declare const SodPolicyRequestStateV3: {
|
|
21304
|
+
readonly Enforced: "ENFORCED";
|
|
21305
|
+
readonly NotEnforced: "NOT_ENFORCED";
|
|
21306
|
+
};
|
|
21307
|
+
export type SodPolicyRequestStateV3 = typeof SodPolicyRequestStateV3[keyof typeof SodPolicyRequestStateV3];
|
|
21308
|
+
export declare const SodPolicyRequestTypeV3: {
|
|
21309
|
+
readonly General: "GENERAL";
|
|
21310
|
+
readonly ConflictingAccessBased: "CONFLICTING_ACCESS_BASED";
|
|
21311
|
+
};
|
|
21312
|
+
export type SodPolicyRequestTypeV3 = typeof SodPolicyRequestTypeV3[keyof typeof SodPolicyRequestTypeV3];
|
|
21313
|
+
/**
|
|
21314
|
+
*
|
|
21315
|
+
* @export
|
|
21316
|
+
* @interface SodPolicyRequestAllOfConflictingAccessCriteria
|
|
21317
|
+
*/
|
|
21318
|
+
export interface SodPolicyRequestAllOfConflictingAccessCriteria {
|
|
21319
|
+
/**
|
|
21320
|
+
*
|
|
21321
|
+
* @type {AccessCriteriaRequest}
|
|
21322
|
+
* @memberof SodPolicyRequestAllOfConflictingAccessCriteria
|
|
21323
|
+
*/
|
|
21324
|
+
'leftCriteria'?: AccessCriteriaRequest;
|
|
21325
|
+
/**
|
|
21326
|
+
*
|
|
21327
|
+
* @type {AccessCriteriaRequest}
|
|
21328
|
+
* @memberof SodPolicyRequestAllOfConflictingAccessCriteria
|
|
21329
|
+
*/
|
|
21330
|
+
'rightCriteria'?: AccessCriteriaRequest;
|
|
21331
|
+
}
|
|
21009
21332
|
/**
|
|
21010
21333
|
*
|
|
21011
21334
|
* @export
|
|
@@ -25427,7 +25750,7 @@ export declare const AccessRequestsApiAxiosParamCreator: (configuration?: Config
|
|
|
25427
25750
|
*/
|
|
25428
25751
|
cancelAccessRequest: (cancelAccessRequest: CancelAccessRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
25429
25752
|
/**
|
|
25430
|
-
* 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. *
|
|
25753
|
+
* 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.
|
|
25431
25754
|
* @summary Submit access request
|
|
25432
25755
|
* @param {AccessRequest} accessRequest
|
|
25433
25756
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25451,7 +25774,7 @@ export declare const AccessRequestsApiAxiosParamCreator: (configuration?: Config
|
|
|
25451
25774
|
* @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.
|
|
25452
25775
|
* @param {number} [limit] Max number of results to return.
|
|
25453
25776
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.
|
|
25454
|
-
* @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*
|
|
25777
|
+
* @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*
|
|
25455
25778
|
* @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**
|
|
25456
25779
|
* @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*.
|
|
25457
25780
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25481,7 +25804,7 @@ export declare const AccessRequestsApiFp: (configuration?: Configuration) => {
|
|
|
25481
25804
|
*/
|
|
25482
25805
|
cancelAccessRequest(cancelAccessRequest: CancelAccessRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
25483
25806
|
/**
|
|
25484
|
-
* 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. *
|
|
25807
|
+
* 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.
|
|
25485
25808
|
* @summary Submit access request
|
|
25486
25809
|
* @param {AccessRequest} accessRequest
|
|
25487
25810
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25505,7 +25828,7 @@ export declare const AccessRequestsApiFp: (configuration?: Configuration) => {
|
|
|
25505
25828
|
* @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.
|
|
25506
25829
|
* @param {number} [limit] Max number of results to return.
|
|
25507
25830
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.
|
|
25508
|
-
* @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*
|
|
25831
|
+
* @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*
|
|
25509
25832
|
* @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**
|
|
25510
25833
|
* @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*.
|
|
25511
25834
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25535,7 +25858,7 @@ export declare const AccessRequestsApiFactory: (configuration?: Configuration, b
|
|
|
25535
25858
|
*/
|
|
25536
25859
|
cancelAccessRequest(requestParameters: AccessRequestsApiCancelAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
25537
25860
|
/**
|
|
25538
|
-
* 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. *
|
|
25861
|
+
* 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.
|
|
25539
25862
|
* @summary Submit access request
|
|
25540
25863
|
* @param {AccessRequestsApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
25541
25864
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25641,7 +25964,7 @@ export interface AccessRequestsApiListAccessRequestStatusRequest {
|
|
|
25641
25964
|
*/
|
|
25642
25965
|
readonly offset?: number;
|
|
25643
25966
|
/**
|
|
25644
|
-
* 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*
|
|
25967
|
+
* 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*
|
|
25645
25968
|
* @type {string}
|
|
25646
25969
|
* @memberof AccessRequestsApiListAccessRequestStatus
|
|
25647
25970
|
*/
|
|
@@ -25689,7 +26012,7 @@ export declare class AccessRequestsApi extends BaseAPI {
|
|
|
25689
26012
|
*/
|
|
25690
26013
|
cancelAccessRequest(requestParameters: AccessRequestsApiCancelAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
25691
26014
|
/**
|
|
25692
|
-
* 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. *
|
|
26015
|
+
* 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.
|
|
25693
26016
|
* @summary Submit access request
|
|
25694
26017
|
* @param {AccessRequestsApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
25695
26018
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -38126,11 +38449,11 @@ export declare const SODPoliciesApiAxiosParamCreator: (configuration?: Configura
|
|
|
38126
38449
|
/**
|
|
38127
38450
|
* 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.
|
|
38128
38451
|
* @summary Create sod policy
|
|
38129
|
-
* @param {
|
|
38452
|
+
* @param {SodPolicyRequest} sodPolicyRequest
|
|
38130
38453
|
* @param {*} [axiosOptions] Override http request option.
|
|
38131
38454
|
* @throws {RequiredError}
|
|
38132
38455
|
*/
|
|
38133
|
-
createSodPolicy: (
|
|
38456
|
+
createSodPolicy: (sodPolicyRequest: SodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
38134
38457
|
/**
|
|
38135
38458
|
* This deletes a specified SOD policy. Requires role of ORG_ADMIN.
|
|
38136
38459
|
* @summary Delete sod policy by id
|
|
@@ -38238,11 +38561,11 @@ export declare const SODPoliciesApiAxiosParamCreator: (configuration?: Configura
|
|
|
38238
38561
|
* This updates a specified SOD policy. Requires role of ORG_ADMIN.
|
|
38239
38562
|
* @summary Update sod policy by id
|
|
38240
38563
|
* @param {string} id The ID of the SOD policy to update.
|
|
38241
|
-
* @param {
|
|
38564
|
+
* @param {SodPolicyRead} sodPolicyRead
|
|
38242
38565
|
* @param {*} [axiosOptions] Override http request option.
|
|
38243
38566
|
* @throws {RequiredError}
|
|
38244
38567
|
*/
|
|
38245
|
-
putSodPolicy: (id: string,
|
|
38568
|
+
putSodPolicy: (id: string, sodPolicyRead: SodPolicyRead, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
38246
38569
|
/**
|
|
38247
38570
|
* Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID.
|
|
38248
38571
|
* @summary Evaluate one policy by id
|
|
@@ -38276,11 +38599,11 @@ export declare const SODPoliciesApiFp: (configuration?: Configuration) => {
|
|
|
38276
38599
|
/**
|
|
38277
38600
|
* 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.
|
|
38278
38601
|
* @summary Create sod policy
|
|
38279
|
-
* @param {
|
|
38602
|
+
* @param {SodPolicyRequest} sodPolicyRequest
|
|
38280
38603
|
* @param {*} [axiosOptions] Override http request option.
|
|
38281
38604
|
* @throws {RequiredError}
|
|
38282
38605
|
*/
|
|
38283
|
-
createSodPolicy(
|
|
38606
|
+
createSodPolicy(sodPolicyRequest: SodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SodPolicyRead>>;
|
|
38284
38607
|
/**
|
|
38285
38608
|
* This deletes a specified SOD policy. Requires role of ORG_ADMIN.
|
|
38286
38609
|
* @summary Delete sod policy by id
|
|
@@ -38329,7 +38652,7 @@ export declare const SODPoliciesApiFp: (configuration?: Configuration) => {
|
|
|
38329
38652
|
* @param {*} [axiosOptions] Override http request option.
|
|
38330
38653
|
* @throws {RequiredError}
|
|
38331
38654
|
*/
|
|
38332
|
-
getSodPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
38655
|
+
getSodPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SodPolicyRead>>;
|
|
38333
38656
|
/**
|
|
38334
38657
|
* This endpoint gets a specified SOD policy\'s schedule.
|
|
38335
38658
|
* @summary Get sod policy schedule
|
|
@@ -38365,7 +38688,7 @@ export declare const SODPoliciesApiFp: (configuration?: Configuration) => {
|
|
|
38365
38688
|
* @param {*} [axiosOptions] Override http request option.
|
|
38366
38689
|
* @throws {RequiredError}
|
|
38367
38690
|
*/
|
|
38368
|
-
listSodPolicies(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
38691
|
+
listSodPolicies(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SodPolicyRead>>>;
|
|
38369
38692
|
/**
|
|
38370
38693
|
* Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception.
|
|
38371
38694
|
* @summary Patch sod policy by id
|
|
@@ -38374,7 +38697,7 @@ export declare const SODPoliciesApiFp: (configuration?: Configuration) => {
|
|
|
38374
38697
|
* @param {*} [axiosOptions] Override http request option.
|
|
38375
38698
|
* @throws {RequiredError}
|
|
38376
38699
|
*/
|
|
38377
|
-
patchSodPolicy(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
38700
|
+
patchSodPolicy(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SodPolicyRead>>;
|
|
38378
38701
|
/**
|
|
38379
38702
|
* This updates schedule for a specified SOD policy.
|
|
38380
38703
|
* @summary Update sod policy schedule
|
|
@@ -38388,11 +38711,11 @@ export declare const SODPoliciesApiFp: (configuration?: Configuration) => {
|
|
|
38388
38711
|
* This updates a specified SOD policy. Requires role of ORG_ADMIN.
|
|
38389
38712
|
* @summary Update sod policy by id
|
|
38390
38713
|
* @param {string} id The ID of the SOD policy to update.
|
|
38391
|
-
* @param {
|
|
38714
|
+
* @param {SodPolicyRead} sodPolicyRead
|
|
38392
38715
|
* @param {*} [axiosOptions] Override http request option.
|
|
38393
38716
|
* @throws {RequiredError}
|
|
38394
38717
|
*/
|
|
38395
|
-
putSodPolicy(id: string,
|
|
38718
|
+
putSodPolicy(id: string, sodPolicyRead: SodPolicyRead, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SodPolicyRead>>;
|
|
38396
38719
|
/**
|
|
38397
38720
|
* Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID.
|
|
38398
38721
|
* @summary Evaluate one policy by id
|
|
@@ -38430,7 +38753,7 @@ export declare const SODPoliciesApiFactory: (configuration?: Configuration, base
|
|
|
38430
38753
|
* @param {*} [axiosOptions] Override http request option.
|
|
38431
38754
|
* @throws {RequiredError}
|
|
38432
38755
|
*/
|
|
38433
|
-
createSodPolicy(requestParameters: SODPoliciesApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<
|
|
38756
|
+
createSodPolicy(requestParameters: SODPoliciesApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SodPolicyRead>;
|
|
38434
38757
|
/**
|
|
38435
38758
|
* This deletes a specified SOD policy. Requires role of ORG_ADMIN.
|
|
38436
38759
|
* @summary Delete sod policy by id
|
|
@@ -38477,7 +38800,7 @@ export declare const SODPoliciesApiFactory: (configuration?: Configuration, base
|
|
|
38477
38800
|
* @param {*} [axiosOptions] Override http request option.
|
|
38478
38801
|
* @throws {RequiredError}
|
|
38479
38802
|
*/
|
|
38480
|
-
getSodPolicy(requestParameters: SODPoliciesApiGetSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<
|
|
38803
|
+
getSodPolicy(requestParameters: SODPoliciesApiGetSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SodPolicyRead>;
|
|
38481
38804
|
/**
|
|
38482
38805
|
* This endpoint gets a specified SOD policy\'s schedule.
|
|
38483
38806
|
* @summary Get sod policy schedule
|
|
@@ -38509,7 +38832,7 @@ export declare const SODPoliciesApiFactory: (configuration?: Configuration, base
|
|
|
38509
38832
|
* @param {*} [axiosOptions] Override http request option.
|
|
38510
38833
|
* @throws {RequiredError}
|
|
38511
38834
|
*/
|
|
38512
|
-
listSodPolicies(requestParameters?: SODPoliciesApiListSodPoliciesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
38835
|
+
listSodPolicies(requestParameters?: SODPoliciesApiListSodPoliciesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<SodPolicyRead>>;
|
|
38513
38836
|
/**
|
|
38514
38837
|
* Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception.
|
|
38515
38838
|
* @summary Patch sod policy by id
|
|
@@ -38517,7 +38840,7 @@ export declare const SODPoliciesApiFactory: (configuration?: Configuration, base
|
|
|
38517
38840
|
* @param {*} [axiosOptions] Override http request option.
|
|
38518
38841
|
* @throws {RequiredError}
|
|
38519
38842
|
*/
|
|
38520
|
-
patchSodPolicy(requestParameters: SODPoliciesApiPatchSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<
|
|
38843
|
+
patchSodPolicy(requestParameters: SODPoliciesApiPatchSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SodPolicyRead>;
|
|
38521
38844
|
/**
|
|
38522
38845
|
* This updates schedule for a specified SOD policy.
|
|
38523
38846
|
* @summary Update sod policy schedule
|
|
@@ -38533,7 +38856,7 @@ export declare const SODPoliciesApiFactory: (configuration?: Configuration, base
|
|
|
38533
38856
|
* @param {*} [axiosOptions] Override http request option.
|
|
38534
38857
|
* @throws {RequiredError}
|
|
38535
38858
|
*/
|
|
38536
|
-
putSodPolicy(requestParameters: SODPoliciesApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<
|
|
38859
|
+
putSodPolicy(requestParameters: SODPoliciesApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SodPolicyRead>;
|
|
38537
38860
|
/**
|
|
38538
38861
|
* Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID.
|
|
38539
38862
|
* @summary Evaluate one policy by id
|
|
@@ -38567,10 +38890,10 @@ export declare const SODPoliciesApiFactory: (configuration?: Configuration, base
|
|
|
38567
38890
|
export interface SODPoliciesApiCreateSodPolicyRequest {
|
|
38568
38891
|
/**
|
|
38569
38892
|
*
|
|
38570
|
-
* @type {
|
|
38893
|
+
* @type {SodPolicyRequest}
|
|
38571
38894
|
* @memberof SODPoliciesApiCreateSodPolicy
|
|
38572
38895
|
*/
|
|
38573
|
-
readonly
|
|
38896
|
+
readonly sodPolicyRequest: SodPolicyRequest;
|
|
38574
38897
|
}
|
|
38575
38898
|
/**
|
|
38576
38899
|
* Request parameters for deleteSodPolicy operation in SODPoliciesApi.
|
|
@@ -38777,10 +39100,10 @@ export interface SODPoliciesApiPutSodPolicyRequest {
|
|
|
38777
39100
|
readonly id: string;
|
|
38778
39101
|
/**
|
|
38779
39102
|
*
|
|
38780
|
-
* @type {
|
|
39103
|
+
* @type {SodPolicyRead}
|
|
38781
39104
|
* @memberof SODPoliciesApiPutSodPolicy
|
|
38782
39105
|
*/
|
|
38783
|
-
readonly
|
|
39106
|
+
readonly sodPolicyRead: SodPolicyRead;
|
|
38784
39107
|
}
|
|
38785
39108
|
/**
|
|
38786
39109
|
* Request parameters for startEvaluateSodPolicy operation in SODPoliciesApi.
|
|
@@ -38836,7 +39159,7 @@ export declare class SODPoliciesApi extends BaseAPI {
|
|
|
38836
39159
|
* @throws {RequiredError}
|
|
38837
39160
|
* @memberof SODPoliciesApi
|
|
38838
39161
|
*/
|
|
38839
|
-
createSodPolicy(requestParameters: SODPoliciesApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
39162
|
+
createSodPolicy(requestParameters: SODPoliciesApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SodPolicyRead, any>>;
|
|
38840
39163
|
/**
|
|
38841
39164
|
* This deletes a specified SOD policy. Requires role of ORG_ADMIN.
|
|
38842
39165
|
* @summary Delete sod policy by id
|
|
@@ -38889,7 +39212,7 @@ export declare class SODPoliciesApi extends BaseAPI {
|
|
|
38889
39212
|
* @throws {RequiredError}
|
|
38890
39213
|
* @memberof SODPoliciesApi
|
|
38891
39214
|
*/
|
|
38892
|
-
getSodPolicy(requestParameters: SODPoliciesApiGetSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
39215
|
+
getSodPolicy(requestParameters: SODPoliciesApiGetSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SodPolicyRead, any>>;
|
|
38893
39216
|
/**
|
|
38894
39217
|
* This endpoint gets a specified SOD policy\'s schedule.
|
|
38895
39218
|
* @summary Get sod policy schedule
|
|
@@ -38925,7 +39248,7 @@ export declare class SODPoliciesApi extends BaseAPI {
|
|
|
38925
39248
|
* @throws {RequiredError}
|
|
38926
39249
|
* @memberof SODPoliciesApi
|
|
38927
39250
|
*/
|
|
38928
|
-
listSodPolicies(requestParameters?: SODPoliciesApiListSodPoliciesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
39251
|
+
listSodPolicies(requestParameters?: SODPoliciesApiListSodPoliciesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SodPolicyRead[], any>>;
|
|
38929
39252
|
/**
|
|
38930
39253
|
* Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception.
|
|
38931
39254
|
* @summary Patch sod policy by id
|
|
@@ -38934,7 +39257,7 @@ export declare class SODPoliciesApi extends BaseAPI {
|
|
|
38934
39257
|
* @throws {RequiredError}
|
|
38935
39258
|
* @memberof SODPoliciesApi
|
|
38936
39259
|
*/
|
|
38937
|
-
patchSodPolicy(requestParameters: SODPoliciesApiPatchSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
39260
|
+
patchSodPolicy(requestParameters: SODPoliciesApiPatchSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SodPolicyRead, any>>;
|
|
38938
39261
|
/**
|
|
38939
39262
|
* This updates schedule for a specified SOD policy.
|
|
38940
39263
|
* @summary Update sod policy schedule
|
|
@@ -38952,7 +39275,7 @@ export declare class SODPoliciesApi extends BaseAPI {
|
|
|
38952
39275
|
* @throws {RequiredError}
|
|
38953
39276
|
* @memberof SODPoliciesApi
|
|
38954
39277
|
*/
|
|
38955
|
-
putSodPolicy(requestParameters: SODPoliciesApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
39278
|
+
putSodPolicy(requestParameters: SODPoliciesApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SodPolicyRead, any>>;
|
|
38956
39279
|
/**
|
|
38957
39280
|
* Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID.
|
|
38958
39281
|
* @summary Evaluate one policy by id
|