sailpoint-api-client 1.6.3 → 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/index.spec.js +2 -2
- package/dist/index.spec.js.map +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/index.spec.ts +3 -3
- 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/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
|
|
@@ -6294,6 +6336,25 @@ export interface ConflictingAccessCriteria {
|
|
|
6294
6336
|
*/
|
|
6295
6337
|
'rightCriteria'?: AccessCriteria;
|
|
6296
6338
|
}
|
|
6339
|
+
/**
|
|
6340
|
+
*
|
|
6341
|
+
* @export
|
|
6342
|
+
* @interface ConflictingAccessCriteriaRequest
|
|
6343
|
+
*/
|
|
6344
|
+
export interface ConflictingAccessCriteriaRequest {
|
|
6345
|
+
/**
|
|
6346
|
+
*
|
|
6347
|
+
* @type {AccessCriteriaRequest}
|
|
6348
|
+
* @memberof ConflictingAccessCriteriaRequest
|
|
6349
|
+
*/
|
|
6350
|
+
'leftCriteria'?: AccessCriteriaRequest;
|
|
6351
|
+
/**
|
|
6352
|
+
*
|
|
6353
|
+
* @type {AccessCriteriaRequest}
|
|
6354
|
+
* @memberof ConflictingAccessCriteriaRequest
|
|
6355
|
+
*/
|
|
6356
|
+
'rightCriteria'?: AccessCriteriaRequest;
|
|
6357
|
+
}
|
|
6297
6358
|
/**
|
|
6298
6359
|
*
|
|
6299
6360
|
* @export
|
|
@@ -20911,12 +20972,6 @@ export interface SodPolicy {
|
|
|
20911
20972
|
* @memberof SodPolicy
|
|
20912
20973
|
*/
|
|
20913
20974
|
'type'?: SodPolicyTypeV3;
|
|
20914
|
-
/**
|
|
20915
|
-
*
|
|
20916
|
-
* @type {SodPolicyConflictingAccessCriteria}
|
|
20917
|
-
* @memberof SodPolicy
|
|
20918
|
-
*/
|
|
20919
|
-
'conflictingAccessCriteria'?: SodPolicyConflictingAccessCriteria;
|
|
20920
20975
|
}
|
|
20921
20976
|
export declare const SodPolicyStateV3: {
|
|
20922
20977
|
readonly Enforced: "ENFORCED";
|
|
@@ -20928,25 +20983,6 @@ export declare const SodPolicyTypeV3: {
|
|
|
20928
20983
|
readonly ConflictingAccessBased: "CONFLICTING_ACCESS_BASED";
|
|
20929
20984
|
};
|
|
20930
20985
|
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
20986
|
/**
|
|
20951
20987
|
* SOD policy.
|
|
20952
20988
|
* @export
|
|
@@ -21006,6 +21042,294 @@ export declare const SodPolicyOwnerRefTypeV3: {
|
|
|
21006
21042
|
readonly GovernanceGroup: "GOVERNANCE_GROUP";
|
|
21007
21043
|
};
|
|
21008
21044
|
export type SodPolicyOwnerRefTypeV3 = typeof SodPolicyOwnerRefTypeV3[keyof typeof SodPolicyOwnerRefTypeV3];
|
|
21045
|
+
/**
|
|
21046
|
+
*
|
|
21047
|
+
* @export
|
|
21048
|
+
* @interface SodPolicyRead
|
|
21049
|
+
*/
|
|
21050
|
+
export interface SodPolicyRead {
|
|
21051
|
+
/**
|
|
21052
|
+
* Policy id
|
|
21053
|
+
* @type {string}
|
|
21054
|
+
* @memberof SodPolicyRead
|
|
21055
|
+
*/
|
|
21056
|
+
'id'?: string;
|
|
21057
|
+
/**
|
|
21058
|
+
* Policy Business Name
|
|
21059
|
+
* @type {string}
|
|
21060
|
+
* @memberof SodPolicyRead
|
|
21061
|
+
*/
|
|
21062
|
+
'name'?: string;
|
|
21063
|
+
/**
|
|
21064
|
+
* The time when this SOD policy is created.
|
|
21065
|
+
* @type {string}
|
|
21066
|
+
* @memberof SodPolicyRead
|
|
21067
|
+
*/
|
|
21068
|
+
'created'?: string;
|
|
21069
|
+
/**
|
|
21070
|
+
* The time when this SOD policy is modified.
|
|
21071
|
+
* @type {string}
|
|
21072
|
+
* @memberof SodPolicyRead
|
|
21073
|
+
*/
|
|
21074
|
+
'modified'?: string;
|
|
21075
|
+
/**
|
|
21076
|
+
* Optional description of the SOD policy
|
|
21077
|
+
* @type {string}
|
|
21078
|
+
* @memberof SodPolicyRead
|
|
21079
|
+
*/
|
|
21080
|
+
'description'?: string | null;
|
|
21081
|
+
/**
|
|
21082
|
+
*
|
|
21083
|
+
* @type {SodPolicyOwnerRef}
|
|
21084
|
+
* @memberof SodPolicyRead
|
|
21085
|
+
*/
|
|
21086
|
+
'ownerRef'?: SodPolicyOwnerRef;
|
|
21087
|
+
/**
|
|
21088
|
+
* Optional External Policy Reference
|
|
21089
|
+
* @type {string}
|
|
21090
|
+
* @memberof SodPolicyRead
|
|
21091
|
+
*/
|
|
21092
|
+
'externalPolicyReference'?: string | null;
|
|
21093
|
+
/**
|
|
21094
|
+
* Search query of the SOD policy
|
|
21095
|
+
* @type {string}
|
|
21096
|
+
* @memberof SodPolicyRead
|
|
21097
|
+
*/
|
|
21098
|
+
'policyQuery'?: string;
|
|
21099
|
+
/**
|
|
21100
|
+
* Optional compensating controls(Mitigating Controls)
|
|
21101
|
+
* @type {string}
|
|
21102
|
+
* @memberof SodPolicyRead
|
|
21103
|
+
*/
|
|
21104
|
+
'compensatingControls'?: string | null;
|
|
21105
|
+
/**
|
|
21106
|
+
* Optional correction advice
|
|
21107
|
+
* @type {string}
|
|
21108
|
+
* @memberof SodPolicyRead
|
|
21109
|
+
*/
|
|
21110
|
+
'correctionAdvice'?: string | null;
|
|
21111
|
+
/**
|
|
21112
|
+
* whether the policy is enforced or not
|
|
21113
|
+
* @type {string}
|
|
21114
|
+
* @memberof SodPolicyRead
|
|
21115
|
+
*/
|
|
21116
|
+
'state'?: SodPolicyReadStateV3;
|
|
21117
|
+
/**
|
|
21118
|
+
* tags for this policy object
|
|
21119
|
+
* @type {Array<string>}
|
|
21120
|
+
* @memberof SodPolicyRead
|
|
21121
|
+
*/
|
|
21122
|
+
'tags'?: Array<string>;
|
|
21123
|
+
/**
|
|
21124
|
+
* Policy\'s creator ID
|
|
21125
|
+
* @type {string}
|
|
21126
|
+
* @memberof SodPolicyRead
|
|
21127
|
+
*/
|
|
21128
|
+
'creatorId'?: string;
|
|
21129
|
+
/**
|
|
21130
|
+
* Policy\'s modifier ID
|
|
21131
|
+
* @type {string}
|
|
21132
|
+
* @memberof SodPolicyRead
|
|
21133
|
+
*/
|
|
21134
|
+
'modifierId'?: string | null;
|
|
21135
|
+
/**
|
|
21136
|
+
*
|
|
21137
|
+
* @type {ViolationOwnerAssignmentConfig}
|
|
21138
|
+
* @memberof SodPolicyRead
|
|
21139
|
+
*/
|
|
21140
|
+
'violationOwnerAssignmentConfig'?: ViolationOwnerAssignmentConfig;
|
|
21141
|
+
/**
|
|
21142
|
+
* defines whether a policy has been scheduled or not
|
|
21143
|
+
* @type {boolean}
|
|
21144
|
+
* @memberof SodPolicyRead
|
|
21145
|
+
*/
|
|
21146
|
+
'scheduled'?: boolean;
|
|
21147
|
+
/**
|
|
21148
|
+
* whether a policy is query based or conflicting access based
|
|
21149
|
+
* @type {string}
|
|
21150
|
+
* @memberof SodPolicyRead
|
|
21151
|
+
*/
|
|
21152
|
+
'type'?: SodPolicyReadTypeV3;
|
|
21153
|
+
/**
|
|
21154
|
+
*
|
|
21155
|
+
* @type {SodPolicyReadAllOfConflictingAccessCriteria}
|
|
21156
|
+
* @memberof SodPolicyRead
|
|
21157
|
+
*/
|
|
21158
|
+
'conflictingAccessCriteria'?: SodPolicyReadAllOfConflictingAccessCriteria;
|
|
21159
|
+
}
|
|
21160
|
+
export declare const SodPolicyReadStateV3: {
|
|
21161
|
+
readonly Enforced: "ENFORCED";
|
|
21162
|
+
readonly NotEnforced: "NOT_ENFORCED";
|
|
21163
|
+
};
|
|
21164
|
+
export type SodPolicyReadStateV3 = typeof SodPolicyReadStateV3[keyof typeof SodPolicyReadStateV3];
|
|
21165
|
+
export declare const SodPolicyReadTypeV3: {
|
|
21166
|
+
readonly General: "GENERAL";
|
|
21167
|
+
readonly ConflictingAccessBased: "CONFLICTING_ACCESS_BASED";
|
|
21168
|
+
};
|
|
21169
|
+
export type SodPolicyReadTypeV3 = typeof SodPolicyReadTypeV3[keyof typeof SodPolicyReadTypeV3];
|
|
21170
|
+
/**
|
|
21171
|
+
*
|
|
21172
|
+
* @export
|
|
21173
|
+
* @interface SodPolicyReadAllOfConflictingAccessCriteria
|
|
21174
|
+
*/
|
|
21175
|
+
export interface SodPolicyReadAllOfConflictingAccessCriteria {
|
|
21176
|
+
/**
|
|
21177
|
+
*
|
|
21178
|
+
* @type {AccessCriteria}
|
|
21179
|
+
* @memberof SodPolicyReadAllOfConflictingAccessCriteria
|
|
21180
|
+
*/
|
|
21181
|
+
'leftCriteria'?: AccessCriteria;
|
|
21182
|
+
/**
|
|
21183
|
+
*
|
|
21184
|
+
* @type {AccessCriteria}
|
|
21185
|
+
* @memberof SodPolicyReadAllOfConflictingAccessCriteria
|
|
21186
|
+
*/
|
|
21187
|
+
'rightCriteria'?: AccessCriteria;
|
|
21188
|
+
}
|
|
21189
|
+
/**
|
|
21190
|
+
*
|
|
21191
|
+
* @export
|
|
21192
|
+
* @interface SodPolicyRequest
|
|
21193
|
+
*/
|
|
21194
|
+
export interface SodPolicyRequest {
|
|
21195
|
+
/**
|
|
21196
|
+
* Policy id
|
|
21197
|
+
* @type {string}
|
|
21198
|
+
* @memberof SodPolicyRequest
|
|
21199
|
+
*/
|
|
21200
|
+
'id'?: string;
|
|
21201
|
+
/**
|
|
21202
|
+
* Policy Business Name
|
|
21203
|
+
* @type {string}
|
|
21204
|
+
* @memberof SodPolicyRequest
|
|
21205
|
+
*/
|
|
21206
|
+
'name'?: string;
|
|
21207
|
+
/**
|
|
21208
|
+
* The time when this SOD policy is created.
|
|
21209
|
+
* @type {string}
|
|
21210
|
+
* @memberof SodPolicyRequest
|
|
21211
|
+
*/
|
|
21212
|
+
'created'?: string;
|
|
21213
|
+
/**
|
|
21214
|
+
* The time when this SOD policy is modified.
|
|
21215
|
+
* @type {string}
|
|
21216
|
+
* @memberof SodPolicyRequest
|
|
21217
|
+
*/
|
|
21218
|
+
'modified'?: string;
|
|
21219
|
+
/**
|
|
21220
|
+
* Optional description of the SOD policy
|
|
21221
|
+
* @type {string}
|
|
21222
|
+
* @memberof SodPolicyRequest
|
|
21223
|
+
*/
|
|
21224
|
+
'description'?: string | null;
|
|
21225
|
+
/**
|
|
21226
|
+
*
|
|
21227
|
+
* @type {SodPolicyOwnerRef}
|
|
21228
|
+
* @memberof SodPolicyRequest
|
|
21229
|
+
*/
|
|
21230
|
+
'ownerRef'?: SodPolicyOwnerRef;
|
|
21231
|
+
/**
|
|
21232
|
+
* Optional External Policy Reference
|
|
21233
|
+
* @type {string}
|
|
21234
|
+
* @memberof SodPolicyRequest
|
|
21235
|
+
*/
|
|
21236
|
+
'externalPolicyReference'?: string | null;
|
|
21237
|
+
/**
|
|
21238
|
+
* Search query of the SOD policy
|
|
21239
|
+
* @type {string}
|
|
21240
|
+
* @memberof SodPolicyRequest
|
|
21241
|
+
*/
|
|
21242
|
+
'policyQuery'?: string;
|
|
21243
|
+
/**
|
|
21244
|
+
* Optional compensating controls(Mitigating Controls)
|
|
21245
|
+
* @type {string}
|
|
21246
|
+
* @memberof SodPolicyRequest
|
|
21247
|
+
*/
|
|
21248
|
+
'compensatingControls'?: string | null;
|
|
21249
|
+
/**
|
|
21250
|
+
* Optional correction advice
|
|
21251
|
+
* @type {string}
|
|
21252
|
+
* @memberof SodPolicyRequest
|
|
21253
|
+
*/
|
|
21254
|
+
'correctionAdvice'?: string | null;
|
|
21255
|
+
/**
|
|
21256
|
+
* whether the policy is enforced or not
|
|
21257
|
+
* @type {string}
|
|
21258
|
+
* @memberof SodPolicyRequest
|
|
21259
|
+
*/
|
|
21260
|
+
'state'?: SodPolicyRequestStateV3;
|
|
21261
|
+
/**
|
|
21262
|
+
* tags for this policy object
|
|
21263
|
+
* @type {Array<string>}
|
|
21264
|
+
* @memberof SodPolicyRequest
|
|
21265
|
+
*/
|
|
21266
|
+
'tags'?: Array<string>;
|
|
21267
|
+
/**
|
|
21268
|
+
* Policy\'s creator ID
|
|
21269
|
+
* @type {string}
|
|
21270
|
+
* @memberof SodPolicyRequest
|
|
21271
|
+
*/
|
|
21272
|
+
'creatorId'?: string;
|
|
21273
|
+
/**
|
|
21274
|
+
* Policy\'s modifier ID
|
|
21275
|
+
* @type {string}
|
|
21276
|
+
* @memberof SodPolicyRequest
|
|
21277
|
+
*/
|
|
21278
|
+
'modifierId'?: string | null;
|
|
21279
|
+
/**
|
|
21280
|
+
*
|
|
21281
|
+
* @type {ViolationOwnerAssignmentConfig}
|
|
21282
|
+
* @memberof SodPolicyRequest
|
|
21283
|
+
*/
|
|
21284
|
+
'violationOwnerAssignmentConfig'?: ViolationOwnerAssignmentConfig;
|
|
21285
|
+
/**
|
|
21286
|
+
* defines whether a policy has been scheduled or not
|
|
21287
|
+
* @type {boolean}
|
|
21288
|
+
* @memberof SodPolicyRequest
|
|
21289
|
+
*/
|
|
21290
|
+
'scheduled'?: boolean;
|
|
21291
|
+
/**
|
|
21292
|
+
* whether a policy is query based or conflicting access based
|
|
21293
|
+
* @type {string}
|
|
21294
|
+
* @memberof SodPolicyRequest
|
|
21295
|
+
*/
|
|
21296
|
+
'type'?: SodPolicyRequestTypeV3;
|
|
21297
|
+
/**
|
|
21298
|
+
*
|
|
21299
|
+
* @type {SodPolicyRequestAllOfConflictingAccessCriteria}
|
|
21300
|
+
* @memberof SodPolicyRequest
|
|
21301
|
+
*/
|
|
21302
|
+
'conflictingAccessCriteria'?: SodPolicyRequestAllOfConflictingAccessCriteria;
|
|
21303
|
+
}
|
|
21304
|
+
export declare const SodPolicyRequestStateV3: {
|
|
21305
|
+
readonly Enforced: "ENFORCED";
|
|
21306
|
+
readonly NotEnforced: "NOT_ENFORCED";
|
|
21307
|
+
};
|
|
21308
|
+
export type SodPolicyRequestStateV3 = typeof SodPolicyRequestStateV3[keyof typeof SodPolicyRequestStateV3];
|
|
21309
|
+
export declare const SodPolicyRequestTypeV3: {
|
|
21310
|
+
readonly General: "GENERAL";
|
|
21311
|
+
readonly ConflictingAccessBased: "CONFLICTING_ACCESS_BASED";
|
|
21312
|
+
};
|
|
21313
|
+
export type SodPolicyRequestTypeV3 = typeof SodPolicyRequestTypeV3[keyof typeof SodPolicyRequestTypeV3];
|
|
21314
|
+
/**
|
|
21315
|
+
*
|
|
21316
|
+
* @export
|
|
21317
|
+
* @interface SodPolicyRequestAllOfConflictingAccessCriteria
|
|
21318
|
+
*/
|
|
21319
|
+
export interface SodPolicyRequestAllOfConflictingAccessCriteria {
|
|
21320
|
+
/**
|
|
21321
|
+
*
|
|
21322
|
+
* @type {AccessCriteriaRequest}
|
|
21323
|
+
* @memberof SodPolicyRequestAllOfConflictingAccessCriteria
|
|
21324
|
+
*/
|
|
21325
|
+
'leftCriteria'?: AccessCriteriaRequest;
|
|
21326
|
+
/**
|
|
21327
|
+
*
|
|
21328
|
+
* @type {AccessCriteriaRequest}
|
|
21329
|
+
* @memberof SodPolicyRequestAllOfConflictingAccessCriteria
|
|
21330
|
+
*/
|
|
21331
|
+
'rightCriteria'?: AccessCriteriaRequest;
|
|
21332
|
+
}
|
|
21009
21333
|
/**
|
|
21010
21334
|
*
|
|
21011
21335
|
* @export
|
|
@@ -25427,7 +25751,7 @@ export declare const AccessRequestsApiAxiosParamCreator: (configuration?: Config
|
|
|
25427
25751
|
*/
|
|
25428
25752
|
cancelAccessRequest: (cancelAccessRequest: CancelAccessRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
25429
25753
|
/**
|
|
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. *
|
|
25754
|
+
* 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
25755
|
* @summary Submit access request
|
|
25432
25756
|
* @param {AccessRequest} accessRequest
|
|
25433
25757
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25451,7 +25775,7 @@ export declare const AccessRequestsApiAxiosParamCreator: (configuration?: Config
|
|
|
25451
25775
|
* @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
25776
|
* @param {number} [limit] Max number of results to return.
|
|
25453
25777
|
* @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*
|
|
25778
|
+
* @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
25779
|
* @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
25780
|
* @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*.
|
|
25457
25781
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25481,7 +25805,7 @@ export declare const AccessRequestsApiFp: (configuration?: Configuration) => {
|
|
|
25481
25805
|
*/
|
|
25482
25806
|
cancelAccessRequest(cancelAccessRequest: CancelAccessRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
25483
25807
|
/**
|
|
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. *
|
|
25808
|
+
* 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
25809
|
* @summary Submit access request
|
|
25486
25810
|
* @param {AccessRequest} accessRequest
|
|
25487
25811
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25505,7 +25829,7 @@ export declare const AccessRequestsApiFp: (configuration?: Configuration) => {
|
|
|
25505
25829
|
* @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
25830
|
* @param {number} [limit] Max number of results to return.
|
|
25507
25831
|
* @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*
|
|
25832
|
+
* @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
25833
|
* @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
25834
|
* @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*.
|
|
25511
25835
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25535,7 +25859,7 @@ export declare const AccessRequestsApiFactory: (configuration?: Configuration, b
|
|
|
25535
25859
|
*/
|
|
25536
25860
|
cancelAccessRequest(requestParameters: AccessRequestsApiCancelAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
25537
25861
|
/**
|
|
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. *
|
|
25862
|
+
* 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
25863
|
* @summary Submit access request
|
|
25540
25864
|
* @param {AccessRequestsApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
25541
25865
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25641,7 +25965,7 @@ export interface AccessRequestsApiListAccessRequestStatusRequest {
|
|
|
25641
25965
|
*/
|
|
25642
25966
|
readonly offset?: number;
|
|
25643
25967
|
/**
|
|
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*
|
|
25968
|
+
* 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
25969
|
* @type {string}
|
|
25646
25970
|
* @memberof AccessRequestsApiListAccessRequestStatus
|
|
25647
25971
|
*/
|
|
@@ -25689,7 +26013,7 @@ export declare class AccessRequestsApi extends BaseAPI {
|
|
|
25689
26013
|
*/
|
|
25690
26014
|
cancelAccessRequest(requestParameters: AccessRequestsApiCancelAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
25691
26015
|
/**
|
|
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. *
|
|
26016
|
+
* 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
26017
|
* @summary Submit access request
|
|
25694
26018
|
* @param {AccessRequestsApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
25695
26019
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -38126,11 +38450,11 @@ export declare const SODPoliciesApiAxiosParamCreator: (configuration?: Configura
|
|
|
38126
38450
|
/**
|
|
38127
38451
|
* 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
38452
|
* @summary Create sod policy
|
|
38129
|
-
* @param {
|
|
38453
|
+
* @param {SodPolicyRequest} sodPolicyRequest
|
|
38130
38454
|
* @param {*} [axiosOptions] Override http request option.
|
|
38131
38455
|
* @throws {RequiredError}
|
|
38132
38456
|
*/
|
|
38133
|
-
createSodPolicy: (
|
|
38457
|
+
createSodPolicy: (sodPolicyRequest: SodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
38134
38458
|
/**
|
|
38135
38459
|
* This deletes a specified SOD policy. Requires role of ORG_ADMIN.
|
|
38136
38460
|
* @summary Delete sod policy by id
|
|
@@ -38238,11 +38562,11 @@ export declare const SODPoliciesApiAxiosParamCreator: (configuration?: Configura
|
|
|
38238
38562
|
* This updates a specified SOD policy. Requires role of ORG_ADMIN.
|
|
38239
38563
|
* @summary Update sod policy by id
|
|
38240
38564
|
* @param {string} id The ID of the SOD policy to update.
|
|
38241
|
-
* @param {
|
|
38565
|
+
* @param {SodPolicyRead} sodPolicyRead
|
|
38242
38566
|
* @param {*} [axiosOptions] Override http request option.
|
|
38243
38567
|
* @throws {RequiredError}
|
|
38244
38568
|
*/
|
|
38245
|
-
putSodPolicy: (id: string,
|
|
38569
|
+
putSodPolicy: (id: string, sodPolicyRead: SodPolicyRead, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
38246
38570
|
/**
|
|
38247
38571
|
* Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID.
|
|
38248
38572
|
* @summary Evaluate one policy by id
|
|
@@ -38276,11 +38600,11 @@ export declare const SODPoliciesApiFp: (configuration?: Configuration) => {
|
|
|
38276
38600
|
/**
|
|
38277
38601
|
* 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
38602
|
* @summary Create sod policy
|
|
38279
|
-
* @param {
|
|
38603
|
+
* @param {SodPolicyRequest} sodPolicyRequest
|
|
38280
38604
|
* @param {*} [axiosOptions] Override http request option.
|
|
38281
38605
|
* @throws {RequiredError}
|
|
38282
38606
|
*/
|
|
38283
|
-
createSodPolicy(
|
|
38607
|
+
createSodPolicy(sodPolicyRequest: SodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SodPolicyRead>>;
|
|
38284
38608
|
/**
|
|
38285
38609
|
* This deletes a specified SOD policy. Requires role of ORG_ADMIN.
|
|
38286
38610
|
* @summary Delete sod policy by id
|
|
@@ -38329,7 +38653,7 @@ export declare const SODPoliciesApiFp: (configuration?: Configuration) => {
|
|
|
38329
38653
|
* @param {*} [axiosOptions] Override http request option.
|
|
38330
38654
|
* @throws {RequiredError}
|
|
38331
38655
|
*/
|
|
38332
|
-
getSodPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
38656
|
+
getSodPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SodPolicyRead>>;
|
|
38333
38657
|
/**
|
|
38334
38658
|
* This endpoint gets a specified SOD policy\'s schedule.
|
|
38335
38659
|
* @summary Get sod policy schedule
|
|
@@ -38365,7 +38689,7 @@ export declare const SODPoliciesApiFp: (configuration?: Configuration) => {
|
|
|
38365
38689
|
* @param {*} [axiosOptions] Override http request option.
|
|
38366
38690
|
* @throws {RequiredError}
|
|
38367
38691
|
*/
|
|
38368
|
-
listSodPolicies(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
38692
|
+
listSodPolicies(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SodPolicyRead>>>;
|
|
38369
38693
|
/**
|
|
38370
38694
|
* 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
38695
|
* @summary Patch sod policy by id
|
|
@@ -38374,7 +38698,7 @@ export declare const SODPoliciesApiFp: (configuration?: Configuration) => {
|
|
|
38374
38698
|
* @param {*} [axiosOptions] Override http request option.
|
|
38375
38699
|
* @throws {RequiredError}
|
|
38376
38700
|
*/
|
|
38377
|
-
patchSodPolicy(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
38701
|
+
patchSodPolicy(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SodPolicyRead>>;
|
|
38378
38702
|
/**
|
|
38379
38703
|
* This updates schedule for a specified SOD policy.
|
|
38380
38704
|
* @summary Update sod policy schedule
|
|
@@ -38388,11 +38712,11 @@ export declare const SODPoliciesApiFp: (configuration?: Configuration) => {
|
|
|
38388
38712
|
* This updates a specified SOD policy. Requires role of ORG_ADMIN.
|
|
38389
38713
|
* @summary Update sod policy by id
|
|
38390
38714
|
* @param {string} id The ID of the SOD policy to update.
|
|
38391
|
-
* @param {
|
|
38715
|
+
* @param {SodPolicyRead} sodPolicyRead
|
|
38392
38716
|
* @param {*} [axiosOptions] Override http request option.
|
|
38393
38717
|
* @throws {RequiredError}
|
|
38394
38718
|
*/
|
|
38395
|
-
putSodPolicy(id: string,
|
|
38719
|
+
putSodPolicy(id: string, sodPolicyRead: SodPolicyRead, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SodPolicyRead>>;
|
|
38396
38720
|
/**
|
|
38397
38721
|
* Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID.
|
|
38398
38722
|
* @summary Evaluate one policy by id
|
|
@@ -38430,7 +38754,7 @@ export declare const SODPoliciesApiFactory: (configuration?: Configuration, base
|
|
|
38430
38754
|
* @param {*} [axiosOptions] Override http request option.
|
|
38431
38755
|
* @throws {RequiredError}
|
|
38432
38756
|
*/
|
|
38433
|
-
createSodPolicy(requestParameters: SODPoliciesApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<
|
|
38757
|
+
createSodPolicy(requestParameters: SODPoliciesApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SodPolicyRead>;
|
|
38434
38758
|
/**
|
|
38435
38759
|
* This deletes a specified SOD policy. Requires role of ORG_ADMIN.
|
|
38436
38760
|
* @summary Delete sod policy by id
|
|
@@ -38477,7 +38801,7 @@ export declare const SODPoliciesApiFactory: (configuration?: Configuration, base
|
|
|
38477
38801
|
* @param {*} [axiosOptions] Override http request option.
|
|
38478
38802
|
* @throws {RequiredError}
|
|
38479
38803
|
*/
|
|
38480
|
-
getSodPolicy(requestParameters: SODPoliciesApiGetSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<
|
|
38804
|
+
getSodPolicy(requestParameters: SODPoliciesApiGetSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SodPolicyRead>;
|
|
38481
38805
|
/**
|
|
38482
38806
|
* This endpoint gets a specified SOD policy\'s schedule.
|
|
38483
38807
|
* @summary Get sod policy schedule
|
|
@@ -38509,7 +38833,7 @@ export declare const SODPoliciesApiFactory: (configuration?: Configuration, base
|
|
|
38509
38833
|
* @param {*} [axiosOptions] Override http request option.
|
|
38510
38834
|
* @throws {RequiredError}
|
|
38511
38835
|
*/
|
|
38512
|
-
listSodPolicies(requestParameters?: SODPoliciesApiListSodPoliciesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
38836
|
+
listSodPolicies(requestParameters?: SODPoliciesApiListSodPoliciesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<SodPolicyRead>>;
|
|
38513
38837
|
/**
|
|
38514
38838
|
* 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
38839
|
* @summary Patch sod policy by id
|
|
@@ -38517,7 +38841,7 @@ export declare const SODPoliciesApiFactory: (configuration?: Configuration, base
|
|
|
38517
38841
|
* @param {*} [axiosOptions] Override http request option.
|
|
38518
38842
|
* @throws {RequiredError}
|
|
38519
38843
|
*/
|
|
38520
|
-
patchSodPolicy(requestParameters: SODPoliciesApiPatchSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<
|
|
38844
|
+
patchSodPolicy(requestParameters: SODPoliciesApiPatchSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SodPolicyRead>;
|
|
38521
38845
|
/**
|
|
38522
38846
|
* This updates schedule for a specified SOD policy.
|
|
38523
38847
|
* @summary Update sod policy schedule
|
|
@@ -38533,7 +38857,7 @@ export declare const SODPoliciesApiFactory: (configuration?: Configuration, base
|
|
|
38533
38857
|
* @param {*} [axiosOptions] Override http request option.
|
|
38534
38858
|
* @throws {RequiredError}
|
|
38535
38859
|
*/
|
|
38536
|
-
putSodPolicy(requestParameters: SODPoliciesApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<
|
|
38860
|
+
putSodPolicy(requestParameters: SODPoliciesApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SodPolicyRead>;
|
|
38537
38861
|
/**
|
|
38538
38862
|
* Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID.
|
|
38539
38863
|
* @summary Evaluate one policy by id
|
|
@@ -38567,10 +38891,10 @@ export declare const SODPoliciesApiFactory: (configuration?: Configuration, base
|
|
|
38567
38891
|
export interface SODPoliciesApiCreateSodPolicyRequest {
|
|
38568
38892
|
/**
|
|
38569
38893
|
*
|
|
38570
|
-
* @type {
|
|
38894
|
+
* @type {SodPolicyRequest}
|
|
38571
38895
|
* @memberof SODPoliciesApiCreateSodPolicy
|
|
38572
38896
|
*/
|
|
38573
|
-
readonly
|
|
38897
|
+
readonly sodPolicyRequest: SodPolicyRequest;
|
|
38574
38898
|
}
|
|
38575
38899
|
/**
|
|
38576
38900
|
* Request parameters for deleteSodPolicy operation in SODPoliciesApi.
|
|
@@ -38777,10 +39101,10 @@ export interface SODPoliciesApiPutSodPolicyRequest {
|
|
|
38777
39101
|
readonly id: string;
|
|
38778
39102
|
/**
|
|
38779
39103
|
*
|
|
38780
|
-
* @type {
|
|
39104
|
+
* @type {SodPolicyRead}
|
|
38781
39105
|
* @memberof SODPoliciesApiPutSodPolicy
|
|
38782
39106
|
*/
|
|
38783
|
-
readonly
|
|
39107
|
+
readonly sodPolicyRead: SodPolicyRead;
|
|
38784
39108
|
}
|
|
38785
39109
|
/**
|
|
38786
39110
|
* Request parameters for startEvaluateSodPolicy operation in SODPoliciesApi.
|
|
@@ -38836,7 +39160,7 @@ export declare class SODPoliciesApi extends BaseAPI {
|
|
|
38836
39160
|
* @throws {RequiredError}
|
|
38837
39161
|
* @memberof SODPoliciesApi
|
|
38838
39162
|
*/
|
|
38839
|
-
createSodPolicy(requestParameters: SODPoliciesApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
39163
|
+
createSodPolicy(requestParameters: SODPoliciesApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SodPolicyRead, any>>;
|
|
38840
39164
|
/**
|
|
38841
39165
|
* This deletes a specified SOD policy. Requires role of ORG_ADMIN.
|
|
38842
39166
|
* @summary Delete sod policy by id
|
|
@@ -38889,7 +39213,7 @@ export declare class SODPoliciesApi extends BaseAPI {
|
|
|
38889
39213
|
* @throws {RequiredError}
|
|
38890
39214
|
* @memberof SODPoliciesApi
|
|
38891
39215
|
*/
|
|
38892
|
-
getSodPolicy(requestParameters: SODPoliciesApiGetSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
39216
|
+
getSodPolicy(requestParameters: SODPoliciesApiGetSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SodPolicyRead, any>>;
|
|
38893
39217
|
/**
|
|
38894
39218
|
* This endpoint gets a specified SOD policy\'s schedule.
|
|
38895
39219
|
* @summary Get sod policy schedule
|
|
@@ -38925,7 +39249,7 @@ export declare class SODPoliciesApi extends BaseAPI {
|
|
|
38925
39249
|
* @throws {RequiredError}
|
|
38926
39250
|
* @memberof SODPoliciesApi
|
|
38927
39251
|
*/
|
|
38928
|
-
listSodPolicies(requestParameters?: SODPoliciesApiListSodPoliciesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
39252
|
+
listSodPolicies(requestParameters?: SODPoliciesApiListSodPoliciesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SodPolicyRead[], any>>;
|
|
38929
39253
|
/**
|
|
38930
39254
|
* 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
39255
|
* @summary Patch sod policy by id
|
|
@@ -38934,7 +39258,7 @@ export declare class SODPoliciesApi extends BaseAPI {
|
|
|
38934
39258
|
* @throws {RequiredError}
|
|
38935
39259
|
* @memberof SODPoliciesApi
|
|
38936
39260
|
*/
|
|
38937
|
-
patchSodPolicy(requestParameters: SODPoliciesApiPatchSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
39261
|
+
patchSodPolicy(requestParameters: SODPoliciesApiPatchSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SodPolicyRead, any>>;
|
|
38938
39262
|
/**
|
|
38939
39263
|
* This updates schedule for a specified SOD policy.
|
|
38940
39264
|
* @summary Update sod policy schedule
|
|
@@ -38952,7 +39276,7 @@ export declare class SODPoliciesApi extends BaseAPI {
|
|
|
38952
39276
|
* @throws {RequiredError}
|
|
38953
39277
|
* @memberof SODPoliciesApi
|
|
38954
39278
|
*/
|
|
38955
|
-
putSodPolicy(requestParameters: SODPoliciesApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
39279
|
+
putSodPolicy(requestParameters: SODPoliciesApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SodPolicyRead, any>>;
|
|
38956
39280
|
/**
|
|
38957
39281
|
* Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID.
|
|
38958
39282
|
* @summary Evaluate one policy by id
|