@sailpoint/api-client 2.2.4 → 2.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/access_profiles/api.d.ts +457 -0
- package/dist/access_profiles/api.js +453 -1
- package/dist/access_profiles/api.js.map +1 -1
- package/dist/entitlements/api.d.ts +333 -0
- package/dist/entitlements/api.js +277 -1
- package/dist/entitlements/api.js.map +1 -1
- package/dist/esm/access_profiles/api.js +452 -0
- package/dist/esm/entitlements/api.js +276 -0
- 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
|
@@ -424,6 +424,201 @@ export declare const AccessProfileUsageUsedByInnerTypeEnum: {
|
|
|
424
424
|
readonly Role: "ROLE";
|
|
425
425
|
};
|
|
426
426
|
export type AccessProfileUsageUsedByInnerTypeEnum = typeof AccessProfileUsageUsedByInnerTypeEnum[keyof typeof AccessProfileUsageUsedByInnerTypeEnum];
|
|
427
|
+
/**
|
|
428
|
+
* 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
|
+
* @export
|
|
430
|
+
* @interface Accessprofilemetadatabulkupdatebyfilterrequest
|
|
431
|
+
*/
|
|
432
|
+
export interface Accessprofilemetadatabulkupdatebyfilterrequest {
|
|
433
|
+
/**
|
|
434
|
+
* 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
|
+
* @type {string}
|
|
436
|
+
* @memberof Accessprofilemetadatabulkupdatebyfilterrequest
|
|
437
|
+
*/
|
|
438
|
+
'filters': string;
|
|
439
|
+
/**
|
|
440
|
+
* The operation to be performed
|
|
441
|
+
* @type {string}
|
|
442
|
+
* @memberof Accessprofilemetadatabulkupdatebyfilterrequest
|
|
443
|
+
*/
|
|
444
|
+
'operation': AccessprofilemetadatabulkupdatebyfilterrequestOperationEnum;
|
|
445
|
+
/**
|
|
446
|
+
* 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
|
+
* @type {string}
|
|
448
|
+
* @memberof Accessprofilemetadatabulkupdatebyfilterrequest
|
|
449
|
+
*/
|
|
450
|
+
'replaceScope': AccessprofilemetadatabulkupdatebyfilterrequestReplaceScopeEnum;
|
|
451
|
+
/**
|
|
452
|
+
* The metadata to be updated, including attribute key and value.
|
|
453
|
+
* @type {Array<AccessprofilemetadatabulkupdatebyidrequestValuesInner>}
|
|
454
|
+
* @memberof Accessprofilemetadatabulkupdatebyfilterrequest
|
|
455
|
+
*/
|
|
456
|
+
'values': Array<AccessprofilemetadatabulkupdatebyidrequestValuesInner>;
|
|
457
|
+
}
|
|
458
|
+
export declare const AccessprofilemetadatabulkupdatebyfilterrequestOperationEnum: {
|
|
459
|
+
readonly Add: "ADD";
|
|
460
|
+
readonly Remove: "REMOVE";
|
|
461
|
+
readonly Replace: "REPLACE";
|
|
462
|
+
};
|
|
463
|
+
export type AccessprofilemetadatabulkupdatebyfilterrequestOperationEnum = typeof AccessprofilemetadatabulkupdatebyfilterrequestOperationEnum[keyof typeof AccessprofilemetadatabulkupdatebyfilterrequestOperationEnum];
|
|
464
|
+
export declare const AccessprofilemetadatabulkupdatebyfilterrequestReplaceScopeEnum: {
|
|
465
|
+
readonly All: "ALL";
|
|
466
|
+
readonly Attribute: "ATTRIBUTE";
|
|
467
|
+
};
|
|
468
|
+
export type AccessprofilemetadatabulkupdatebyfilterrequestReplaceScopeEnum = typeof AccessprofilemetadatabulkupdatebyfilterrequestReplaceScopeEnum[keyof typeof AccessprofilemetadatabulkupdatebyfilterrequestReplaceScopeEnum];
|
|
469
|
+
/**
|
|
470
|
+
* 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
|
+
* @export
|
|
472
|
+
* @interface Accessprofilemetadatabulkupdatebyidrequest
|
|
473
|
+
*/
|
|
474
|
+
export interface Accessprofilemetadatabulkupdatebyidrequest {
|
|
475
|
+
/**
|
|
476
|
+
* The IDs of the access profiles to update.
|
|
477
|
+
* @type {Array<string>}
|
|
478
|
+
* @memberof Accessprofilemetadatabulkupdatebyidrequest
|
|
479
|
+
*/
|
|
480
|
+
'accessProfiles': Array<string>;
|
|
481
|
+
/**
|
|
482
|
+
* The operation to be performed
|
|
483
|
+
* @type {string}
|
|
484
|
+
* @memberof Accessprofilemetadatabulkupdatebyidrequest
|
|
485
|
+
*/
|
|
486
|
+
'operation': AccessprofilemetadatabulkupdatebyidrequestOperationEnum;
|
|
487
|
+
/**
|
|
488
|
+
* 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
|
+
* @type {string}
|
|
490
|
+
* @memberof Accessprofilemetadatabulkupdatebyidrequest
|
|
491
|
+
*/
|
|
492
|
+
'replaceScope': AccessprofilemetadatabulkupdatebyidrequestReplaceScopeEnum;
|
|
493
|
+
/**
|
|
494
|
+
* The metadata to be updated, including attribute key and value.
|
|
495
|
+
* @type {Array<AccessprofilemetadatabulkupdatebyidrequestValuesInner>}
|
|
496
|
+
* @memberof Accessprofilemetadatabulkupdatebyidrequest
|
|
497
|
+
*/
|
|
498
|
+
'values': Array<AccessprofilemetadatabulkupdatebyidrequestValuesInner>;
|
|
499
|
+
}
|
|
500
|
+
export declare const AccessprofilemetadatabulkupdatebyidrequestOperationEnum: {
|
|
501
|
+
readonly Add: "ADD";
|
|
502
|
+
readonly Remove: "REMOVE";
|
|
503
|
+
readonly Replace: "REPLACE";
|
|
504
|
+
};
|
|
505
|
+
export type AccessprofilemetadatabulkupdatebyidrequestOperationEnum = typeof AccessprofilemetadatabulkupdatebyidrequestOperationEnum[keyof typeof AccessprofilemetadatabulkupdatebyidrequestOperationEnum];
|
|
506
|
+
export declare const AccessprofilemetadatabulkupdatebyidrequestReplaceScopeEnum: {
|
|
507
|
+
readonly All: "ALL";
|
|
508
|
+
readonly Attribute: "ATTRIBUTE";
|
|
509
|
+
};
|
|
510
|
+
export type AccessprofilemetadatabulkupdatebyidrequestReplaceScopeEnum = typeof AccessprofilemetadatabulkupdatebyidrequestReplaceScopeEnum[keyof typeof AccessprofilemetadatabulkupdatebyidrequestReplaceScopeEnum];
|
|
511
|
+
/**
|
|
512
|
+
*
|
|
513
|
+
* @export
|
|
514
|
+
* @interface AccessprofilemetadatabulkupdatebyidrequestValuesInner
|
|
515
|
+
*/
|
|
516
|
+
export interface AccessprofilemetadatabulkupdatebyidrequestValuesInner {
|
|
517
|
+
/**
|
|
518
|
+
* The technical name of the metadata attribute.
|
|
519
|
+
* @type {string}
|
|
520
|
+
* @memberof AccessprofilemetadatabulkupdatebyidrequestValuesInner
|
|
521
|
+
*/
|
|
522
|
+
'attribute': string;
|
|
523
|
+
/**
|
|
524
|
+
* The values of the attribute to be updated.
|
|
525
|
+
* @type {Array<string>}
|
|
526
|
+
* @memberof AccessprofilemetadatabulkupdatebyidrequestValuesInner
|
|
527
|
+
*/
|
|
528
|
+
'values': Array<string> | null;
|
|
529
|
+
/**
|
|
530
|
+
* The type of the metadata attribute. Set to `custom` for custom metadata attributes, which require a suite license.
|
|
531
|
+
* @type {string}
|
|
532
|
+
* @memberof AccessprofilemetadatabulkupdatebyidrequestValuesInner
|
|
533
|
+
*/
|
|
534
|
+
'objectType'?: string;
|
|
535
|
+
}
|
|
536
|
+
/**
|
|
537
|
+
* 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
|
+
* @export
|
|
539
|
+
* @interface Accessprofilemetadatabulkupdatebyqueryrequest
|
|
540
|
+
*/
|
|
541
|
+
export interface Accessprofilemetadatabulkupdatebyqueryrequest {
|
|
542
|
+
/**
|
|
543
|
+
* The search query selecting the access profiles to update.
|
|
544
|
+
* @type {object}
|
|
545
|
+
* @memberof Accessprofilemetadatabulkupdatebyqueryrequest
|
|
546
|
+
*/
|
|
547
|
+
'query': object;
|
|
548
|
+
/**
|
|
549
|
+
* The operation to be performed
|
|
550
|
+
* @type {string}
|
|
551
|
+
* @memberof Accessprofilemetadatabulkupdatebyqueryrequest
|
|
552
|
+
*/
|
|
553
|
+
'operation': AccessprofilemetadatabulkupdatebyqueryrequestOperationEnum;
|
|
554
|
+
/**
|
|
555
|
+
* 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
|
+
* @type {string}
|
|
557
|
+
* @memberof Accessprofilemetadatabulkupdatebyqueryrequest
|
|
558
|
+
*/
|
|
559
|
+
'replaceScope': AccessprofilemetadatabulkupdatebyqueryrequestReplaceScopeEnum;
|
|
560
|
+
/**
|
|
561
|
+
* The metadata to be updated, including attribute key and value.
|
|
562
|
+
* @type {Array<AccessprofilemetadatabulkupdatebyidrequestValuesInner>}
|
|
563
|
+
* @memberof Accessprofilemetadatabulkupdatebyqueryrequest
|
|
564
|
+
*/
|
|
565
|
+
'values': Array<AccessprofilemetadatabulkupdatebyidrequestValuesInner>;
|
|
566
|
+
}
|
|
567
|
+
export declare const AccessprofilemetadatabulkupdatebyqueryrequestOperationEnum: {
|
|
568
|
+
readonly Add: "ADD";
|
|
569
|
+
readonly Remove: "REMOVE";
|
|
570
|
+
readonly Replace: "REPLACE";
|
|
571
|
+
};
|
|
572
|
+
export type AccessprofilemetadatabulkupdatebyqueryrequestOperationEnum = typeof AccessprofilemetadatabulkupdatebyqueryrequestOperationEnum[keyof typeof AccessprofilemetadatabulkupdatebyqueryrequestOperationEnum];
|
|
573
|
+
export declare const AccessprofilemetadatabulkupdatebyqueryrequestReplaceScopeEnum: {
|
|
574
|
+
readonly All: "ALL";
|
|
575
|
+
readonly Attribute: "ATTRIBUTE";
|
|
576
|
+
};
|
|
577
|
+
export type AccessprofilemetadatabulkupdatebyqueryrequestReplaceScopeEnum = typeof AccessprofilemetadatabulkupdatebyqueryrequestReplaceScopeEnum[keyof typeof AccessprofilemetadatabulkupdatebyqueryrequestReplaceScopeEnum];
|
|
578
|
+
/**
|
|
579
|
+
*
|
|
580
|
+
* @export
|
|
581
|
+
* @interface Accessprofilemetadatabulkupdateresponse
|
|
582
|
+
*/
|
|
583
|
+
export interface Accessprofilemetadatabulkupdateresponse {
|
|
584
|
+
/**
|
|
585
|
+
* ID of the task that is processing the bulk update.
|
|
586
|
+
* @type {string}
|
|
587
|
+
* @memberof Accessprofilemetadatabulkupdateresponse
|
|
588
|
+
*/
|
|
589
|
+
'id'?: string;
|
|
590
|
+
/**
|
|
591
|
+
* Type of the object the bulk update applies to.
|
|
592
|
+
* @type {string}
|
|
593
|
+
* @memberof Accessprofilemetadatabulkupdateresponse
|
|
594
|
+
*/
|
|
595
|
+
'type'?: string;
|
|
596
|
+
/**
|
|
597
|
+
* The status of the bulk update request.
|
|
598
|
+
* @type {string}
|
|
599
|
+
* @memberof Accessprofilemetadatabulkupdateresponse
|
|
600
|
+
*/
|
|
601
|
+
'status'?: AccessprofilemetadatabulkupdateresponseStatusEnum;
|
|
602
|
+
/**
|
|
603
|
+
* Time when the bulk update request was created
|
|
604
|
+
* @type {string}
|
|
605
|
+
* @memberof Accessprofilemetadatabulkupdateresponse
|
|
606
|
+
*/
|
|
607
|
+
'created'?: string;
|
|
608
|
+
}
|
|
609
|
+
export declare const AccessprofilemetadatabulkupdateresponseStatusEnum: {
|
|
610
|
+
readonly Created: "CREATED";
|
|
611
|
+
readonly PreProcess: "PRE_PROCESS";
|
|
612
|
+
readonly PreProcessCompleted: "PRE_PROCESS_COMPLETED";
|
|
613
|
+
readonly PostProcess: "POST_PROCESS";
|
|
614
|
+
readonly Completed: "COMPLETED";
|
|
615
|
+
readonly ChunkPending: "CHUNK_PENDING";
|
|
616
|
+
readonly ChunkProcessing: "CHUNK_PROCESSING";
|
|
617
|
+
readonly ReProcessing: "RE_PROCESSING";
|
|
618
|
+
readonly PreProcessFailed: "PRE_PROCESS_FAILED";
|
|
619
|
+
readonly Failed: "FAILED";
|
|
620
|
+
};
|
|
621
|
+
export type AccessprofilemetadatabulkupdateresponseStatusEnum = typeof AccessprofilemetadatabulkupdateresponseStatusEnum[keyof typeof AccessprofilemetadatabulkupdateresponseStatusEnum];
|
|
427
622
|
/**
|
|
428
623
|
* Reference to an additional owner (identity or governance group).
|
|
429
624
|
* @export
|
|
@@ -1183,6 +1378,16 @@ export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Config
|
|
|
1183
1378
|
* @throws {RequiredError}
|
|
1184
1379
|
*/
|
|
1185
1380
|
deleteAccessProfilesInBulkV1: (accessProfileBulkDeleteRequest: AccessProfileBulkDeleteRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1381
|
+
/**
|
|
1382
|
+
* This API removes a single Access Model Metadata value from an access profile by attribute key and attribute value.
|
|
1383
|
+
* @summary Remove metadata from access profile
|
|
1384
|
+
* @param {string} id The access profile\'s ID.
|
|
1385
|
+
* @param {string} attributeKey Technical name of the Attribute.
|
|
1386
|
+
* @param {string} attributeValue Technical name of the Attribute Value.
|
|
1387
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1388
|
+
* @throws {RequiredError}
|
|
1389
|
+
*/
|
|
1390
|
+
deleteMetadataFromAccessProfileByKeyAndValueV1: (id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1186
1391
|
/**
|
|
1187
1392
|
* Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
1188
1393
|
* @summary List access profile\'s entitlements
|
|
@@ -1236,6 +1441,40 @@ export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Config
|
|
|
1236
1441
|
* @throws {RequiredError}
|
|
1237
1442
|
*/
|
|
1238
1443
|
updateAccessProfilesInBulkV1: (accessProfileBulkUpdateRequestInner: Array<AccessProfileBulkUpdateRequestInner>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1444
|
+
/**
|
|
1445
|
+
* 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
|
+
* @summary Bulk-update metadata by filter
|
|
1447
|
+
* @param {Accessprofilemetadatabulkupdatebyfilterrequest} accessprofilemetadatabulkupdatebyfilterrequest
|
|
1448
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1449
|
+
* @throws {RequiredError}
|
|
1450
|
+
*/
|
|
1451
|
+
updateAccessProfilesMetadataByFilterV1: (accessprofilemetadatabulkupdatebyfilterrequest: Accessprofilemetadatabulkupdatebyfilterrequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1452
|
+
/**
|
|
1453
|
+
* 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
|
+
* @summary Bulk-update metadata by ids
|
|
1455
|
+
* @param {Accessprofilemetadatabulkupdatebyidrequest} accessprofilemetadatabulkupdatebyidrequest
|
|
1456
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1457
|
+
* @throws {RequiredError}
|
|
1458
|
+
*/
|
|
1459
|
+
updateAccessProfilesMetadataByIdsV1: (accessprofilemetadatabulkupdatebyidrequest: Accessprofilemetadatabulkupdatebyidrequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1460
|
+
/**
|
|
1461
|
+
* 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
|
+
* @summary Bulk-update metadata by query
|
|
1463
|
+
* @param {Accessprofilemetadatabulkupdatebyqueryrequest} accessprofilemetadatabulkupdatebyqueryrequest
|
|
1464
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1465
|
+
* @throws {RequiredError}
|
|
1466
|
+
*/
|
|
1467
|
+
updateAccessProfilesMetadataByQueryV1: (accessprofilemetadatabulkupdatebyqueryrequest: Accessprofilemetadatabulkupdatebyqueryrequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1468
|
+
/**
|
|
1469
|
+
* 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
|
+
* @summary Add metadata to access profile
|
|
1471
|
+
* @param {string} id The access profile\'s ID.
|
|
1472
|
+
* @param {string} attributeKey Technical name of the Attribute.
|
|
1473
|
+
* @param {string} attributeValue Technical name of the Attribute Value.
|
|
1474
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1475
|
+
* @throws {RequiredError}
|
|
1476
|
+
*/
|
|
1477
|
+
updateAttributeKeyAndValueToAccessProfileV1: (id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1239
1478
|
};
|
|
1240
1479
|
/**
|
|
1241
1480
|
* AccessProfilesApi - functional programming interface
|
|
@@ -1266,6 +1505,16 @@ export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
|
1266
1505
|
* @throws {RequiredError}
|
|
1267
1506
|
*/
|
|
1268
1507
|
deleteAccessProfilesInBulkV1(accessProfileBulkDeleteRequest: AccessProfileBulkDeleteRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessProfileBulkDeleteResponse>>;
|
|
1508
|
+
/**
|
|
1509
|
+
* This API removes a single Access Model Metadata value from an access profile by attribute key and attribute value.
|
|
1510
|
+
* @summary Remove metadata from access profile
|
|
1511
|
+
* @param {string} id The access profile\'s ID.
|
|
1512
|
+
* @param {string} attributeKey Technical name of the Attribute.
|
|
1513
|
+
* @param {string} attributeValue Technical name of the Attribute Value.
|
|
1514
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1515
|
+
* @throws {RequiredError}
|
|
1516
|
+
*/
|
|
1517
|
+
deleteMetadataFromAccessProfileByKeyAndValueV1(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1269
1518
|
/**
|
|
1270
1519
|
* Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
1271
1520
|
* @summary List access profile\'s entitlements
|
|
@@ -1319,6 +1568,40 @@ export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
|
1319
1568
|
* @throws {RequiredError}
|
|
1320
1569
|
*/
|
|
1321
1570
|
updateAccessProfilesInBulkV1(accessProfileBulkUpdateRequestInner: Array<AccessProfileBulkUpdateRequestInner>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccessProfileUpdateItem>>>;
|
|
1571
|
+
/**
|
|
1572
|
+
* 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
|
+
* @summary Bulk-update metadata by filter
|
|
1574
|
+
* @param {Accessprofilemetadatabulkupdatebyfilterrequest} accessprofilemetadatabulkupdatebyfilterrequest
|
|
1575
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1576
|
+
* @throws {RequiredError}
|
|
1577
|
+
*/
|
|
1578
|
+
updateAccessProfilesMetadataByFilterV1(accessprofilemetadatabulkupdatebyfilterrequest: Accessprofilemetadatabulkupdatebyfilterrequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Accessprofilemetadatabulkupdateresponse>>;
|
|
1579
|
+
/**
|
|
1580
|
+
* 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
|
+
* @summary Bulk-update metadata by ids
|
|
1582
|
+
* @param {Accessprofilemetadatabulkupdatebyidrequest} accessprofilemetadatabulkupdatebyidrequest
|
|
1583
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1584
|
+
* @throws {RequiredError}
|
|
1585
|
+
*/
|
|
1586
|
+
updateAccessProfilesMetadataByIdsV1(accessprofilemetadatabulkupdatebyidrequest: Accessprofilemetadatabulkupdatebyidrequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Accessprofilemetadatabulkupdateresponse>>;
|
|
1587
|
+
/**
|
|
1588
|
+
* 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
|
+
* @summary Bulk-update metadata by query
|
|
1590
|
+
* @param {Accessprofilemetadatabulkupdatebyqueryrequest} accessprofilemetadatabulkupdatebyqueryrequest
|
|
1591
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1592
|
+
* @throws {RequiredError}
|
|
1593
|
+
*/
|
|
1594
|
+
updateAccessProfilesMetadataByQueryV1(accessprofilemetadatabulkupdatebyqueryrequest: Accessprofilemetadatabulkupdatebyqueryrequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Accessprofilemetadatabulkupdateresponse>>;
|
|
1595
|
+
/**
|
|
1596
|
+
* 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
|
+
* @summary Add metadata to access profile
|
|
1598
|
+
* @param {string} id The access profile\'s ID.
|
|
1599
|
+
* @param {string} attributeKey Technical name of the Attribute.
|
|
1600
|
+
* @param {string} attributeValue Technical name of the Attribute Value.
|
|
1601
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1602
|
+
* @throws {RequiredError}
|
|
1603
|
+
*/
|
|
1604
|
+
updateAttributeKeyAndValueToAccessProfileV1(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessProfile>>;
|
|
1322
1605
|
};
|
|
1323
1606
|
/**
|
|
1324
1607
|
* AccessProfilesApi - factory interface
|
|
@@ -1349,6 +1632,14 @@ export declare const AccessProfilesApiFactory: (configuration?: Configuration, b
|
|
|
1349
1632
|
* @throws {RequiredError}
|
|
1350
1633
|
*/
|
|
1351
1634
|
deleteAccessProfilesInBulkV1(requestParameters: AccessProfilesApiDeleteAccessProfilesInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<AccessProfileBulkDeleteResponse>;
|
|
1635
|
+
/**
|
|
1636
|
+
* This API removes a single Access Model Metadata value from an access profile by attribute key and attribute value.
|
|
1637
|
+
* @summary Remove metadata from access profile
|
|
1638
|
+
* @param {AccessProfilesApiDeleteMetadataFromAccessProfileByKeyAndValueV1Request} requestParameters Request parameters.
|
|
1639
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1640
|
+
* @throws {RequiredError}
|
|
1641
|
+
*/
|
|
1642
|
+
deleteMetadataFromAccessProfileByKeyAndValueV1(requestParameters: AccessProfilesApiDeleteMetadataFromAccessProfileByKeyAndValueV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1352
1643
|
/**
|
|
1353
1644
|
* Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
1354
1645
|
* @summary List access profile\'s entitlements
|
|
@@ -1389,6 +1680,38 @@ export declare const AccessProfilesApiFactory: (configuration?: Configuration, b
|
|
|
1389
1680
|
* @throws {RequiredError}
|
|
1390
1681
|
*/
|
|
1391
1682
|
updateAccessProfilesInBulkV1(requestParameters: AccessProfilesApiUpdateAccessProfilesInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<AccessProfileUpdateItem>>;
|
|
1683
|
+
/**
|
|
1684
|
+
* 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.
|
|
1685
|
+
* @summary Bulk-update metadata by filter
|
|
1686
|
+
* @param {AccessProfilesApiUpdateAccessProfilesMetadataByFilterV1Request} requestParameters Request parameters.
|
|
1687
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1688
|
+
* @throws {RequiredError}
|
|
1689
|
+
*/
|
|
1690
|
+
updateAccessProfilesMetadataByFilterV1(requestParameters: AccessProfilesApiUpdateAccessProfilesMetadataByFilterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Accessprofilemetadatabulkupdateresponse>;
|
|
1691
|
+
/**
|
|
1692
|
+
* 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
|
+
* @summary Bulk-update metadata by ids
|
|
1694
|
+
* @param {AccessProfilesApiUpdateAccessProfilesMetadataByIdsV1Request} requestParameters Request parameters.
|
|
1695
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1696
|
+
* @throws {RequiredError}
|
|
1697
|
+
*/
|
|
1698
|
+
updateAccessProfilesMetadataByIdsV1(requestParameters: AccessProfilesApiUpdateAccessProfilesMetadataByIdsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Accessprofilemetadatabulkupdateresponse>;
|
|
1699
|
+
/**
|
|
1700
|
+
* 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
|
+
* @summary Bulk-update metadata by query
|
|
1702
|
+
* @param {AccessProfilesApiUpdateAccessProfilesMetadataByQueryV1Request} requestParameters Request parameters.
|
|
1703
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1704
|
+
* @throws {RequiredError}
|
|
1705
|
+
*/
|
|
1706
|
+
updateAccessProfilesMetadataByQueryV1(requestParameters: AccessProfilesApiUpdateAccessProfilesMetadataByQueryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Accessprofilemetadatabulkupdateresponse>;
|
|
1707
|
+
/**
|
|
1708
|
+
* 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
|
+
* @summary Add metadata to access profile
|
|
1710
|
+
* @param {AccessProfilesApiUpdateAttributeKeyAndValueToAccessProfileV1Request} requestParameters Request parameters.
|
|
1711
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1712
|
+
* @throws {RequiredError}
|
|
1713
|
+
*/
|
|
1714
|
+
updateAttributeKeyAndValueToAccessProfileV1(requestParameters: AccessProfilesApiUpdateAttributeKeyAndValueToAccessProfileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<AccessProfile>;
|
|
1392
1715
|
};
|
|
1393
1716
|
/**
|
|
1394
1717
|
* Request parameters for createAccessProfileV1 operation in AccessProfilesApi.
|
|
@@ -1429,6 +1752,31 @@ export interface AccessProfilesApiDeleteAccessProfilesInBulkV1Request {
|
|
|
1429
1752
|
*/
|
|
1430
1753
|
readonly accessProfileBulkDeleteRequest: AccessProfileBulkDeleteRequest;
|
|
1431
1754
|
}
|
|
1755
|
+
/**
|
|
1756
|
+
* Request parameters for deleteMetadataFromAccessProfileByKeyAndValueV1 operation in AccessProfilesApi.
|
|
1757
|
+
* @export
|
|
1758
|
+
* @interface AccessProfilesApiDeleteMetadataFromAccessProfileByKeyAndValueV1Request
|
|
1759
|
+
*/
|
|
1760
|
+
export interface AccessProfilesApiDeleteMetadataFromAccessProfileByKeyAndValueV1Request {
|
|
1761
|
+
/**
|
|
1762
|
+
* The access profile\'s ID.
|
|
1763
|
+
* @type {string}
|
|
1764
|
+
* @memberof AccessProfilesApiDeleteMetadataFromAccessProfileByKeyAndValueV1
|
|
1765
|
+
*/
|
|
1766
|
+
readonly id: string;
|
|
1767
|
+
/**
|
|
1768
|
+
* Technical name of the Attribute.
|
|
1769
|
+
* @type {string}
|
|
1770
|
+
* @memberof AccessProfilesApiDeleteMetadataFromAccessProfileByKeyAndValueV1
|
|
1771
|
+
*/
|
|
1772
|
+
readonly attributeKey: string;
|
|
1773
|
+
/**
|
|
1774
|
+
* Technical name of the Attribute Value.
|
|
1775
|
+
* @type {string}
|
|
1776
|
+
* @memberof AccessProfilesApiDeleteMetadataFromAccessProfileByKeyAndValueV1
|
|
1777
|
+
*/
|
|
1778
|
+
readonly attributeValue: string;
|
|
1779
|
+
}
|
|
1432
1780
|
/**
|
|
1433
1781
|
* Request parameters for getAccessProfileEntitlementsV1 operation in AccessProfilesApi.
|
|
1434
1782
|
* @export
|
|
@@ -1572,6 +1920,70 @@ export interface AccessProfilesApiUpdateAccessProfilesInBulkV1Request {
|
|
|
1572
1920
|
*/
|
|
1573
1921
|
readonly accessProfileBulkUpdateRequestInner: Array<AccessProfileBulkUpdateRequestInner>;
|
|
1574
1922
|
}
|
|
1923
|
+
/**
|
|
1924
|
+
* Request parameters for updateAccessProfilesMetadataByFilterV1 operation in AccessProfilesApi.
|
|
1925
|
+
* @export
|
|
1926
|
+
* @interface AccessProfilesApiUpdateAccessProfilesMetadataByFilterV1Request
|
|
1927
|
+
*/
|
|
1928
|
+
export interface AccessProfilesApiUpdateAccessProfilesMetadataByFilterV1Request {
|
|
1929
|
+
/**
|
|
1930
|
+
*
|
|
1931
|
+
* @type {Accessprofilemetadatabulkupdatebyfilterrequest}
|
|
1932
|
+
* @memberof AccessProfilesApiUpdateAccessProfilesMetadataByFilterV1
|
|
1933
|
+
*/
|
|
1934
|
+
readonly accessprofilemetadatabulkupdatebyfilterrequest: Accessprofilemetadatabulkupdatebyfilterrequest;
|
|
1935
|
+
}
|
|
1936
|
+
/**
|
|
1937
|
+
* Request parameters for updateAccessProfilesMetadataByIdsV1 operation in AccessProfilesApi.
|
|
1938
|
+
* @export
|
|
1939
|
+
* @interface AccessProfilesApiUpdateAccessProfilesMetadataByIdsV1Request
|
|
1940
|
+
*/
|
|
1941
|
+
export interface AccessProfilesApiUpdateAccessProfilesMetadataByIdsV1Request {
|
|
1942
|
+
/**
|
|
1943
|
+
*
|
|
1944
|
+
* @type {Accessprofilemetadatabulkupdatebyidrequest}
|
|
1945
|
+
* @memberof AccessProfilesApiUpdateAccessProfilesMetadataByIdsV1
|
|
1946
|
+
*/
|
|
1947
|
+
readonly accessprofilemetadatabulkupdatebyidrequest: Accessprofilemetadatabulkupdatebyidrequest;
|
|
1948
|
+
}
|
|
1949
|
+
/**
|
|
1950
|
+
* Request parameters for updateAccessProfilesMetadataByQueryV1 operation in AccessProfilesApi.
|
|
1951
|
+
* @export
|
|
1952
|
+
* @interface AccessProfilesApiUpdateAccessProfilesMetadataByQueryV1Request
|
|
1953
|
+
*/
|
|
1954
|
+
export interface AccessProfilesApiUpdateAccessProfilesMetadataByQueryV1Request {
|
|
1955
|
+
/**
|
|
1956
|
+
*
|
|
1957
|
+
* @type {Accessprofilemetadatabulkupdatebyqueryrequest}
|
|
1958
|
+
* @memberof AccessProfilesApiUpdateAccessProfilesMetadataByQueryV1
|
|
1959
|
+
*/
|
|
1960
|
+
readonly accessprofilemetadatabulkupdatebyqueryrequest: Accessprofilemetadatabulkupdatebyqueryrequest;
|
|
1961
|
+
}
|
|
1962
|
+
/**
|
|
1963
|
+
* Request parameters for updateAttributeKeyAndValueToAccessProfileV1 operation in AccessProfilesApi.
|
|
1964
|
+
* @export
|
|
1965
|
+
* @interface AccessProfilesApiUpdateAttributeKeyAndValueToAccessProfileV1Request
|
|
1966
|
+
*/
|
|
1967
|
+
export interface AccessProfilesApiUpdateAttributeKeyAndValueToAccessProfileV1Request {
|
|
1968
|
+
/**
|
|
1969
|
+
* The access profile\'s ID.
|
|
1970
|
+
* @type {string}
|
|
1971
|
+
* @memberof AccessProfilesApiUpdateAttributeKeyAndValueToAccessProfileV1
|
|
1972
|
+
*/
|
|
1973
|
+
readonly id: string;
|
|
1974
|
+
/**
|
|
1975
|
+
* Technical name of the Attribute.
|
|
1976
|
+
* @type {string}
|
|
1977
|
+
* @memberof AccessProfilesApiUpdateAttributeKeyAndValueToAccessProfileV1
|
|
1978
|
+
*/
|
|
1979
|
+
readonly attributeKey: string;
|
|
1980
|
+
/**
|
|
1981
|
+
* Technical name of the Attribute Value.
|
|
1982
|
+
* @type {string}
|
|
1983
|
+
* @memberof AccessProfilesApiUpdateAttributeKeyAndValueToAccessProfileV1
|
|
1984
|
+
*/
|
|
1985
|
+
readonly attributeValue: string;
|
|
1986
|
+
}
|
|
1575
1987
|
/**
|
|
1576
1988
|
* AccessProfilesApi - object-oriented interface
|
|
1577
1989
|
* @export
|
|
@@ -1606,6 +2018,15 @@ export declare class AccessProfilesApi extends BaseAPI {
|
|
|
1606
2018
|
* @memberof AccessProfilesApi
|
|
1607
2019
|
*/
|
|
1608
2020
|
deleteAccessProfilesInBulkV1(requestParameters: AccessProfilesApiDeleteAccessProfilesInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfileBulkDeleteResponse, any>>;
|
|
2021
|
+
/**
|
|
2022
|
+
* This API removes a single Access Model Metadata value from an access profile by attribute key and attribute value.
|
|
2023
|
+
* @summary Remove metadata from access profile
|
|
2024
|
+
* @param {AccessProfilesApiDeleteMetadataFromAccessProfileByKeyAndValueV1Request} requestParameters Request parameters.
|
|
2025
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2026
|
+
* @throws {RequiredError}
|
|
2027
|
+
* @memberof AccessProfilesApi
|
|
2028
|
+
*/
|
|
2029
|
+
deleteMetadataFromAccessProfileByKeyAndValueV1(requestParameters: AccessProfilesApiDeleteMetadataFromAccessProfileByKeyAndValueV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
1609
2030
|
/**
|
|
1610
2031
|
* Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
1611
2032
|
* @summary List access profile\'s entitlements
|
|
@@ -1651,4 +2072,40 @@ export declare class AccessProfilesApi extends BaseAPI {
|
|
|
1651
2072
|
* @memberof AccessProfilesApi
|
|
1652
2073
|
*/
|
|
1653
2074
|
updateAccessProfilesInBulkV1(requestParameters: AccessProfilesApiUpdateAccessProfilesInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfileUpdateItem[], any>>;
|
|
2075
|
+
/**
|
|
2076
|
+
* 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.
|
|
2077
|
+
* @summary Bulk-update metadata by filter
|
|
2078
|
+
* @param {AccessProfilesApiUpdateAccessProfilesMetadataByFilterV1Request} requestParameters Request parameters.
|
|
2079
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2080
|
+
* @throws {RequiredError}
|
|
2081
|
+
* @memberof AccessProfilesApi
|
|
2082
|
+
*/
|
|
2083
|
+
updateAccessProfilesMetadataByFilterV1(requestParameters: AccessProfilesApiUpdateAccessProfilesMetadataByFilterV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Accessprofilemetadatabulkupdateresponse, any>>;
|
|
2084
|
+
/**
|
|
2085
|
+
* 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
|
+
* @summary Bulk-update metadata by ids
|
|
2087
|
+
* @param {AccessProfilesApiUpdateAccessProfilesMetadataByIdsV1Request} requestParameters Request parameters.
|
|
2088
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2089
|
+
* @throws {RequiredError}
|
|
2090
|
+
* @memberof AccessProfilesApi
|
|
2091
|
+
*/
|
|
2092
|
+
updateAccessProfilesMetadataByIdsV1(requestParameters: AccessProfilesApiUpdateAccessProfilesMetadataByIdsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Accessprofilemetadatabulkupdateresponse, any>>;
|
|
2093
|
+
/**
|
|
2094
|
+
* 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
|
+
* @summary Bulk-update metadata by query
|
|
2096
|
+
* @param {AccessProfilesApiUpdateAccessProfilesMetadataByQueryV1Request} requestParameters Request parameters.
|
|
2097
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2098
|
+
* @throws {RequiredError}
|
|
2099
|
+
* @memberof AccessProfilesApi
|
|
2100
|
+
*/
|
|
2101
|
+
updateAccessProfilesMetadataByQueryV1(requestParameters: AccessProfilesApiUpdateAccessProfilesMetadataByQueryV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Accessprofilemetadatabulkupdateresponse, any>>;
|
|
2102
|
+
/**
|
|
2103
|
+
* 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
|
+
* @summary Add metadata to access profile
|
|
2105
|
+
* @param {AccessProfilesApiUpdateAttributeKeyAndValueToAccessProfileV1Request} requestParameters Request parameters.
|
|
2106
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2107
|
+
* @throws {RequiredError}
|
|
2108
|
+
* @memberof AccessProfilesApi
|
|
2109
|
+
*/
|
|
2110
|
+
updateAttributeKeyAndValueToAccessProfileV1(requestParameters: AccessProfilesApiUpdateAttributeKeyAndValueToAccessProfileV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfile, any>>;
|
|
1654
2111
|
}
|