@sailpoint/api-client 2.2.12 → 2.2.14
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/dist/access_profiles/api.d.ts +309 -169
- package/dist/access_profiles/api.js +158 -44
- package/dist/access_profiles/api.js.map +1 -1
- package/dist/data_access_security/api.d.ts +550 -20
- package/dist/data_access_security/api.js +540 -21
- package/dist/data_access_security/api.js.map +1 -1
- package/dist/esm/access_profiles/api.js +157 -43
- package/dist/esm/data_access_security/api.js +539 -20
- package/dist/esm/nerm/common.js +2 -2
- package/dist/esm/nermv2025/common.js +2 -2
- package/dist/nerm/common.js +2 -2
- package/dist/nerm/common.js.map +1 -1
- package/dist/nermv2025/common.js +2 -2
- package/dist/nermv2025/common.js.map +1 -1
- package/package.json +1 -1
|
@@ -317,296 +317,226 @@ export interface AccessProfileBulkUpdateRequestInner {
|
|
|
317
317
|
'requestable'?: boolean;
|
|
318
318
|
}
|
|
319
319
|
/**
|
|
320
|
-
*
|
|
321
|
-
* @export
|
|
322
|
-
* @interface AccessProfileSourceRef
|
|
323
|
-
*/
|
|
324
|
-
export interface AccessProfileSourceRef {
|
|
325
|
-
/**
|
|
326
|
-
* ID of the source the access profile is associated with.
|
|
327
|
-
* @type {string}
|
|
328
|
-
* @memberof AccessProfileSourceRef
|
|
329
|
-
*/
|
|
330
|
-
'id'?: string;
|
|
331
|
-
/**
|
|
332
|
-
* Source\'s DTO type.
|
|
333
|
-
* @type {string}
|
|
334
|
-
* @memberof AccessProfileSourceRef
|
|
335
|
-
*/
|
|
336
|
-
'type'?: AccessProfileSourceRefTypeEnum;
|
|
337
|
-
/**
|
|
338
|
-
* Source name.
|
|
339
|
-
* @type {string}
|
|
340
|
-
* @memberof AccessProfileSourceRef
|
|
341
|
-
*/
|
|
342
|
-
'name'?: string;
|
|
343
|
-
}
|
|
344
|
-
export declare const AccessProfileSourceRefTypeEnum: {
|
|
345
|
-
readonly Source: "SOURCE";
|
|
346
|
-
};
|
|
347
|
-
export type AccessProfileSourceRefTypeEnum = typeof AccessProfileSourceRefTypeEnum[keyof typeof AccessProfileSourceRefTypeEnum];
|
|
348
|
-
/**
|
|
349
|
-
*
|
|
320
|
+
* Filter criteria and Access Model Metadata key/values used to select access profiles.
|
|
350
321
|
* @export
|
|
351
|
-
* @interface
|
|
322
|
+
* @interface AccessProfileListFilterDTO
|
|
352
323
|
*/
|
|
353
|
-
export interface
|
|
324
|
+
export interface AccessProfileListFilterDTO {
|
|
354
325
|
/**
|
|
355
|
-
*
|
|
356
|
-
* @type {string}
|
|
357
|
-
* @memberof AccessProfileUpdateItem
|
|
358
|
-
*/
|
|
359
|
-
'id': string;
|
|
360
|
-
/**
|
|
361
|
-
* Access Profile requestable or not.
|
|
362
|
-
* @type {boolean}
|
|
363
|
-
* @memberof AccessProfileUpdateItem
|
|
364
|
-
*/
|
|
365
|
-
'requestable': boolean;
|
|
366
|
-
/**
|
|
367
|
-
* The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation. > 201 - Access profile is updated successfully. > 404 - Access profile not found.
|
|
326
|
+
* 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, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or*
|
|
368
327
|
* @type {string}
|
|
369
|
-
* @memberof
|
|
328
|
+
* @memberof AccessProfileListFilterDTO
|
|
370
329
|
*/
|
|
371
|
-
'
|
|
330
|
+
'filters'?: string | null;
|
|
372
331
|
/**
|
|
373
|
-
*
|
|
374
|
-
* @type {
|
|
375
|
-
* @memberof
|
|
332
|
+
* The Access Model Metadata attributes and values used to filter the results.
|
|
333
|
+
* @type {Array<AccessProfileListFilterDTOAmmKeyValuesInner>}
|
|
334
|
+
* @memberof AccessProfileListFilterDTO
|
|
376
335
|
*/
|
|
377
|
-
'
|
|
336
|
+
'ammKeyValues'?: Array<AccessProfileListFilterDTOAmmKeyValuesInner> | null;
|
|
378
337
|
}
|
|
379
338
|
/**
|
|
380
339
|
*
|
|
381
340
|
* @export
|
|
382
|
-
* @interface
|
|
383
|
-
*/
|
|
384
|
-
export interface AccessProfileUsage {
|
|
385
|
-
/**
|
|
386
|
-
* ID of the Access Profile that is in use
|
|
387
|
-
* @type {string}
|
|
388
|
-
* @memberof AccessProfileUsage
|
|
389
|
-
*/
|
|
390
|
-
'accessProfileId'?: string;
|
|
391
|
-
/**
|
|
392
|
-
* List of references to objects which are using the indicated Access Profile
|
|
393
|
-
* @type {Array<AccessProfileUsageUsedByInner>}
|
|
394
|
-
* @memberof AccessProfileUsage
|
|
395
|
-
*/
|
|
396
|
-
'usedBy'?: Array<AccessProfileUsageUsedByInner>;
|
|
397
|
-
}
|
|
398
|
-
/**
|
|
399
|
-
* Role using the access profile.
|
|
400
|
-
* @export
|
|
401
|
-
* @interface AccessProfileUsageUsedByInner
|
|
341
|
+
* @interface AccessProfileListFilterDTOAmmKeyValuesInner
|
|
402
342
|
*/
|
|
403
|
-
export interface
|
|
343
|
+
export interface AccessProfileListFilterDTOAmmKeyValuesInner {
|
|
404
344
|
/**
|
|
405
|
-
*
|
|
345
|
+
* The technical name of the metadata attribute. A blank or missing value is rejected with a 400 error.
|
|
406
346
|
* @type {string}
|
|
407
|
-
* @memberof
|
|
347
|
+
* @memberof AccessProfileListFilterDTOAmmKeyValuesInner
|
|
408
348
|
*/
|
|
409
|
-
'
|
|
410
|
-
/**
|
|
411
|
-
* ID of role using the access profile.
|
|
412
|
-
* @type {string}
|
|
413
|
-
* @memberof AccessProfileUsageUsedByInner
|
|
414
|
-
*/
|
|
415
|
-
'id'?: string;
|
|
349
|
+
'attribute'?: string;
|
|
416
350
|
/**
|
|
417
|
-
*
|
|
418
|
-
* @type {string}
|
|
419
|
-
* @memberof
|
|
351
|
+
* The attribute values used to filter access profiles. If the list is empty, results are filtered by attribute key only.
|
|
352
|
+
* @type {Array<string>}
|
|
353
|
+
* @memberof AccessProfileListFilterDTOAmmKeyValuesInner
|
|
420
354
|
*/
|
|
421
|
-
'
|
|
355
|
+
'values'?: Array<string>;
|
|
422
356
|
}
|
|
423
|
-
export declare const AccessProfileUsageUsedByInnerTypeEnum: {
|
|
424
|
-
readonly Role: "ROLE";
|
|
425
|
-
};
|
|
426
|
-
export type AccessProfileUsageUsedByInnerTypeEnum = typeof AccessProfileUsageUsedByInnerTypeEnum[keyof typeof AccessProfileUsageUsedByInnerTypeEnum];
|
|
427
357
|
/**
|
|
428
358
|
* Request to bulk update Access Model Metadata on every access profile matching a filter expression. A single access profile cannot be assigned more than 25 metadata values. Adding or replacing custom metadata requires a suite license.
|
|
429
359
|
* @export
|
|
430
|
-
* @interface
|
|
360
|
+
* @interface AccessProfileMetadataBulkUpdateByFilterRequest
|
|
431
361
|
*/
|
|
432
|
-
export interface
|
|
362
|
+
export interface AccessProfileMetadataBulkUpdateByFilterRequest {
|
|
433
363
|
/**
|
|
434
364
|
* 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, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or*
|
|
435
365
|
* @type {string}
|
|
436
|
-
* @memberof
|
|
366
|
+
* @memberof AccessProfileMetadataBulkUpdateByFilterRequest
|
|
437
367
|
*/
|
|
438
368
|
'filters': string;
|
|
439
369
|
/**
|
|
440
370
|
* The operation to be performed
|
|
441
371
|
* @type {string}
|
|
442
|
-
* @memberof
|
|
372
|
+
* @memberof AccessProfileMetadataBulkUpdateByFilterRequest
|
|
443
373
|
*/
|
|
444
|
-
'operation':
|
|
374
|
+
'operation': AccessProfileMetadataBulkUpdateByFilterRequestOperationEnum;
|
|
445
375
|
/**
|
|
446
376
|
* The choice of update scope. **ATTRIBUTE** replaces only the values of the attributes named in `values`, and **ALL** replaces every metadata attribute on the access profile.
|
|
447
377
|
* @type {string}
|
|
448
|
-
* @memberof
|
|
378
|
+
* @memberof AccessProfileMetadataBulkUpdateByFilterRequest
|
|
449
379
|
*/
|
|
450
|
-
'replaceScope':
|
|
380
|
+
'replaceScope': AccessProfileMetadataBulkUpdateByFilterRequestReplaceScopeEnum;
|
|
451
381
|
/**
|
|
452
382
|
* The metadata to be updated, including attribute key and value.
|
|
453
|
-
* @type {Array<
|
|
454
|
-
* @memberof
|
|
383
|
+
* @type {Array<AccessProfileMetadataBulkUpdateByIdRequestValuesInner>}
|
|
384
|
+
* @memberof AccessProfileMetadataBulkUpdateByFilterRequest
|
|
455
385
|
*/
|
|
456
|
-
'values': Array<
|
|
386
|
+
'values': Array<AccessProfileMetadataBulkUpdateByIdRequestValuesInner>;
|
|
457
387
|
}
|
|
458
|
-
export declare const
|
|
388
|
+
export declare const AccessProfileMetadataBulkUpdateByFilterRequestOperationEnum: {
|
|
459
389
|
readonly Add: "ADD";
|
|
460
390
|
readonly Remove: "REMOVE";
|
|
461
391
|
readonly Replace: "REPLACE";
|
|
462
392
|
};
|
|
463
|
-
export type
|
|
464
|
-
export declare const
|
|
393
|
+
export type AccessProfileMetadataBulkUpdateByFilterRequestOperationEnum = typeof AccessProfileMetadataBulkUpdateByFilterRequestOperationEnum[keyof typeof AccessProfileMetadataBulkUpdateByFilterRequestOperationEnum];
|
|
394
|
+
export declare const AccessProfileMetadataBulkUpdateByFilterRequestReplaceScopeEnum: {
|
|
465
395
|
readonly All: "ALL";
|
|
466
396
|
readonly Attribute: "ATTRIBUTE";
|
|
467
397
|
};
|
|
468
|
-
export type
|
|
398
|
+
export type AccessProfileMetadataBulkUpdateByFilterRequestReplaceScopeEnum = typeof AccessProfileMetadataBulkUpdateByFilterRequestReplaceScopeEnum[keyof typeof AccessProfileMetadataBulkUpdateByFilterRequestReplaceScopeEnum];
|
|
469
399
|
/**
|
|
470
400
|
* Request to bulk update Access Model Metadata on a list of access profiles identified by ID. The maximum access profile count in a single request is 3000. A single access profile cannot be assigned more than 25 metadata values. Adding or replacing custom metadata requires a suite license.
|
|
471
401
|
* @export
|
|
472
|
-
* @interface
|
|
402
|
+
* @interface AccessProfileMetadataBulkUpdateByIdRequest
|
|
473
403
|
*/
|
|
474
|
-
export interface
|
|
404
|
+
export interface AccessProfileMetadataBulkUpdateByIdRequest {
|
|
475
405
|
/**
|
|
476
406
|
* The IDs of the access profiles to update.
|
|
477
407
|
* @type {Array<string>}
|
|
478
|
-
* @memberof
|
|
408
|
+
* @memberof AccessProfileMetadataBulkUpdateByIdRequest
|
|
479
409
|
*/
|
|
480
410
|
'accessProfiles': Array<string>;
|
|
481
411
|
/**
|
|
482
412
|
* The operation to be performed
|
|
483
413
|
* @type {string}
|
|
484
|
-
* @memberof
|
|
414
|
+
* @memberof AccessProfileMetadataBulkUpdateByIdRequest
|
|
485
415
|
*/
|
|
486
|
-
'operation':
|
|
416
|
+
'operation': AccessProfileMetadataBulkUpdateByIdRequestOperationEnum;
|
|
487
417
|
/**
|
|
488
418
|
* The choice of update scope. **ATTRIBUTE** replaces only the values of the attributes named in `values`, and **ALL** replaces every metadata attribute on the access profile.
|
|
489
419
|
* @type {string}
|
|
490
|
-
* @memberof
|
|
420
|
+
* @memberof AccessProfileMetadataBulkUpdateByIdRequest
|
|
491
421
|
*/
|
|
492
|
-
'replaceScope':
|
|
422
|
+
'replaceScope': AccessProfileMetadataBulkUpdateByIdRequestReplaceScopeEnum;
|
|
493
423
|
/**
|
|
494
424
|
* The metadata to be updated, including attribute key and value.
|
|
495
|
-
* @type {Array<
|
|
496
|
-
* @memberof
|
|
425
|
+
* @type {Array<AccessProfileMetadataBulkUpdateByIdRequestValuesInner>}
|
|
426
|
+
* @memberof AccessProfileMetadataBulkUpdateByIdRequest
|
|
497
427
|
*/
|
|
498
|
-
'values': Array<
|
|
428
|
+
'values': Array<AccessProfileMetadataBulkUpdateByIdRequestValuesInner>;
|
|
499
429
|
}
|
|
500
|
-
export declare const
|
|
430
|
+
export declare const AccessProfileMetadataBulkUpdateByIdRequestOperationEnum: {
|
|
501
431
|
readonly Add: "ADD";
|
|
502
432
|
readonly Remove: "REMOVE";
|
|
503
433
|
readonly Replace: "REPLACE";
|
|
504
434
|
};
|
|
505
|
-
export type
|
|
506
|
-
export declare const
|
|
435
|
+
export type AccessProfileMetadataBulkUpdateByIdRequestOperationEnum = typeof AccessProfileMetadataBulkUpdateByIdRequestOperationEnum[keyof typeof AccessProfileMetadataBulkUpdateByIdRequestOperationEnum];
|
|
436
|
+
export declare const AccessProfileMetadataBulkUpdateByIdRequestReplaceScopeEnum: {
|
|
507
437
|
readonly All: "ALL";
|
|
508
438
|
readonly Attribute: "ATTRIBUTE";
|
|
509
439
|
};
|
|
510
|
-
export type
|
|
440
|
+
export type AccessProfileMetadataBulkUpdateByIdRequestReplaceScopeEnum = typeof AccessProfileMetadataBulkUpdateByIdRequestReplaceScopeEnum[keyof typeof AccessProfileMetadataBulkUpdateByIdRequestReplaceScopeEnum];
|
|
511
441
|
/**
|
|
512
442
|
*
|
|
513
443
|
* @export
|
|
514
|
-
* @interface
|
|
444
|
+
* @interface AccessProfileMetadataBulkUpdateByIdRequestValuesInner
|
|
515
445
|
*/
|
|
516
|
-
export interface
|
|
446
|
+
export interface AccessProfileMetadataBulkUpdateByIdRequestValuesInner {
|
|
517
447
|
/**
|
|
518
448
|
* The technical name of the metadata attribute.
|
|
519
449
|
* @type {string}
|
|
520
|
-
* @memberof
|
|
450
|
+
* @memberof AccessProfileMetadataBulkUpdateByIdRequestValuesInner
|
|
521
451
|
*/
|
|
522
452
|
'attribute': string;
|
|
523
453
|
/**
|
|
524
454
|
* The values of the attribute to be updated.
|
|
525
455
|
* @type {Array<string>}
|
|
526
|
-
* @memberof
|
|
456
|
+
* @memberof AccessProfileMetadataBulkUpdateByIdRequestValuesInner
|
|
527
457
|
*/
|
|
528
458
|
'values': Array<string> | null;
|
|
529
459
|
/**
|
|
530
460
|
* The type of the metadata attribute. Set to `custom` for custom metadata attributes, which require a suite license.
|
|
531
461
|
* @type {string}
|
|
532
|
-
* @memberof
|
|
462
|
+
* @memberof AccessProfileMetadataBulkUpdateByIdRequestValuesInner
|
|
533
463
|
*/
|
|
534
464
|
'objectType'?: string;
|
|
535
465
|
}
|
|
536
466
|
/**
|
|
537
467
|
* Request to bulk update Access Model Metadata on every access profile matching a search query. A single access profile cannot be assigned more than 25 metadata values. Adding or replacing custom metadata requires a suite license. For more information about the query object, refer to [V3 API Perform Search](https://developer.sailpoint.com/docs/api/v3/search-post).
|
|
538
468
|
* @export
|
|
539
|
-
* @interface
|
|
469
|
+
* @interface AccessProfileMetadataBulkUpdateByQueryRequest
|
|
540
470
|
*/
|
|
541
|
-
export interface
|
|
471
|
+
export interface AccessProfileMetadataBulkUpdateByQueryRequest {
|
|
542
472
|
/**
|
|
543
473
|
* The search query selecting the access profiles to update.
|
|
544
474
|
* @type {object}
|
|
545
|
-
* @memberof
|
|
475
|
+
* @memberof AccessProfileMetadataBulkUpdateByQueryRequest
|
|
546
476
|
*/
|
|
547
477
|
'query': object;
|
|
548
478
|
/**
|
|
549
479
|
* The operation to be performed
|
|
550
480
|
* @type {string}
|
|
551
|
-
* @memberof
|
|
481
|
+
* @memberof AccessProfileMetadataBulkUpdateByQueryRequest
|
|
552
482
|
*/
|
|
553
|
-
'operation':
|
|
483
|
+
'operation': AccessProfileMetadataBulkUpdateByQueryRequestOperationEnum;
|
|
554
484
|
/**
|
|
555
485
|
* The choice of update scope. **ATTRIBUTE** replaces only the values of the attributes named in `values`, and **ALL** replaces every metadata attribute on the access profile.
|
|
556
486
|
* @type {string}
|
|
557
|
-
* @memberof
|
|
487
|
+
* @memberof AccessProfileMetadataBulkUpdateByQueryRequest
|
|
558
488
|
*/
|
|
559
|
-
'replaceScope':
|
|
489
|
+
'replaceScope': AccessProfileMetadataBulkUpdateByQueryRequestReplaceScopeEnum;
|
|
560
490
|
/**
|
|
561
491
|
* The metadata to be updated, including attribute key and value.
|
|
562
|
-
* @type {Array<
|
|
563
|
-
* @memberof
|
|
492
|
+
* @type {Array<AccessProfileMetadataBulkUpdateByIdRequestValuesInner>}
|
|
493
|
+
* @memberof AccessProfileMetadataBulkUpdateByQueryRequest
|
|
564
494
|
*/
|
|
565
|
-
'values': Array<
|
|
495
|
+
'values': Array<AccessProfileMetadataBulkUpdateByIdRequestValuesInner>;
|
|
566
496
|
}
|
|
567
|
-
export declare const
|
|
497
|
+
export declare const AccessProfileMetadataBulkUpdateByQueryRequestOperationEnum: {
|
|
568
498
|
readonly Add: "ADD";
|
|
569
499
|
readonly Remove: "REMOVE";
|
|
570
500
|
readonly Replace: "REPLACE";
|
|
571
501
|
};
|
|
572
|
-
export type
|
|
573
|
-
export declare const
|
|
502
|
+
export type AccessProfileMetadataBulkUpdateByQueryRequestOperationEnum = typeof AccessProfileMetadataBulkUpdateByQueryRequestOperationEnum[keyof typeof AccessProfileMetadataBulkUpdateByQueryRequestOperationEnum];
|
|
503
|
+
export declare const AccessProfileMetadataBulkUpdateByQueryRequestReplaceScopeEnum: {
|
|
574
504
|
readonly All: "ALL";
|
|
575
505
|
readonly Attribute: "ATTRIBUTE";
|
|
576
506
|
};
|
|
577
|
-
export type
|
|
507
|
+
export type AccessProfileMetadataBulkUpdateByQueryRequestReplaceScopeEnum = typeof AccessProfileMetadataBulkUpdateByQueryRequestReplaceScopeEnum[keyof typeof AccessProfileMetadataBulkUpdateByQueryRequestReplaceScopeEnum];
|
|
578
508
|
/**
|
|
579
509
|
*
|
|
580
510
|
* @export
|
|
581
|
-
* @interface
|
|
511
|
+
* @interface AccessProfileMetadataBulkUpdateResponse
|
|
582
512
|
*/
|
|
583
|
-
export interface
|
|
513
|
+
export interface AccessProfileMetadataBulkUpdateResponse {
|
|
584
514
|
/**
|
|
585
515
|
* ID of the task that is processing the bulk update.
|
|
586
516
|
* @type {string}
|
|
587
|
-
* @memberof
|
|
517
|
+
* @memberof AccessProfileMetadataBulkUpdateResponse
|
|
588
518
|
*/
|
|
589
519
|
'id'?: string;
|
|
590
520
|
/**
|
|
591
521
|
* Type of the object the bulk update applies to.
|
|
592
522
|
* @type {string}
|
|
593
|
-
* @memberof
|
|
523
|
+
* @memberof AccessProfileMetadataBulkUpdateResponse
|
|
594
524
|
*/
|
|
595
525
|
'type'?: string;
|
|
596
526
|
/**
|
|
597
527
|
* The status of the bulk update request.
|
|
598
528
|
* @type {string}
|
|
599
|
-
* @memberof
|
|
529
|
+
* @memberof AccessProfileMetadataBulkUpdateResponse
|
|
600
530
|
*/
|
|
601
|
-
'status'?:
|
|
531
|
+
'status'?: AccessProfileMetadataBulkUpdateResponseStatusEnum;
|
|
602
532
|
/**
|
|
603
533
|
* Time when the bulk update request was created
|
|
604
534
|
* @type {string}
|
|
605
|
-
* @memberof
|
|
535
|
+
* @memberof AccessProfileMetadataBulkUpdateResponse
|
|
606
536
|
*/
|
|
607
537
|
'created'?: string;
|
|
608
538
|
}
|
|
609
|
-
export declare const
|
|
539
|
+
export declare const AccessProfileMetadataBulkUpdateResponseStatusEnum: {
|
|
610
540
|
readonly Created: "CREATED";
|
|
611
541
|
readonly PreProcess: "PRE_PROCESS";
|
|
612
542
|
readonly PreProcessCompleted: "PRE_PROCESS_COMPLETED";
|
|
@@ -618,7 +548,115 @@ export declare const AccessprofilemetadatabulkupdateresponseStatusEnum: {
|
|
|
618
548
|
readonly PreProcessFailed: "PRE_PROCESS_FAILED";
|
|
619
549
|
readonly Failed: "FAILED";
|
|
620
550
|
};
|
|
621
|
-
export type
|
|
551
|
+
export type AccessProfileMetadataBulkUpdateResponseStatusEnum = typeof AccessProfileMetadataBulkUpdateResponseStatusEnum[keyof typeof AccessProfileMetadataBulkUpdateResponseStatusEnum];
|
|
552
|
+
/**
|
|
553
|
+
*
|
|
554
|
+
* @export
|
|
555
|
+
* @interface AccessProfileSourceRef
|
|
556
|
+
*/
|
|
557
|
+
export interface AccessProfileSourceRef {
|
|
558
|
+
/**
|
|
559
|
+
* ID of the source the access profile is associated with.
|
|
560
|
+
* @type {string}
|
|
561
|
+
* @memberof AccessProfileSourceRef
|
|
562
|
+
*/
|
|
563
|
+
'id'?: string;
|
|
564
|
+
/**
|
|
565
|
+
* Source\'s DTO type.
|
|
566
|
+
* @type {string}
|
|
567
|
+
* @memberof AccessProfileSourceRef
|
|
568
|
+
*/
|
|
569
|
+
'type'?: AccessProfileSourceRefTypeEnum;
|
|
570
|
+
/**
|
|
571
|
+
* Source name.
|
|
572
|
+
* @type {string}
|
|
573
|
+
* @memberof AccessProfileSourceRef
|
|
574
|
+
*/
|
|
575
|
+
'name'?: string;
|
|
576
|
+
}
|
|
577
|
+
export declare const AccessProfileSourceRefTypeEnum: {
|
|
578
|
+
readonly Source: "SOURCE";
|
|
579
|
+
};
|
|
580
|
+
export type AccessProfileSourceRefTypeEnum = typeof AccessProfileSourceRefTypeEnum[keyof typeof AccessProfileSourceRefTypeEnum];
|
|
581
|
+
/**
|
|
582
|
+
*
|
|
583
|
+
* @export
|
|
584
|
+
* @interface AccessProfileUpdateItem
|
|
585
|
+
*/
|
|
586
|
+
export interface AccessProfileUpdateItem {
|
|
587
|
+
/**
|
|
588
|
+
* Identifier of Access Profile in bulk update request.
|
|
589
|
+
* @type {string}
|
|
590
|
+
* @memberof AccessProfileUpdateItem
|
|
591
|
+
*/
|
|
592
|
+
'id': string;
|
|
593
|
+
/**
|
|
594
|
+
* Access Profile requestable or not.
|
|
595
|
+
* @type {boolean}
|
|
596
|
+
* @memberof AccessProfileUpdateItem
|
|
597
|
+
*/
|
|
598
|
+
'requestable': boolean;
|
|
599
|
+
/**
|
|
600
|
+
* The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation. > 201 - Access profile is updated successfully. > 404 - Access profile not found.
|
|
601
|
+
* @type {string}
|
|
602
|
+
* @memberof AccessProfileUpdateItem
|
|
603
|
+
*/
|
|
604
|
+
'status': string;
|
|
605
|
+
/**
|
|
606
|
+
* Human readable status description and containing additional context information about success or failures etc.
|
|
607
|
+
* @type {string}
|
|
608
|
+
* @memberof AccessProfileUpdateItem
|
|
609
|
+
*/
|
|
610
|
+
'description'?: string;
|
|
611
|
+
}
|
|
612
|
+
/**
|
|
613
|
+
*
|
|
614
|
+
* @export
|
|
615
|
+
* @interface AccessProfileUsage
|
|
616
|
+
*/
|
|
617
|
+
export interface AccessProfileUsage {
|
|
618
|
+
/**
|
|
619
|
+
* ID of the Access Profile that is in use
|
|
620
|
+
* @type {string}
|
|
621
|
+
* @memberof AccessProfileUsage
|
|
622
|
+
*/
|
|
623
|
+
'accessProfileId'?: string;
|
|
624
|
+
/**
|
|
625
|
+
* List of references to objects which are using the indicated Access Profile
|
|
626
|
+
* @type {Array<AccessProfileUsageUsedByInner>}
|
|
627
|
+
* @memberof AccessProfileUsage
|
|
628
|
+
*/
|
|
629
|
+
'usedBy'?: Array<AccessProfileUsageUsedByInner>;
|
|
630
|
+
}
|
|
631
|
+
/**
|
|
632
|
+
* Role using the access profile.
|
|
633
|
+
* @export
|
|
634
|
+
* @interface AccessProfileUsageUsedByInner
|
|
635
|
+
*/
|
|
636
|
+
export interface AccessProfileUsageUsedByInner {
|
|
637
|
+
/**
|
|
638
|
+
* DTO type of role using the access profile.
|
|
639
|
+
* @type {string}
|
|
640
|
+
* @memberof AccessProfileUsageUsedByInner
|
|
641
|
+
*/
|
|
642
|
+
'type'?: AccessProfileUsageUsedByInnerTypeEnum;
|
|
643
|
+
/**
|
|
644
|
+
* ID of role using the access profile.
|
|
645
|
+
* @type {string}
|
|
646
|
+
* @memberof AccessProfileUsageUsedByInner
|
|
647
|
+
*/
|
|
648
|
+
'id'?: string;
|
|
649
|
+
/**
|
|
650
|
+
* Display name of role using the access profile.
|
|
651
|
+
* @type {string}
|
|
652
|
+
* @memberof AccessProfileUsageUsedByInner
|
|
653
|
+
*/
|
|
654
|
+
'name'?: string;
|
|
655
|
+
}
|
|
656
|
+
export declare const AccessProfileUsageUsedByInnerTypeEnum: {
|
|
657
|
+
readonly Role: "ROLE";
|
|
658
|
+
};
|
|
659
|
+
export type AccessProfileUsageUsedByInnerTypeEnum = typeof AccessProfileUsageUsedByInnerTypeEnum[keyof typeof AccessProfileUsageUsedByInnerTypeEnum];
|
|
622
660
|
/**
|
|
623
661
|
* Reference to an additional owner (identity or governance group).
|
|
624
662
|
* @export
|
|
@@ -1433,6 +1471,21 @@ export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Config
|
|
|
1433
1471
|
* @throws {RequiredError}
|
|
1434
1472
|
*/
|
|
1435
1473
|
patchAccessProfileV1: (id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1474
|
+
/**
|
|
1475
|
+
* Get a list of access profiles filtered by Access Model Metadata and by filter expression. Filtering is supported by filter expression, by metadata attribute key and values, or by both together.
|
|
1476
|
+
* @summary Filter access profiles by metadata
|
|
1477
|
+
* @param {AccessProfileListFilterDTO} accessProfileListFilterDTO
|
|
1478
|
+
* @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error.
|
|
1479
|
+
* @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.
|
|
1480
|
+
* @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.
|
|
1481
|
+
* @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.
|
|
1482
|
+
* @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, created, modified**
|
|
1483
|
+
* @param {string} [forSegmentIds] Filters the returned list to those access profiles assigned to the specified segment IDs.
|
|
1484
|
+
* @param {boolean} [includeUnsegmented] Whether the returned list includes unsegmented access profiles.
|
|
1485
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1486
|
+
* @throws {RequiredError}
|
|
1487
|
+
*/
|
|
1488
|
+
searchAccessProfilesByFilterV1: (accessProfileListFilterDTO: AccessProfileListFilterDTO, forSubadmin?: string, limit?: number, offset?: number, count?: boolean, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1436
1489
|
/**
|
|
1437
1490
|
* This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer.
|
|
1438
1491
|
* @summary Update access profile(s) requestable field.
|
|
@@ -1444,27 +1497,27 @@ export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Config
|
|
|
1444
1497
|
/**
|
|
1445
1498
|
* This API initiates a bulk update of Access Model Metadata for every access profile matching the supplied filter expression. The update is processed asynchronously. The response returns the ID of the task performing the update. A single access profile cannot be assigned more than 25 metadata values. Adding or replacing custom metadata requires a suite license.
|
|
1446
1499
|
* @summary Bulk-update metadata by filter
|
|
1447
|
-
* @param {
|
|
1500
|
+
* @param {AccessProfileMetadataBulkUpdateByFilterRequest} accessProfileMetadataBulkUpdateByFilterRequest
|
|
1448
1501
|
* @param {*} [axiosOptions] Override http request option.
|
|
1449
1502
|
* @throws {RequiredError}
|
|
1450
1503
|
*/
|
|
1451
|
-
updateAccessProfilesMetadataByFilterV1: (
|
|
1504
|
+
updateAccessProfilesMetadataByFilterV1: (accessProfileMetadataBulkUpdateByFilterRequest: AccessProfileMetadataBulkUpdateByFilterRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1452
1505
|
/**
|
|
1453
1506
|
* This API initiates a bulk update of Access Model Metadata for one or more access profiles by a list of access profile IDs. The update is processed asynchronously. The response returns the ID of the task performing the update. The maximum access profile count in a single request is 3000. A single access profile cannot be assigned more than 25 metadata values. Adding or replacing custom metadata requires a suite license.
|
|
1454
1507
|
* @summary Bulk-update metadata by ids
|
|
1455
|
-
* @param {
|
|
1508
|
+
* @param {AccessProfileMetadataBulkUpdateByIdRequest} accessProfileMetadataBulkUpdateByIdRequest
|
|
1456
1509
|
* @param {*} [axiosOptions] Override http request option.
|
|
1457
1510
|
* @throws {RequiredError}
|
|
1458
1511
|
*/
|
|
1459
|
-
updateAccessProfilesMetadataByIdsV1: (
|
|
1512
|
+
updateAccessProfilesMetadataByIdsV1: (accessProfileMetadataBulkUpdateByIdRequest: AccessProfileMetadataBulkUpdateByIdRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1460
1513
|
/**
|
|
1461
1514
|
* This API initiates a bulk update of Access Model Metadata for every access profile matching the supplied search query. The update is processed asynchronously. The response returns the ID of the task performing the update. A single access profile cannot be assigned more than 25 metadata values. Adding or replacing custom metadata requires a suite license.
|
|
1462
1515
|
* @summary Bulk-update metadata by query
|
|
1463
|
-
* @param {
|
|
1516
|
+
* @param {AccessProfileMetadataBulkUpdateByQueryRequest} accessProfileMetadataBulkUpdateByQueryRequest
|
|
1464
1517
|
* @param {*} [axiosOptions] Override http request option.
|
|
1465
1518
|
* @throws {RequiredError}
|
|
1466
1519
|
*/
|
|
1467
|
-
updateAccessProfilesMetadataByQueryV1: (
|
|
1520
|
+
updateAccessProfilesMetadataByQueryV1: (accessProfileMetadataBulkUpdateByQueryRequest: AccessProfileMetadataBulkUpdateByQueryRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1468
1521
|
/**
|
|
1469
1522
|
* This API adds a single Access Model Metadata value to an access profile by attribute key and attribute value. A single access profile cannot be assigned more than 25 metadata values. Adding custom metadata requires a suite license.
|
|
1470
1523
|
* @summary Add metadata to access profile
|
|
@@ -1560,6 +1613,21 @@ export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
|
1560
1613
|
* @throws {RequiredError}
|
|
1561
1614
|
*/
|
|
1562
1615
|
patchAccessProfileV1(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessProfile>>;
|
|
1616
|
+
/**
|
|
1617
|
+
* Get a list of access profiles filtered by Access Model Metadata and by filter expression. Filtering is supported by filter expression, by metadata attribute key and values, or by both together.
|
|
1618
|
+
* @summary Filter access profiles by metadata
|
|
1619
|
+
* @param {AccessProfileListFilterDTO} accessProfileListFilterDTO
|
|
1620
|
+
* @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error.
|
|
1621
|
+
* @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.
|
|
1622
|
+
* @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.
|
|
1623
|
+
* @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.
|
|
1624
|
+
* @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, created, modified**
|
|
1625
|
+
* @param {string} [forSegmentIds] Filters the returned list to those access profiles assigned to the specified segment IDs.
|
|
1626
|
+
* @param {boolean} [includeUnsegmented] Whether the returned list includes unsegmented access profiles.
|
|
1627
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1628
|
+
* @throws {RequiredError}
|
|
1629
|
+
*/
|
|
1630
|
+
searchAccessProfilesByFilterV1(accessProfileListFilterDTO: AccessProfileListFilterDTO, forSubadmin?: string, limit?: number, offset?: number, count?: boolean, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccessProfile>>>;
|
|
1563
1631
|
/**
|
|
1564
1632
|
* This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer.
|
|
1565
1633
|
* @summary Update access profile(s) requestable field.
|
|
@@ -1571,27 +1639,27 @@ export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
|
1571
1639
|
/**
|
|
1572
1640
|
* This API initiates a bulk update of Access Model Metadata for every access profile matching the supplied filter expression. The update is processed asynchronously. The response returns the ID of the task performing the update. A single access profile cannot be assigned more than 25 metadata values. Adding or replacing custom metadata requires a suite license.
|
|
1573
1641
|
* @summary Bulk-update metadata by filter
|
|
1574
|
-
* @param {
|
|
1642
|
+
* @param {AccessProfileMetadataBulkUpdateByFilterRequest} accessProfileMetadataBulkUpdateByFilterRequest
|
|
1575
1643
|
* @param {*} [axiosOptions] Override http request option.
|
|
1576
1644
|
* @throws {RequiredError}
|
|
1577
1645
|
*/
|
|
1578
|
-
updateAccessProfilesMetadataByFilterV1(
|
|
1646
|
+
updateAccessProfilesMetadataByFilterV1(accessProfileMetadataBulkUpdateByFilterRequest: AccessProfileMetadataBulkUpdateByFilterRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessProfileMetadataBulkUpdateResponse>>;
|
|
1579
1647
|
/**
|
|
1580
1648
|
* This API initiates a bulk update of Access Model Metadata for one or more access profiles by a list of access profile IDs. The update is processed asynchronously. The response returns the ID of the task performing the update. The maximum access profile count in a single request is 3000. A single access profile cannot be assigned more than 25 metadata values. Adding or replacing custom metadata requires a suite license.
|
|
1581
1649
|
* @summary Bulk-update metadata by ids
|
|
1582
|
-
* @param {
|
|
1650
|
+
* @param {AccessProfileMetadataBulkUpdateByIdRequest} accessProfileMetadataBulkUpdateByIdRequest
|
|
1583
1651
|
* @param {*} [axiosOptions] Override http request option.
|
|
1584
1652
|
* @throws {RequiredError}
|
|
1585
1653
|
*/
|
|
1586
|
-
updateAccessProfilesMetadataByIdsV1(
|
|
1654
|
+
updateAccessProfilesMetadataByIdsV1(accessProfileMetadataBulkUpdateByIdRequest: AccessProfileMetadataBulkUpdateByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessProfileMetadataBulkUpdateResponse>>;
|
|
1587
1655
|
/**
|
|
1588
1656
|
* This API initiates a bulk update of Access Model Metadata for every access profile matching the supplied search query. The update is processed asynchronously. The response returns the ID of the task performing the update. A single access profile cannot be assigned more than 25 metadata values. Adding or replacing custom metadata requires a suite license.
|
|
1589
1657
|
* @summary Bulk-update metadata by query
|
|
1590
|
-
* @param {
|
|
1658
|
+
* @param {AccessProfileMetadataBulkUpdateByQueryRequest} accessProfileMetadataBulkUpdateByQueryRequest
|
|
1591
1659
|
* @param {*} [axiosOptions] Override http request option.
|
|
1592
1660
|
* @throws {RequiredError}
|
|
1593
1661
|
*/
|
|
1594
|
-
updateAccessProfilesMetadataByQueryV1(
|
|
1662
|
+
updateAccessProfilesMetadataByQueryV1(accessProfileMetadataBulkUpdateByQueryRequest: AccessProfileMetadataBulkUpdateByQueryRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessProfileMetadataBulkUpdateResponse>>;
|
|
1595
1663
|
/**
|
|
1596
1664
|
* This API adds a single Access Model Metadata value to an access profile by attribute key and attribute value. A single access profile cannot be assigned more than 25 metadata values. Adding custom metadata requires a suite license.
|
|
1597
1665
|
* @summary Add metadata to access profile
|
|
@@ -1672,6 +1740,14 @@ export declare const AccessProfilesApiFactory: (configuration?: Configuration, b
|
|
|
1672
1740
|
* @throws {RequiredError}
|
|
1673
1741
|
*/
|
|
1674
1742
|
patchAccessProfileV1(requestParameters: AccessProfilesApiPatchAccessProfileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<AccessProfile>;
|
|
1743
|
+
/**
|
|
1744
|
+
* Get a list of access profiles filtered by Access Model Metadata and by filter expression. Filtering is supported by filter expression, by metadata attribute key and values, or by both together.
|
|
1745
|
+
* @summary Filter access profiles by metadata
|
|
1746
|
+
* @param {AccessProfilesApiSearchAccessProfilesByFilterV1Request} requestParameters Request parameters.
|
|
1747
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1748
|
+
* @throws {RequiredError}
|
|
1749
|
+
*/
|
|
1750
|
+
searchAccessProfilesByFilterV1(requestParameters: AccessProfilesApiSearchAccessProfilesByFilterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<AccessProfile>>;
|
|
1675
1751
|
/**
|
|
1676
1752
|
* This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer.
|
|
1677
1753
|
* @summary Update access profile(s) requestable field.
|
|
@@ -1687,7 +1763,7 @@ export declare const AccessProfilesApiFactory: (configuration?: Configuration, b
|
|
|
1687
1763
|
* @param {*} [axiosOptions] Override http request option.
|
|
1688
1764
|
* @throws {RequiredError}
|
|
1689
1765
|
*/
|
|
1690
|
-
updateAccessProfilesMetadataByFilterV1(requestParameters: AccessProfilesApiUpdateAccessProfilesMetadataByFilterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<
|
|
1766
|
+
updateAccessProfilesMetadataByFilterV1(requestParameters: AccessProfilesApiUpdateAccessProfilesMetadataByFilterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<AccessProfileMetadataBulkUpdateResponse>;
|
|
1691
1767
|
/**
|
|
1692
1768
|
* This API initiates a bulk update of Access Model Metadata for one or more access profiles by a list of access profile IDs. The update is processed asynchronously. The response returns the ID of the task performing the update. The maximum access profile count in a single request is 3000. A single access profile cannot be assigned more than 25 metadata values. Adding or replacing custom metadata requires a suite license.
|
|
1693
1769
|
* @summary Bulk-update metadata by ids
|
|
@@ -1695,7 +1771,7 @@ export declare const AccessProfilesApiFactory: (configuration?: Configuration, b
|
|
|
1695
1771
|
* @param {*} [axiosOptions] Override http request option.
|
|
1696
1772
|
* @throws {RequiredError}
|
|
1697
1773
|
*/
|
|
1698
|
-
updateAccessProfilesMetadataByIdsV1(requestParameters: AccessProfilesApiUpdateAccessProfilesMetadataByIdsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<
|
|
1774
|
+
updateAccessProfilesMetadataByIdsV1(requestParameters: AccessProfilesApiUpdateAccessProfilesMetadataByIdsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<AccessProfileMetadataBulkUpdateResponse>;
|
|
1699
1775
|
/**
|
|
1700
1776
|
* This API initiates a bulk update of Access Model Metadata for every access profile matching the supplied search query. The update is processed asynchronously. The response returns the ID of the task performing the update. A single access profile cannot be assigned more than 25 metadata values. Adding or replacing custom metadata requires a suite license.
|
|
1701
1777
|
* @summary Bulk-update metadata by query
|
|
@@ -1703,7 +1779,7 @@ export declare const AccessProfilesApiFactory: (configuration?: Configuration, b
|
|
|
1703
1779
|
* @param {*} [axiosOptions] Override http request option.
|
|
1704
1780
|
* @throws {RequiredError}
|
|
1705
1781
|
*/
|
|
1706
|
-
updateAccessProfilesMetadataByQueryV1(requestParameters: AccessProfilesApiUpdateAccessProfilesMetadataByQueryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<
|
|
1782
|
+
updateAccessProfilesMetadataByQueryV1(requestParameters: AccessProfilesApiUpdateAccessProfilesMetadataByQueryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<AccessProfileMetadataBulkUpdateResponse>;
|
|
1707
1783
|
/**
|
|
1708
1784
|
* This API adds a single Access Model Metadata value to an access profile by attribute key and attribute value. A single access profile cannot be assigned more than 25 metadata values. Adding custom metadata requires a suite license.
|
|
1709
1785
|
* @summary Add metadata to access profile
|
|
@@ -1907,6 +1983,61 @@ export interface AccessProfilesApiPatchAccessProfileV1Request {
|
|
|
1907
1983
|
*/
|
|
1908
1984
|
readonly jsonPatchOperation: Array<JsonPatchOperation>;
|
|
1909
1985
|
}
|
|
1986
|
+
/**
|
|
1987
|
+
* Request parameters for searchAccessProfilesByFilterV1 operation in AccessProfilesApi.
|
|
1988
|
+
* @export
|
|
1989
|
+
* @interface AccessProfilesApiSearchAccessProfilesByFilterV1Request
|
|
1990
|
+
*/
|
|
1991
|
+
export interface AccessProfilesApiSearchAccessProfilesByFilterV1Request {
|
|
1992
|
+
/**
|
|
1993
|
+
*
|
|
1994
|
+
* @type {AccessProfileListFilterDTO}
|
|
1995
|
+
* @memberof AccessProfilesApiSearchAccessProfilesByFilterV1
|
|
1996
|
+
*/
|
|
1997
|
+
readonly accessProfileListFilterDTO: AccessProfileListFilterDTO;
|
|
1998
|
+
/**
|
|
1999
|
+
* Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error.
|
|
2000
|
+
* @type {string}
|
|
2001
|
+
* @memberof AccessProfilesApiSearchAccessProfilesByFilterV1
|
|
2002
|
+
*/
|
|
2003
|
+
readonly forSubadmin?: string;
|
|
2004
|
+
/**
|
|
2005
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
2006
|
+
* @type {number}
|
|
2007
|
+
* @memberof AccessProfilesApiSearchAccessProfilesByFilterV1
|
|
2008
|
+
*/
|
|
2009
|
+
readonly limit?: number;
|
|
2010
|
+
/**
|
|
2011
|
+
* 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.
|
|
2012
|
+
* @type {number}
|
|
2013
|
+
* @memberof AccessProfilesApiSearchAccessProfilesByFilterV1
|
|
2014
|
+
*/
|
|
2015
|
+
readonly offset?: number;
|
|
2016
|
+
/**
|
|
2017
|
+
* 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.
|
|
2018
|
+
* @type {boolean}
|
|
2019
|
+
* @memberof AccessProfilesApiSearchAccessProfilesByFilterV1
|
|
2020
|
+
*/
|
|
2021
|
+
readonly count?: boolean;
|
|
2022
|
+
/**
|
|
2023
|
+
* 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, created, modified**
|
|
2024
|
+
* @type {string}
|
|
2025
|
+
* @memberof AccessProfilesApiSearchAccessProfilesByFilterV1
|
|
2026
|
+
*/
|
|
2027
|
+
readonly sorters?: string;
|
|
2028
|
+
/**
|
|
2029
|
+
* Filters the returned list to those access profiles assigned to the specified segment IDs.
|
|
2030
|
+
* @type {string}
|
|
2031
|
+
* @memberof AccessProfilesApiSearchAccessProfilesByFilterV1
|
|
2032
|
+
*/
|
|
2033
|
+
readonly forSegmentIds?: string;
|
|
2034
|
+
/**
|
|
2035
|
+
* Whether the returned list includes unsegmented access profiles.
|
|
2036
|
+
* @type {boolean}
|
|
2037
|
+
* @memberof AccessProfilesApiSearchAccessProfilesByFilterV1
|
|
2038
|
+
*/
|
|
2039
|
+
readonly includeUnsegmented?: boolean;
|
|
2040
|
+
}
|
|
1910
2041
|
/**
|
|
1911
2042
|
* Request parameters for updateAccessProfilesInBulkV1 operation in AccessProfilesApi.
|
|
1912
2043
|
* @export
|
|
@@ -1928,10 +2059,10 @@ export interface AccessProfilesApiUpdateAccessProfilesInBulkV1Request {
|
|
|
1928
2059
|
export interface AccessProfilesApiUpdateAccessProfilesMetadataByFilterV1Request {
|
|
1929
2060
|
/**
|
|
1930
2061
|
*
|
|
1931
|
-
* @type {
|
|
2062
|
+
* @type {AccessProfileMetadataBulkUpdateByFilterRequest}
|
|
1932
2063
|
* @memberof AccessProfilesApiUpdateAccessProfilesMetadataByFilterV1
|
|
1933
2064
|
*/
|
|
1934
|
-
readonly
|
|
2065
|
+
readonly accessProfileMetadataBulkUpdateByFilterRequest: AccessProfileMetadataBulkUpdateByFilterRequest;
|
|
1935
2066
|
}
|
|
1936
2067
|
/**
|
|
1937
2068
|
* Request parameters for updateAccessProfilesMetadataByIdsV1 operation in AccessProfilesApi.
|
|
@@ -1941,10 +2072,10 @@ export interface AccessProfilesApiUpdateAccessProfilesMetadataByFilterV1Request
|
|
|
1941
2072
|
export interface AccessProfilesApiUpdateAccessProfilesMetadataByIdsV1Request {
|
|
1942
2073
|
/**
|
|
1943
2074
|
*
|
|
1944
|
-
* @type {
|
|
2075
|
+
* @type {AccessProfileMetadataBulkUpdateByIdRequest}
|
|
1945
2076
|
* @memberof AccessProfilesApiUpdateAccessProfilesMetadataByIdsV1
|
|
1946
2077
|
*/
|
|
1947
|
-
readonly
|
|
2078
|
+
readonly accessProfileMetadataBulkUpdateByIdRequest: AccessProfileMetadataBulkUpdateByIdRequest;
|
|
1948
2079
|
}
|
|
1949
2080
|
/**
|
|
1950
2081
|
* Request parameters for updateAccessProfilesMetadataByQueryV1 operation in AccessProfilesApi.
|
|
@@ -1954,10 +2085,10 @@ export interface AccessProfilesApiUpdateAccessProfilesMetadataByIdsV1Request {
|
|
|
1954
2085
|
export interface AccessProfilesApiUpdateAccessProfilesMetadataByQueryV1Request {
|
|
1955
2086
|
/**
|
|
1956
2087
|
*
|
|
1957
|
-
* @type {
|
|
2088
|
+
* @type {AccessProfileMetadataBulkUpdateByQueryRequest}
|
|
1958
2089
|
* @memberof AccessProfilesApiUpdateAccessProfilesMetadataByQueryV1
|
|
1959
2090
|
*/
|
|
1960
|
-
readonly
|
|
2091
|
+
readonly accessProfileMetadataBulkUpdateByQueryRequest: AccessProfileMetadataBulkUpdateByQueryRequest;
|
|
1961
2092
|
}
|
|
1962
2093
|
/**
|
|
1963
2094
|
* Request parameters for updateAttributeKeyAndValueToAccessProfileV1 operation in AccessProfilesApi.
|
|
@@ -2063,6 +2194,15 @@ export declare class AccessProfilesApi extends BaseAPI {
|
|
|
2063
2194
|
* @memberof AccessProfilesApi
|
|
2064
2195
|
*/
|
|
2065
2196
|
patchAccessProfileV1(requestParameters: AccessProfilesApiPatchAccessProfileV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfile, any>>;
|
|
2197
|
+
/**
|
|
2198
|
+
* Get a list of access profiles filtered by Access Model Metadata and by filter expression. Filtering is supported by filter expression, by metadata attribute key and values, or by both together.
|
|
2199
|
+
* @summary Filter access profiles by metadata
|
|
2200
|
+
* @param {AccessProfilesApiSearchAccessProfilesByFilterV1Request} requestParameters Request parameters.
|
|
2201
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2202
|
+
* @throws {RequiredError}
|
|
2203
|
+
* @memberof AccessProfilesApi
|
|
2204
|
+
*/
|
|
2205
|
+
searchAccessProfilesByFilterV1(requestParameters: AccessProfilesApiSearchAccessProfilesByFilterV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfile[], any>>;
|
|
2066
2206
|
/**
|
|
2067
2207
|
* This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer.
|
|
2068
2208
|
* @summary Update access profile(s) requestable field.
|
|
@@ -2080,7 +2220,7 @@ export declare class AccessProfilesApi extends BaseAPI {
|
|
|
2080
2220
|
* @throws {RequiredError}
|
|
2081
2221
|
* @memberof AccessProfilesApi
|
|
2082
2222
|
*/
|
|
2083
|
-
updateAccessProfilesMetadataByFilterV1(requestParameters: AccessProfilesApiUpdateAccessProfilesMetadataByFilterV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
2223
|
+
updateAccessProfilesMetadataByFilterV1(requestParameters: AccessProfilesApiUpdateAccessProfilesMetadataByFilterV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfileMetadataBulkUpdateResponse, any>>;
|
|
2084
2224
|
/**
|
|
2085
2225
|
* This API initiates a bulk update of Access Model Metadata for one or more access profiles by a list of access profile IDs. The update is processed asynchronously. The response returns the ID of the task performing the update. The maximum access profile count in a single request is 3000. A single access profile cannot be assigned more than 25 metadata values. Adding or replacing custom metadata requires a suite license.
|
|
2086
2226
|
* @summary Bulk-update metadata by ids
|
|
@@ -2089,7 +2229,7 @@ export declare class AccessProfilesApi extends BaseAPI {
|
|
|
2089
2229
|
* @throws {RequiredError}
|
|
2090
2230
|
* @memberof AccessProfilesApi
|
|
2091
2231
|
*/
|
|
2092
|
-
updateAccessProfilesMetadataByIdsV1(requestParameters: AccessProfilesApiUpdateAccessProfilesMetadataByIdsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
2232
|
+
updateAccessProfilesMetadataByIdsV1(requestParameters: AccessProfilesApiUpdateAccessProfilesMetadataByIdsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfileMetadataBulkUpdateResponse, any>>;
|
|
2093
2233
|
/**
|
|
2094
2234
|
* This API initiates a bulk update of Access Model Metadata for every access profile matching the supplied search query. The update is processed asynchronously. The response returns the ID of the task performing the update. A single access profile cannot be assigned more than 25 metadata values. Adding or replacing custom metadata requires a suite license.
|
|
2095
2235
|
* @summary Bulk-update metadata by query
|
|
@@ -2098,7 +2238,7 @@ export declare class AccessProfilesApi extends BaseAPI {
|
|
|
2098
2238
|
* @throws {RequiredError}
|
|
2099
2239
|
* @memberof AccessProfilesApi
|
|
2100
2240
|
*/
|
|
2101
|
-
updateAccessProfilesMetadataByQueryV1(requestParameters: AccessProfilesApiUpdateAccessProfilesMetadataByQueryV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
2241
|
+
updateAccessProfilesMetadataByQueryV1(requestParameters: AccessProfilesApiUpdateAccessProfilesMetadataByQueryV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfileMetadataBulkUpdateResponse, any>>;
|
|
2102
2242
|
/**
|
|
2103
2243
|
* This API adds a single Access Model Metadata value to an access profile by attribute key and attribute value. A single access profile cannot be assigned more than 25 metadata values. Adding custom metadata requires a suite license.
|
|
2104
2244
|
* @summary Add metadata to access profile
|