sailpoint-api-client 1.6.5 → 1.6.7
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 +1060 -453
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/dist/beta/api.d.ts +914 -363
- package/dist/beta/api.js +464 -256
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/common.js +1 -1
- package/dist/index.spec.js +7 -14
- package/dist/index.spec.js.map +1 -1
- package/dist/paginator.js +0 -1
- package/dist/paginator.js.map +1 -1
- package/dist/v2024/api.d.ts +915 -713
- package/dist/v2024/api.js +318 -503
- package/dist/v2024/api.js.map +1 -1
- package/dist/v2024/common.js +1 -1
- package/dist/v2025/api.d.ts +2060 -538
- package/dist/v2025/api.js +1793 -687
- package/dist/v2025/api.js.map +1 -1
- package/dist/v2025/common.js +1 -1
- package/dist/v3/api.d.ts +64 -20
- package/dist/v3/api.js +20 -23
- package/dist/v3/api.js.map +1 -1
- package/dist/v3/common.js +1 -1
- package/index.spec.ts +7 -7
- package/package.json +1 -1
- package/paginator.ts +0 -1
- package/v2024/README.md +2 -2
- package/v2024/api.ts +1178 -1189
- package/v2024/common.ts +2 -2
- package/v2024/package.json +1 -1
- package/v2025/README.md +2 -2
- package/v2025/api.ts +2893 -934
- package/v2025/common.ts +2 -2
- package/v2025/package.json +1 -1
- package/v3/README.md +2 -2
- package/v3/api.ts +71 -29
- package/v3/common.ts +2 -2
- package/v3/package.json +1 -1
package/dist/v2024/api.d.ts
CHANGED
|
@@ -166,15 +166,28 @@ export interface AccessCriteriaV2024 {
|
|
|
166
166
|
/**
|
|
167
167
|
*
|
|
168
168
|
* @export
|
|
169
|
-
* @interface
|
|
169
|
+
* @interface AccessItemAccessProfileResponseAppRefsInnerV2024
|
|
170
170
|
*/
|
|
171
|
-
export interface
|
|
171
|
+
export interface AccessItemAccessProfileResponseAppRefsInnerV2024 {
|
|
172
172
|
/**
|
|
173
|
-
* the
|
|
173
|
+
* the cloud app id associated with the access profile
|
|
174
174
|
* @type {string}
|
|
175
|
-
* @memberof
|
|
175
|
+
* @memberof AccessItemAccessProfileResponseAppRefsInnerV2024
|
|
176
176
|
*/
|
|
177
|
-
'
|
|
177
|
+
'cloudAppId'?: string;
|
|
178
|
+
/**
|
|
179
|
+
* the cloud app name associated with the access profile
|
|
180
|
+
* @type {string}
|
|
181
|
+
* @memberof AccessItemAccessProfileResponseAppRefsInnerV2024
|
|
182
|
+
*/
|
|
183
|
+
'cloudAppName'?: string;
|
|
184
|
+
}
|
|
185
|
+
/**
|
|
186
|
+
*
|
|
187
|
+
* @export
|
|
188
|
+
* @interface AccessItemAccessProfileResponseV2024
|
|
189
|
+
*/
|
|
190
|
+
export interface AccessItemAccessProfileResponseV2024 {
|
|
178
191
|
/**
|
|
179
192
|
* the access item id
|
|
180
193
|
* @type {string}
|
|
@@ -182,65 +195,65 @@ export interface AccessItemAccessProfileResponseV2024 {
|
|
|
182
195
|
*/
|
|
183
196
|
'id'?: string;
|
|
184
197
|
/**
|
|
185
|
-
* the access
|
|
198
|
+
* the access item type. accessProfile in this case
|
|
186
199
|
* @type {string}
|
|
187
200
|
* @memberof AccessItemAccessProfileResponseV2024
|
|
188
201
|
*/
|
|
189
|
-
'
|
|
202
|
+
'accessType'?: string;
|
|
190
203
|
/**
|
|
191
|
-
* the name of the
|
|
204
|
+
* the display name of the identity
|
|
192
205
|
* @type {string}
|
|
193
206
|
* @memberof AccessItemAccessProfileResponseV2024
|
|
194
207
|
*/
|
|
195
|
-
'
|
|
208
|
+
'displayName'?: string;
|
|
196
209
|
/**
|
|
197
|
-
* the
|
|
210
|
+
* the name of the source
|
|
198
211
|
* @type {string}
|
|
199
212
|
* @memberof AccessItemAccessProfileResponseV2024
|
|
200
213
|
*/
|
|
201
|
-
'
|
|
214
|
+
'sourceName'?: string;
|
|
202
215
|
/**
|
|
203
|
-
* the
|
|
204
|
-
* @type {
|
|
216
|
+
* the number of entitlements the access profile will create
|
|
217
|
+
* @type {number}
|
|
205
218
|
* @memberof AccessItemAccessProfileResponseV2024
|
|
206
219
|
*/
|
|
207
|
-
'
|
|
220
|
+
'entitlementCount': number;
|
|
208
221
|
/**
|
|
209
|
-
* the
|
|
222
|
+
* the description for the access profile
|
|
210
223
|
* @type {string}
|
|
211
224
|
* @memberof AccessItemAccessProfileResponseV2024
|
|
212
225
|
*/
|
|
213
|
-
'
|
|
226
|
+
'description'?: string | null;
|
|
214
227
|
/**
|
|
215
|
-
* the
|
|
228
|
+
* the id of the source
|
|
216
229
|
* @type {string}
|
|
217
230
|
* @memberof AccessItemAccessProfileResponseV2024
|
|
218
231
|
*/
|
|
219
|
-
'
|
|
232
|
+
'sourceId'?: string;
|
|
220
233
|
/**
|
|
221
|
-
* the
|
|
222
|
-
* @type {
|
|
234
|
+
* the list of app ids associated with the access profile
|
|
235
|
+
* @type {Array<AccessItemAccessProfileResponseAppRefsInnerV2024>}
|
|
223
236
|
* @memberof AccessItemAccessProfileResponseV2024
|
|
224
237
|
*/
|
|
225
|
-
'
|
|
238
|
+
'appRefs': Array<AccessItemAccessProfileResponseAppRefsInnerV2024>;
|
|
226
239
|
/**
|
|
227
240
|
* the date the access profile is no longer assigned to the specified identity
|
|
228
241
|
* @type {string}
|
|
229
242
|
* @memberof AccessItemAccessProfileResponseV2024
|
|
230
243
|
*/
|
|
231
|
-
'removeDate'?: string;
|
|
244
|
+
'removeDate'?: string | null;
|
|
232
245
|
/**
|
|
233
246
|
* indicates whether the access profile is standalone
|
|
234
247
|
* @type {boolean}
|
|
235
248
|
* @memberof AccessItemAccessProfileResponseV2024
|
|
236
249
|
*/
|
|
237
|
-
'standalone': boolean;
|
|
250
|
+
'standalone': boolean | null;
|
|
238
251
|
/**
|
|
239
|
-
* indicates whether the access profile is
|
|
252
|
+
* indicates whether the access profile is revocable
|
|
240
253
|
* @type {boolean}
|
|
241
254
|
* @memberof AccessItemAccessProfileResponseV2024
|
|
242
255
|
*/
|
|
243
|
-
'revocable': boolean;
|
|
256
|
+
'revocable': boolean | null;
|
|
244
257
|
}
|
|
245
258
|
/**
|
|
246
259
|
*
|
|
@@ -249,23 +262,23 @@ export interface AccessItemAccessProfileResponseV2024 {
|
|
|
249
262
|
*/
|
|
250
263
|
export interface AccessItemAccountResponseV2024 {
|
|
251
264
|
/**
|
|
252
|
-
* the access item
|
|
265
|
+
* the access item id
|
|
253
266
|
* @type {string}
|
|
254
267
|
* @memberof AccessItemAccountResponseV2024
|
|
255
268
|
*/
|
|
256
|
-
'
|
|
269
|
+
'id'?: string;
|
|
257
270
|
/**
|
|
258
|
-
* the access item
|
|
271
|
+
* the access item type. account in this case
|
|
259
272
|
* @type {string}
|
|
260
273
|
* @memberof AccessItemAccountResponseV2024
|
|
261
274
|
*/
|
|
262
|
-
'
|
|
275
|
+
'accessType'?: string;
|
|
263
276
|
/**
|
|
264
|
-
* the
|
|
277
|
+
* the display name of the identity
|
|
265
278
|
* @type {string}
|
|
266
279
|
* @memberof AccessItemAccountResponseV2024
|
|
267
280
|
*/
|
|
268
|
-
'
|
|
281
|
+
'displayName'?: string;
|
|
269
282
|
/**
|
|
270
283
|
* the name of the source
|
|
271
284
|
* @type {string}
|
|
@@ -273,23 +286,23 @@ export interface AccessItemAccountResponseV2024 {
|
|
|
273
286
|
*/
|
|
274
287
|
'sourceName'?: string;
|
|
275
288
|
/**
|
|
276
|
-
* the
|
|
289
|
+
* the native identifier used to uniquely identify an acccount
|
|
277
290
|
* @type {string}
|
|
278
291
|
* @memberof AccessItemAccountResponseV2024
|
|
279
292
|
*/
|
|
280
|
-
'
|
|
293
|
+
'nativeIdentity': string;
|
|
281
294
|
/**
|
|
282
|
-
* the
|
|
295
|
+
* the id of the source
|
|
283
296
|
* @type {string}
|
|
284
297
|
* @memberof AccessItemAccountResponseV2024
|
|
285
298
|
*/
|
|
286
|
-
'
|
|
299
|
+
'sourceId'?: string;
|
|
287
300
|
/**
|
|
288
|
-
* the
|
|
289
|
-
* @type {
|
|
301
|
+
* the number of entitlements the account will create
|
|
302
|
+
* @type {number}
|
|
290
303
|
* @memberof AccessItemAccountResponseV2024
|
|
291
304
|
*/
|
|
292
|
-
'
|
|
305
|
+
'entitlementCount'?: number;
|
|
293
306
|
}
|
|
294
307
|
/**
|
|
295
308
|
*
|
|
@@ -298,17 +311,17 @@ export interface AccessItemAccountResponseV2024 {
|
|
|
298
311
|
*/
|
|
299
312
|
export interface AccessItemAppResponseV2024 {
|
|
300
313
|
/**
|
|
301
|
-
* the access item
|
|
314
|
+
* the access item id
|
|
302
315
|
* @type {string}
|
|
303
316
|
* @memberof AccessItemAppResponseV2024
|
|
304
317
|
*/
|
|
305
|
-
'
|
|
318
|
+
'id'?: string;
|
|
306
319
|
/**
|
|
307
|
-
* the access item
|
|
320
|
+
* the access item type. entitlement in this case
|
|
308
321
|
* @type {string}
|
|
309
322
|
* @memberof AccessItemAppResponseV2024
|
|
310
323
|
*/
|
|
311
|
-
'
|
|
324
|
+
'accessType'?: string;
|
|
312
325
|
/**
|
|
313
326
|
* the access item display name
|
|
314
327
|
* @type {string}
|
|
@@ -320,13 +333,13 @@ export interface AccessItemAppResponseV2024 {
|
|
|
320
333
|
* @type {string}
|
|
321
334
|
* @memberof AccessItemAppResponseV2024
|
|
322
335
|
*/
|
|
323
|
-
'sourceName'?: string;
|
|
336
|
+
'sourceName'?: string | null;
|
|
324
337
|
/**
|
|
325
338
|
* the app role id
|
|
326
339
|
* @type {string}
|
|
327
340
|
* @memberof AccessItemAppResponseV2024
|
|
328
341
|
*/
|
|
329
|
-
'appRoleId'
|
|
342
|
+
'appRoleId': string | null;
|
|
330
343
|
}
|
|
331
344
|
/**
|
|
332
345
|
* Identity who approved the access item request.
|
|
@@ -358,10 +371,120 @@ export declare const AccessItemApproverDtoV2024TypeV2024: {
|
|
|
358
371
|
};
|
|
359
372
|
export type AccessItemApproverDtoV2024TypeV2024 = typeof AccessItemApproverDtoV2024TypeV2024[keyof typeof AccessItemApproverDtoV2024TypeV2024];
|
|
360
373
|
/**
|
|
361
|
-
*
|
|
374
|
+
*
|
|
362
375
|
* @export
|
|
376
|
+
* @interface AccessItemAssociatedAccessItemV2024
|
|
363
377
|
*/
|
|
364
|
-
export
|
|
378
|
+
export interface AccessItemAssociatedAccessItemV2024 {
|
|
379
|
+
/**
|
|
380
|
+
* the access item id
|
|
381
|
+
* @type {string}
|
|
382
|
+
* @memberof AccessItemAssociatedAccessItemV2024
|
|
383
|
+
*/
|
|
384
|
+
'id'?: string;
|
|
385
|
+
/**
|
|
386
|
+
* the access item type. entitlement in this case
|
|
387
|
+
* @type {string}
|
|
388
|
+
* @memberof AccessItemAssociatedAccessItemV2024
|
|
389
|
+
*/
|
|
390
|
+
'accessType'?: string;
|
|
391
|
+
/**
|
|
392
|
+
* the access item display name
|
|
393
|
+
* @type {string}
|
|
394
|
+
* @memberof AccessItemAssociatedAccessItemV2024
|
|
395
|
+
*/
|
|
396
|
+
'displayName'?: string;
|
|
397
|
+
/**
|
|
398
|
+
* the associated source name if it exists
|
|
399
|
+
* @type {string}
|
|
400
|
+
* @memberof AccessItemAssociatedAccessItemV2024
|
|
401
|
+
*/
|
|
402
|
+
'sourceName'?: string | null;
|
|
403
|
+
/**
|
|
404
|
+
* the entitlement attribute
|
|
405
|
+
* @type {string}
|
|
406
|
+
* @memberof AccessItemAssociatedAccessItemV2024
|
|
407
|
+
*/
|
|
408
|
+
'attribute': string;
|
|
409
|
+
/**
|
|
410
|
+
* the associated value
|
|
411
|
+
* @type {string}
|
|
412
|
+
* @memberof AccessItemAssociatedAccessItemV2024
|
|
413
|
+
*/
|
|
414
|
+
'value': string;
|
|
415
|
+
/**
|
|
416
|
+
* the type of entitlement
|
|
417
|
+
* @type {string}
|
|
418
|
+
* @memberof AccessItemAssociatedAccessItemV2024
|
|
419
|
+
*/
|
|
420
|
+
'type': string;
|
|
421
|
+
/**
|
|
422
|
+
* the description for the role
|
|
423
|
+
* @type {string}
|
|
424
|
+
* @memberof AccessItemAssociatedAccessItemV2024
|
|
425
|
+
*/
|
|
426
|
+
'description'?: string;
|
|
427
|
+
/**
|
|
428
|
+
* the id of the source
|
|
429
|
+
* @type {string}
|
|
430
|
+
* @memberof AccessItemAssociatedAccessItemV2024
|
|
431
|
+
*/
|
|
432
|
+
'sourceId'?: string;
|
|
433
|
+
/**
|
|
434
|
+
* indicates whether the access profile is standalone
|
|
435
|
+
* @type {boolean}
|
|
436
|
+
* @memberof AccessItemAssociatedAccessItemV2024
|
|
437
|
+
*/
|
|
438
|
+
'standalone': boolean | null;
|
|
439
|
+
/**
|
|
440
|
+
* indicates whether the entitlement is privileged
|
|
441
|
+
* @type {boolean}
|
|
442
|
+
* @memberof AccessItemAssociatedAccessItemV2024
|
|
443
|
+
*/
|
|
444
|
+
'privileged': boolean | null;
|
|
445
|
+
/**
|
|
446
|
+
* indicates whether the entitlement is cloud governed
|
|
447
|
+
* @type {boolean}
|
|
448
|
+
* @memberof AccessItemAssociatedAccessItemV2024
|
|
449
|
+
*/
|
|
450
|
+
'cloudGoverned': boolean | null;
|
|
451
|
+
/**
|
|
452
|
+
* the number of entitlements the account will create
|
|
453
|
+
* @type {number}
|
|
454
|
+
* @memberof AccessItemAssociatedAccessItemV2024
|
|
455
|
+
*/
|
|
456
|
+
'entitlementCount': number;
|
|
457
|
+
/**
|
|
458
|
+
* the list of app ids associated with the access profile
|
|
459
|
+
* @type {Array<AccessItemAccessProfileResponseAppRefsInnerV2024>}
|
|
460
|
+
* @memberof AccessItemAssociatedAccessItemV2024
|
|
461
|
+
*/
|
|
462
|
+
'appRefs': Array<AccessItemAccessProfileResponseAppRefsInnerV2024>;
|
|
463
|
+
/**
|
|
464
|
+
* the date the role is no longer assigned to the specified identity
|
|
465
|
+
* @type {string}
|
|
466
|
+
* @memberof AccessItemAssociatedAccessItemV2024
|
|
467
|
+
*/
|
|
468
|
+
'removeDate'?: string;
|
|
469
|
+
/**
|
|
470
|
+
* indicates whether the role is revocable
|
|
471
|
+
* @type {boolean}
|
|
472
|
+
* @memberof AccessItemAssociatedAccessItemV2024
|
|
473
|
+
*/
|
|
474
|
+
'revocable': boolean;
|
|
475
|
+
/**
|
|
476
|
+
* the native identifier used to uniquely identify an acccount
|
|
477
|
+
* @type {string}
|
|
478
|
+
* @memberof AccessItemAssociatedAccessItemV2024
|
|
479
|
+
*/
|
|
480
|
+
'nativeIdentity': string;
|
|
481
|
+
/**
|
|
482
|
+
* the app role id
|
|
483
|
+
* @type {string}
|
|
484
|
+
* @memberof AccessItemAssociatedAccessItemV2024
|
|
485
|
+
*/
|
|
486
|
+
'appRoleId': string | null;
|
|
487
|
+
}
|
|
365
488
|
/**
|
|
366
489
|
*
|
|
367
490
|
* @export
|
|
@@ -369,36 +492,50 @@ export type AccessItemAssociatedAccessItemV2024 = AccessItemAccessProfileRespons
|
|
|
369
492
|
*/
|
|
370
493
|
export interface AccessItemAssociatedV2024 {
|
|
371
494
|
/**
|
|
372
|
-
*
|
|
373
|
-
* @type {
|
|
495
|
+
* the event type
|
|
496
|
+
* @type {string}
|
|
374
497
|
* @memberof AccessItemAssociatedV2024
|
|
375
498
|
*/
|
|
376
|
-
'
|
|
499
|
+
'eventType'?: string;
|
|
377
500
|
/**
|
|
378
|
-
* the
|
|
501
|
+
* the date of event
|
|
379
502
|
* @type {string}
|
|
380
503
|
* @memberof AccessItemAssociatedV2024
|
|
381
504
|
*/
|
|
382
|
-
'
|
|
505
|
+
'dateTime'?: string;
|
|
383
506
|
/**
|
|
384
|
-
* the
|
|
507
|
+
* the identity id
|
|
385
508
|
* @type {string}
|
|
386
509
|
* @memberof AccessItemAssociatedV2024
|
|
387
510
|
*/
|
|
388
|
-
'
|
|
511
|
+
'identityId'?: string;
|
|
389
512
|
/**
|
|
390
|
-
*
|
|
391
|
-
* @type {
|
|
513
|
+
*
|
|
514
|
+
* @type {AccessItemAssociatedAccessItemV2024}
|
|
392
515
|
* @memberof AccessItemAssociatedV2024
|
|
393
516
|
*/
|
|
394
|
-
'
|
|
517
|
+
'accessItem': AccessItemAssociatedAccessItemV2024;
|
|
395
518
|
/**
|
|
396
519
|
*
|
|
397
520
|
* @type {CorrelatedGovernanceEventV2024}
|
|
398
521
|
* @memberof AccessItemAssociatedV2024
|
|
399
522
|
*/
|
|
400
|
-
'governanceEvent'
|
|
523
|
+
'governanceEvent': CorrelatedGovernanceEventV2024 | null;
|
|
524
|
+
/**
|
|
525
|
+
* the access item type
|
|
526
|
+
* @type {string}
|
|
527
|
+
* @memberof AccessItemAssociatedV2024
|
|
528
|
+
*/
|
|
529
|
+
'accessItemType'?: AccessItemAssociatedV2024AccessItemTypeV2024;
|
|
401
530
|
}
|
|
531
|
+
export declare const AccessItemAssociatedV2024AccessItemTypeV2024: {
|
|
532
|
+
readonly Account: "account";
|
|
533
|
+
readonly App: "app";
|
|
534
|
+
readonly Entitlement: "entitlement";
|
|
535
|
+
readonly Role: "role";
|
|
536
|
+
readonly AccessProfile: "accessProfile";
|
|
537
|
+
};
|
|
538
|
+
export type AccessItemAssociatedV2024AccessItemTypeV2024 = typeof AccessItemAssociatedV2024AccessItemTypeV2024[keyof typeof AccessItemAssociatedV2024AccessItemTypeV2024];
|
|
402
539
|
/**
|
|
403
540
|
*
|
|
404
541
|
* @export
|
|
@@ -442,77 +579,77 @@ export type AccessItemDiffV2024EventTypeV2024 = typeof AccessItemDiffV2024EventT
|
|
|
442
579
|
*/
|
|
443
580
|
export interface AccessItemEntitlementResponseV2024 {
|
|
444
581
|
/**
|
|
445
|
-
* the access item
|
|
582
|
+
* the access item id
|
|
446
583
|
* @type {string}
|
|
447
584
|
* @memberof AccessItemEntitlementResponseV2024
|
|
448
585
|
*/
|
|
449
|
-
'
|
|
586
|
+
'id'?: string;
|
|
450
587
|
/**
|
|
451
|
-
* the access item
|
|
588
|
+
* the access item type. entitlement in this case
|
|
452
589
|
* @type {string}
|
|
453
590
|
* @memberof AccessItemEntitlementResponseV2024
|
|
454
591
|
*/
|
|
455
|
-
'
|
|
592
|
+
'accessType'?: string;
|
|
456
593
|
/**
|
|
457
|
-
* the
|
|
594
|
+
* the display name of the identity
|
|
458
595
|
* @type {string}
|
|
459
596
|
* @memberof AccessItemEntitlementResponseV2024
|
|
460
597
|
*/
|
|
461
|
-
'
|
|
598
|
+
'displayName'?: string;
|
|
462
599
|
/**
|
|
463
|
-
* the
|
|
600
|
+
* the name of the source
|
|
464
601
|
* @type {string}
|
|
465
602
|
* @memberof AccessItemEntitlementResponseV2024
|
|
466
603
|
*/
|
|
467
|
-
'
|
|
604
|
+
'sourceName'?: string;
|
|
468
605
|
/**
|
|
469
|
-
* the
|
|
606
|
+
* the entitlement attribute
|
|
470
607
|
* @type {string}
|
|
471
608
|
* @memberof AccessItemEntitlementResponseV2024
|
|
472
609
|
*/
|
|
473
|
-
'
|
|
610
|
+
'attribute': string;
|
|
474
611
|
/**
|
|
475
|
-
* the
|
|
612
|
+
* the associated value
|
|
476
613
|
* @type {string}
|
|
477
614
|
* @memberof AccessItemEntitlementResponseV2024
|
|
478
615
|
*/
|
|
479
|
-
'
|
|
616
|
+
'value': string;
|
|
480
617
|
/**
|
|
481
|
-
* the
|
|
618
|
+
* the type of entitlement
|
|
482
619
|
* @type {string}
|
|
483
620
|
* @memberof AccessItemEntitlementResponseV2024
|
|
484
621
|
*/
|
|
485
|
-
'
|
|
622
|
+
'type': string;
|
|
486
623
|
/**
|
|
487
624
|
* the description for the entitlment
|
|
488
625
|
* @type {string}
|
|
489
626
|
* @memberof AccessItemEntitlementResponseV2024
|
|
490
627
|
*/
|
|
491
|
-
'description'?: string;
|
|
628
|
+
'description'?: string | null;
|
|
492
629
|
/**
|
|
493
|
-
* the
|
|
630
|
+
* the id of the source
|
|
494
631
|
* @type {string}
|
|
495
632
|
* @memberof AccessItemEntitlementResponseV2024
|
|
496
633
|
*/
|
|
497
|
-
'
|
|
634
|
+
'sourceId'?: string;
|
|
498
635
|
/**
|
|
499
636
|
* indicates whether the entitlement is standalone
|
|
500
637
|
* @type {boolean}
|
|
501
638
|
* @memberof AccessItemEntitlementResponseV2024
|
|
502
639
|
*/
|
|
503
|
-
'standalone': boolean;
|
|
640
|
+
'standalone': boolean | null;
|
|
504
641
|
/**
|
|
505
642
|
* indicates whether the entitlement is privileged
|
|
506
643
|
* @type {boolean}
|
|
507
644
|
* @memberof AccessItemEntitlementResponseV2024
|
|
508
645
|
*/
|
|
509
|
-
'privileged': boolean;
|
|
646
|
+
'privileged': boolean | null;
|
|
510
647
|
/**
|
|
511
648
|
* indicates whether the entitlement is cloud governed
|
|
512
649
|
* @type {boolean}
|
|
513
650
|
* @memberof AccessItemEntitlementResponseV2024
|
|
514
651
|
*/
|
|
515
|
-
'cloudGoverned': boolean;
|
|
652
|
+
'cloudGoverned': boolean | null;
|
|
516
653
|
}
|
|
517
654
|
/**
|
|
518
655
|
*
|
|
@@ -550,7 +687,7 @@ export interface AccessItemRemovedV2024 {
|
|
|
550
687
|
* @type {AccessItemAssociatedAccessItemV2024}
|
|
551
688
|
* @memberof AccessItemRemovedV2024
|
|
552
689
|
*/
|
|
553
|
-
'accessItem'
|
|
690
|
+
'accessItem': AccessItemAssociatedAccessItemV2024;
|
|
554
691
|
/**
|
|
555
692
|
* the identity id
|
|
556
693
|
* @type {string}
|
|
@@ -568,14 +705,28 @@ export interface AccessItemRemovedV2024 {
|
|
|
568
705
|
* @type {string}
|
|
569
706
|
* @memberof AccessItemRemovedV2024
|
|
570
707
|
*/
|
|
571
|
-
'
|
|
708
|
+
'dateTime'?: string;
|
|
709
|
+
/**
|
|
710
|
+
* the access item type
|
|
711
|
+
* @type {string}
|
|
712
|
+
* @memberof AccessItemRemovedV2024
|
|
713
|
+
*/
|
|
714
|
+
'accessItemType'?: AccessItemRemovedV2024AccessItemTypeV2024;
|
|
572
715
|
/**
|
|
573
716
|
*
|
|
574
717
|
* @type {CorrelatedGovernanceEventV2024}
|
|
575
718
|
* @memberof AccessItemRemovedV2024
|
|
576
719
|
*/
|
|
577
|
-
'governanceEvent'?: CorrelatedGovernanceEventV2024;
|
|
720
|
+
'governanceEvent'?: CorrelatedGovernanceEventV2024 | null;
|
|
578
721
|
}
|
|
722
|
+
export declare const AccessItemRemovedV2024AccessItemTypeV2024: {
|
|
723
|
+
readonly Account: "account";
|
|
724
|
+
readonly App: "app";
|
|
725
|
+
readonly Entitlement: "entitlement";
|
|
726
|
+
readonly Role: "role";
|
|
727
|
+
readonly AccessProfile: "accessProfile";
|
|
728
|
+
};
|
|
729
|
+
export type AccessItemRemovedV2024AccessItemTypeV2024 = typeof AccessItemRemovedV2024AccessItemTypeV2024[keyof typeof AccessItemRemovedV2024AccessItemTypeV2024];
|
|
579
730
|
/**
|
|
580
731
|
* Identity the access item is requested for.
|
|
581
732
|
* @export
|
|
@@ -728,17 +879,17 @@ export type AccessItemReviewedByV2024TypeV2024 = typeof AccessItemReviewedByV202
|
|
|
728
879
|
*/
|
|
729
880
|
export interface AccessItemRoleResponseV2024 {
|
|
730
881
|
/**
|
|
731
|
-
* the access item
|
|
882
|
+
* the access item id
|
|
732
883
|
* @type {string}
|
|
733
884
|
* @memberof AccessItemRoleResponseV2024
|
|
734
885
|
*/
|
|
735
|
-
'
|
|
886
|
+
'id'?: string;
|
|
736
887
|
/**
|
|
737
|
-
* the access item
|
|
888
|
+
* the access item type. role in this case
|
|
738
889
|
* @type {string}
|
|
739
890
|
* @memberof AccessItemRoleResponseV2024
|
|
740
891
|
*/
|
|
741
|
-
'
|
|
892
|
+
'accessType'?: string;
|
|
742
893
|
/**
|
|
743
894
|
* the role display name
|
|
744
895
|
* @type {string}
|
|
@@ -746,17 +897,17 @@ export interface AccessItemRoleResponseV2024 {
|
|
|
746
897
|
*/
|
|
747
898
|
'displayName'?: string;
|
|
748
899
|
/**
|
|
749
|
-
* the
|
|
900
|
+
* the associated source name if it exists
|
|
750
901
|
* @type {string}
|
|
751
902
|
* @memberof AccessItemRoleResponseV2024
|
|
752
903
|
*/
|
|
753
|
-
'
|
|
904
|
+
'sourceName'?: string | null;
|
|
754
905
|
/**
|
|
755
|
-
* the
|
|
906
|
+
* the description for the role
|
|
756
907
|
* @type {string}
|
|
757
908
|
* @memberof AccessItemRoleResponseV2024
|
|
758
909
|
*/
|
|
759
|
-
'
|
|
910
|
+
'description'?: string;
|
|
760
911
|
/**
|
|
761
912
|
* the date the role is no longer assigned to the specified identity
|
|
762
913
|
* @type {string}
|
|
@@ -2156,66 +2307,6 @@ export interface AccessRequestDynamicApproverV2024 {
|
|
|
2156
2307
|
*/
|
|
2157
2308
|
'requestedBy': AccessItemRequesterDtoV2024;
|
|
2158
2309
|
}
|
|
2159
|
-
/**
|
|
2160
|
-
*
|
|
2161
|
-
* @export
|
|
2162
|
-
* @interface AccessRequestItemResponseV2024
|
|
2163
|
-
*/
|
|
2164
|
-
export interface AccessRequestItemResponseV2024 {
|
|
2165
|
-
/**
|
|
2166
|
-
* the access request item operation
|
|
2167
|
-
* @type {string}
|
|
2168
|
-
* @memberof AccessRequestItemResponseV2024
|
|
2169
|
-
*/
|
|
2170
|
-
'operation'?: string;
|
|
2171
|
-
/**
|
|
2172
|
-
* the access item type
|
|
2173
|
-
* @type {string}
|
|
2174
|
-
* @memberof AccessRequestItemResponseV2024
|
|
2175
|
-
*/
|
|
2176
|
-
'accessItemType'?: string;
|
|
2177
|
-
/**
|
|
2178
|
-
* the name of access request item
|
|
2179
|
-
* @type {string}
|
|
2180
|
-
* @memberof AccessRequestItemResponseV2024
|
|
2181
|
-
*/
|
|
2182
|
-
'name'?: string;
|
|
2183
|
-
/**
|
|
2184
|
-
* the final decision for the access request
|
|
2185
|
-
* @type {string}
|
|
2186
|
-
* @memberof AccessRequestItemResponseV2024
|
|
2187
|
-
*/
|
|
2188
|
-
'decision'?: AccessRequestItemResponseV2024DecisionV2024;
|
|
2189
|
-
/**
|
|
2190
|
-
* the description of access request item
|
|
2191
|
-
* @type {string}
|
|
2192
|
-
* @memberof AccessRequestItemResponseV2024
|
|
2193
|
-
*/
|
|
2194
|
-
'description'?: string;
|
|
2195
|
-
/**
|
|
2196
|
-
* the source id
|
|
2197
|
-
* @type {string}
|
|
2198
|
-
* @memberof AccessRequestItemResponseV2024
|
|
2199
|
-
*/
|
|
2200
|
-
'sourceId'?: string;
|
|
2201
|
-
/**
|
|
2202
|
-
* the source Name
|
|
2203
|
-
* @type {string}
|
|
2204
|
-
* @memberof AccessRequestItemResponseV2024
|
|
2205
|
-
*/
|
|
2206
|
-
'sourceName'?: string;
|
|
2207
|
-
/**
|
|
2208
|
-
*
|
|
2209
|
-
* @type {Array<ApprovalInfoResponseV2024>}
|
|
2210
|
-
* @memberof AccessRequestItemResponseV2024
|
|
2211
|
-
*/
|
|
2212
|
-
'approvalInfos'?: Array<ApprovalInfoResponseV2024>;
|
|
2213
|
-
}
|
|
2214
|
-
export declare const AccessRequestItemResponseV2024DecisionV2024: {
|
|
2215
|
-
readonly Approved: "APPROVED";
|
|
2216
|
-
readonly Rejected: "REJECTED";
|
|
2217
|
-
};
|
|
2218
|
-
export type AccessRequestItemResponseV2024DecisionV2024 = typeof AccessRequestItemResponseV2024DecisionV2024[keyof typeof AccessRequestItemResponseV2024DecisionV2024];
|
|
2219
2310
|
/**
|
|
2220
2311
|
*
|
|
2221
2312
|
* @export
|
|
@@ -2799,31 +2890,6 @@ export interface AccessRequestRecommendationItemV2024 {
|
|
|
2799
2890
|
*/
|
|
2800
2891
|
'type'?: AccessRequestRecommendationItemTypeV2024;
|
|
2801
2892
|
}
|
|
2802
|
-
/**
|
|
2803
|
-
*
|
|
2804
|
-
* @export
|
|
2805
|
-
* @interface AccessRequestResponse1V2024
|
|
2806
|
-
*/
|
|
2807
|
-
export interface AccessRequestResponse1V2024 {
|
|
2808
|
-
/**
|
|
2809
|
-
* the requester Id
|
|
2810
|
-
* @type {string}
|
|
2811
|
-
* @memberof AccessRequestResponse1V2024
|
|
2812
|
-
*/
|
|
2813
|
-
'requesterId'?: string;
|
|
2814
|
-
/**
|
|
2815
|
-
* the requesterName
|
|
2816
|
-
* @type {string}
|
|
2817
|
-
* @memberof AccessRequestResponse1V2024
|
|
2818
|
-
*/
|
|
2819
|
-
'requesterName'?: string;
|
|
2820
|
-
/**
|
|
2821
|
-
*
|
|
2822
|
-
* @type {Array<AccessRequestItemResponseV2024>}
|
|
2823
|
-
* @memberof AccessRequestResponse1V2024
|
|
2824
|
-
*/
|
|
2825
|
-
'items'?: Array<AccessRequestItemResponseV2024>;
|
|
2826
|
-
}
|
|
2827
2893
|
/**
|
|
2828
2894
|
*
|
|
2829
2895
|
* @export
|
|
@@ -2923,6 +2989,86 @@ export interface AccessRequestV2024 {
|
|
|
2923
2989
|
*/
|
|
2924
2990
|
'requestedForWithRequestedItems'?: Array<RequestedForDtoRefV2024> | null;
|
|
2925
2991
|
}
|
|
2992
|
+
/**
|
|
2993
|
+
*
|
|
2994
|
+
* @export
|
|
2995
|
+
* @interface AccessRequestedAccountV2024
|
|
2996
|
+
*/
|
|
2997
|
+
export interface AccessRequestedAccountV2024 {
|
|
2998
|
+
/**
|
|
2999
|
+
* the ID of the account in the database
|
|
3000
|
+
* @type {string}
|
|
3001
|
+
* @memberof AccessRequestedAccountV2024
|
|
3002
|
+
*/
|
|
3003
|
+
'id'?: string;
|
|
3004
|
+
/**
|
|
3005
|
+
* the native identifier of the account
|
|
3006
|
+
* @type {string}
|
|
3007
|
+
* @memberof AccessRequestedAccountV2024
|
|
3008
|
+
*/
|
|
3009
|
+
'nativeIdentity'?: string;
|
|
3010
|
+
/**
|
|
3011
|
+
* the display name of the account
|
|
3012
|
+
* @type {string}
|
|
3013
|
+
* @memberof AccessRequestedAccountV2024
|
|
3014
|
+
*/
|
|
3015
|
+
'displayName'?: string;
|
|
3016
|
+
/**
|
|
3017
|
+
* the ID of the source for this account
|
|
3018
|
+
* @type {string}
|
|
3019
|
+
* @memberof AccessRequestedAccountV2024
|
|
3020
|
+
*/
|
|
3021
|
+
'sourceId'?: string;
|
|
3022
|
+
/**
|
|
3023
|
+
* the name of the source for this account
|
|
3024
|
+
* @type {string}
|
|
3025
|
+
* @memberof AccessRequestedAccountV2024
|
|
3026
|
+
*/
|
|
3027
|
+
'sourceName'?: string;
|
|
3028
|
+
/**
|
|
3029
|
+
* the number of entitlements on this account
|
|
3030
|
+
* @type {number}
|
|
3031
|
+
* @memberof AccessRequestedAccountV2024
|
|
3032
|
+
*/
|
|
3033
|
+
'entitlementCount'?: number;
|
|
3034
|
+
/**
|
|
3035
|
+
* this value is always \"account\"
|
|
3036
|
+
* @type {string}
|
|
3037
|
+
* @memberof AccessRequestedAccountV2024
|
|
3038
|
+
*/
|
|
3039
|
+
'accessType'?: string;
|
|
3040
|
+
}
|
|
3041
|
+
/**
|
|
3042
|
+
*
|
|
3043
|
+
* @export
|
|
3044
|
+
* @interface AccessRequestedStatusChangeV2024
|
|
3045
|
+
*/
|
|
3046
|
+
export interface AccessRequestedStatusChangeV2024 {
|
|
3047
|
+
/**
|
|
3048
|
+
* the previous status of the account
|
|
3049
|
+
* @type {string}
|
|
3050
|
+
* @memberof AccessRequestedStatusChangeV2024
|
|
3051
|
+
*/
|
|
3052
|
+
'previousStatus'?: AccessRequestedStatusChangeV2024PreviousStatusV2024;
|
|
3053
|
+
/**
|
|
3054
|
+
* the new status of the account
|
|
3055
|
+
* @type {string}
|
|
3056
|
+
* @memberof AccessRequestedStatusChangeV2024
|
|
3057
|
+
*/
|
|
3058
|
+
'newStatus'?: AccessRequestedStatusChangeV2024NewStatusV2024;
|
|
3059
|
+
}
|
|
3060
|
+
export declare const AccessRequestedStatusChangeV2024PreviousStatusV2024: {
|
|
3061
|
+
readonly Enabled: "enabled";
|
|
3062
|
+
readonly Disabled: "disabled";
|
|
3063
|
+
readonly Locked: "locked";
|
|
3064
|
+
};
|
|
3065
|
+
export type AccessRequestedStatusChangeV2024PreviousStatusV2024 = typeof AccessRequestedStatusChangeV2024PreviousStatusV2024[keyof typeof AccessRequestedStatusChangeV2024PreviousStatusV2024];
|
|
3066
|
+
export declare const AccessRequestedStatusChangeV2024NewStatusV2024: {
|
|
3067
|
+
readonly Enabled: "enabled";
|
|
3068
|
+
readonly Disabled: "disabled";
|
|
3069
|
+
readonly Locked: "locked";
|
|
3070
|
+
};
|
|
3071
|
+
export type AccessRequestedStatusChangeV2024NewStatusV2024 = typeof AccessRequestedStatusChangeV2024NewStatusV2024[keyof typeof AccessRequestedStatusChangeV2024NewStatusV2024];
|
|
2926
3072
|
/**
|
|
2927
3073
|
*
|
|
2928
3074
|
* @export
|
|
@@ -2930,11 +3076,11 @@ export interface AccessRequestV2024 {
|
|
|
2930
3076
|
*/
|
|
2931
3077
|
export interface AccessRequestedV2024 {
|
|
2932
3078
|
/**
|
|
2933
|
-
*
|
|
2934
|
-
* @type {
|
|
3079
|
+
* the event type
|
|
3080
|
+
* @type {string}
|
|
2935
3081
|
* @memberof AccessRequestedV2024
|
|
2936
3082
|
*/
|
|
2937
|
-
'
|
|
3083
|
+
'eventType'?: string;
|
|
2938
3084
|
/**
|
|
2939
3085
|
* the identity id
|
|
2940
3086
|
* @type {string}
|
|
@@ -2942,17 +3088,23 @@ export interface AccessRequestedV2024 {
|
|
|
2942
3088
|
*/
|
|
2943
3089
|
'identityId'?: string;
|
|
2944
3090
|
/**
|
|
2945
|
-
* the event
|
|
3091
|
+
* the date of event
|
|
2946
3092
|
* @type {string}
|
|
2947
3093
|
* @memberof AccessRequestedV2024
|
|
2948
3094
|
*/
|
|
2949
|
-
'
|
|
3095
|
+
'dateTime'?: string;
|
|
2950
3096
|
/**
|
|
2951
|
-
*
|
|
2952
|
-
* @type {
|
|
3097
|
+
*
|
|
3098
|
+
* @type {AccessRequestedAccountV2024}
|
|
3099
|
+
* @memberof AccessRequestedV2024
|
|
3100
|
+
*/
|
|
3101
|
+
'account': AccessRequestedAccountV2024;
|
|
3102
|
+
/**
|
|
3103
|
+
*
|
|
3104
|
+
* @type {AccessRequestedStatusChangeV2024}
|
|
2953
3105
|
* @memberof AccessRequestedV2024
|
|
2954
3106
|
*/
|
|
2955
|
-
'
|
|
3107
|
+
'statusChange': AccessRequestedStatusChangeV2024;
|
|
2956
3108
|
}
|
|
2957
3109
|
/**
|
|
2958
3110
|
*
|
|
@@ -3887,6 +4039,30 @@ export interface AccountAggregationStatusV2024 {
|
|
|
3887
4039
|
* @memberof AccountAggregationStatusV2024
|
|
3888
4040
|
*/
|
|
3889
4041
|
'processedAccounts'?: number;
|
|
4042
|
+
/**
|
|
4043
|
+
* The total number of accounts that have been marked for deletion during the aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.*
|
|
4044
|
+
* @type {number}
|
|
4045
|
+
* @memberof AccountAggregationStatusV2024
|
|
4046
|
+
*/
|
|
4047
|
+
'totalAccountsMarkedForDeletion'?: number;
|
|
4048
|
+
/**
|
|
4049
|
+
* The number of accounts that have been deleted during the aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.*
|
|
4050
|
+
* @type {number}
|
|
4051
|
+
* @memberof AccountAggregationStatusV2024
|
|
4052
|
+
*/
|
|
4053
|
+
'deletedAccounts'?: number;
|
|
4054
|
+
/**
|
|
4055
|
+
* The total number of unique identities that have been marked for refresh. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.*
|
|
4056
|
+
* @type {number}
|
|
4057
|
+
* @memberof AccountAggregationStatusV2024
|
|
4058
|
+
*/
|
|
4059
|
+
'totalIdentities'?: number;
|
|
4060
|
+
/**
|
|
4061
|
+
* The number of unique identities that have been refreshed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.*
|
|
4062
|
+
* @type {number}
|
|
4063
|
+
* @memberof AccountAggregationStatusV2024
|
|
4064
|
+
*/
|
|
4065
|
+
'processedIdentities'?: number;
|
|
3890
4066
|
}
|
|
3891
4067
|
export declare const AccountAggregationStatusV2024StatusV2024: {
|
|
3892
4068
|
readonly Started: "STARTED";
|
|
@@ -4620,86 +4796,6 @@ export interface AccountSourceV2024 {
|
|
|
4620
4796
|
*/
|
|
4621
4797
|
'type'?: string;
|
|
4622
4798
|
}
|
|
4623
|
-
/**
|
|
4624
|
-
*
|
|
4625
|
-
* @export
|
|
4626
|
-
* @interface AccountStatusChangedAccountV2024
|
|
4627
|
-
*/
|
|
4628
|
-
export interface AccountStatusChangedAccountV2024 {
|
|
4629
|
-
/**
|
|
4630
|
-
* the ID of the account in the database
|
|
4631
|
-
* @type {string}
|
|
4632
|
-
* @memberof AccountStatusChangedAccountV2024
|
|
4633
|
-
*/
|
|
4634
|
-
'id'?: string;
|
|
4635
|
-
/**
|
|
4636
|
-
* the native identifier of the account
|
|
4637
|
-
* @type {string}
|
|
4638
|
-
* @memberof AccountStatusChangedAccountV2024
|
|
4639
|
-
*/
|
|
4640
|
-
'nativeIdentity'?: string;
|
|
4641
|
-
/**
|
|
4642
|
-
* the display name of the account
|
|
4643
|
-
* @type {string}
|
|
4644
|
-
* @memberof AccountStatusChangedAccountV2024
|
|
4645
|
-
*/
|
|
4646
|
-
'displayName'?: string;
|
|
4647
|
-
/**
|
|
4648
|
-
* the ID of the source for this account
|
|
4649
|
-
* @type {string}
|
|
4650
|
-
* @memberof AccountStatusChangedAccountV2024
|
|
4651
|
-
*/
|
|
4652
|
-
'sourceId'?: string;
|
|
4653
|
-
/**
|
|
4654
|
-
* the name of the source for this account
|
|
4655
|
-
* @type {string}
|
|
4656
|
-
* @memberof AccountStatusChangedAccountV2024
|
|
4657
|
-
*/
|
|
4658
|
-
'sourceName'?: string;
|
|
4659
|
-
/**
|
|
4660
|
-
* the number of entitlements on this account
|
|
4661
|
-
* @type {number}
|
|
4662
|
-
* @memberof AccountStatusChangedAccountV2024
|
|
4663
|
-
*/
|
|
4664
|
-
'entitlementCount'?: number;
|
|
4665
|
-
/**
|
|
4666
|
-
* this value is always \"account\"
|
|
4667
|
-
* @type {string}
|
|
4668
|
-
* @memberof AccountStatusChangedAccountV2024
|
|
4669
|
-
*/
|
|
4670
|
-
'accessType'?: string;
|
|
4671
|
-
}
|
|
4672
|
-
/**
|
|
4673
|
-
*
|
|
4674
|
-
* @export
|
|
4675
|
-
* @interface AccountStatusChangedStatusChangeV2024
|
|
4676
|
-
*/
|
|
4677
|
-
export interface AccountStatusChangedStatusChangeV2024 {
|
|
4678
|
-
/**
|
|
4679
|
-
* the previous status of the account
|
|
4680
|
-
* @type {string}
|
|
4681
|
-
* @memberof AccountStatusChangedStatusChangeV2024
|
|
4682
|
-
*/
|
|
4683
|
-
'previousStatus'?: AccountStatusChangedStatusChangeV2024PreviousStatusV2024;
|
|
4684
|
-
/**
|
|
4685
|
-
* the new status of the account
|
|
4686
|
-
* @type {string}
|
|
4687
|
-
* @memberof AccountStatusChangedStatusChangeV2024
|
|
4688
|
-
*/
|
|
4689
|
-
'newStatus'?: AccountStatusChangedStatusChangeV2024NewStatusV2024;
|
|
4690
|
-
}
|
|
4691
|
-
export declare const AccountStatusChangedStatusChangeV2024PreviousStatusV2024: {
|
|
4692
|
-
readonly Enabled: "enabled";
|
|
4693
|
-
readonly Disabled: "disabled";
|
|
4694
|
-
readonly Locked: "locked";
|
|
4695
|
-
};
|
|
4696
|
-
export type AccountStatusChangedStatusChangeV2024PreviousStatusV2024 = typeof AccountStatusChangedStatusChangeV2024PreviousStatusV2024[keyof typeof AccountStatusChangedStatusChangeV2024PreviousStatusV2024];
|
|
4697
|
-
export declare const AccountStatusChangedStatusChangeV2024NewStatusV2024: {
|
|
4698
|
-
readonly Enabled: "enabled";
|
|
4699
|
-
readonly Disabled: "disabled";
|
|
4700
|
-
readonly Locked: "locked";
|
|
4701
|
-
};
|
|
4702
|
-
export type AccountStatusChangedStatusChangeV2024NewStatusV2024 = typeof AccountStatusChangedStatusChangeV2024NewStatusV2024[keyof typeof AccountStatusChangedStatusChangeV2024NewStatusV2024];
|
|
4703
4799
|
/**
|
|
4704
4800
|
*
|
|
4705
4801
|
* @export
|
|
@@ -4723,19 +4819,19 @@ export interface AccountStatusChangedV2024 {
|
|
|
4723
4819
|
* @type {string}
|
|
4724
4820
|
* @memberof AccountStatusChangedV2024
|
|
4725
4821
|
*/
|
|
4726
|
-
'
|
|
4822
|
+
'dateTime'?: string;
|
|
4727
4823
|
/**
|
|
4728
4824
|
*
|
|
4729
|
-
* @type {
|
|
4825
|
+
* @type {AccessRequestedAccountV2024}
|
|
4730
4826
|
* @memberof AccountStatusChangedV2024
|
|
4731
4827
|
*/
|
|
4732
|
-
'account'
|
|
4828
|
+
'account': AccessRequestedAccountV2024;
|
|
4733
4829
|
/**
|
|
4734
4830
|
*
|
|
4735
|
-
* @type {
|
|
4831
|
+
* @type {AccessRequestedStatusChangeV2024}
|
|
4736
4832
|
* @memberof AccountStatusChangedV2024
|
|
4737
4833
|
*/
|
|
4738
|
-
'statusChange'
|
|
4834
|
+
'statusChange': AccessRequestedStatusChangeV2024;
|
|
4739
4835
|
}
|
|
4740
4836
|
/**
|
|
4741
4837
|
* Request used for account enable/disable
|
|
@@ -5845,31 +5941,6 @@ export declare const ApprovalIdentityV2024TypeV2024: {
|
|
|
5845
5941
|
readonly Identity: "IDENTITY";
|
|
5846
5942
|
};
|
|
5847
5943
|
export type ApprovalIdentityV2024TypeV2024 = typeof ApprovalIdentityV2024TypeV2024[keyof typeof ApprovalIdentityV2024TypeV2024];
|
|
5848
|
-
/**
|
|
5849
|
-
*
|
|
5850
|
-
* @export
|
|
5851
|
-
* @interface ApprovalInfoResponseV2024
|
|
5852
|
-
*/
|
|
5853
|
-
export interface ApprovalInfoResponseV2024 {
|
|
5854
|
-
/**
|
|
5855
|
-
* the id of approver
|
|
5856
|
-
* @type {string}
|
|
5857
|
-
* @memberof ApprovalInfoResponseV2024
|
|
5858
|
-
*/
|
|
5859
|
-
'id'?: string;
|
|
5860
|
-
/**
|
|
5861
|
-
* the name of approver
|
|
5862
|
-
* @type {string}
|
|
5863
|
-
* @memberof ApprovalInfoResponseV2024
|
|
5864
|
-
*/
|
|
5865
|
-
'name'?: string;
|
|
5866
|
-
/**
|
|
5867
|
-
* the status of the approval request
|
|
5868
|
-
* @type {string}
|
|
5869
|
-
* @memberof ApprovalInfoResponseV2024
|
|
5870
|
-
*/
|
|
5871
|
-
'status'?: string;
|
|
5872
|
-
}
|
|
5873
5944
|
/**
|
|
5874
5945
|
*
|
|
5875
5946
|
* @export
|
|
@@ -6882,7 +6953,7 @@ export interface AttributesChangedV2024 {
|
|
|
6882
6953
|
* @type {Array<AttributeChangeV2024>}
|
|
6883
6954
|
* @memberof AttributesChangedV2024
|
|
6884
6955
|
*/
|
|
6885
|
-
'
|
|
6956
|
+
'attributeChanges': Array<AttributeChangeV2024>;
|
|
6886
6957
|
/**
|
|
6887
6958
|
* the event type
|
|
6888
6959
|
* @type {string}
|
|
@@ -6900,7 +6971,7 @@ export interface AttributesChangedV2024 {
|
|
|
6900
6971
|
* @type {string}
|
|
6901
6972
|
* @memberof AttributesChangedV2024
|
|
6902
6973
|
*/
|
|
6903
|
-
'
|
|
6974
|
+
'dateTime'?: string;
|
|
6904
6975
|
}
|
|
6905
6976
|
/**
|
|
6906
6977
|
* Audit details for the reassignment configuration of an identity
|
|
@@ -8251,7 +8322,6 @@ export interface CampaignAllOfFilterV2024 {
|
|
|
8251
8322
|
}
|
|
8252
8323
|
export declare const CampaignAllOfFilterV2024TypeV2024: {
|
|
8253
8324
|
readonly CampaignFilter: "CAMPAIGN_FILTER";
|
|
8254
|
-
readonly Rule: "RULE";
|
|
8255
8325
|
};
|
|
8256
8326
|
export type CampaignAllOfFilterV2024TypeV2024 = typeof CampaignAllOfFilterV2024TypeV2024[keyof typeof CampaignAllOfFilterV2024TypeV2024];
|
|
8257
8327
|
/**
|
|
@@ -11903,7 +11973,7 @@ export interface CorrelatedGovernanceEventV2024 {
|
|
|
11903
11973
|
* @type {string}
|
|
11904
11974
|
* @memberof CorrelatedGovernanceEventV2024
|
|
11905
11975
|
*/
|
|
11906
|
-
'
|
|
11976
|
+
'dateTime'?: string;
|
|
11907
11977
|
/**
|
|
11908
11978
|
* The type of governance event.
|
|
11909
11979
|
* @type {string}
|
|
@@ -12449,7 +12519,13 @@ export interface CreatePersonalAccessTokenRequestV2024 {
|
|
|
12449
12519
|
* @type {number}
|
|
12450
12520
|
* @memberof CreatePersonalAccessTokenRequestV2024
|
|
12451
12521
|
*/
|
|
12452
|
-
'accessTokenValiditySeconds'?: number;
|
|
12522
|
+
'accessTokenValiditySeconds'?: number | null;
|
|
12523
|
+
/**
|
|
12524
|
+
* Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date.
|
|
12525
|
+
* @type {string}
|
|
12526
|
+
* @memberof CreatePersonalAccessTokenRequestV2024
|
|
12527
|
+
*/
|
|
12528
|
+
'expirationDate'?: string | null;
|
|
12453
12529
|
}
|
|
12454
12530
|
/**
|
|
12455
12531
|
*
|
|
@@ -12499,6 +12575,12 @@ export interface CreatePersonalAccessTokenResponseV2024 {
|
|
|
12499
12575
|
* @memberof CreatePersonalAccessTokenResponseV2024
|
|
12500
12576
|
*/
|
|
12501
12577
|
'accessTokenValiditySeconds': number;
|
|
12578
|
+
/**
|
|
12579
|
+
* Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date.
|
|
12580
|
+
* @type {string}
|
|
12581
|
+
* @memberof CreatePersonalAccessTokenResponseV2024
|
|
12582
|
+
*/
|
|
12583
|
+
'expirationDate': string;
|
|
12502
12584
|
}
|
|
12503
12585
|
/**
|
|
12504
12586
|
*
|
|
@@ -14132,7 +14214,7 @@ export declare const EntitlementApprovalSchemeV2024ApproverTypeV2024: {
|
|
|
14132
14214
|
};
|
|
14133
14215
|
export type EntitlementApprovalSchemeV2024ApproverTypeV2024 = typeof EntitlementApprovalSchemeV2024ApproverTypeV2024[keyof typeof EntitlementApprovalSchemeV2024ApproverTypeV2024];
|
|
14134
14216
|
/**
|
|
14135
|
-
*
|
|
14217
|
+
* Object for specifying the bulk update request
|
|
14136
14218
|
* @export
|
|
14137
14219
|
* @interface EntitlementBulkUpdateRequestV2024
|
|
14138
14220
|
*/
|
|
@@ -17457,96 +17539,104 @@ export type GetDiscoveredApplications200ResponseInnerV2024 = FullDiscoveredAppli
|
|
|
17457
17539
|
*/
|
|
17458
17540
|
export interface GetHistoricalIdentityEvents200ResponseInnerV2024 {
|
|
17459
17541
|
/**
|
|
17460
|
-
*
|
|
17461
|
-
* @type {
|
|
17542
|
+
* the id of the certification item
|
|
17543
|
+
* @type {string}
|
|
17462
17544
|
* @memberof GetHistoricalIdentityEvents200ResponseInnerV2024
|
|
17463
17545
|
*/
|
|
17464
|
-
'
|
|
17546
|
+
'certificationId': string;
|
|
17465
17547
|
/**
|
|
17466
|
-
* the
|
|
17548
|
+
* the certification item name
|
|
17467
17549
|
* @type {string}
|
|
17468
17550
|
* @memberof GetHistoricalIdentityEvents200ResponseInnerV2024
|
|
17469
17551
|
*/
|
|
17470
|
-
'
|
|
17552
|
+
'certificationName': string;
|
|
17471
17553
|
/**
|
|
17472
|
-
* the
|
|
17554
|
+
* the date ceritification was signed
|
|
17473
17555
|
* @type {string}
|
|
17474
17556
|
* @memberof GetHistoricalIdentityEvents200ResponseInnerV2024
|
|
17475
17557
|
*/
|
|
17476
|
-
'
|
|
17558
|
+
'signedDate'?: string;
|
|
17477
17559
|
/**
|
|
17478
|
-
*
|
|
17479
|
-
* @type {
|
|
17560
|
+
* this field is deprecated and may go away
|
|
17561
|
+
* @type {Array<CertifierResponseV2024>}
|
|
17480
17562
|
* @memberof GetHistoricalIdentityEvents200ResponseInnerV2024
|
|
17481
17563
|
*/
|
|
17482
|
-
'
|
|
17564
|
+
'certifiers'?: Array<CertifierResponseV2024>;
|
|
17483
17565
|
/**
|
|
17484
|
-
*
|
|
17485
|
-
* @type {
|
|
17566
|
+
* The list of identities who review this certification
|
|
17567
|
+
* @type {Array<CertifierResponseV2024>}
|
|
17486
17568
|
* @memberof GetHistoricalIdentityEvents200ResponseInnerV2024
|
|
17487
17569
|
*/
|
|
17488
|
-
'
|
|
17570
|
+
'reviewers'?: Array<CertifierResponseV2024>;
|
|
17489
17571
|
/**
|
|
17490
17572
|
*
|
|
17491
|
-
* @type {
|
|
17573
|
+
* @type {CertifierResponseV2024}
|
|
17492
17574
|
* @memberof GetHistoricalIdentityEvents200ResponseInnerV2024
|
|
17493
17575
|
*/
|
|
17494
|
-
'
|
|
17576
|
+
'signer'?: CertifierResponseV2024;
|
|
17495
17577
|
/**
|
|
17496
|
-
*
|
|
17497
|
-
* @type {
|
|
17578
|
+
* the event type
|
|
17579
|
+
* @type {string}
|
|
17498
17580
|
* @memberof GetHistoricalIdentityEvents200ResponseInnerV2024
|
|
17499
17581
|
*/
|
|
17500
|
-
'
|
|
17582
|
+
'eventType'?: string;
|
|
17501
17583
|
/**
|
|
17502
|
-
* the
|
|
17584
|
+
* the date of event
|
|
17503
17585
|
* @type {string}
|
|
17504
17586
|
* @memberof GetHistoricalIdentityEvents200ResponseInnerV2024
|
|
17505
17587
|
*/
|
|
17506
|
-
'
|
|
17588
|
+
'dateTime'?: string;
|
|
17507
17589
|
/**
|
|
17508
|
-
* the
|
|
17590
|
+
* the identity id
|
|
17509
17591
|
* @type {string}
|
|
17510
17592
|
* @memberof GetHistoricalIdentityEvents200ResponseInnerV2024
|
|
17511
17593
|
*/
|
|
17512
|
-
'
|
|
17594
|
+
'identityId'?: string;
|
|
17513
17595
|
/**
|
|
17514
|
-
*
|
|
17515
|
-
* @type {
|
|
17596
|
+
*
|
|
17597
|
+
* @type {AccessItemAssociatedAccessItemV2024}
|
|
17516
17598
|
* @memberof GetHistoricalIdentityEvents200ResponseInnerV2024
|
|
17517
17599
|
*/
|
|
17518
|
-
'
|
|
17600
|
+
'accessItem': AccessItemAssociatedAccessItemV2024;
|
|
17519
17601
|
/**
|
|
17520
|
-
*
|
|
17521
|
-
* @type {
|
|
17602
|
+
*
|
|
17603
|
+
* @type {CorrelatedGovernanceEventV2024}
|
|
17522
17604
|
* @memberof GetHistoricalIdentityEvents200ResponseInnerV2024
|
|
17523
17605
|
*/
|
|
17524
|
-
'
|
|
17606
|
+
'governanceEvent': CorrelatedGovernanceEventV2024 | null;
|
|
17525
17607
|
/**
|
|
17526
|
-
*
|
|
17527
|
-
* @type {
|
|
17608
|
+
* the access item type
|
|
17609
|
+
* @type {string}
|
|
17528
17610
|
* @memberof GetHistoricalIdentityEvents200ResponseInnerV2024
|
|
17529
17611
|
*/
|
|
17530
|
-
'
|
|
17612
|
+
'accessItemType'?: GetHistoricalIdentityEvents200ResponseInnerV2024AccessItemTypeV2024;
|
|
17531
17613
|
/**
|
|
17532
17614
|
*
|
|
17533
|
-
* @type {
|
|
17615
|
+
* @type {Array<AttributeChangeV2024>}
|
|
17534
17616
|
* @memberof GetHistoricalIdentityEvents200ResponseInnerV2024
|
|
17535
17617
|
*/
|
|
17536
|
-
'
|
|
17618
|
+
'attributeChanges': Array<AttributeChangeV2024>;
|
|
17537
17619
|
/**
|
|
17538
17620
|
*
|
|
17539
|
-
* @type {
|
|
17621
|
+
* @type {AccessRequestedAccountV2024}
|
|
17540
17622
|
* @memberof GetHistoricalIdentityEvents200ResponseInnerV2024
|
|
17541
17623
|
*/
|
|
17542
|
-
'account'
|
|
17624
|
+
'account': AccessRequestedAccountV2024;
|
|
17543
17625
|
/**
|
|
17544
17626
|
*
|
|
17545
|
-
* @type {
|
|
17627
|
+
* @type {AccessRequestedStatusChangeV2024}
|
|
17546
17628
|
* @memberof GetHistoricalIdentityEvents200ResponseInnerV2024
|
|
17547
17629
|
*/
|
|
17548
|
-
'statusChange'
|
|
17630
|
+
'statusChange': AccessRequestedStatusChangeV2024;
|
|
17549
17631
|
}
|
|
17632
|
+
export declare const GetHistoricalIdentityEvents200ResponseInnerV2024AccessItemTypeV2024: {
|
|
17633
|
+
readonly Account: "account";
|
|
17634
|
+
readonly App: "app";
|
|
17635
|
+
readonly Entitlement: "entitlement";
|
|
17636
|
+
readonly Role: "role";
|
|
17637
|
+
readonly AccessProfile: "accessProfile";
|
|
17638
|
+
};
|
|
17639
|
+
export type GetHistoricalIdentityEvents200ResponseInnerV2024AccessItemTypeV2024 = typeof GetHistoricalIdentityEvents200ResponseInnerV2024AccessItemTypeV2024[keyof typeof GetHistoricalIdentityEvents200ResponseInnerV2024AccessItemTypeV2024];
|
|
17550
17640
|
/**
|
|
17551
17641
|
*
|
|
17552
17642
|
* @export
|
|
@@ -17728,6 +17818,18 @@ export interface GetPersonalAccessTokenResponseV2024 {
|
|
|
17728
17818
|
* @memberof GetPersonalAccessTokenResponseV2024
|
|
17729
17819
|
*/
|
|
17730
17820
|
'managed'?: boolean;
|
|
17821
|
+
/**
|
|
17822
|
+
* Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200.
|
|
17823
|
+
* @type {number}
|
|
17824
|
+
* @memberof GetPersonalAccessTokenResponseV2024
|
|
17825
|
+
*/
|
|
17826
|
+
'accessTokenValiditySeconds'?: number;
|
|
17827
|
+
/**
|
|
17828
|
+
* Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date.
|
|
17829
|
+
* @type {string}
|
|
17830
|
+
* @memberof GetPersonalAccessTokenResponseV2024
|
|
17831
|
+
*/
|
|
17832
|
+
'expirationDate'?: string;
|
|
17731
17833
|
}
|
|
17732
17834
|
/**
|
|
17733
17835
|
*
|
|
@@ -18562,13 +18664,13 @@ export interface IdentityCertifiedV2024 {
|
|
|
18562
18664
|
* @type {string}
|
|
18563
18665
|
* @memberof IdentityCertifiedV2024
|
|
18564
18666
|
*/
|
|
18565
|
-
'certificationId'
|
|
18667
|
+
'certificationId': string;
|
|
18566
18668
|
/**
|
|
18567
18669
|
* the certification item name
|
|
18568
18670
|
* @type {string}
|
|
18569
18671
|
* @memberof IdentityCertifiedV2024
|
|
18570
18672
|
*/
|
|
18571
|
-
'certificationName'
|
|
18673
|
+
'certificationName': string;
|
|
18572
18674
|
/**
|
|
18573
18675
|
* the date ceritification was signed
|
|
18574
18676
|
* @type {string}
|
|
@@ -18604,7 +18706,7 @@ export interface IdentityCertifiedV2024 {
|
|
|
18604
18706
|
* @type {string}
|
|
18605
18707
|
* @memberof IdentityCertifiedV2024
|
|
18606
18708
|
*/
|
|
18607
|
-
'
|
|
18709
|
+
'dateTime'?: string;
|
|
18608
18710
|
}
|
|
18609
18711
|
/**
|
|
18610
18712
|
*
|
|
@@ -21277,10 +21379,125 @@ export interface ListFormInstancesByTenantResponseV2024 {
|
|
|
21277
21379
|
'results'?: Array<FormInstanceResponseV2024>;
|
|
21278
21380
|
}
|
|
21279
21381
|
/**
|
|
21280
|
-
*
|
|
21382
|
+
*
|
|
21281
21383
|
* @export
|
|
21384
|
+
* @interface ListIdentityAccessItems200ResponseInnerV2024
|
|
21282
21385
|
*/
|
|
21283
|
-
export
|
|
21386
|
+
export interface ListIdentityAccessItems200ResponseInnerV2024 {
|
|
21387
|
+
/**
|
|
21388
|
+
* the access item id
|
|
21389
|
+
* @type {string}
|
|
21390
|
+
* @memberof ListIdentityAccessItems200ResponseInnerV2024
|
|
21391
|
+
*/
|
|
21392
|
+
'id'?: string;
|
|
21393
|
+
/**
|
|
21394
|
+
* the access item type. entitlement in this case
|
|
21395
|
+
* @type {string}
|
|
21396
|
+
* @memberof ListIdentityAccessItems200ResponseInnerV2024
|
|
21397
|
+
*/
|
|
21398
|
+
'accessType'?: string;
|
|
21399
|
+
/**
|
|
21400
|
+
* the access item display name
|
|
21401
|
+
* @type {string}
|
|
21402
|
+
* @memberof ListIdentityAccessItems200ResponseInnerV2024
|
|
21403
|
+
*/
|
|
21404
|
+
'displayName'?: string;
|
|
21405
|
+
/**
|
|
21406
|
+
* the associated source name if it exists
|
|
21407
|
+
* @type {string}
|
|
21408
|
+
* @memberof ListIdentityAccessItems200ResponseInnerV2024
|
|
21409
|
+
*/
|
|
21410
|
+
'sourceName'?: string | null;
|
|
21411
|
+
/**
|
|
21412
|
+
* the entitlement attribute
|
|
21413
|
+
* @type {string}
|
|
21414
|
+
* @memberof ListIdentityAccessItems200ResponseInnerV2024
|
|
21415
|
+
*/
|
|
21416
|
+
'attribute': string;
|
|
21417
|
+
/**
|
|
21418
|
+
* the associated value
|
|
21419
|
+
* @type {string}
|
|
21420
|
+
* @memberof ListIdentityAccessItems200ResponseInnerV2024
|
|
21421
|
+
*/
|
|
21422
|
+
'value': string;
|
|
21423
|
+
/**
|
|
21424
|
+
* the type of entitlement
|
|
21425
|
+
* @type {string}
|
|
21426
|
+
* @memberof ListIdentityAccessItems200ResponseInnerV2024
|
|
21427
|
+
*/
|
|
21428
|
+
'type': string;
|
|
21429
|
+
/**
|
|
21430
|
+
* the description for the role
|
|
21431
|
+
* @type {string}
|
|
21432
|
+
* @memberof ListIdentityAccessItems200ResponseInnerV2024
|
|
21433
|
+
*/
|
|
21434
|
+
'description'?: string;
|
|
21435
|
+
/**
|
|
21436
|
+
* the id of the source
|
|
21437
|
+
* @type {string}
|
|
21438
|
+
* @memberof ListIdentityAccessItems200ResponseInnerV2024
|
|
21439
|
+
*/
|
|
21440
|
+
'sourceId'?: string;
|
|
21441
|
+
/**
|
|
21442
|
+
* indicates whether the access profile is standalone
|
|
21443
|
+
* @type {boolean}
|
|
21444
|
+
* @memberof ListIdentityAccessItems200ResponseInnerV2024
|
|
21445
|
+
*/
|
|
21446
|
+
'standalone': boolean | null;
|
|
21447
|
+
/**
|
|
21448
|
+
* indicates whether the entitlement is privileged
|
|
21449
|
+
* @type {boolean}
|
|
21450
|
+
* @memberof ListIdentityAccessItems200ResponseInnerV2024
|
|
21451
|
+
*/
|
|
21452
|
+
'privileged': boolean | null;
|
|
21453
|
+
/**
|
|
21454
|
+
* indicates whether the entitlement is cloud governed
|
|
21455
|
+
* @type {boolean}
|
|
21456
|
+
* @memberof ListIdentityAccessItems200ResponseInnerV2024
|
|
21457
|
+
*/
|
|
21458
|
+
'cloudGoverned': boolean | null;
|
|
21459
|
+
/**
|
|
21460
|
+
* the number of entitlements the account will create
|
|
21461
|
+
* @type {number}
|
|
21462
|
+
* @memberof ListIdentityAccessItems200ResponseInnerV2024
|
|
21463
|
+
*/
|
|
21464
|
+
'entitlementCount': number;
|
|
21465
|
+
/**
|
|
21466
|
+
* the list of app ids associated with the access profile
|
|
21467
|
+
* @type {Array<AccessItemAccessProfileResponseAppRefsInnerV2024>}
|
|
21468
|
+
* @memberof ListIdentityAccessItems200ResponseInnerV2024
|
|
21469
|
+
*/
|
|
21470
|
+
'appRefs': Array<AccessItemAccessProfileResponseAppRefsInnerV2024>;
|
|
21471
|
+
/**
|
|
21472
|
+
* the date the role is no longer assigned to the specified identity
|
|
21473
|
+
* @type {string}
|
|
21474
|
+
* @memberof ListIdentityAccessItems200ResponseInnerV2024
|
|
21475
|
+
*/
|
|
21476
|
+
'removeDate'?: string;
|
|
21477
|
+
/**
|
|
21478
|
+
* indicates whether the role is revocable
|
|
21479
|
+
* @type {boolean}
|
|
21480
|
+
* @memberof ListIdentityAccessItems200ResponseInnerV2024
|
|
21481
|
+
*/
|
|
21482
|
+
'revocable': boolean;
|
|
21483
|
+
/**
|
|
21484
|
+
* the native identifier used to uniquely identify an acccount
|
|
21485
|
+
* @type {string}
|
|
21486
|
+
* @memberof ListIdentityAccessItems200ResponseInnerV2024
|
|
21487
|
+
*/
|
|
21488
|
+
'nativeIdentity': string;
|
|
21489
|
+
/**
|
|
21490
|
+
* the app role id
|
|
21491
|
+
* @type {string}
|
|
21492
|
+
* @memberof ListIdentityAccessItems200ResponseInnerV2024
|
|
21493
|
+
*/
|
|
21494
|
+
'appRoleId': string | null;
|
|
21495
|
+
}
|
|
21496
|
+
/**
|
|
21497
|
+
* @type ListIdentitySnapshotAccessItems200ResponseInnerV2024
|
|
21498
|
+
* @export
|
|
21499
|
+
*/
|
|
21500
|
+
export type ListIdentitySnapshotAccessItems200ResponseInnerV2024 = AccessItemAccessProfileResponseV2024 | AccessItemAccountResponseV2024 | AccessItemAppResponseV2024 | AccessItemEntitlementResponseV2024 | AccessItemRoleResponseV2024;
|
|
21284
21501
|
/**
|
|
21285
21502
|
*
|
|
21286
21503
|
* @export
|
|
@@ -22057,7 +22274,7 @@ export type MachineAccountV2024ClassificationMethodV2024 = typeof MachineAccount
|
|
|
22057
22274
|
*/
|
|
22058
22275
|
export interface MachineClassificationConfigV2024 {
|
|
22059
22276
|
/**
|
|
22060
|
-
* Indicates
|
|
22277
|
+
* Indicates whether Classification is enabled for a Source
|
|
22061
22278
|
* @type {boolean}
|
|
22062
22279
|
* @memberof MachineClassificationConfigV2024
|
|
22063
22280
|
*/
|
|
@@ -22069,19 +22286,19 @@ export interface MachineClassificationConfigV2024 {
|
|
|
22069
22286
|
*/
|
|
22070
22287
|
'classificationMethod'?: MachineClassificationConfigV2024ClassificationMethodV2024;
|
|
22071
22288
|
/**
|
|
22072
|
-
*
|
|
22073
|
-
* @type {
|
|
22289
|
+
*
|
|
22290
|
+
* @type {MachineClassificationCriteriaLevel1V2024}
|
|
22074
22291
|
* @memberof MachineClassificationConfigV2024
|
|
22075
22292
|
*/
|
|
22076
|
-
'criteria'?:
|
|
22293
|
+
'criteria'?: MachineClassificationCriteriaLevel1V2024;
|
|
22077
22294
|
/**
|
|
22078
|
-
*
|
|
22295
|
+
* Date the config was created
|
|
22079
22296
|
* @type {string}
|
|
22080
22297
|
* @memberof MachineClassificationConfigV2024
|
|
22081
22298
|
*/
|
|
22082
22299
|
'created'?: string;
|
|
22083
22300
|
/**
|
|
22084
|
-
*
|
|
22301
|
+
* Date the config was last updated
|
|
22085
22302
|
* @type {string}
|
|
22086
22303
|
* @memberof MachineClassificationConfigV2024
|
|
22087
22304
|
*/
|
|
@@ -22089,8 +22306,153 @@ export interface MachineClassificationConfigV2024 {
|
|
|
22089
22306
|
}
|
|
22090
22307
|
export declare const MachineClassificationConfigV2024ClassificationMethodV2024: {
|
|
22091
22308
|
readonly Source: "SOURCE";
|
|
22309
|
+
readonly Criteria: "CRITERIA";
|
|
22092
22310
|
};
|
|
22093
22311
|
export type MachineClassificationConfigV2024ClassificationMethodV2024 = typeof MachineClassificationConfigV2024ClassificationMethodV2024[keyof typeof MachineClassificationConfigV2024ClassificationMethodV2024];
|
|
22312
|
+
/**
|
|
22313
|
+
*
|
|
22314
|
+
* @export
|
|
22315
|
+
* @interface MachineClassificationCriteriaLevel1V2024
|
|
22316
|
+
*/
|
|
22317
|
+
export interface MachineClassificationCriteriaLevel1V2024 {
|
|
22318
|
+
/**
|
|
22319
|
+
*
|
|
22320
|
+
* @type {MachineClassificationCriteriaOperationV2024}
|
|
22321
|
+
* @memberof MachineClassificationCriteriaLevel1V2024
|
|
22322
|
+
*/
|
|
22323
|
+
'operation'?: MachineClassificationCriteriaOperationV2024;
|
|
22324
|
+
/**
|
|
22325
|
+
* Indicates whether case matters when evaluating the criteria
|
|
22326
|
+
* @type {boolean}
|
|
22327
|
+
* @memberof MachineClassificationCriteriaLevel1V2024
|
|
22328
|
+
*/
|
|
22329
|
+
'caseSensitive'?: boolean;
|
|
22330
|
+
/**
|
|
22331
|
+
* The data type of the attribute being evaluated
|
|
22332
|
+
* @type {string}
|
|
22333
|
+
* @memberof MachineClassificationCriteriaLevel1V2024
|
|
22334
|
+
*/
|
|
22335
|
+
'dataType'?: string | null;
|
|
22336
|
+
/**
|
|
22337
|
+
* The attribute to evaluate in the classification criteria
|
|
22338
|
+
* @type {string}
|
|
22339
|
+
* @memberof MachineClassificationCriteriaLevel1V2024
|
|
22340
|
+
*/
|
|
22341
|
+
'attribute'?: string | null;
|
|
22342
|
+
/**
|
|
22343
|
+
* The value to compare against the attribute in the classification criteria
|
|
22344
|
+
* @type {string}
|
|
22345
|
+
* @memberof MachineClassificationCriteriaLevel1V2024
|
|
22346
|
+
*/
|
|
22347
|
+
'value'?: string | null;
|
|
22348
|
+
/**
|
|
22349
|
+
* An array of child classification criteria objects
|
|
22350
|
+
* @type {Array<MachineClassificationCriteriaLevel2V2024>}
|
|
22351
|
+
* @memberof MachineClassificationCriteriaLevel1V2024
|
|
22352
|
+
*/
|
|
22353
|
+
'children'?: Array<MachineClassificationCriteriaLevel2V2024> | null;
|
|
22354
|
+
}
|
|
22355
|
+
/**
|
|
22356
|
+
*
|
|
22357
|
+
* @export
|
|
22358
|
+
* @interface MachineClassificationCriteriaLevel2V2024
|
|
22359
|
+
*/
|
|
22360
|
+
export interface MachineClassificationCriteriaLevel2V2024 {
|
|
22361
|
+
/**
|
|
22362
|
+
*
|
|
22363
|
+
* @type {MachineClassificationCriteriaOperationV2024}
|
|
22364
|
+
* @memberof MachineClassificationCriteriaLevel2V2024
|
|
22365
|
+
*/
|
|
22366
|
+
'operation'?: MachineClassificationCriteriaOperationV2024;
|
|
22367
|
+
/**
|
|
22368
|
+
* Indicates whether case matters when evaluating the criteria
|
|
22369
|
+
* @type {boolean}
|
|
22370
|
+
* @memberof MachineClassificationCriteriaLevel2V2024
|
|
22371
|
+
*/
|
|
22372
|
+
'caseSensitive'?: boolean;
|
|
22373
|
+
/**
|
|
22374
|
+
* The data type of the attribute being evaluated
|
|
22375
|
+
* @type {string}
|
|
22376
|
+
* @memberof MachineClassificationCriteriaLevel2V2024
|
|
22377
|
+
*/
|
|
22378
|
+
'dataType'?: string | null;
|
|
22379
|
+
/**
|
|
22380
|
+
* The attribute to evaluate in the classification criteria
|
|
22381
|
+
* @type {string}
|
|
22382
|
+
* @memberof MachineClassificationCriteriaLevel2V2024
|
|
22383
|
+
*/
|
|
22384
|
+
'attribute'?: string | null;
|
|
22385
|
+
/**
|
|
22386
|
+
* The value to compare against the attribute in the classification criteria
|
|
22387
|
+
* @type {string}
|
|
22388
|
+
* @memberof MachineClassificationCriteriaLevel2V2024
|
|
22389
|
+
*/
|
|
22390
|
+
'value'?: string | null;
|
|
22391
|
+
/**
|
|
22392
|
+
* An array of child classification criteria objects
|
|
22393
|
+
* @type {Array<MachineClassificationCriteriaLevel3V2024>}
|
|
22394
|
+
* @memberof MachineClassificationCriteriaLevel2V2024
|
|
22395
|
+
*/
|
|
22396
|
+
'children'?: Array<MachineClassificationCriteriaLevel3V2024> | null;
|
|
22397
|
+
}
|
|
22398
|
+
/**
|
|
22399
|
+
*
|
|
22400
|
+
* @export
|
|
22401
|
+
* @interface MachineClassificationCriteriaLevel3V2024
|
|
22402
|
+
*/
|
|
22403
|
+
export interface MachineClassificationCriteriaLevel3V2024 {
|
|
22404
|
+
/**
|
|
22405
|
+
*
|
|
22406
|
+
* @type {MachineClassificationCriteriaOperationV2024}
|
|
22407
|
+
* @memberof MachineClassificationCriteriaLevel3V2024
|
|
22408
|
+
*/
|
|
22409
|
+
'operation'?: MachineClassificationCriteriaOperationV2024;
|
|
22410
|
+
/**
|
|
22411
|
+
* Indicates whether or not case matters when evaluating the criteria
|
|
22412
|
+
* @type {boolean}
|
|
22413
|
+
* @memberof MachineClassificationCriteriaLevel3V2024
|
|
22414
|
+
*/
|
|
22415
|
+
'caseSensitive'?: boolean;
|
|
22416
|
+
/**
|
|
22417
|
+
* The data type of the attribute being evaluated
|
|
22418
|
+
* @type {string}
|
|
22419
|
+
* @memberof MachineClassificationCriteriaLevel3V2024
|
|
22420
|
+
*/
|
|
22421
|
+
'dataType'?: string | null;
|
|
22422
|
+
/**
|
|
22423
|
+
* The attribute to evaluate in the classification criteria
|
|
22424
|
+
* @type {string}
|
|
22425
|
+
* @memberof MachineClassificationCriteriaLevel3V2024
|
|
22426
|
+
*/
|
|
22427
|
+
'attribute'?: string | null;
|
|
22428
|
+
/**
|
|
22429
|
+
* The value to compare against the attribute in the classification criteria
|
|
22430
|
+
* @type {string}
|
|
22431
|
+
* @memberof MachineClassificationCriteriaLevel3V2024
|
|
22432
|
+
*/
|
|
22433
|
+
'value'?: string | null;
|
|
22434
|
+
/**
|
|
22435
|
+
* An array of child classification criteria objects
|
|
22436
|
+
* @type {Array<string>}
|
|
22437
|
+
* @memberof MachineClassificationCriteriaLevel3V2024
|
|
22438
|
+
*/
|
|
22439
|
+
'children'?: Array<string> | null;
|
|
22440
|
+
}
|
|
22441
|
+
/**
|
|
22442
|
+
* An operation to perform on the classification criteria
|
|
22443
|
+
* @export
|
|
22444
|
+
* @enum {string}
|
|
22445
|
+
*/
|
|
22446
|
+
export declare const MachineClassificationCriteriaOperationV2024: {
|
|
22447
|
+
readonly Equals: "EQUALS";
|
|
22448
|
+
readonly NotEquals: "NOT_EQUALS";
|
|
22449
|
+
readonly StartsWith: "STARTS_WITH";
|
|
22450
|
+
readonly EndsWith: "ENDS_WITH";
|
|
22451
|
+
readonly Contains: "CONTAINS";
|
|
22452
|
+
readonly And: "AND";
|
|
22453
|
+
readonly Or: "OR";
|
|
22454
|
+
};
|
|
22455
|
+
export type MachineClassificationCriteriaOperationV2024 = typeof MachineClassificationCriteriaOperationV2024[keyof typeof MachineClassificationCriteriaOperationV2024];
|
|
22094
22456
|
/**
|
|
22095
22457
|
*
|
|
22096
22458
|
* @export
|
|
@@ -30803,7 +31165,7 @@ export declare const RoleCriteriaKeyTypeV2024: {
|
|
|
30803
31165
|
};
|
|
30804
31166
|
export type RoleCriteriaKeyTypeV2024 = typeof RoleCriteriaKeyTypeV2024[keyof typeof RoleCriteriaKeyTypeV2024];
|
|
30805
31167
|
/**
|
|
30806
|
-
* Refers to a specific Identity attribute, Account
|
|
31168
|
+
* Refers to a specific Identity attribute, Account attribute, or Entitlement used in Role membership criteria
|
|
30807
31169
|
* @export
|
|
30808
31170
|
* @interface RoleCriteriaKeyV2024
|
|
30809
31171
|
*/
|
|
@@ -36431,6 +36793,35 @@ export interface SodPolicyConflictingAccessCriteriaV2024 {
|
|
|
36431
36793
|
*/
|
|
36432
36794
|
'rightCriteria'?: AccessCriteriaV2024;
|
|
36433
36795
|
}
|
|
36796
|
+
/**
|
|
36797
|
+
* SOD policy.
|
|
36798
|
+
* @export
|
|
36799
|
+
* @interface SodPolicyDto1V2024
|
|
36800
|
+
*/
|
|
36801
|
+
export interface SodPolicyDto1V2024 {
|
|
36802
|
+
/**
|
|
36803
|
+
* SOD policy DTO type.
|
|
36804
|
+
* @type {string}
|
|
36805
|
+
* @memberof SodPolicyDto1V2024
|
|
36806
|
+
*/
|
|
36807
|
+
'type'?: SodPolicyDto1V2024TypeV2024;
|
|
36808
|
+
/**
|
|
36809
|
+
* SOD policy ID.
|
|
36810
|
+
* @type {string}
|
|
36811
|
+
* @memberof SodPolicyDto1V2024
|
|
36812
|
+
*/
|
|
36813
|
+
'id'?: string;
|
|
36814
|
+
/**
|
|
36815
|
+
* SOD policy display name.
|
|
36816
|
+
* @type {string}
|
|
36817
|
+
* @memberof SodPolicyDto1V2024
|
|
36818
|
+
*/
|
|
36819
|
+
'name'?: string;
|
|
36820
|
+
}
|
|
36821
|
+
export declare const SodPolicyDto1V2024TypeV2024: {
|
|
36822
|
+
readonly SodPolicy: "SOD_POLICY";
|
|
36823
|
+
};
|
|
36824
|
+
export type SodPolicyDto1V2024TypeV2024 = typeof SodPolicyDto1V2024TypeV2024[keyof typeof SodPolicyDto1V2024TypeV2024];
|
|
36434
36825
|
/**
|
|
36435
36826
|
* SOD policy.
|
|
36436
36827
|
* @export
|
|
@@ -36762,10 +37153,10 @@ export interface SodViolationCheckResultV2024 {
|
|
|
36762
37153
|
'violationContexts'?: Array<SodViolationContextV2024> | null;
|
|
36763
37154
|
/**
|
|
36764
37155
|
* A list of the SOD policies that were violated.
|
|
36765
|
-
* @type {Array<
|
|
37156
|
+
* @type {Array<SodPolicyDto1V2024>}
|
|
36766
37157
|
* @memberof SodViolationCheckResultV2024
|
|
36767
37158
|
*/
|
|
36768
|
-
'violatedPolicies'?: Array<
|
|
37159
|
+
'violatedPolicies'?: Array<SodPolicyDto1V2024> | null;
|
|
36769
37160
|
}
|
|
36770
37161
|
/**
|
|
36771
37162
|
* An object referencing an SOD violation check
|
|
@@ -36856,10 +37247,10 @@ export interface SodViolationContextConflictingAccessCriteriaV2024 {
|
|
|
36856
37247
|
export interface SodViolationContextV2024 {
|
|
36857
37248
|
/**
|
|
36858
37249
|
*
|
|
36859
|
-
* @type {
|
|
37250
|
+
* @type {SodPolicyDto1V2024}
|
|
36860
37251
|
* @memberof SodViolationContextV2024
|
|
36861
37252
|
*/
|
|
36862
|
-
'policy'?:
|
|
37253
|
+
'policy'?: SodPolicyDto1V2024;
|
|
36863
37254
|
/**
|
|
36864
37255
|
*
|
|
36865
37256
|
* @type {SodViolationContextConflictingAccessCriteriaV2024}
|
|
@@ -42193,7 +42584,7 @@ export declare const WorkItemTypeManualWorkItemsV2024: {
|
|
|
42193
42584
|
readonly Approval: "Approval";
|
|
42194
42585
|
readonly ViolationReview: "ViolationReview";
|
|
42195
42586
|
readonly Form: "Form";
|
|
42196
|
-
readonly
|
|
42587
|
+
readonly PolicyViolation: "PolicyViolation";
|
|
42197
42588
|
readonly Challenge: "Challenge";
|
|
42198
42589
|
readonly ImpactAnalysis: "ImpactAnalysis";
|
|
42199
42590
|
readonly Signoff: "Signoff";
|
|
@@ -43423,39 +43814,42 @@ export declare const AccessModelMetadataV2024ApiAxiosParamCreator: (configuratio
|
|
|
43423
43814
|
* Get single Access Model Metadata Attribute
|
|
43424
43815
|
* @summary Get access model metadata attribute
|
|
43425
43816
|
* @param {string} key Technical name of the Attribute.
|
|
43426
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
43427
43817
|
* @param {*} [axiosOptions] Override http request option.
|
|
43428
43818
|
* @throws {RequiredError}
|
|
43429
43819
|
*/
|
|
43430
|
-
getAccessModelMetadataAttribute: (key: string,
|
|
43820
|
+
getAccessModelMetadataAttribute: (key: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
43431
43821
|
/**
|
|
43432
43822
|
* Get single Access Model Metadata Attribute Value
|
|
43433
43823
|
* @summary Get access model metadata value
|
|
43434
43824
|
* @param {string} key Technical name of the Attribute.
|
|
43435
43825
|
* @param {string} value Technical name of the Attribute value.
|
|
43436
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
43437
43826
|
* @param {*} [axiosOptions] Override http request option.
|
|
43438
43827
|
* @throws {RequiredError}
|
|
43439
43828
|
*/
|
|
43440
|
-
getAccessModelMetadataAttributeValue: (key: string, value: string,
|
|
43829
|
+
getAccessModelMetadataAttributeValue: (key: string, value: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
43441
43830
|
/**
|
|
43442
43831
|
* Get a list of Access Model Metadata Attributes
|
|
43443
43832
|
* @summary List access model metadata attributes
|
|
43444
|
-
* @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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators
|
|
43445
|
-
* @param {string} [
|
|
43833
|
+
* @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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* **Supported composite operators**: *and*
|
|
43834
|
+
* @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: **name, key**
|
|
43835
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
43836
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
43837
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
43446
43838
|
* @param {*} [axiosOptions] Override http request option.
|
|
43447
43839
|
* @throws {RequiredError}
|
|
43448
43840
|
*/
|
|
43449
|
-
listAccessModelMetadataAttribute: (filters?: string,
|
|
43841
|
+
listAccessModelMetadataAttribute: (filters?: string, sorters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
43450
43842
|
/**
|
|
43451
43843
|
* Get a list of Access Model Metadata Attribute Values
|
|
43452
43844
|
* @summary List access model metadata values
|
|
43453
43845
|
* @param {string} key Technical name of the Attribute.
|
|
43454
|
-
* @param {
|
|
43846
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
43847
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
43848
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
43455
43849
|
* @param {*} [axiosOptions] Override http request option.
|
|
43456
43850
|
* @throws {RequiredError}
|
|
43457
43851
|
*/
|
|
43458
|
-
listAccessModelMetadataAttributeValue: (key: string,
|
|
43852
|
+
listAccessModelMetadataAttributeValue: (key: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
43459
43853
|
};
|
|
43460
43854
|
/**
|
|
43461
43855
|
* AccessModelMetadataV2024Api - functional programming interface
|
|
@@ -43466,39 +43860,42 @@ export declare const AccessModelMetadataV2024ApiFp: (configuration?: Configurati
|
|
|
43466
43860
|
* Get single Access Model Metadata Attribute
|
|
43467
43861
|
* @summary Get access model metadata attribute
|
|
43468
43862
|
* @param {string} key Technical name of the Attribute.
|
|
43469
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
43470
43863
|
* @param {*} [axiosOptions] Override http request option.
|
|
43471
43864
|
* @throws {RequiredError}
|
|
43472
43865
|
*/
|
|
43473
|
-
getAccessModelMetadataAttribute(key: string,
|
|
43866
|
+
getAccessModelMetadataAttribute(key: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AttributeDTOV2024>>;
|
|
43474
43867
|
/**
|
|
43475
43868
|
* Get single Access Model Metadata Attribute Value
|
|
43476
43869
|
* @summary Get access model metadata value
|
|
43477
43870
|
* @param {string} key Technical name of the Attribute.
|
|
43478
43871
|
* @param {string} value Technical name of the Attribute value.
|
|
43479
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
43480
43872
|
* @param {*} [axiosOptions] Override http request option.
|
|
43481
43873
|
* @throws {RequiredError}
|
|
43482
43874
|
*/
|
|
43483
|
-
getAccessModelMetadataAttributeValue(key: string, value: string,
|
|
43875
|
+
getAccessModelMetadataAttributeValue(key: string, value: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AttributeValueDTOV2024>>;
|
|
43484
43876
|
/**
|
|
43485
43877
|
* Get a list of Access Model Metadata Attributes
|
|
43486
43878
|
* @summary List access model metadata attributes
|
|
43487
|
-
* @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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators
|
|
43488
|
-
* @param {string} [
|
|
43879
|
+
* @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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* **Supported composite operators**: *and*
|
|
43880
|
+
* @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: **name, key**
|
|
43881
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
43882
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
43883
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
43489
43884
|
* @param {*} [axiosOptions] Override http request option.
|
|
43490
43885
|
* @throws {RequiredError}
|
|
43491
43886
|
*/
|
|
43492
|
-
listAccessModelMetadataAttribute(filters?: string,
|
|
43887
|
+
listAccessModelMetadataAttribute(filters?: string, sorters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AttributeDTOV2024>>>;
|
|
43493
43888
|
/**
|
|
43494
43889
|
* Get a list of Access Model Metadata Attribute Values
|
|
43495
43890
|
* @summary List access model metadata values
|
|
43496
43891
|
* @param {string} key Technical name of the Attribute.
|
|
43497
|
-
* @param {
|
|
43892
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
43893
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
43894
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
43498
43895
|
* @param {*} [axiosOptions] Override http request option.
|
|
43499
43896
|
* @throws {RequiredError}
|
|
43500
43897
|
*/
|
|
43501
|
-
listAccessModelMetadataAttributeValue(key: string,
|
|
43898
|
+
listAccessModelMetadataAttributeValue(key: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AttributeValueDTOV2024>>>;
|
|
43502
43899
|
};
|
|
43503
43900
|
/**
|
|
43504
43901
|
* AccessModelMetadataV2024Api - factory interface
|
|
@@ -43550,12 +43947,6 @@ export interface AccessModelMetadataV2024ApiGetAccessModelMetadataAttributeReque
|
|
|
43550
43947
|
* @memberof AccessModelMetadataV2024ApiGetAccessModelMetadataAttribute
|
|
43551
43948
|
*/
|
|
43552
43949
|
readonly key: string;
|
|
43553
|
-
/**
|
|
43554
|
-
* Use this header to enable this experimental API.
|
|
43555
|
-
* @type {string}
|
|
43556
|
-
* @memberof AccessModelMetadataV2024ApiGetAccessModelMetadataAttribute
|
|
43557
|
-
*/
|
|
43558
|
-
readonly xSailPointExperimental?: string;
|
|
43559
43950
|
}
|
|
43560
43951
|
/**
|
|
43561
43952
|
* Request parameters for getAccessModelMetadataAttributeValue operation in AccessModelMetadataV2024Api.
|
|
@@ -43575,12 +43966,6 @@ export interface AccessModelMetadataV2024ApiGetAccessModelMetadataAttributeValue
|
|
|
43575
43966
|
* @memberof AccessModelMetadataV2024ApiGetAccessModelMetadataAttributeValue
|
|
43576
43967
|
*/
|
|
43577
43968
|
readonly value: string;
|
|
43578
|
-
/**
|
|
43579
|
-
* Use this header to enable this experimental API.
|
|
43580
|
-
* @type {string}
|
|
43581
|
-
* @memberof AccessModelMetadataV2024ApiGetAccessModelMetadataAttributeValue
|
|
43582
|
-
*/
|
|
43583
|
-
readonly xSailPointExperimental?: string;
|
|
43584
43969
|
}
|
|
43585
43970
|
/**
|
|
43586
43971
|
* Request parameters for listAccessModelMetadataAttribute operation in AccessModelMetadataV2024Api.
|
|
@@ -43589,17 +43974,35 @@ export interface AccessModelMetadataV2024ApiGetAccessModelMetadataAttributeValue
|
|
|
43589
43974
|
*/
|
|
43590
43975
|
export interface AccessModelMetadataV2024ApiListAccessModelMetadataAttributeRequest {
|
|
43591
43976
|
/**
|
|
43592
|
-
* 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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators
|
|
43977
|
+
* 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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* **Supported composite operators**: *and*
|
|
43593
43978
|
* @type {string}
|
|
43594
43979
|
* @memberof AccessModelMetadataV2024ApiListAccessModelMetadataAttribute
|
|
43595
43980
|
*/
|
|
43596
43981
|
readonly filters?: string;
|
|
43597
43982
|
/**
|
|
43598
|
-
*
|
|
43983
|
+
* 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: **name, key**
|
|
43599
43984
|
* @type {string}
|
|
43600
43985
|
* @memberof AccessModelMetadataV2024ApiListAccessModelMetadataAttribute
|
|
43601
43986
|
*/
|
|
43602
|
-
readonly
|
|
43987
|
+
readonly sorters?: string;
|
|
43988
|
+
/**
|
|
43989
|
+
* Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
43990
|
+
* @type {number}
|
|
43991
|
+
* @memberof AccessModelMetadataV2024ApiListAccessModelMetadataAttribute
|
|
43992
|
+
*/
|
|
43993
|
+
readonly offset?: number;
|
|
43994
|
+
/**
|
|
43995
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
43996
|
+
* @type {number}
|
|
43997
|
+
* @memberof AccessModelMetadataV2024ApiListAccessModelMetadataAttribute
|
|
43998
|
+
*/
|
|
43999
|
+
readonly limit?: number;
|
|
44000
|
+
/**
|
|
44001
|
+
* If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
44002
|
+
* @type {boolean}
|
|
44003
|
+
* @memberof AccessModelMetadataV2024ApiListAccessModelMetadataAttribute
|
|
44004
|
+
*/
|
|
44005
|
+
readonly count?: boolean;
|
|
43603
44006
|
}
|
|
43604
44007
|
/**
|
|
43605
44008
|
* Request parameters for listAccessModelMetadataAttributeValue operation in AccessModelMetadataV2024Api.
|
|
@@ -43614,11 +44017,23 @@ export interface AccessModelMetadataV2024ApiListAccessModelMetadataAttributeValu
|
|
|
43614
44017
|
*/
|
|
43615
44018
|
readonly key: string;
|
|
43616
44019
|
/**
|
|
43617
|
-
*
|
|
43618
|
-
* @type {
|
|
44020
|
+
* Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
44021
|
+
* @type {number}
|
|
43619
44022
|
* @memberof AccessModelMetadataV2024ApiListAccessModelMetadataAttributeValue
|
|
43620
44023
|
*/
|
|
43621
|
-
readonly
|
|
44024
|
+
readonly offset?: number;
|
|
44025
|
+
/**
|
|
44026
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
44027
|
+
* @type {number}
|
|
44028
|
+
* @memberof AccessModelMetadataV2024ApiListAccessModelMetadataAttributeValue
|
|
44029
|
+
*/
|
|
44030
|
+
readonly limit?: number;
|
|
44031
|
+
/**
|
|
44032
|
+
* If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
44033
|
+
* @type {boolean}
|
|
44034
|
+
* @memberof AccessModelMetadataV2024ApiListAccessModelMetadataAttributeValue
|
|
44035
|
+
*/
|
|
44036
|
+
readonly count?: boolean;
|
|
43622
44037
|
}
|
|
43623
44038
|
/**
|
|
43624
44039
|
* AccessModelMetadataV2024Api - object-oriented interface
|
|
@@ -44784,11 +45199,10 @@ export declare const AccessRequestsV2024ApiAxiosParamCreator: (configuration?: C
|
|
|
44784
45199
|
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/provisioning-completed/) for each access request that is closed.
|
|
44785
45200
|
* @summary Close access request
|
|
44786
45201
|
* @param {CloseAccessRequestV2024} closeAccessRequestV2024
|
|
44787
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
44788
45202
|
* @param {*} [axiosOptions] Override http request option.
|
|
44789
45203
|
* @throws {RequiredError}
|
|
44790
45204
|
*/
|
|
44791
|
-
closeAccessRequest: (closeAccessRequestV2024: CloseAccessRequestV2024,
|
|
45205
|
+
closeAccessRequest: (closeAccessRequestV2024: CloseAccessRequestV2024, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44792
45206
|
/**
|
|
44793
45207
|
* 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.
|
|
44794
45208
|
* @summary Submit access request
|
|
@@ -44888,11 +45302,10 @@ export declare const AccessRequestsV2024ApiFp: (configuration?: Configuration) =
|
|
|
44888
45302
|
* This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/provisioning-completed/) for each access request that is closed.
|
|
44889
45303
|
* @summary Close access request
|
|
44890
45304
|
* @param {CloseAccessRequestV2024} closeAccessRequestV2024
|
|
44891
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
44892
45305
|
* @param {*} [axiosOptions] Override http request option.
|
|
44893
45306
|
* @throws {RequiredError}
|
|
44894
45307
|
*/
|
|
44895
|
-
closeAccessRequest(closeAccessRequestV2024: CloseAccessRequestV2024,
|
|
45308
|
+
closeAccessRequest(closeAccessRequestV2024: CloseAccessRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
44896
45309
|
/**
|
|
44897
45310
|
* 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.
|
|
44898
45311
|
* @summary Submit access request
|
|
@@ -45095,12 +45508,6 @@ export interface AccessRequestsV2024ApiCloseAccessRequestRequest {
|
|
|
45095
45508
|
* @memberof AccessRequestsV2024ApiCloseAccessRequest
|
|
45096
45509
|
*/
|
|
45097
45510
|
readonly closeAccessRequestV2024: CloseAccessRequestV2024;
|
|
45098
|
-
/**
|
|
45099
|
-
* Use this header to enable this experimental API.
|
|
45100
|
-
* @type {string}
|
|
45101
|
-
* @memberof AccessRequestsV2024ApiCloseAccessRequest
|
|
45102
|
-
*/
|
|
45103
|
-
readonly xSailPointExperimental?: string;
|
|
45104
45511
|
}
|
|
45105
45512
|
/**
|
|
45106
45513
|
* Request parameters for createAccessRequest operation in AccessRequestsV2024Api.
|
|
@@ -45555,11 +45962,10 @@ export declare const AccountAggregationsV2024ApiAxiosParamCreator: (configuratio
|
|
|
45555
45962
|
* This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* required to call this API.
|
|
45556
45963
|
* @summary In-progress account aggregation status
|
|
45557
45964
|
* @param {string} id The account aggregation id
|
|
45558
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
45559
45965
|
* @param {*} [axiosOptions] Override http request option.
|
|
45560
45966
|
* @throws {RequiredError}
|
|
45561
45967
|
*/
|
|
45562
|
-
getAccountAggregationStatus: (id: string,
|
|
45968
|
+
getAccountAggregationStatus: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
45563
45969
|
};
|
|
45564
45970
|
/**
|
|
45565
45971
|
* AccountAggregationsV2024Api - functional programming interface
|
|
@@ -45570,11 +45976,10 @@ export declare const AccountAggregationsV2024ApiFp: (configuration?: Configurati
|
|
|
45570
45976
|
* This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* required to call this API.
|
|
45571
45977
|
* @summary In-progress account aggregation status
|
|
45572
45978
|
* @param {string} id The account aggregation id
|
|
45573
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
45574
45979
|
* @param {*} [axiosOptions] Override http request option.
|
|
45575
45980
|
* @throws {RequiredError}
|
|
45576
45981
|
*/
|
|
45577
|
-
getAccountAggregationStatus(id: string,
|
|
45982
|
+
getAccountAggregationStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountAggregationStatusV2024>>;
|
|
45578
45983
|
};
|
|
45579
45984
|
/**
|
|
45580
45985
|
* AccountAggregationsV2024Api - factory interface
|
|
@@ -45602,12 +46007,6 @@ export interface AccountAggregationsV2024ApiGetAccountAggregationStatusRequest {
|
|
|
45602
46007
|
* @memberof AccountAggregationsV2024ApiGetAccountAggregationStatus
|
|
45603
46008
|
*/
|
|
45604
46009
|
readonly id: string;
|
|
45605
|
-
/**
|
|
45606
|
-
* Use this header to enable this experimental API.
|
|
45607
|
-
* @type {string}
|
|
45608
|
-
* @memberof AccountAggregationsV2024ApiGetAccountAggregationStatus
|
|
45609
|
-
*/
|
|
45610
|
-
readonly xSailPointExperimental?: string;
|
|
45611
46010
|
}
|
|
45612
46011
|
/**
|
|
45613
46012
|
* AccountAggregationsV2024Api - object-oriented interface
|
|
@@ -45755,11 +46154,10 @@ export declare const AccountsV2024ApiAxiosParamCreator: (configuration?: Configu
|
|
|
45755
46154
|
* Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc.
|
|
45756
46155
|
* @summary Remove account
|
|
45757
46156
|
* @param {string} id The account id
|
|
45758
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
45759
46157
|
* @param {*} [axiosOptions] Override http request option.
|
|
45760
46158
|
* @throws {RequiredError}
|
|
45761
46159
|
*/
|
|
45762
|
-
deleteAccountAsync: (id: string,
|
|
46160
|
+
deleteAccountAsync: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
45763
46161
|
/**
|
|
45764
46162
|
* This API submits a task to disable the account and returns the task ID.
|
|
45765
46163
|
* @summary Disable account
|
|
@@ -45773,20 +46171,18 @@ export declare const AccountsV2024ApiAxiosParamCreator: (configuration?: Configu
|
|
|
45773
46171
|
* This API submits a task to disable IDN account for a single identity.
|
|
45774
46172
|
* @summary Disable idn account for identity
|
|
45775
46173
|
* @param {string} id The identity id.
|
|
45776
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
45777
46174
|
* @param {*} [axiosOptions] Override http request option.
|
|
45778
46175
|
* @throws {RequiredError}
|
|
45779
46176
|
*/
|
|
45780
|
-
disableAccountForIdentity: (id: string,
|
|
46177
|
+
disableAccountForIdentity: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
45781
46178
|
/**
|
|
45782
46179
|
* This API submits tasks to disable IDN account for each identity provided in the request body.
|
|
45783
46180
|
* @summary Disable idn accounts for identities
|
|
45784
46181
|
* @param {IdentitiesAccountsBulkRequestV2024} identitiesAccountsBulkRequestV2024
|
|
45785
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
45786
46182
|
* @param {*} [axiosOptions] Override http request option.
|
|
45787
46183
|
* @throws {RequiredError}
|
|
45788
46184
|
*/
|
|
45789
|
-
disableAccountsForIdentities: (identitiesAccountsBulkRequestV2024: IdentitiesAccountsBulkRequestV2024,
|
|
46185
|
+
disableAccountsForIdentities: (identitiesAccountsBulkRequestV2024: IdentitiesAccountsBulkRequestV2024, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
45790
46186
|
/**
|
|
45791
46187
|
* This API submits a task to enable account and returns the task ID.
|
|
45792
46188
|
* @summary Enable account
|
|
@@ -45800,20 +46196,18 @@ export declare const AccountsV2024ApiAxiosParamCreator: (configuration?: Configu
|
|
|
45800
46196
|
* This API submits a task to enable IDN account for a single identity.
|
|
45801
46197
|
* @summary Enable idn account for identity
|
|
45802
46198
|
* @param {string} id The identity id.
|
|
45803
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
45804
46199
|
* @param {*} [axiosOptions] Override http request option.
|
|
45805
46200
|
* @throws {RequiredError}
|
|
45806
46201
|
*/
|
|
45807
|
-
enableAccountForIdentity: (id: string,
|
|
46202
|
+
enableAccountForIdentity: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
45808
46203
|
/**
|
|
45809
46204
|
* This API submits tasks to enable IDN account for each identity provided in the request body.
|
|
45810
46205
|
* @summary Enable idn accounts for identities
|
|
45811
46206
|
* @param {IdentitiesAccountsBulkRequestV2024} identitiesAccountsBulkRequestV2024
|
|
45812
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
45813
46207
|
* @param {*} [axiosOptions] Override http request option.
|
|
45814
46208
|
* @throws {RequiredError}
|
|
45815
46209
|
*/
|
|
45816
|
-
enableAccountsForIdentities: (identitiesAccountsBulkRequestV2024: IdentitiesAccountsBulkRequestV2024,
|
|
46210
|
+
enableAccountsForIdentities: (identitiesAccountsBulkRequestV2024: IdentitiesAccountsBulkRequestV2024, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
45817
46211
|
/**
|
|
45818
46212
|
* Use this API to return the details for a single account by its ID.
|
|
45819
46213
|
* @summary Account details
|
|
@@ -45907,11 +46301,10 @@ export declare const AccountsV2024ApiFp: (configuration?: Configuration) => {
|
|
|
45907
46301
|
* Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc.
|
|
45908
46302
|
* @summary Remove account
|
|
45909
46303
|
* @param {string} id The account id
|
|
45910
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
45911
46304
|
* @param {*} [axiosOptions] Override http request option.
|
|
45912
46305
|
* @throws {RequiredError}
|
|
45913
46306
|
*/
|
|
45914
|
-
deleteAccountAsync(id: string,
|
|
46307
|
+
deleteAccountAsync(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskResultDtoV2024>>;
|
|
45915
46308
|
/**
|
|
45916
46309
|
* This API submits a task to disable the account and returns the task ID.
|
|
45917
46310
|
* @summary Disable account
|
|
@@ -45925,20 +46318,18 @@ export declare const AccountsV2024ApiFp: (configuration?: Configuration) => {
|
|
|
45925
46318
|
* This API submits a task to disable IDN account for a single identity.
|
|
45926
46319
|
* @summary Disable idn account for identity
|
|
45927
46320
|
* @param {string} id The identity id.
|
|
45928
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
45929
46321
|
* @param {*} [axiosOptions] Override http request option.
|
|
45930
46322
|
* @throws {RequiredError}
|
|
45931
46323
|
*/
|
|
45932
|
-
disableAccountForIdentity(id: string,
|
|
46324
|
+
disableAccountForIdentity(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
45933
46325
|
/**
|
|
45934
46326
|
* This API submits tasks to disable IDN account for each identity provided in the request body.
|
|
45935
46327
|
* @summary Disable idn accounts for identities
|
|
45936
46328
|
* @param {IdentitiesAccountsBulkRequestV2024} identitiesAccountsBulkRequestV2024
|
|
45937
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
45938
46329
|
* @param {*} [axiosOptions] Override http request option.
|
|
45939
46330
|
* @throws {RequiredError}
|
|
45940
46331
|
*/
|
|
45941
|
-
disableAccountsForIdentities(identitiesAccountsBulkRequestV2024: IdentitiesAccountsBulkRequestV2024,
|
|
46332
|
+
disableAccountsForIdentities(identitiesAccountsBulkRequestV2024: IdentitiesAccountsBulkRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BulkIdentitiesAccountsResponseV2024>>>;
|
|
45942
46333
|
/**
|
|
45943
46334
|
* This API submits a task to enable account and returns the task ID.
|
|
45944
46335
|
* @summary Enable account
|
|
@@ -45952,20 +46343,18 @@ export declare const AccountsV2024ApiFp: (configuration?: Configuration) => {
|
|
|
45952
46343
|
* This API submits a task to enable IDN account for a single identity.
|
|
45953
46344
|
* @summary Enable idn account for identity
|
|
45954
46345
|
* @param {string} id The identity id.
|
|
45955
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
45956
46346
|
* @param {*} [axiosOptions] Override http request option.
|
|
45957
46347
|
* @throws {RequiredError}
|
|
45958
46348
|
*/
|
|
45959
|
-
enableAccountForIdentity(id: string,
|
|
46349
|
+
enableAccountForIdentity(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
45960
46350
|
/**
|
|
45961
46351
|
* This API submits tasks to enable IDN account for each identity provided in the request body.
|
|
45962
46352
|
* @summary Enable idn accounts for identities
|
|
45963
46353
|
* @param {IdentitiesAccountsBulkRequestV2024} identitiesAccountsBulkRequestV2024
|
|
45964
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
45965
46354
|
* @param {*} [axiosOptions] Override http request option.
|
|
45966
46355
|
* @throws {RequiredError}
|
|
45967
46356
|
*/
|
|
45968
|
-
enableAccountsForIdentities(identitiesAccountsBulkRequestV2024: IdentitiesAccountsBulkRequestV2024,
|
|
46357
|
+
enableAccountsForIdentities(identitiesAccountsBulkRequestV2024: IdentitiesAccountsBulkRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BulkIdentitiesAccountsResponseV2024>>>;
|
|
45969
46358
|
/**
|
|
45970
46359
|
* Use this API to return the details for a single account by its ID.
|
|
45971
46360
|
* @summary Account details
|
|
@@ -46206,12 +46595,6 @@ export interface AccountsV2024ApiDeleteAccountAsyncRequest {
|
|
|
46206
46595
|
* @memberof AccountsV2024ApiDeleteAccountAsync
|
|
46207
46596
|
*/
|
|
46208
46597
|
readonly id: string;
|
|
46209
|
-
/**
|
|
46210
|
-
* Use this header to enable this experimental API.
|
|
46211
|
-
* @type {string}
|
|
46212
|
-
* @memberof AccountsV2024ApiDeleteAccountAsync
|
|
46213
|
-
*/
|
|
46214
|
-
readonly xSailPointExperimental?: string;
|
|
46215
46598
|
}
|
|
46216
46599
|
/**
|
|
46217
46600
|
* Request parameters for disableAccount operation in AccountsV2024Api.
|
|
@@ -46244,12 +46627,6 @@ export interface AccountsV2024ApiDisableAccountForIdentityRequest {
|
|
|
46244
46627
|
* @memberof AccountsV2024ApiDisableAccountForIdentity
|
|
46245
46628
|
*/
|
|
46246
46629
|
readonly id: string;
|
|
46247
|
-
/**
|
|
46248
|
-
* Use this header to enable this experimental API.
|
|
46249
|
-
* @type {string}
|
|
46250
|
-
* @memberof AccountsV2024ApiDisableAccountForIdentity
|
|
46251
|
-
*/
|
|
46252
|
-
readonly xSailPointExperimental?: string;
|
|
46253
46630
|
}
|
|
46254
46631
|
/**
|
|
46255
46632
|
* Request parameters for disableAccountsForIdentities operation in AccountsV2024Api.
|
|
@@ -46263,12 +46640,6 @@ export interface AccountsV2024ApiDisableAccountsForIdentitiesRequest {
|
|
|
46263
46640
|
* @memberof AccountsV2024ApiDisableAccountsForIdentities
|
|
46264
46641
|
*/
|
|
46265
46642
|
readonly identitiesAccountsBulkRequestV2024: IdentitiesAccountsBulkRequestV2024;
|
|
46266
|
-
/**
|
|
46267
|
-
* Use this header to enable this experimental API.
|
|
46268
|
-
* @type {string}
|
|
46269
|
-
* @memberof AccountsV2024ApiDisableAccountsForIdentities
|
|
46270
|
-
*/
|
|
46271
|
-
readonly xSailPointExperimental?: string;
|
|
46272
46643
|
}
|
|
46273
46644
|
/**
|
|
46274
46645
|
* Request parameters for enableAccount operation in AccountsV2024Api.
|
|
@@ -46301,12 +46672,6 @@ export interface AccountsV2024ApiEnableAccountForIdentityRequest {
|
|
|
46301
46672
|
* @memberof AccountsV2024ApiEnableAccountForIdentity
|
|
46302
46673
|
*/
|
|
46303
46674
|
readonly id: string;
|
|
46304
|
-
/**
|
|
46305
|
-
* Use this header to enable this experimental API.
|
|
46306
|
-
* @type {string}
|
|
46307
|
-
* @memberof AccountsV2024ApiEnableAccountForIdentity
|
|
46308
|
-
*/
|
|
46309
|
-
readonly xSailPointExperimental?: string;
|
|
46310
46675
|
}
|
|
46311
46676
|
/**
|
|
46312
46677
|
* Request parameters for enableAccountsForIdentities operation in AccountsV2024Api.
|
|
@@ -46320,12 +46685,6 @@ export interface AccountsV2024ApiEnableAccountsForIdentitiesRequest {
|
|
|
46320
46685
|
* @memberof AccountsV2024ApiEnableAccountsForIdentities
|
|
46321
46686
|
*/
|
|
46322
46687
|
readonly identitiesAccountsBulkRequestV2024: IdentitiesAccountsBulkRequestV2024;
|
|
46323
|
-
/**
|
|
46324
|
-
* Use this header to enable this experimental API.
|
|
46325
|
-
* @type {string}
|
|
46326
|
-
* @memberof AccountsV2024ApiEnableAccountsForIdentities
|
|
46327
|
-
*/
|
|
46328
|
-
readonly xSailPointExperimental?: string;
|
|
46329
46688
|
}
|
|
46330
46689
|
/**
|
|
46331
46690
|
* Request parameters for getAccount operation in AccountsV2024Api.
|
|
@@ -55959,51 +56318,46 @@ export declare const EntitlementsV2024ApiAxiosParamCreator: (configuration?: Con
|
|
|
55959
56318
|
* @param {string} id The entitlement id.
|
|
55960
56319
|
* @param {string} attributeKey Technical name of the Attribute.
|
|
55961
56320
|
* @param {string} attributeValue Technical name of the Attribute Value.
|
|
55962
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
55963
56321
|
* @param {*} [axiosOptions] Override http request option.
|
|
55964
56322
|
* @throws {RequiredError}
|
|
55965
56323
|
*/
|
|
55966
|
-
createAccessModelMetadataForEntitlement: (id: string, attributeKey: string, attributeValue: string,
|
|
56324
|
+
createAccessModelMetadataForEntitlement: (id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
55967
56325
|
/**
|
|
55968
56326
|
* Remove single Access Model Metadata from an entitlement.
|
|
55969
56327
|
* @summary Remove metadata from an entitlement.
|
|
55970
56328
|
* @param {string} id The entitlement id.
|
|
55971
56329
|
* @param {string} attributeKey Technical name of the Attribute.
|
|
55972
56330
|
* @param {string} attributeValue Technical name of the Attribute Value.
|
|
55973
|
-
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
55974
56331
|
* @param {*} [axiosOptions] Override http request option.
|
|
55975
56332
|
* @throws {RequiredError}
|
|
55976
56333
|
*/
|
|
55977
|
-
deleteAccessModelMetadataFromEntitlement: (id: string, attributeKey: string, attributeValue: string,
|
|
56334
|
+
deleteAccessModelMetadataFromEntitlement: (id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
55978
56335
|
/**
|
|
55979
56336
|
* This API returns an entitlement by its ID.
|
|
55980
56337
|
* @summary Get an entitlement
|
|
55981
56338
|
* @param {string} id The entitlement ID
|
|
55982
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
55983
56339
|
* @param {*} [axiosOptions] Override http request option.
|
|
55984
56340
|
* @throws {RequiredError}
|
|
55985
56341
|
*/
|
|
55986
|
-
getEntitlement: (id: string,
|
|
56342
|
+
getEntitlement: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
55987
56343
|
/**
|
|
55988
56344
|
* This API returns the entitlement request config for a specified entitlement.
|
|
55989
56345
|
* @summary Get entitlement request config
|
|
55990
56346
|
* @param {string} id Entitlement Id
|
|
55991
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
55992
56347
|
* @param {*} [axiosOptions] Override http request option.
|
|
55993
56348
|
* @throws {RequiredError}
|
|
55994
56349
|
*/
|
|
55995
|
-
getEntitlementRequestConfig: (id: string,
|
|
56350
|
+
getEntitlementRequestConfig: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
55996
56351
|
/**
|
|
55997
56352
|
* Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`.
|
|
55998
56353
|
* @summary Aggregate entitlements
|
|
55999
56354
|
* @param {string} id Source Id
|
|
56000
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
56001
56355
|
* @param {File} [csvFile] The CSV file containing the source entitlements to aggregate.
|
|
56002
56356
|
* @param {*} [axiosOptions] Override http request option.
|
|
56003
56357
|
* @deprecated
|
|
56004
56358
|
* @throws {RequiredError}
|
|
56005
56359
|
*/
|
|
56006
|
-
importEntitlementsBySource: (id: string,
|
|
56360
|
+
importEntitlementsBySource: (id: string, csvFile?: File, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
56007
56361
|
/**
|
|
56008
56362
|
* This API returns a list of all child entitlements of a given entitlement.
|
|
56009
56363
|
* @summary List of entitlements children
|
|
@@ -56013,11 +56367,10 @@ export declare const EntitlementsV2024ApiAxiosParamCreator: (configuration?: Con
|
|
|
56013
56367
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
56014
56368
|
* @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: **id, name, created, modified, type, attribute, value, source.id**
|
|
56015
56369
|
* @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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le*
|
|
56016
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
56017
56370
|
* @param {*} [axiosOptions] Override http request option.
|
|
56018
56371
|
* @throws {RequiredError}
|
|
56019
56372
|
*/
|
|
56020
|
-
listEntitlementChildren: (id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string,
|
|
56373
|
+
listEntitlementChildren: (id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
56021
56374
|
/**
|
|
56022
56375
|
* This API returns a list of all parent entitlements of a given entitlement.
|
|
56023
56376
|
* @summary List of entitlements parents
|
|
@@ -56027,16 +56380,15 @@ export declare const EntitlementsV2024ApiAxiosParamCreator: (configuration?: Con
|
|
|
56027
56380
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
56028
56381
|
* @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: **id, name, created, modified, type, attribute, value, source.id**
|
|
56029
56382
|
* @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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le*
|
|
56030
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
56031
56383
|
* @param {*} [axiosOptions] Override http request option.
|
|
56032
56384
|
* @throws {RequiredError}
|
|
56033
56385
|
*/
|
|
56034
|
-
listEntitlementParents: (id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string,
|
|
56386
|
+
listEntitlementParents: (id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
56035
56387
|
/**
|
|
56036
56388
|
* This API returns a list of entitlements. This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). Any authenticated token can call this API.
|
|
56037
56389
|
* @summary Gets a list of entitlements.
|
|
56038
56390
|
* @param {string} [accountId] The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s).
|
|
56039
|
-
* @param {string} [segmentedForIdentity] If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID.
|
|
56391
|
+
* @param {string} [segmentedForIdentity] If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user\'s Identity.
|
|
56040
56392
|
* @param {string} [forSegmentIds] If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s).
|
|
56041
56393
|
* @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error.
|
|
56042
56394
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -56044,49 +56396,44 @@ export declare const EntitlementsV2024ApiAxiosParamCreator: (configuration?: Con
|
|
|
56044
56396
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
56045
56397
|
* @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: **id, name, created, modified, type, attribute, value, source.id, requestable**
|
|
56046
56398
|
* @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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in*
|
|
56047
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
56048
56399
|
* @param {*} [axiosOptions] Override http request option.
|
|
56049
56400
|
* @throws {RequiredError}
|
|
56050
56401
|
*/
|
|
56051
|
-
listEntitlements: (accountId?: string, segmentedForIdentity?: string, forSegmentIds?: string, includeUnsegmented?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string,
|
|
56402
|
+
listEntitlements: (accountId?: string, segmentedForIdentity?: string, forSegmentIds?: string, includeUnsegmented?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
56052
56403
|
/**
|
|
56053
56404
|
* This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.
|
|
56054
56405
|
* @summary Patch an entitlement
|
|
56055
56406
|
* @param {string} id ID of the entitlement to patch
|
|
56056
|
-
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
56057
56407
|
* @param {Array<JsonPatchOperationV2024>} [jsonPatchOperationV2024]
|
|
56058
56408
|
* @param {*} [axiosOptions] Override http request option.
|
|
56059
56409
|
* @throws {RequiredError}
|
|
56060
56410
|
*/
|
|
56061
|
-
patchEntitlement: (id: string,
|
|
56411
|
+
patchEntitlement: (id: string, jsonPatchOperationV2024?: Array<JsonPatchOperationV2024>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
56062
56412
|
/**
|
|
56063
56413
|
* This API replaces the entitlement request config for a specified entitlement.
|
|
56064
56414
|
* @summary Replace entitlement request config
|
|
56065
56415
|
* @param {string} id Entitlement ID
|
|
56066
|
-
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
56067
56416
|
* @param {EntitlementRequestConfigV2024} entitlementRequestConfigV2024
|
|
56068
56417
|
* @param {*} [axiosOptions] Override http request option.
|
|
56069
56418
|
* @throws {RequiredError}
|
|
56070
56419
|
*/
|
|
56071
|
-
putEntitlementRequestConfig: (id: string,
|
|
56420
|
+
putEntitlementRequestConfig: (id: string, entitlementRequestConfigV2024: EntitlementRequestConfigV2024, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
56072
56421
|
/**
|
|
56073
56422
|
* Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`.
|
|
56074
56423
|
* @summary Reset source entitlements
|
|
56075
56424
|
* @param {string} id ID of source for the entitlement reset
|
|
56076
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
56077
56425
|
* @param {*} [axiosOptions] Override http request option.
|
|
56078
56426
|
* @throws {RequiredError}
|
|
56079
56427
|
*/
|
|
56080
|
-
resetSourceEntitlements: (id: string,
|
|
56428
|
+
resetSourceEntitlements: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
56081
56429
|
/**
|
|
56082
|
-
*
|
|
56430
|
+
* This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/overrideLevel\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API.
|
|
56083
56431
|
* @summary Bulk update an entitlement list
|
|
56084
56432
|
* @param {EntitlementBulkUpdateRequestV2024} entitlementBulkUpdateRequestV2024
|
|
56085
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
56086
56433
|
* @param {*} [axiosOptions] Override http request option.
|
|
56087
56434
|
* @throws {RequiredError}
|
|
56088
56435
|
*/
|
|
56089
|
-
updateEntitlementsInBulk: (entitlementBulkUpdateRequestV2024: EntitlementBulkUpdateRequestV2024,
|
|
56436
|
+
updateEntitlementsInBulk: (entitlementBulkUpdateRequestV2024: EntitlementBulkUpdateRequestV2024, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
56090
56437
|
};
|
|
56091
56438
|
/**
|
|
56092
56439
|
* EntitlementsV2024Api - functional programming interface
|
|
@@ -56099,51 +56446,46 @@ export declare const EntitlementsV2024ApiFp: (configuration?: Configuration) =>
|
|
|
56099
56446
|
* @param {string} id The entitlement id.
|
|
56100
56447
|
* @param {string} attributeKey Technical name of the Attribute.
|
|
56101
56448
|
* @param {string} attributeValue Technical name of the Attribute Value.
|
|
56102
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
56103
56449
|
* @param {*} [axiosOptions] Override http request option.
|
|
56104
56450
|
* @throws {RequiredError}
|
|
56105
56451
|
*/
|
|
56106
|
-
createAccessModelMetadataForEntitlement(id: string, attributeKey: string, attributeValue: string,
|
|
56452
|
+
createAccessModelMetadataForEntitlement(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntitlementV2024>>;
|
|
56107
56453
|
/**
|
|
56108
56454
|
* Remove single Access Model Metadata from an entitlement.
|
|
56109
56455
|
* @summary Remove metadata from an entitlement.
|
|
56110
56456
|
* @param {string} id The entitlement id.
|
|
56111
56457
|
* @param {string} attributeKey Technical name of the Attribute.
|
|
56112
56458
|
* @param {string} attributeValue Technical name of the Attribute Value.
|
|
56113
|
-
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
56114
56459
|
* @param {*} [axiosOptions] Override http request option.
|
|
56115
56460
|
* @throws {RequiredError}
|
|
56116
56461
|
*/
|
|
56117
|
-
deleteAccessModelMetadataFromEntitlement(id: string, attributeKey: string, attributeValue: string,
|
|
56462
|
+
deleteAccessModelMetadataFromEntitlement(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
56118
56463
|
/**
|
|
56119
56464
|
* This API returns an entitlement by its ID.
|
|
56120
56465
|
* @summary Get an entitlement
|
|
56121
56466
|
* @param {string} id The entitlement ID
|
|
56122
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
56123
56467
|
* @param {*} [axiosOptions] Override http request option.
|
|
56124
56468
|
* @throws {RequiredError}
|
|
56125
56469
|
*/
|
|
56126
|
-
getEntitlement(id: string,
|
|
56470
|
+
getEntitlement(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntitlementV2024>>;
|
|
56127
56471
|
/**
|
|
56128
56472
|
* This API returns the entitlement request config for a specified entitlement.
|
|
56129
56473
|
* @summary Get entitlement request config
|
|
56130
56474
|
* @param {string} id Entitlement Id
|
|
56131
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
56132
56475
|
* @param {*} [axiosOptions] Override http request option.
|
|
56133
56476
|
* @throws {RequiredError}
|
|
56134
56477
|
*/
|
|
56135
|
-
getEntitlementRequestConfig(id: string,
|
|
56478
|
+
getEntitlementRequestConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntitlementRequestConfigV2024>>;
|
|
56136
56479
|
/**
|
|
56137
56480
|
* Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`.
|
|
56138
56481
|
* @summary Aggregate entitlements
|
|
56139
56482
|
* @param {string} id Source Id
|
|
56140
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
56141
56483
|
* @param {File} [csvFile] The CSV file containing the source entitlements to aggregate.
|
|
56142
56484
|
* @param {*} [axiosOptions] Override http request option.
|
|
56143
56485
|
* @deprecated
|
|
56144
56486
|
* @throws {RequiredError}
|
|
56145
56487
|
*/
|
|
56146
|
-
importEntitlementsBySource(id: string,
|
|
56488
|
+
importEntitlementsBySource(id: string, csvFile?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoadEntitlementTaskV2024>>;
|
|
56147
56489
|
/**
|
|
56148
56490
|
* This API returns a list of all child entitlements of a given entitlement.
|
|
56149
56491
|
* @summary List of entitlements children
|
|
@@ -56153,11 +56495,10 @@ export declare const EntitlementsV2024ApiFp: (configuration?: Configuration) =>
|
|
|
56153
56495
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
56154
56496
|
* @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: **id, name, created, modified, type, attribute, value, source.id**
|
|
56155
56497
|
* @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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le*
|
|
56156
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
56157
56498
|
* @param {*} [axiosOptions] Override http request option.
|
|
56158
56499
|
* @throws {RequiredError}
|
|
56159
56500
|
*/
|
|
56160
|
-
listEntitlementChildren(id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string,
|
|
56501
|
+
listEntitlementChildren(id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EntitlementV2024>>>;
|
|
56161
56502
|
/**
|
|
56162
56503
|
* This API returns a list of all parent entitlements of a given entitlement.
|
|
56163
56504
|
* @summary List of entitlements parents
|
|
@@ -56167,16 +56508,15 @@ export declare const EntitlementsV2024ApiFp: (configuration?: Configuration) =>
|
|
|
56167
56508
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
56168
56509
|
* @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: **id, name, created, modified, type, attribute, value, source.id**
|
|
56169
56510
|
* @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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le*
|
|
56170
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
56171
56511
|
* @param {*} [axiosOptions] Override http request option.
|
|
56172
56512
|
* @throws {RequiredError}
|
|
56173
56513
|
*/
|
|
56174
|
-
listEntitlementParents(id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string,
|
|
56514
|
+
listEntitlementParents(id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EntitlementV2024>>>;
|
|
56175
56515
|
/**
|
|
56176
56516
|
* This API returns a list of entitlements. This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). Any authenticated token can call this API.
|
|
56177
56517
|
* @summary Gets a list of entitlements.
|
|
56178
56518
|
* @param {string} [accountId] The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s).
|
|
56179
|
-
* @param {string} [segmentedForIdentity] If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID.
|
|
56519
|
+
* @param {string} [segmentedForIdentity] If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user\'s Identity.
|
|
56180
56520
|
* @param {string} [forSegmentIds] If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s).
|
|
56181
56521
|
* @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error.
|
|
56182
56522
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -56184,49 +56524,44 @@ export declare const EntitlementsV2024ApiFp: (configuration?: Configuration) =>
|
|
|
56184
56524
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
56185
56525
|
* @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: **id, name, created, modified, type, attribute, value, source.id, requestable**
|
|
56186
56526
|
* @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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in*
|
|
56187
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
56188
56527
|
* @param {*} [axiosOptions] Override http request option.
|
|
56189
56528
|
* @throws {RequiredError}
|
|
56190
56529
|
*/
|
|
56191
|
-
listEntitlements(accountId?: string, segmentedForIdentity?: string, forSegmentIds?: string, includeUnsegmented?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string,
|
|
56530
|
+
listEntitlements(accountId?: string, segmentedForIdentity?: string, forSegmentIds?: string, includeUnsegmented?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EntitlementV2024>>>;
|
|
56192
56531
|
/**
|
|
56193
56532
|
* This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.
|
|
56194
56533
|
* @summary Patch an entitlement
|
|
56195
56534
|
* @param {string} id ID of the entitlement to patch
|
|
56196
|
-
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
56197
56535
|
* @param {Array<JsonPatchOperationV2024>} [jsonPatchOperationV2024]
|
|
56198
56536
|
* @param {*} [axiosOptions] Override http request option.
|
|
56199
56537
|
* @throws {RequiredError}
|
|
56200
56538
|
*/
|
|
56201
|
-
patchEntitlement(id: string,
|
|
56539
|
+
patchEntitlement(id: string, jsonPatchOperationV2024?: Array<JsonPatchOperationV2024>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntitlementV2024>>;
|
|
56202
56540
|
/**
|
|
56203
56541
|
* This API replaces the entitlement request config for a specified entitlement.
|
|
56204
56542
|
* @summary Replace entitlement request config
|
|
56205
56543
|
* @param {string} id Entitlement ID
|
|
56206
|
-
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
56207
56544
|
* @param {EntitlementRequestConfigV2024} entitlementRequestConfigV2024
|
|
56208
56545
|
* @param {*} [axiosOptions] Override http request option.
|
|
56209
56546
|
* @throws {RequiredError}
|
|
56210
56547
|
*/
|
|
56211
|
-
putEntitlementRequestConfig(id: string,
|
|
56548
|
+
putEntitlementRequestConfig(id: string, entitlementRequestConfigV2024: EntitlementRequestConfigV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntitlementRequestConfigV2024>>;
|
|
56212
56549
|
/**
|
|
56213
56550
|
* Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`.
|
|
56214
56551
|
* @summary Reset source entitlements
|
|
56215
56552
|
* @param {string} id ID of source for the entitlement reset
|
|
56216
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
56217
56553
|
* @param {*} [axiosOptions] Override http request option.
|
|
56218
56554
|
* @throws {RequiredError}
|
|
56219
56555
|
*/
|
|
56220
|
-
resetSourceEntitlements(id: string,
|
|
56556
|
+
resetSourceEntitlements(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntitlementSourceResetBaseReferenceDtoV2024>>;
|
|
56221
56557
|
/**
|
|
56222
|
-
*
|
|
56558
|
+
* This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/overrideLevel\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API.
|
|
56223
56559
|
* @summary Bulk update an entitlement list
|
|
56224
56560
|
* @param {EntitlementBulkUpdateRequestV2024} entitlementBulkUpdateRequestV2024
|
|
56225
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
56226
56561
|
* @param {*} [axiosOptions] Override http request option.
|
|
56227
56562
|
* @throws {RequiredError}
|
|
56228
56563
|
*/
|
|
56229
|
-
updateEntitlementsInBulk(entitlementBulkUpdateRequestV2024: EntitlementBulkUpdateRequestV2024,
|
|
56564
|
+
updateEntitlementsInBulk(entitlementBulkUpdateRequestV2024: EntitlementBulkUpdateRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
56230
56565
|
};
|
|
56231
56566
|
/**
|
|
56232
56567
|
* EntitlementsV2024Api - factory interface
|
|
@@ -56323,7 +56658,7 @@ export declare const EntitlementsV2024ApiFactory: (configuration?: Configuration
|
|
|
56323
56658
|
*/
|
|
56324
56659
|
resetSourceEntitlements(requestParameters: EntitlementsV2024ApiResetSourceEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<EntitlementSourceResetBaseReferenceDtoV2024>;
|
|
56325
56660
|
/**
|
|
56326
|
-
*
|
|
56661
|
+
* This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/overrideLevel\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API.
|
|
56327
56662
|
* @summary Bulk update an entitlement list
|
|
56328
56663
|
* @param {EntitlementsV2024ApiUpdateEntitlementsInBulkRequest} requestParameters Request parameters.
|
|
56329
56664
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -56355,12 +56690,6 @@ export interface EntitlementsV2024ApiCreateAccessModelMetadataForEntitlementRequ
|
|
|
56355
56690
|
* @memberof EntitlementsV2024ApiCreateAccessModelMetadataForEntitlement
|
|
56356
56691
|
*/
|
|
56357
56692
|
readonly attributeValue: string;
|
|
56358
|
-
/**
|
|
56359
|
-
* Use this header to enable this experimental API.
|
|
56360
|
-
* @type {string}
|
|
56361
|
-
* @memberof EntitlementsV2024ApiCreateAccessModelMetadataForEntitlement
|
|
56362
|
-
*/
|
|
56363
|
-
readonly xSailPointExperimental?: string;
|
|
56364
56693
|
}
|
|
56365
56694
|
/**
|
|
56366
56695
|
* Request parameters for deleteAccessModelMetadataFromEntitlement operation in EntitlementsV2024Api.
|
|
@@ -56386,12 +56715,6 @@ export interface EntitlementsV2024ApiDeleteAccessModelMetadataFromEntitlementReq
|
|
|
56386
56715
|
* @memberof EntitlementsV2024ApiDeleteAccessModelMetadataFromEntitlement
|
|
56387
56716
|
*/
|
|
56388
56717
|
readonly attributeValue: string;
|
|
56389
|
-
/**
|
|
56390
|
-
* Use this header to enable this experimental API.
|
|
56391
|
-
* @type {string}
|
|
56392
|
-
* @memberof EntitlementsV2024ApiDeleteAccessModelMetadataFromEntitlement
|
|
56393
|
-
*/
|
|
56394
|
-
readonly xSailPointExperimental: string;
|
|
56395
56718
|
}
|
|
56396
56719
|
/**
|
|
56397
56720
|
* Request parameters for getEntitlement operation in EntitlementsV2024Api.
|
|
@@ -56405,12 +56728,6 @@ export interface EntitlementsV2024ApiGetEntitlementRequest {
|
|
|
56405
56728
|
* @memberof EntitlementsV2024ApiGetEntitlement
|
|
56406
56729
|
*/
|
|
56407
56730
|
readonly id: string;
|
|
56408
|
-
/**
|
|
56409
|
-
* Use this header to enable this experimental API.
|
|
56410
|
-
* @type {string}
|
|
56411
|
-
* @memberof EntitlementsV2024ApiGetEntitlement
|
|
56412
|
-
*/
|
|
56413
|
-
readonly xSailPointExperimental?: string;
|
|
56414
56731
|
}
|
|
56415
56732
|
/**
|
|
56416
56733
|
* Request parameters for getEntitlementRequestConfig operation in EntitlementsV2024Api.
|
|
@@ -56424,12 +56741,6 @@ export interface EntitlementsV2024ApiGetEntitlementRequestConfigRequest {
|
|
|
56424
56741
|
* @memberof EntitlementsV2024ApiGetEntitlementRequestConfig
|
|
56425
56742
|
*/
|
|
56426
56743
|
readonly id: string;
|
|
56427
|
-
/**
|
|
56428
|
-
* Use this header to enable this experimental API.
|
|
56429
|
-
* @type {string}
|
|
56430
|
-
* @memberof EntitlementsV2024ApiGetEntitlementRequestConfig
|
|
56431
|
-
*/
|
|
56432
|
-
readonly xSailPointExperimental?: string;
|
|
56433
56744
|
}
|
|
56434
56745
|
/**
|
|
56435
56746
|
* Request parameters for importEntitlementsBySource operation in EntitlementsV2024Api.
|
|
@@ -56443,12 +56754,6 @@ export interface EntitlementsV2024ApiImportEntitlementsBySourceRequest {
|
|
|
56443
56754
|
* @memberof EntitlementsV2024ApiImportEntitlementsBySource
|
|
56444
56755
|
*/
|
|
56445
56756
|
readonly id: string;
|
|
56446
|
-
/**
|
|
56447
|
-
* Use this header to enable this experimental API.
|
|
56448
|
-
* @type {string}
|
|
56449
|
-
* @memberof EntitlementsV2024ApiImportEntitlementsBySource
|
|
56450
|
-
*/
|
|
56451
|
-
readonly xSailPointExperimental?: string;
|
|
56452
56757
|
/**
|
|
56453
56758
|
* The CSV file containing the source entitlements to aggregate.
|
|
56454
56759
|
* @type {File}
|
|
@@ -56498,12 +56803,6 @@ export interface EntitlementsV2024ApiListEntitlementChildrenRequest {
|
|
|
56498
56803
|
* @memberof EntitlementsV2024ApiListEntitlementChildren
|
|
56499
56804
|
*/
|
|
56500
56805
|
readonly filters?: string;
|
|
56501
|
-
/**
|
|
56502
|
-
* Use this header to enable this experimental API.
|
|
56503
|
-
* @type {string}
|
|
56504
|
-
* @memberof EntitlementsV2024ApiListEntitlementChildren
|
|
56505
|
-
*/
|
|
56506
|
-
readonly xSailPointExperimental?: string;
|
|
56507
56806
|
}
|
|
56508
56807
|
/**
|
|
56509
56808
|
* Request parameters for listEntitlementParents operation in EntitlementsV2024Api.
|
|
@@ -56547,12 +56846,6 @@ export interface EntitlementsV2024ApiListEntitlementParentsRequest {
|
|
|
56547
56846
|
* @memberof EntitlementsV2024ApiListEntitlementParents
|
|
56548
56847
|
*/
|
|
56549
56848
|
readonly filters?: string;
|
|
56550
|
-
/**
|
|
56551
|
-
* Use this header to enable this experimental API.
|
|
56552
|
-
* @type {string}
|
|
56553
|
-
* @memberof EntitlementsV2024ApiListEntitlementParents
|
|
56554
|
-
*/
|
|
56555
|
-
readonly xSailPointExperimental?: string;
|
|
56556
56849
|
}
|
|
56557
56850
|
/**
|
|
56558
56851
|
* Request parameters for listEntitlements operation in EntitlementsV2024Api.
|
|
@@ -56567,7 +56860,7 @@ export interface EntitlementsV2024ApiListEntitlementsRequest {
|
|
|
56567
56860
|
*/
|
|
56568
56861
|
readonly accountId?: string;
|
|
56569
56862
|
/**
|
|
56570
|
-
* If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID.
|
|
56863
|
+
* If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user\'s Identity.
|
|
56571
56864
|
* @type {string}
|
|
56572
56865
|
* @memberof EntitlementsV2024ApiListEntitlements
|
|
56573
56866
|
*/
|
|
@@ -56614,12 +56907,6 @@ export interface EntitlementsV2024ApiListEntitlementsRequest {
|
|
|
56614
56907
|
* @memberof EntitlementsV2024ApiListEntitlements
|
|
56615
56908
|
*/
|
|
56616
56909
|
readonly filters?: string;
|
|
56617
|
-
/**
|
|
56618
|
-
* Use this header to enable this experimental API.
|
|
56619
|
-
* @type {string}
|
|
56620
|
-
* @memberof EntitlementsV2024ApiListEntitlements
|
|
56621
|
-
*/
|
|
56622
|
-
readonly xSailPointExperimental?: string;
|
|
56623
56910
|
}
|
|
56624
56911
|
/**
|
|
56625
56912
|
* Request parameters for patchEntitlement operation in EntitlementsV2024Api.
|
|
@@ -56633,12 +56920,6 @@ export interface EntitlementsV2024ApiPatchEntitlementRequest {
|
|
|
56633
56920
|
* @memberof EntitlementsV2024ApiPatchEntitlement
|
|
56634
56921
|
*/
|
|
56635
56922
|
readonly id: string;
|
|
56636
|
-
/**
|
|
56637
|
-
* Use this header to enable this experimental API.
|
|
56638
|
-
* @type {string}
|
|
56639
|
-
* @memberof EntitlementsV2024ApiPatchEntitlement
|
|
56640
|
-
*/
|
|
56641
|
-
readonly xSailPointExperimental: string;
|
|
56642
56923
|
/**
|
|
56643
56924
|
*
|
|
56644
56925
|
* @type {Array<JsonPatchOperationV2024>}
|
|
@@ -56658,12 +56939,6 @@ export interface EntitlementsV2024ApiPutEntitlementRequestConfigRequest {
|
|
|
56658
56939
|
* @memberof EntitlementsV2024ApiPutEntitlementRequestConfig
|
|
56659
56940
|
*/
|
|
56660
56941
|
readonly id: string;
|
|
56661
|
-
/**
|
|
56662
|
-
* Use this header to enable this experimental API.
|
|
56663
|
-
* @type {string}
|
|
56664
|
-
* @memberof EntitlementsV2024ApiPutEntitlementRequestConfig
|
|
56665
|
-
*/
|
|
56666
|
-
readonly xSailPointExperimental: string;
|
|
56667
56942
|
/**
|
|
56668
56943
|
*
|
|
56669
56944
|
* @type {EntitlementRequestConfigV2024}
|
|
@@ -56683,12 +56958,6 @@ export interface EntitlementsV2024ApiResetSourceEntitlementsRequest {
|
|
|
56683
56958
|
* @memberof EntitlementsV2024ApiResetSourceEntitlements
|
|
56684
56959
|
*/
|
|
56685
56960
|
readonly id: string;
|
|
56686
|
-
/**
|
|
56687
|
-
* Use this header to enable this experimental API.
|
|
56688
|
-
* @type {string}
|
|
56689
|
-
* @memberof EntitlementsV2024ApiResetSourceEntitlements
|
|
56690
|
-
*/
|
|
56691
|
-
readonly xSailPointExperimental?: string;
|
|
56692
56961
|
}
|
|
56693
56962
|
/**
|
|
56694
56963
|
* Request parameters for updateEntitlementsInBulk operation in EntitlementsV2024Api.
|
|
@@ -56702,12 +56971,6 @@ export interface EntitlementsV2024ApiUpdateEntitlementsInBulkRequest {
|
|
|
56702
56971
|
* @memberof EntitlementsV2024ApiUpdateEntitlementsInBulk
|
|
56703
56972
|
*/
|
|
56704
56973
|
readonly entitlementBulkUpdateRequestV2024: EntitlementBulkUpdateRequestV2024;
|
|
56705
|
-
/**
|
|
56706
|
-
* Use this header to enable this experimental API.
|
|
56707
|
-
* @type {string}
|
|
56708
|
-
* @memberof EntitlementsV2024ApiUpdateEntitlementsInBulk
|
|
56709
|
-
*/
|
|
56710
|
-
readonly xSailPointExperimental?: string;
|
|
56711
56974
|
}
|
|
56712
56975
|
/**
|
|
56713
56976
|
* EntitlementsV2024Api - object-oriented interface
|
|
@@ -56817,7 +57080,7 @@ export declare class EntitlementsV2024Api extends BaseAPI {
|
|
|
56817
57080
|
*/
|
|
56818
57081
|
resetSourceEntitlements(requestParameters: EntitlementsV2024ApiResetSourceEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementSourceResetBaseReferenceDtoV2024, any>>;
|
|
56819
57082
|
/**
|
|
56820
|
-
*
|
|
57083
|
+
* This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/overrideLevel\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API.
|
|
56821
57084
|
* @summary Bulk update an entitlement list
|
|
56822
57085
|
* @param {EntitlementsV2024ApiUpdateEntitlementsInBulkRequest} requestParameters Request parameters.
|
|
56823
57086
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -62956,7 +63219,7 @@ export declare const IdentityHistoryV2024ApiAxiosParamCreator: (configuration?:
|
|
|
62956
63219
|
getHistoricalIdentity: (id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
62957
63220
|
/**
|
|
62958
63221
|
* This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\'
|
|
62959
|
-
* @summary
|
|
63222
|
+
* @summary List identity event history
|
|
62960
63223
|
* @param {string} id The identity id
|
|
62961
63224
|
* @param {string} [from] The optional instant until which access events are returned
|
|
62962
63225
|
* @param {Array<string>} [eventTypes] An optional list of event types to return. If null or empty, all events are returned
|
|
@@ -63020,7 +63283,7 @@ export declare const IdentityHistoryV2024ApiAxiosParamCreator: (configuration?:
|
|
|
63020
63283
|
* This method retrieves a list of access item for the identity filtered by the access item type
|
|
63021
63284
|
* @summary List access items by identity
|
|
63022
63285
|
* @param {string} id The identity id
|
|
63023
|
-
* @param {
|
|
63286
|
+
* @param {ListIdentityAccessItemsTypeV2024} [type] The type of access item for the identity. If not provided, it defaults to account
|
|
63024
63287
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
63025
63288
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
63026
63289
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -63028,7 +63291,7 @@ export declare const IdentityHistoryV2024ApiAxiosParamCreator: (configuration?:
|
|
|
63028
63291
|
* @param {*} [axiosOptions] Override http request option.
|
|
63029
63292
|
* @throws {RequiredError}
|
|
63030
63293
|
*/
|
|
63031
|
-
listIdentityAccessItems: (id: string, type?:
|
|
63294
|
+
listIdentityAccessItems: (id: string, type?: ListIdentityAccessItemsTypeV2024, xSailPointExperimental?: string, limit?: number, count?: boolean, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63032
63295
|
/**
|
|
63033
63296
|
* This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of \'idn:identity-history:read\'
|
|
63034
63297
|
* @summary Gets the list of identity access items at a given date filterd by item type
|
|
@@ -63102,7 +63365,7 @@ export declare const IdentityHistoryV2024ApiFp: (configuration?: Configuration)
|
|
|
63102
63365
|
getHistoricalIdentity(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdentityHistoryResponseV2024>>;
|
|
63103
63366
|
/**
|
|
63104
63367
|
* This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\'
|
|
63105
|
-
* @summary
|
|
63368
|
+
* @summary List identity event history
|
|
63106
63369
|
* @param {string} id The identity id
|
|
63107
63370
|
* @param {string} [from] The optional instant until which access events are returned
|
|
63108
63371
|
* @param {Array<string>} [eventTypes] An optional list of event types to return. If null or empty, all events are returned
|
|
@@ -63166,7 +63429,7 @@ export declare const IdentityHistoryV2024ApiFp: (configuration?: Configuration)
|
|
|
63166
63429
|
* This method retrieves a list of access item for the identity filtered by the access item type
|
|
63167
63430
|
* @summary List access items by identity
|
|
63168
63431
|
* @param {string} id The identity id
|
|
63169
|
-
* @param {
|
|
63432
|
+
* @param {ListIdentityAccessItemsTypeV2024} [type] The type of access item for the identity. If not provided, it defaults to account
|
|
63170
63433
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
63171
63434
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
63172
63435
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -63174,7 +63437,7 @@ export declare const IdentityHistoryV2024ApiFp: (configuration?: Configuration)
|
|
|
63174
63437
|
* @param {*} [axiosOptions] Override http request option.
|
|
63175
63438
|
* @throws {RequiredError}
|
|
63176
63439
|
*/
|
|
63177
|
-
listIdentityAccessItems(id: string, type?:
|
|
63440
|
+
listIdentityAccessItems(id: string, type?: ListIdentityAccessItemsTypeV2024, xSailPointExperimental?: string, limit?: number, count?: boolean, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ListIdentityAccessItems200ResponseInnerV2024>>>;
|
|
63178
63441
|
/**
|
|
63179
63442
|
* This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of \'idn:identity-history:read\'
|
|
63180
63443
|
* @summary Gets the list of identity access items at a given date filterd by item type
|
|
@@ -63185,7 +63448,7 @@ export declare const IdentityHistoryV2024ApiFp: (configuration?: Configuration)
|
|
|
63185
63448
|
* @param {*} [axiosOptions] Override http request option.
|
|
63186
63449
|
* @throws {RequiredError}
|
|
63187
63450
|
*/
|
|
63188
|
-
listIdentitySnapshotAccessItems(id: string, date: string, type?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
63451
|
+
listIdentitySnapshotAccessItems(id: string, date: string, type?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ListIdentitySnapshotAccessItems200ResponseInnerV2024>>>;
|
|
63189
63452
|
/**
|
|
63190
63453
|
* This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\'
|
|
63191
63454
|
* @summary Lists all the snapshots for the identity
|
|
@@ -63232,7 +63495,7 @@ export declare const IdentityHistoryV2024ApiFactory: (configuration?: Configurat
|
|
|
63232
63495
|
getHistoricalIdentity(requestParameters: IdentityHistoryV2024ApiGetHistoricalIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<IdentityHistoryResponseV2024>;
|
|
63233
63496
|
/**
|
|
63234
63497
|
* This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\'
|
|
63235
|
-
* @summary
|
|
63498
|
+
* @summary List identity event history
|
|
63236
63499
|
* @param {IdentityHistoryV2024ApiGetHistoricalIdentityEventsRequest} requestParameters Request parameters.
|
|
63237
63500
|
* @param {*} [axiosOptions] Override http request option.
|
|
63238
63501
|
* @throws {RequiredError}
|
|
@@ -63285,7 +63548,7 @@ export declare const IdentityHistoryV2024ApiFactory: (configuration?: Configurat
|
|
|
63285
63548
|
* @param {*} [axiosOptions] Override http request option.
|
|
63286
63549
|
* @throws {RequiredError}
|
|
63287
63550
|
*/
|
|
63288
|
-
listIdentitySnapshotAccessItems(requestParameters: IdentityHistoryV2024ApiListIdentitySnapshotAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
63551
|
+
listIdentitySnapshotAccessItems(requestParameters: IdentityHistoryV2024ApiListIdentitySnapshotAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<ListIdentitySnapshotAccessItems200ResponseInnerV2024>>;
|
|
63289
63552
|
/**
|
|
63290
63553
|
* This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\'
|
|
63291
63554
|
* @summary Lists all the snapshots for the identity
|
|
@@ -63641,10 +63904,10 @@ export interface IdentityHistoryV2024ApiListIdentityAccessItemsRequest {
|
|
|
63641
63904
|
readonly id: string;
|
|
63642
63905
|
/**
|
|
63643
63906
|
* The type of access item for the identity. If not provided, it defaults to account
|
|
63644
|
-
* @type {
|
|
63907
|
+
* @type {'account' | 'entitlement' | 'app' | 'accessProfile' | 'role'}
|
|
63645
63908
|
* @memberof IdentityHistoryV2024ApiListIdentityAccessItems
|
|
63646
63909
|
*/
|
|
63647
|
-
readonly type?:
|
|
63910
|
+
readonly type?: ListIdentityAccessItemsTypeV2024;
|
|
63648
63911
|
/**
|
|
63649
63912
|
* Use this header to enable this experimental API.
|
|
63650
63913
|
* @type {string}
|
|
@@ -63786,7 +64049,7 @@ export declare class IdentityHistoryV2024Api extends BaseAPI {
|
|
|
63786
64049
|
getHistoricalIdentity(requestParameters: IdentityHistoryV2024ApiGetHistoricalIdentityRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityHistoryResponseV2024, any>>;
|
|
63787
64050
|
/**
|
|
63788
64051
|
* This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\'
|
|
63789
|
-
* @summary
|
|
64052
|
+
* @summary List identity event history
|
|
63790
64053
|
* @param {IdentityHistoryV2024ApiGetHistoricalIdentityEventsRequest} requestParameters Request parameters.
|
|
63791
64054
|
* @param {*} [axiosOptions] Override http request option.
|
|
63792
64055
|
* @throws {RequiredError}
|
|
@@ -63846,7 +64109,7 @@ export declare class IdentityHistoryV2024Api extends BaseAPI {
|
|
|
63846
64109
|
* @throws {RequiredError}
|
|
63847
64110
|
* @memberof IdentityHistoryV2024Api
|
|
63848
64111
|
*/
|
|
63849
|
-
listIdentitySnapshotAccessItems(requestParameters: IdentityHistoryV2024ApiListIdentitySnapshotAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
64112
|
+
listIdentitySnapshotAccessItems(requestParameters: IdentityHistoryV2024ApiListIdentitySnapshotAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListIdentitySnapshotAccessItems200ResponseInnerV2024[], any>>;
|
|
63850
64113
|
/**
|
|
63851
64114
|
* This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\'
|
|
63852
64115
|
* @summary Lists all the snapshots for the identity
|
|
@@ -63876,6 +64139,17 @@ export declare const GetIdentitySnapshotSummaryIntervalV2024: {
|
|
|
63876
64139
|
readonly Month: "month";
|
|
63877
64140
|
};
|
|
63878
64141
|
export type GetIdentitySnapshotSummaryIntervalV2024 = typeof GetIdentitySnapshotSummaryIntervalV2024[keyof typeof GetIdentitySnapshotSummaryIntervalV2024];
|
|
64142
|
+
/**
|
|
64143
|
+
* @export
|
|
64144
|
+
*/
|
|
64145
|
+
export declare const ListIdentityAccessItemsTypeV2024: {
|
|
64146
|
+
readonly Account: "account";
|
|
64147
|
+
readonly Entitlement: "entitlement";
|
|
64148
|
+
readonly App: "app";
|
|
64149
|
+
readonly AccessProfile: "accessProfile";
|
|
64150
|
+
readonly Role: "role";
|
|
64151
|
+
};
|
|
64152
|
+
export type ListIdentityAccessItemsTypeV2024 = typeof ListIdentityAccessItemsTypeV2024[keyof typeof ListIdentityAccessItemsTypeV2024];
|
|
63879
64153
|
/**
|
|
63880
64154
|
* @export
|
|
63881
64155
|
*/
|
|
@@ -69852,7 +70126,7 @@ export declare const NotificationsV2024ApiAxiosParamCreator: (configuration?: Co
|
|
|
69852
70126
|
*/
|
|
69853
70127
|
createDomainDkim: (xSailPointExperimental: string, domainAddressV2024: DomainAddressV2024, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
69854
70128
|
/**
|
|
69855
|
-
* This
|
|
70129
|
+
* This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready.
|
|
69856
70130
|
* @summary Create notification template
|
|
69857
70131
|
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
69858
70132
|
* @param {TemplateDtoV2024} templateDtoV2024
|
|
@@ -69959,11 +70233,12 @@ export declare const NotificationsV2024ApiAxiosParamCreator: (configuration?: Co
|
|
|
69959
70233
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
69960
70234
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
69961
70235
|
* @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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw*
|
|
70236
|
+
* @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: **key, name, medium**
|
|
69962
70237
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
69963
70238
|
* @param {*} [axiosOptions] Override http request option.
|
|
69964
70239
|
* @throws {RequiredError}
|
|
69965
70240
|
*/
|
|
69966
|
-
listNotificationTemplates: (limit?: number, offset?: number, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
70241
|
+
listNotificationTemplates: (limit?: number, offset?: number, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
69967
70242
|
/**
|
|
69968
70243
|
* Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS
|
|
69969
70244
|
* @summary Change mail from domain
|
|
@@ -69998,7 +70273,7 @@ export declare const NotificationsV2024ApiFp: (configuration?: Configuration) =>
|
|
|
69998
70273
|
*/
|
|
69999
70274
|
createDomainDkim(xSailPointExperimental: string, domainAddressV2024: DomainAddressV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DomainStatusDtoV2024>>;
|
|
70000
70275
|
/**
|
|
70001
|
-
* This
|
|
70276
|
+
* This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready.
|
|
70002
70277
|
* @summary Create notification template
|
|
70003
70278
|
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
70004
70279
|
* @param {TemplateDtoV2024} templateDtoV2024
|
|
@@ -70105,11 +70380,12 @@ export declare const NotificationsV2024ApiFp: (configuration?: Configuration) =>
|
|
|
70105
70380
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
70106
70381
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
70107
70382
|
* @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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw*
|
|
70383
|
+
* @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: **key, name, medium**
|
|
70108
70384
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
70109
70385
|
* @param {*} [axiosOptions] Override http request option.
|
|
70110
70386
|
* @throws {RequiredError}
|
|
70111
70387
|
*/
|
|
70112
|
-
listNotificationTemplates(limit?: number, offset?: number, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TemplateDtoV2024>>>;
|
|
70388
|
+
listNotificationTemplates(limit?: number, offset?: number, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TemplateDtoV2024>>>;
|
|
70113
70389
|
/**
|
|
70114
70390
|
* Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS
|
|
70115
70391
|
* @summary Change mail from domain
|
|
@@ -70143,7 +70419,7 @@ export declare const NotificationsV2024ApiFactory: (configuration?: Configuratio
|
|
|
70143
70419
|
*/
|
|
70144
70420
|
createDomainDkim(requestParameters: NotificationsV2024ApiCreateDomainDkimRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<DomainStatusDtoV2024>;
|
|
70145
70421
|
/**
|
|
70146
|
-
* This
|
|
70422
|
+
* This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready.
|
|
70147
70423
|
* @summary Create notification template
|
|
70148
70424
|
* @param {NotificationsV2024ApiCreateNotificationTemplateRequest} requestParameters Request parameters.
|
|
70149
70425
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -70525,6 +70801,12 @@ export interface NotificationsV2024ApiListNotificationTemplatesRequest {
|
|
|
70525
70801
|
* @memberof NotificationsV2024ApiListNotificationTemplates
|
|
70526
70802
|
*/
|
|
70527
70803
|
readonly filters?: string;
|
|
70804
|
+
/**
|
|
70805
|
+
* 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: **key, name, medium**
|
|
70806
|
+
* @type {string}
|
|
70807
|
+
* @memberof NotificationsV2024ApiListNotificationTemplates
|
|
70808
|
+
*/
|
|
70809
|
+
readonly sorters?: string;
|
|
70528
70810
|
/**
|
|
70529
70811
|
* Use this header to enable this experimental API.
|
|
70530
70812
|
* @type {string}
|
|
@@ -70587,7 +70869,7 @@ export declare class NotificationsV2024Api extends BaseAPI {
|
|
|
70587
70869
|
*/
|
|
70588
70870
|
createDomainDkim(requestParameters: NotificationsV2024ApiCreateDomainDkimRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DomainStatusDtoV2024, any>>;
|
|
70589
70871
|
/**
|
|
70590
|
-
* This
|
|
70872
|
+
* This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready.
|
|
70591
70873
|
* @summary Create notification template
|
|
70592
70874
|
* @param {NotificationsV2024ApiCreateNotificationTemplateRequest} requestParameters Request parameters.
|
|
70593
70875
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -72894,7 +73176,7 @@ export type GetReportFileFormatV2024 = typeof GetReportFileFormatV2024[keyof typ
|
|
|
72894
73176
|
*/
|
|
72895
73177
|
export declare const RequestableObjectsV2024ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
72896
73178
|
/**
|
|
72897
|
-
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
73179
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
72898
73180
|
* @summary Requestable objects list
|
|
72899
73181
|
* @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result.
|
|
72900
73182
|
* @param {Array<ListRequestableObjectsTypesV2024>} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice.
|
|
@@ -72916,7 +73198,7 @@ export declare const RequestableObjectsV2024ApiAxiosParamCreator: (configuration
|
|
|
72916
73198
|
*/
|
|
72917
73199
|
export declare const RequestableObjectsV2024ApiFp: (configuration?: Configuration) => {
|
|
72918
73200
|
/**
|
|
72919
|
-
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
73201
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
72920
73202
|
* @summary Requestable objects list
|
|
72921
73203
|
* @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result.
|
|
72922
73204
|
* @param {Array<ListRequestableObjectsTypesV2024>} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice.
|
|
@@ -72938,7 +73220,7 @@ export declare const RequestableObjectsV2024ApiFp: (configuration?: Configuratio
|
|
|
72938
73220
|
*/
|
|
72939
73221
|
export declare const RequestableObjectsV2024ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
72940
73222
|
/**
|
|
72941
|
-
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
73223
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
72942
73224
|
* @summary Requestable objects list
|
|
72943
73225
|
* @param {RequestableObjectsV2024ApiListRequestableObjectsRequest} requestParameters Request parameters.
|
|
72944
73226
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -73015,7 +73297,7 @@ export interface RequestableObjectsV2024ApiListRequestableObjectsRequest {
|
|
|
73015
73297
|
*/
|
|
73016
73298
|
export declare class RequestableObjectsV2024Api extends BaseAPI {
|
|
73017
73299
|
/**
|
|
73018
|
-
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
73300
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
73019
73301
|
* @summary Requestable objects list
|
|
73020
73302
|
* @param {RequestableObjectsV2024ApiListRequestableObjectsRequest} requestParameters Request parameters.
|
|
73021
73303
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -78644,13 +78926,12 @@ export declare const SourcesV2024ApiAxiosParamCreator: (configuration?: Configur
|
|
|
78644
78926
|
createSourceSchema: (sourceId: string, schemaV2024: SchemaV2024, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
78645
78927
|
/**
|
|
78646
78928
|
* Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc.
|
|
78647
|
-
* @summary Remove all accounts in
|
|
78929
|
+
* @summary Remove all accounts in source
|
|
78648
78930
|
* @param {string} id The source id
|
|
78649
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
78650
78931
|
* @param {*} [axiosOptions] Override http request option.
|
|
78651
78932
|
* @throws {RequiredError}
|
|
78652
78933
|
*/
|
|
78653
|
-
deleteAccountsAsync: (id: string,
|
|
78934
|
+
deleteAccountsAsync: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
78654
78935
|
/**
|
|
78655
78936
|
* Deletes the native change detection configuration for the source specified by the given ID.
|
|
78656
78937
|
* @summary Delete native change detection configuration
|
|
@@ -78826,13 +79107,12 @@ export declare const SourcesV2024ApiAxiosParamCreator: (configuration?: Configur
|
|
|
78826
79107
|
* Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`.
|
|
78827
79108
|
* @summary Account aggregation
|
|
78828
79109
|
* @param {string} id Source Id
|
|
78829
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
78830
79110
|
* @param {File} [file] The CSV file containing the source accounts to aggregate.
|
|
78831
79111
|
* @param {string} [disableOptimization] Use this flag to reprocess every account whether or not the data has changed.
|
|
78832
79112
|
* @param {*} [axiosOptions] Override http request option.
|
|
78833
79113
|
* @throws {RequiredError}
|
|
78834
79114
|
*/
|
|
78835
|
-
importAccounts: (id: string,
|
|
79115
|
+
importAccounts: (id: string, file?: File, disableOptimization?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
78836
79116
|
/**
|
|
78837
79117
|
* This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.**
|
|
78838
79118
|
* @summary Uploads source accounts schema template
|
|
@@ -78855,12 +79135,11 @@ export declare const SourcesV2024ApiAxiosParamCreator: (configuration?: Configur
|
|
|
78855
79135
|
* Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
78856
79136
|
* @summary Entitlement aggregation
|
|
78857
79137
|
* @param {string} sourceId Source Id
|
|
78858
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
78859
79138
|
* @param {File} [file] The CSV file containing the source entitlements to aggregate.
|
|
78860
79139
|
* @param {*} [axiosOptions] Override http request option.
|
|
78861
79140
|
* @throws {RequiredError}
|
|
78862
79141
|
*/
|
|
78863
|
-
importEntitlements: (sourceId: string,
|
|
79142
|
+
importEntitlements: (sourceId: string, file?: File, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
78864
79143
|
/**
|
|
78865
79144
|
* This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.**
|
|
78866
79145
|
* @summary Uploads source entitlements schema template
|
|
@@ -78875,12 +79154,11 @@ export declare const SourcesV2024ApiAxiosParamCreator: (configuration?: Configur
|
|
|
78875
79154
|
* File is required for upload. You will also need to set the Content-Type header to `multipart/form-data`
|
|
78876
79155
|
* @summary Process uncorrelated accounts
|
|
78877
79156
|
* @param {string} id Source Id
|
|
78878
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
78879
79157
|
* @param {File} [file]
|
|
78880
79158
|
* @param {*} [axiosOptions] Override http request option.
|
|
78881
79159
|
* @throws {RequiredError}
|
|
78882
79160
|
*/
|
|
78883
|
-
importUncorrelatedAccounts: (id: string,
|
|
79161
|
+
importUncorrelatedAccounts: (id: string, file?: File, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
78884
79162
|
/**
|
|
78885
79163
|
* This end-point lists all the ProvisioningPolicies in IdentityNow.
|
|
78886
79164
|
* @summary Lists provisioningpolicies
|
|
@@ -79112,13 +79390,12 @@ export declare const SourcesV2024ApiFp: (configuration?: Configuration) => {
|
|
|
79112
79390
|
createSourceSchema(sourceId: string, schemaV2024: SchemaV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SchemaV2024>>;
|
|
79113
79391
|
/**
|
|
79114
79392
|
* Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc.
|
|
79115
|
-
* @summary Remove all accounts in
|
|
79393
|
+
* @summary Remove all accounts in source
|
|
79116
79394
|
* @param {string} id The source id
|
|
79117
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
79118
79395
|
* @param {*} [axiosOptions] Override http request option.
|
|
79119
79396
|
* @throws {RequiredError}
|
|
79120
79397
|
*/
|
|
79121
|
-
deleteAccountsAsync(id: string,
|
|
79398
|
+
deleteAccountsAsync(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskResultDtoV2024>>;
|
|
79122
79399
|
/**
|
|
79123
79400
|
* Deletes the native change detection configuration for the source specified by the given ID.
|
|
79124
79401
|
* @summary Delete native change detection configuration
|
|
@@ -79294,13 +79571,12 @@ export declare const SourcesV2024ApiFp: (configuration?: Configuration) => {
|
|
|
79294
79571
|
* Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`.
|
|
79295
79572
|
* @summary Account aggregation
|
|
79296
79573
|
* @param {string} id Source Id
|
|
79297
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
79298
79574
|
* @param {File} [file] The CSV file containing the source accounts to aggregate.
|
|
79299
79575
|
* @param {string} [disableOptimization] Use this flag to reprocess every account whether or not the data has changed.
|
|
79300
79576
|
* @param {*} [axiosOptions] Override http request option.
|
|
79301
79577
|
* @throws {RequiredError}
|
|
79302
79578
|
*/
|
|
79303
|
-
importAccounts(id: string,
|
|
79579
|
+
importAccounts(id: string, file?: File, disableOptimization?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoadAccountsTaskV2024>>;
|
|
79304
79580
|
/**
|
|
79305
79581
|
* This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.**
|
|
79306
79582
|
* @summary Uploads source accounts schema template
|
|
@@ -79323,12 +79599,11 @@ export declare const SourcesV2024ApiFp: (configuration?: Configuration) => {
|
|
|
79323
79599
|
* Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
79324
79600
|
* @summary Entitlement aggregation
|
|
79325
79601
|
* @param {string} sourceId Source Id
|
|
79326
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
79327
79602
|
* @param {File} [file] The CSV file containing the source entitlements to aggregate.
|
|
79328
79603
|
* @param {*} [axiosOptions] Override http request option.
|
|
79329
79604
|
* @throws {RequiredError}
|
|
79330
79605
|
*/
|
|
79331
|
-
importEntitlements(sourceId: string,
|
|
79606
|
+
importEntitlements(sourceId: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoadEntitlementTaskV2024>>;
|
|
79332
79607
|
/**
|
|
79333
79608
|
* This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.**
|
|
79334
79609
|
* @summary Uploads source entitlements schema template
|
|
@@ -79343,12 +79618,11 @@ export declare const SourcesV2024ApiFp: (configuration?: Configuration) => {
|
|
|
79343
79618
|
* File is required for upload. You will also need to set the Content-Type header to `multipart/form-data`
|
|
79344
79619
|
* @summary Process uncorrelated accounts
|
|
79345
79620
|
* @param {string} id Source Id
|
|
79346
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
79347
79621
|
* @param {File} [file]
|
|
79348
79622
|
* @param {*} [axiosOptions] Override http request option.
|
|
79349
79623
|
* @throws {RequiredError}
|
|
79350
79624
|
*/
|
|
79351
|
-
importUncorrelatedAccounts(id: string,
|
|
79625
|
+
importUncorrelatedAccounts(id: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoadUncorrelatedAccountsTaskV2024>>;
|
|
79352
79626
|
/**
|
|
79353
79627
|
* This end-point lists all the ProvisioningPolicies in IdentityNow.
|
|
79354
79628
|
* @summary Lists provisioningpolicies
|
|
@@ -79576,7 +79850,7 @@ export declare const SourcesV2024ApiFactory: (configuration?: Configuration, bas
|
|
|
79576
79850
|
createSourceSchema(requestParameters: SourcesV2024ApiCreateSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SchemaV2024>;
|
|
79577
79851
|
/**
|
|
79578
79852
|
* Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc.
|
|
79579
|
-
* @summary Remove all accounts in
|
|
79853
|
+
* @summary Remove all accounts in source
|
|
79580
79854
|
* @param {SourcesV2024ApiDeleteAccountsAsyncRequest} requestParameters Request parameters.
|
|
79581
79855
|
* @param {*} [axiosOptions] Override http request option.
|
|
79582
79856
|
* @throws {RequiredError}
|
|
@@ -80039,12 +80313,6 @@ export interface SourcesV2024ApiDeleteAccountsAsyncRequest {
|
|
|
80039
80313
|
* @memberof SourcesV2024ApiDeleteAccountsAsync
|
|
80040
80314
|
*/
|
|
80041
80315
|
readonly id: string;
|
|
80042
|
-
/**
|
|
80043
|
-
* Use this header to enable this experimental API.
|
|
80044
|
-
* @type {string}
|
|
80045
|
-
* @memberof SourcesV2024ApiDeleteAccountsAsync
|
|
80046
|
-
*/
|
|
80047
|
-
readonly xSailPointExperimental?: string;
|
|
80048
80316
|
}
|
|
80049
80317
|
/**
|
|
80050
80318
|
* Request parameters for deleteNativeChangeDetectionConfig operation in SourcesV2024Api.
|
|
@@ -80384,12 +80652,6 @@ export interface SourcesV2024ApiImportAccountsRequest {
|
|
|
80384
80652
|
* @memberof SourcesV2024ApiImportAccounts
|
|
80385
80653
|
*/
|
|
80386
80654
|
readonly id: string;
|
|
80387
|
-
/**
|
|
80388
|
-
* Use this header to enable this experimental API.
|
|
80389
|
-
* @type {string}
|
|
80390
|
-
* @memberof SourcesV2024ApiImportAccounts
|
|
80391
|
-
*/
|
|
80392
|
-
readonly xSailPointExperimental?: string;
|
|
80393
80655
|
/**
|
|
80394
80656
|
* The CSV file containing the source accounts to aggregate.
|
|
80395
80657
|
* @type {File}
|
|
@@ -80453,12 +80715,6 @@ export interface SourcesV2024ApiImportEntitlementsRequest {
|
|
|
80453
80715
|
* @memberof SourcesV2024ApiImportEntitlements
|
|
80454
80716
|
*/
|
|
80455
80717
|
readonly sourceId: string;
|
|
80456
|
-
/**
|
|
80457
|
-
* Use this header to enable this experimental API.
|
|
80458
|
-
* @type {string}
|
|
80459
|
-
* @memberof SourcesV2024ApiImportEntitlements
|
|
80460
|
-
*/
|
|
80461
|
-
readonly xSailPointExperimental?: string;
|
|
80462
80718
|
/**
|
|
80463
80719
|
* The CSV file containing the source entitlements to aggregate.
|
|
80464
80720
|
* @type {File}
|
|
@@ -80503,12 +80759,6 @@ export interface SourcesV2024ApiImportUncorrelatedAccountsRequest {
|
|
|
80503
80759
|
* @memberof SourcesV2024ApiImportUncorrelatedAccounts
|
|
80504
80760
|
*/
|
|
80505
80761
|
readonly id: string;
|
|
80506
|
-
/**
|
|
80507
|
-
* Use this header to enable this experimental API.
|
|
80508
|
-
* @type {string}
|
|
80509
|
-
* @memberof SourcesV2024ApiImportUncorrelatedAccounts
|
|
80510
|
-
*/
|
|
80511
|
-
readonly xSailPointExperimental?: string;
|
|
80512
80762
|
/**
|
|
80513
80763
|
*
|
|
80514
80764
|
* @type {File}
|
|
@@ -80983,7 +81233,7 @@ export declare class SourcesV2024Api extends BaseAPI {
|
|
|
80983
81233
|
createSourceSchema(requestParameters: SourcesV2024ApiCreateSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SchemaV2024, any>>;
|
|
80984
81234
|
/**
|
|
80985
81235
|
* Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc.
|
|
80986
|
-
* @summary Remove all accounts in
|
|
81236
|
+
* @summary Remove all accounts in source
|
|
80987
81237
|
* @param {SourcesV2024ApiDeleteAccountsAsyncRequest} requestParameters Request parameters.
|
|
80988
81238
|
* @param {*} [axiosOptions] Override http request option.
|
|
80989
81239
|
* @throws {RequiredError}
|
|
@@ -82452,34 +82702,31 @@ export declare const TaskManagementV2024ApiAxiosParamCreator: (configuration?: C
|
|
|
82452
82702
|
/**
|
|
82453
82703
|
* Responds with headers only for list of task statuses for pending tasks.
|
|
82454
82704
|
* @summary Retrieve pending task list headers
|
|
82455
|
-
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
82456
82705
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
82457
82706
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
82458
82707
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
82459
82708
|
* @param {*} [axiosOptions] Override http request option.
|
|
82460
82709
|
* @throws {RequiredError}
|
|
82461
82710
|
*/
|
|
82462
|
-
getPendingTaskHeaders: (
|
|
82711
|
+
getPendingTaskHeaders: (offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82463
82712
|
/**
|
|
82464
82713
|
* Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
|
|
82465
82714
|
* @summary Retrieve pending task status list
|
|
82466
82715
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
82467
82716
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
82468
82717
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
82469
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82470
82718
|
* @param {*} [axiosOptions] Override http request option.
|
|
82471
82719
|
* @throws {RequiredError}
|
|
82472
82720
|
*/
|
|
82473
|
-
getPendingTasks: (offset?: number, limit?: number, count?: boolean,
|
|
82721
|
+
getPendingTasks: (offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82474
82722
|
/**
|
|
82475
82723
|
* Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
|
|
82476
82724
|
* @summary Get task status by id
|
|
82477
82725
|
* @param {string} id Task ID.
|
|
82478
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82479
82726
|
* @param {*} [axiosOptions] Override http request option.
|
|
82480
82727
|
* @throws {RequiredError}
|
|
82481
82728
|
*/
|
|
82482
|
-
getTaskStatus: (id: string,
|
|
82729
|
+
getTaskStatus: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82483
82730
|
/**
|
|
82484
82731
|
* Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) endpoint.
|
|
82485
82732
|
* @summary Retrieve task status list
|
|
@@ -82488,21 +82735,19 @@ export declare const TaskManagementV2024ApiAxiosParamCreator: (configuration?: C
|
|
|
82488
82735
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
82489
82736
|
* @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: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in*
|
|
82490
82737
|
* @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**
|
|
82491
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82492
82738
|
* @param {*} [axiosOptions] Override http request option.
|
|
82493
82739
|
* @throws {RequiredError}
|
|
82494
82740
|
*/
|
|
82495
|
-
getTaskStatusList: (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string,
|
|
82741
|
+
getTaskStatusList: (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82496
82742
|
/**
|
|
82497
82743
|
* Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
|
|
82498
82744
|
* @summary Update task status by id
|
|
82499
82745
|
* @param {string} id Task ID.
|
|
82500
|
-
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
82501
82746
|
* @param {Array<JsonPatchOperationV2024>} jsonPatchOperationV2024 The JSONPatch payload used to update the object.
|
|
82502
82747
|
* @param {*} [axiosOptions] Override http request option.
|
|
82503
82748
|
* @throws {RequiredError}
|
|
82504
82749
|
*/
|
|
82505
|
-
updateTaskStatus: (id: string,
|
|
82750
|
+
updateTaskStatus: (id: string, jsonPatchOperationV2024: Array<JsonPatchOperationV2024>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82506
82751
|
};
|
|
82507
82752
|
/**
|
|
82508
82753
|
* TaskManagementV2024Api - functional programming interface
|
|
@@ -82512,34 +82757,31 @@ export declare const TaskManagementV2024ApiFp: (configuration?: Configuration) =
|
|
|
82512
82757
|
/**
|
|
82513
82758
|
* Responds with headers only for list of task statuses for pending tasks.
|
|
82514
82759
|
* @summary Retrieve pending task list headers
|
|
82515
|
-
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
82516
82760
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
82517
82761
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
82518
82762
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
82519
82763
|
* @param {*} [axiosOptions] Override http request option.
|
|
82520
82764
|
* @throws {RequiredError}
|
|
82521
82765
|
*/
|
|
82522
|
-
getPendingTaskHeaders(
|
|
82766
|
+
getPendingTaskHeaders(offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
82523
82767
|
/**
|
|
82524
82768
|
* Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
|
|
82525
82769
|
* @summary Retrieve pending task status list
|
|
82526
82770
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
82527
82771
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
82528
82772
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
82529
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82530
82773
|
* @param {*} [axiosOptions] Override http request option.
|
|
82531
82774
|
* @throws {RequiredError}
|
|
82532
82775
|
*/
|
|
82533
|
-
getPendingTasks(offset?: number, limit?: number, count?: boolean,
|
|
82776
|
+
getPendingTasks(offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TaskStatusV2024>>>;
|
|
82534
82777
|
/**
|
|
82535
82778
|
* Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
|
|
82536
82779
|
* @summary Get task status by id
|
|
82537
82780
|
* @param {string} id Task ID.
|
|
82538
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82539
82781
|
* @param {*} [axiosOptions] Override http request option.
|
|
82540
82782
|
* @throws {RequiredError}
|
|
82541
82783
|
*/
|
|
82542
|
-
getTaskStatus(id: string,
|
|
82784
|
+
getTaskStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskStatusV2024>>;
|
|
82543
82785
|
/**
|
|
82544
82786
|
* Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) endpoint.
|
|
82545
82787
|
* @summary Retrieve task status list
|
|
@@ -82548,21 +82790,19 @@ export declare const TaskManagementV2024ApiFp: (configuration?: Configuration) =
|
|
|
82548
82790
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
82549
82791
|
* @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: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in*
|
|
82550
82792
|
* @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**
|
|
82551
|
-
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
82552
82793
|
* @param {*} [axiosOptions] Override http request option.
|
|
82553
82794
|
* @throws {RequiredError}
|
|
82554
82795
|
*/
|
|
82555
|
-
getTaskStatusList(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string,
|
|
82796
|
+
getTaskStatusList(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TaskStatusV2024>>>;
|
|
82556
82797
|
/**
|
|
82557
82798
|
* Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
|
|
82558
82799
|
* @summary Update task status by id
|
|
82559
82800
|
* @param {string} id Task ID.
|
|
82560
|
-
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
82561
82801
|
* @param {Array<JsonPatchOperationV2024>} jsonPatchOperationV2024 The JSONPatch payload used to update the object.
|
|
82562
82802
|
* @param {*} [axiosOptions] Override http request option.
|
|
82563
82803
|
* @throws {RequiredError}
|
|
82564
82804
|
*/
|
|
82565
|
-
updateTaskStatus(id: string,
|
|
82805
|
+
updateTaskStatus(id: string, jsonPatchOperationV2024: Array<JsonPatchOperationV2024>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskStatusV2024>>;
|
|
82566
82806
|
};
|
|
82567
82807
|
/**
|
|
82568
82808
|
* TaskManagementV2024Api - factory interface
|
|
@@ -82576,7 +82816,7 @@ export declare const TaskManagementV2024ApiFactory: (configuration?: Configurati
|
|
|
82576
82816
|
* @param {*} [axiosOptions] Override http request option.
|
|
82577
82817
|
* @throws {RequiredError}
|
|
82578
82818
|
*/
|
|
82579
|
-
getPendingTaskHeaders(requestParameters
|
|
82819
|
+
getPendingTaskHeaders(requestParameters?: TaskManagementV2024ApiGetPendingTaskHeadersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
82580
82820
|
/**
|
|
82581
82821
|
* Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
|
|
82582
82822
|
* @summary Retrieve pending task status list
|
|
@@ -82616,12 +82856,6 @@ export declare const TaskManagementV2024ApiFactory: (configuration?: Configurati
|
|
|
82616
82856
|
* @interface TaskManagementV2024ApiGetPendingTaskHeadersRequest
|
|
82617
82857
|
*/
|
|
82618
82858
|
export interface TaskManagementV2024ApiGetPendingTaskHeadersRequest {
|
|
82619
|
-
/**
|
|
82620
|
-
* Use this header to enable this experimental API.
|
|
82621
|
-
* @type {string}
|
|
82622
|
-
* @memberof TaskManagementV2024ApiGetPendingTaskHeaders
|
|
82623
|
-
*/
|
|
82624
|
-
readonly xSailPointExperimental: string;
|
|
82625
82859
|
/**
|
|
82626
82860
|
* Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
82627
82861
|
* @type {number}
|
|
@@ -82665,12 +82899,6 @@ export interface TaskManagementV2024ApiGetPendingTasksRequest {
|
|
|
82665
82899
|
* @memberof TaskManagementV2024ApiGetPendingTasks
|
|
82666
82900
|
*/
|
|
82667
82901
|
readonly count?: boolean;
|
|
82668
|
-
/**
|
|
82669
|
-
* Use this header to enable this experimental API.
|
|
82670
|
-
* @type {string}
|
|
82671
|
-
* @memberof TaskManagementV2024ApiGetPendingTasks
|
|
82672
|
-
*/
|
|
82673
|
-
readonly xSailPointExperimental?: string;
|
|
82674
82902
|
}
|
|
82675
82903
|
/**
|
|
82676
82904
|
* Request parameters for getTaskStatus operation in TaskManagementV2024Api.
|
|
@@ -82684,12 +82912,6 @@ export interface TaskManagementV2024ApiGetTaskStatusRequest {
|
|
|
82684
82912
|
* @memberof TaskManagementV2024ApiGetTaskStatus
|
|
82685
82913
|
*/
|
|
82686
82914
|
readonly id: string;
|
|
82687
|
-
/**
|
|
82688
|
-
* Use this header to enable this experimental API.
|
|
82689
|
-
* @type {string}
|
|
82690
|
-
* @memberof TaskManagementV2024ApiGetTaskStatus
|
|
82691
|
-
*/
|
|
82692
|
-
readonly xSailPointExperimental?: string;
|
|
82693
82915
|
}
|
|
82694
82916
|
/**
|
|
82695
82917
|
* Request parameters for getTaskStatusList operation in TaskManagementV2024Api.
|
|
@@ -82727,12 +82949,6 @@ export interface TaskManagementV2024ApiGetTaskStatusListRequest {
|
|
|
82727
82949
|
* @memberof TaskManagementV2024ApiGetTaskStatusList
|
|
82728
82950
|
*/
|
|
82729
82951
|
readonly sorters?: string;
|
|
82730
|
-
/**
|
|
82731
|
-
* Use this header to enable this experimental API.
|
|
82732
|
-
* @type {string}
|
|
82733
|
-
* @memberof TaskManagementV2024ApiGetTaskStatusList
|
|
82734
|
-
*/
|
|
82735
|
-
readonly xSailPointExperimental?: string;
|
|
82736
82952
|
}
|
|
82737
82953
|
/**
|
|
82738
82954
|
* Request parameters for updateTaskStatus operation in TaskManagementV2024Api.
|
|
@@ -82746,12 +82962,6 @@ export interface TaskManagementV2024ApiUpdateTaskStatusRequest {
|
|
|
82746
82962
|
* @memberof TaskManagementV2024ApiUpdateTaskStatus
|
|
82747
82963
|
*/
|
|
82748
82964
|
readonly id: string;
|
|
82749
|
-
/**
|
|
82750
|
-
* Use this header to enable this experimental API.
|
|
82751
|
-
* @type {string}
|
|
82752
|
-
* @memberof TaskManagementV2024ApiUpdateTaskStatus
|
|
82753
|
-
*/
|
|
82754
|
-
readonly xSailPointExperimental: string;
|
|
82755
82965
|
/**
|
|
82756
82966
|
* The JSONPatch payload used to update the object.
|
|
82757
82967
|
* @type {Array<JsonPatchOperationV2024>}
|
|
@@ -82774,7 +82984,7 @@ export declare class TaskManagementV2024Api extends BaseAPI {
|
|
|
82774
82984
|
* @throws {RequiredError}
|
|
82775
82985
|
* @memberof TaskManagementV2024Api
|
|
82776
82986
|
*/
|
|
82777
|
-
getPendingTaskHeaders(requestParameters
|
|
82987
|
+
getPendingTaskHeaders(requestParameters?: TaskManagementV2024ApiGetPendingTaskHeadersRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
82778
82988
|
/**
|
|
82779
82989
|
* Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned.
|
|
82780
82990
|
* @summary Retrieve pending task status list
|
|
@@ -85578,12 +85788,11 @@ export declare const WorkflowsV2024ApiAxiosParamCreator: (configuration?: Config
|
|
|
85578
85788
|
* @param {string} id Workflow ID.
|
|
85579
85789
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
85580
85790
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
85581
|
-
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
85582
85791
|
* @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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq*
|
|
85583
85792
|
* @param {*} [axiosOptions] Override http request option.
|
|
85584
85793
|
* @throws {RequiredError}
|
|
85585
85794
|
*/
|
|
85586
|
-
getWorkflowExecutions: (id: string, limit?: number, offset?: number,
|
|
85795
|
+
getWorkflowExecutions: (id: string, limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
85587
85796
|
/**
|
|
85588
85797
|
* This lists all triggers, actions, and operators in the library
|
|
85589
85798
|
* @summary List complete workflow library
|
|
@@ -85740,12 +85949,11 @@ export declare const WorkflowsV2024ApiFp: (configuration?: Configuration) => {
|
|
|
85740
85949
|
* @param {string} id Workflow ID.
|
|
85741
85950
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
85742
85951
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
85743
|
-
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
85744
85952
|
* @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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq*
|
|
85745
85953
|
* @param {*} [axiosOptions] Override http request option.
|
|
85746
85954
|
* @throws {RequiredError}
|
|
85747
85955
|
*/
|
|
85748
|
-
getWorkflowExecutions(id: string, limit?: number, offset?: number,
|
|
85956
|
+
getWorkflowExecutions(id: string, limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WorkflowExecutionV2024>>>;
|
|
85749
85957
|
/**
|
|
85750
85958
|
* This lists all triggers, actions, and operators in the library
|
|
85751
85959
|
* @summary List complete workflow library
|
|
@@ -86108,12 +86316,6 @@ export interface WorkflowsV2024ApiGetWorkflowExecutionsRequest {
|
|
|
86108
86316
|
* @memberof WorkflowsV2024ApiGetWorkflowExecutions
|
|
86109
86317
|
*/
|
|
86110
86318
|
readonly offset?: number;
|
|
86111
|
-
/**
|
|
86112
|
-
* If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
86113
|
-
* @type {boolean}
|
|
86114
|
-
* @memberof WorkflowsV2024ApiGetWorkflowExecutions
|
|
86115
|
-
*/
|
|
86116
|
-
readonly count?: boolean;
|
|
86117
86319
|
/**
|
|
86118
86320
|
* 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq*
|
|
86119
86321
|
* @type {string}
|