@sailpoint/api-client 2.2.11 → 2.2.13
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/connectors/api.d.ts +113 -0
- package/dist/connectors/api.js +32 -1
- package/dist/connectors/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/entitlements/api.d.ts +4 -4
- package/dist/entitlements/api.js +4 -4
- package/dist/entitlements/api.js.map +1 -1
- package/dist/esm/access_profiles/api.js +157 -43
- package/dist/esm/connectors/api.js +31 -0
- package/dist/esm/data_access_security/api.js +539 -20
- package/dist/esm/entitlements/api.js +4 -4
- 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/dist/sources/api.d.ts +6 -0
- package/dist/sources/api.js.map +1 -1
- package/package.json +1 -1
|
@@ -524,6 +524,32 @@ export interface CreateScheduleRequest {
|
|
|
524
524
|
*/
|
|
525
525
|
'applicationId'?: number | null;
|
|
526
526
|
}
|
|
527
|
+
/**
|
|
528
|
+
* Request body for creating a custom data dictionary field.
|
|
529
|
+
* @export
|
|
530
|
+
* @interface Createdatadictionaryfieldrequest
|
|
531
|
+
*/
|
|
532
|
+
export interface Createdatadictionaryfieldrequest {
|
|
533
|
+
/**
|
|
534
|
+
* The unique field name to create.
|
|
535
|
+
* @type {string}
|
|
536
|
+
* @memberof Createdatadictionaryfieldrequest
|
|
537
|
+
*/
|
|
538
|
+
'name': string;
|
|
539
|
+
/**
|
|
540
|
+
* The data dictionary that owns this field.
|
|
541
|
+
* @type {string}
|
|
542
|
+
* @memberof Createdatadictionaryfieldrequest
|
|
543
|
+
*/
|
|
544
|
+
'dataDictionaryType': CreatedatadictionaryfieldrequestDataDictionaryTypeEnum;
|
|
545
|
+
}
|
|
546
|
+
export declare const CreatedatadictionaryfieldrequestDataDictionaryTypeEnum: {
|
|
547
|
+
readonly Users: "Users";
|
|
548
|
+
readonly Roles: "Roles";
|
|
549
|
+
readonly PermissionTypes: "Permission Types";
|
|
550
|
+
readonly BusinessResources: "Business Resources";
|
|
551
|
+
};
|
|
552
|
+
export type CreatedatadictionaryfieldrequestDataDictionaryTypeEnum = typeof CreatedatadictionaryfieldrequestDataDictionaryTypeEnum[keyof typeof CreatedatadictionaryfieldrequestDataDictionaryTypeEnum];
|
|
527
553
|
/**
|
|
528
554
|
*
|
|
529
555
|
* @export
|
|
@@ -542,6 +568,18 @@ export interface Createidentitycollectorrequest {
|
|
|
542
568
|
* @memberof Createidentitycollectorrequest
|
|
543
569
|
*/
|
|
544
570
|
'sourceId': string;
|
|
571
|
+
/**
|
|
572
|
+
*
|
|
573
|
+
* @type {Identitycollectorcollectionsettings}
|
|
574
|
+
* @memberof Createidentitycollectorrequest
|
|
575
|
+
*/
|
|
576
|
+
'users'?: Identitycollectorcollectionsettings;
|
|
577
|
+
/**
|
|
578
|
+
*
|
|
579
|
+
* @type {Identitycollectorcollectionsettings}
|
|
580
|
+
* @memberof Createidentitycollectorrequest
|
|
581
|
+
*/
|
|
582
|
+
'groups'?: Identitycollectorcollectionsettings;
|
|
545
583
|
}
|
|
546
584
|
/**
|
|
547
585
|
*
|
|
@@ -587,6 +625,44 @@ export interface DataOwnerModel {
|
|
|
587
625
|
*/
|
|
588
626
|
'fullPath'?: string | null;
|
|
589
627
|
}
|
|
628
|
+
/**
|
|
629
|
+
* A custom data dictionary field used for permission and identity collector mappings.
|
|
630
|
+
* @export
|
|
631
|
+
* @interface Datadictionaryfieldlistitem
|
|
632
|
+
*/
|
|
633
|
+
export interface Datadictionaryfieldlistitem {
|
|
634
|
+
/**
|
|
635
|
+
* The unique field name.
|
|
636
|
+
* @type {string}
|
|
637
|
+
* @memberof Datadictionaryfieldlistitem
|
|
638
|
+
*/
|
|
639
|
+
'name': string;
|
|
640
|
+
/**
|
|
641
|
+
* The field data type. Custom fields are always String.
|
|
642
|
+
* @type {string}
|
|
643
|
+
* @memberof Datadictionaryfieldlistitem
|
|
644
|
+
*/
|
|
645
|
+
'fieldType': string;
|
|
646
|
+
/**
|
|
647
|
+
* The data dictionary that owns this field.
|
|
648
|
+
* @type {string}
|
|
649
|
+
* @memberof Datadictionaryfieldlistitem
|
|
650
|
+
*/
|
|
651
|
+
'dataDictionaryType': DatadictionaryfieldlistitemDataDictionaryTypeEnum;
|
|
652
|
+
/**
|
|
653
|
+
* Whether the field is required. Custom fields returned by list are always false.
|
|
654
|
+
* @type {boolean}
|
|
655
|
+
* @memberof Datadictionaryfieldlistitem
|
|
656
|
+
*/
|
|
657
|
+
'required': boolean;
|
|
658
|
+
}
|
|
659
|
+
export declare const DatadictionaryfieldlistitemDataDictionaryTypeEnum: {
|
|
660
|
+
readonly Users: "Users";
|
|
661
|
+
readonly Roles: "Roles";
|
|
662
|
+
readonly PermissionTypes: "Permission Types";
|
|
663
|
+
readonly BusinessResources: "Business Resources";
|
|
664
|
+
};
|
|
665
|
+
export type DatadictionaryfieldlistitemDataDictionaryTypeEnum = typeof DatadictionaryfieldlistitemDataDictionaryTypeEnum[keyof typeof DatadictionaryfieldlistitemDataDictionaryTypeEnum];
|
|
590
666
|
/**
|
|
591
667
|
*
|
|
592
668
|
* @export
|
|
@@ -669,6 +745,82 @@ export interface GetTasksV1429Response {
|
|
|
669
745
|
*/
|
|
670
746
|
'message'?: any;
|
|
671
747
|
}
|
|
748
|
+
/**
|
|
749
|
+
*
|
|
750
|
+
* @export
|
|
751
|
+
* @interface Identitycollectorbuiltinpropertiesbytype
|
|
752
|
+
*/
|
|
753
|
+
export interface Identitycollectorbuiltinpropertiesbytype {
|
|
754
|
+
/**
|
|
755
|
+
* Identity collector type display name.
|
|
756
|
+
* @type {string}
|
|
757
|
+
* @memberof Identitycollectorbuiltinpropertiesbytype
|
|
758
|
+
*/
|
|
759
|
+
'type': string;
|
|
760
|
+
/**
|
|
761
|
+
* Built-in user source attribute names that can be used in field mappings for the identity collector type.
|
|
762
|
+
* @type {Array<string>}
|
|
763
|
+
* @memberof Identitycollectorbuiltinpropertiesbytype
|
|
764
|
+
*/
|
|
765
|
+
'users': Array<string>;
|
|
766
|
+
/**
|
|
767
|
+
* Built-in group source attribute names that can be used in field mappings for the identity collector type.
|
|
768
|
+
* @type {Array<string>}
|
|
769
|
+
* @memberof Identitycollectorbuiltinpropertiesbytype
|
|
770
|
+
*/
|
|
771
|
+
'groups': Array<string>;
|
|
772
|
+
}
|
|
773
|
+
/**
|
|
774
|
+
*
|
|
775
|
+
* @export
|
|
776
|
+
* @interface Identitycollectorbuiltinpropertiesresponse
|
|
777
|
+
*/
|
|
778
|
+
export interface Identitycollectorbuiltinpropertiesresponse {
|
|
779
|
+
/**
|
|
780
|
+
* Built-in source attribute names grouped by identity collector type.
|
|
781
|
+
* @type {Array<Identitycollectorbuiltinpropertiesbytype>}
|
|
782
|
+
* @memberof Identitycollectorbuiltinpropertiesresponse
|
|
783
|
+
*/
|
|
784
|
+
'types': Array<Identitycollectorbuiltinpropertiesbytype>;
|
|
785
|
+
}
|
|
786
|
+
/**
|
|
787
|
+
*
|
|
788
|
+
* @export
|
|
789
|
+
* @interface Identitycollectorcollectionsettings
|
|
790
|
+
*/
|
|
791
|
+
export interface Identitycollectorcollectionsettings {
|
|
792
|
+
/**
|
|
793
|
+
* Source attribute names to register as datasource columns for this collection. These names must match the attributes sent by Identity Security Cloud. Use an empty array when no custom attributes are required.
|
|
794
|
+
* @type {Array<string>}
|
|
795
|
+
* @memberof Identitycollectorcollectionsettings
|
|
796
|
+
*/
|
|
797
|
+
'properties': Array<string>;
|
|
798
|
+
/**
|
|
799
|
+
* Maps source attributes to data dictionary fields and DAS custom field slots. Each `sourceAttributeName` must be either a built-in attribute for the identity collector type or listed in `properties`. Use an empty array when no dynamic field mappings are configured.
|
|
800
|
+
* @type {Array<Identitycollectorfieldmapping>}
|
|
801
|
+
* @memberof Identitycollectorcollectionsettings
|
|
802
|
+
*/
|
|
803
|
+
'fieldMappings': Array<Identitycollectorfieldmapping>;
|
|
804
|
+
}
|
|
805
|
+
/**
|
|
806
|
+
*
|
|
807
|
+
* @export
|
|
808
|
+
* @interface Identitycollectorfieldmapping
|
|
809
|
+
*/
|
|
810
|
+
export interface Identitycollectorfieldmapping {
|
|
811
|
+
/**
|
|
812
|
+
* The name of the data dictionary field to map to. Dictionary fields of type Users apply to the users collection; dictionary fields of type Roles apply to the groups collection.
|
|
813
|
+
* @type {string}
|
|
814
|
+
* @memberof Identitycollectorfieldmapping
|
|
815
|
+
*/
|
|
816
|
+
'fieldDictionaryName': string;
|
|
817
|
+
/**
|
|
818
|
+
* The source attribute name to read at runtime. This may be a built-in attribute for the identity collector type or a custom attribute listed in `properties` for the same collection. Built-in attributes can be discovered using the identity collector properties metadata endpoint.
|
|
819
|
+
* @type {string}
|
|
820
|
+
* @memberof Identitycollectorfieldmapping
|
|
821
|
+
*/
|
|
822
|
+
'sourceAttributeName': string;
|
|
823
|
+
}
|
|
672
824
|
/**
|
|
673
825
|
*
|
|
674
826
|
* @export
|
|
@@ -688,7 +840,7 @@ export interface Identitycollectorlistitem {
|
|
|
688
840
|
*/
|
|
689
841
|
'name'?: string;
|
|
690
842
|
/**
|
|
691
|
-
* The identity collector type, derived from its underlying source.
|
|
843
|
+
* The identity collector type, derived from its underlying source.
|
|
692
844
|
* @type {string}
|
|
693
845
|
* @memberof Identitycollectorlistitem
|
|
694
846
|
*/
|
|
@@ -699,6 +851,18 @@ export interface Identitycollectorlistitem {
|
|
|
699
851
|
* @memberof Identitycollectorlistitem
|
|
700
852
|
*/
|
|
701
853
|
'sourceId'?: string;
|
|
854
|
+
/**
|
|
855
|
+
*
|
|
856
|
+
* @type {Identitycollectorcollectionsettings}
|
|
857
|
+
* @memberof Identitycollectorlistitem
|
|
858
|
+
*/
|
|
859
|
+
'users'?: Identitycollectorcollectionsettings;
|
|
860
|
+
/**
|
|
861
|
+
*
|
|
862
|
+
* @type {Identitycollectorcollectionsettings}
|
|
863
|
+
* @memberof Identitycollectorlistitem
|
|
864
|
+
*/
|
|
865
|
+
'groups'?: Identitycollectorcollectionsettings;
|
|
702
866
|
}
|
|
703
867
|
/**
|
|
704
868
|
*
|
|
@@ -1141,7 +1305,45 @@ export interface UpdateScheduleRequest {
|
|
|
1141
1305
|
'applicationId'?: number | null;
|
|
1142
1306
|
}
|
|
1143
1307
|
/**
|
|
1144
|
-
*
|
|
1308
|
+
* Complete data dictionary field representation for [Replace Data Dictionary Field](https://developer.sailpoint.com/docs/api/put-data-dictionary-field-v-1). The server fully replaces the field using this body. For custom fields, `fieldType`, `dataDictionaryType`, and `required` must match the current values; only `name` may change. Built-in fields where `required` is true cannot be updated.
|
|
1309
|
+
* @export
|
|
1310
|
+
* @interface Updatedatadictionaryfieldrequest
|
|
1311
|
+
*/
|
|
1312
|
+
export interface Updatedatadictionaryfieldrequest {
|
|
1313
|
+
/**
|
|
1314
|
+
* The field name.
|
|
1315
|
+
* @type {string}
|
|
1316
|
+
* @memberof Updatedatadictionaryfieldrequest
|
|
1317
|
+
*/
|
|
1318
|
+
'name': string;
|
|
1319
|
+
/**
|
|
1320
|
+
* The field data type. Must match the current value.
|
|
1321
|
+
* @type {string}
|
|
1322
|
+
* @memberof Updatedatadictionaryfieldrequest
|
|
1323
|
+
*/
|
|
1324
|
+
'fieldType': string;
|
|
1325
|
+
/**
|
|
1326
|
+
* The data dictionary that owns this field. Must match the current value.
|
|
1327
|
+
* @type {string}
|
|
1328
|
+
* @memberof Updatedatadictionaryfieldrequest
|
|
1329
|
+
*/
|
|
1330
|
+
'dataDictionaryType': UpdatedatadictionaryfieldrequestDataDictionaryTypeEnum;
|
|
1331
|
+
/**
|
|
1332
|
+
* Must match the current value. Custom fields must be false.
|
|
1333
|
+
* @type {boolean}
|
|
1334
|
+
* @memberof Updatedatadictionaryfieldrequest
|
|
1335
|
+
*/
|
|
1336
|
+
'required': boolean;
|
|
1337
|
+
}
|
|
1338
|
+
export declare const UpdatedatadictionaryfieldrequestDataDictionaryTypeEnum: {
|
|
1339
|
+
readonly Users: "Users";
|
|
1340
|
+
readonly Roles: "Roles";
|
|
1341
|
+
readonly PermissionTypes: "Permission Types";
|
|
1342
|
+
readonly BusinessResources: "Business Resources";
|
|
1343
|
+
};
|
|
1344
|
+
export type UpdatedatadictionaryfieldrequestDataDictionaryTypeEnum = typeof UpdatedatadictionaryfieldrequestDataDictionaryTypeEnum[keyof typeof UpdatedatadictionaryfieldrequestDataDictionaryTypeEnum];
|
|
1345
|
+
/**
|
|
1346
|
+
* Complete identity collector representation for [Replace Identity Collector](https://developer.sailpoint.com/docs/api/put-identity-collector-v-1). The server fully replaces the existing resource with this payload. Partial updates are not supported; `users` and `groups` must always be supplied and replace the current collection settings in their entirety.
|
|
1145
1347
|
* @export
|
|
1146
1348
|
* @interface Updateidentitycollectorrequest
|
|
1147
1349
|
*/
|
|
@@ -1164,6 +1366,18 @@ export interface Updateidentitycollectorrequest {
|
|
|
1164
1366
|
* @memberof Updateidentitycollectorrequest
|
|
1165
1367
|
*/
|
|
1166
1368
|
'type': string;
|
|
1369
|
+
/**
|
|
1370
|
+
*
|
|
1371
|
+
* @type {Identitycollectorcollectionsettings}
|
|
1372
|
+
* @memberof Updateidentitycollectorrequest
|
|
1373
|
+
*/
|
|
1374
|
+
'users': Identitycollectorcollectionsettings;
|
|
1375
|
+
/**
|
|
1376
|
+
*
|
|
1377
|
+
* @type {Identitycollectorcollectionsettings}
|
|
1378
|
+
* @memberof Updateidentitycollectorrequest
|
|
1379
|
+
*/
|
|
1380
|
+
'groups': Identitycollectorcollectionsettings;
|
|
1167
1381
|
}
|
|
1168
1382
|
/**
|
|
1169
1383
|
* DataAccessSecurityApi - axios parameter creator
|
|
@@ -1187,7 +1401,15 @@ export declare const DataAccessSecurityApiAxiosParamCreator: (configuration?: Co
|
|
|
1187
1401
|
*/
|
|
1188
1402
|
createApplicationV1: (baseCreateApplicationRequest: BaseCreateApplicationRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1189
1403
|
/**
|
|
1190
|
-
*
|
|
1404
|
+
* Creates a custom data dictionary field. The server assigns fieldType String and required false; callers do not supply those values.
|
|
1405
|
+
* @summary Create data dictionary field
|
|
1406
|
+
* @param {Createdatadictionaryfieldrequest} createdatadictionaryfieldrequest Custom data dictionary field to create.
|
|
1407
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1408
|
+
* @throws {RequiredError}
|
|
1409
|
+
*/
|
|
1410
|
+
createDataDictionaryFieldV1: (createdatadictionaryfieldrequest: Createdatadictionaryfieldrequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1411
|
+
/**
|
|
1412
|
+
* This endpoint creates a new identity collector in Data Access Security for the specified source. The identity collector type is derived from the source. Optionally configure `users` and `groups` to register source attributes (`properties`) and map them to data dictionary fields by name (`fieldMappings.fieldDictionaryName`). When omitted, both collections are created with fixed columns only.
|
|
1191
1413
|
* @summary Create identity collector
|
|
1192
1414
|
* @param {Createidentitycollectorrequest} createidentitycollectorrequest Request body containing the details required to create a new identity collector.
|
|
1193
1415
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1255,6 +1477,14 @@ export declare const DataAccessSecurityApiAxiosParamCreator: (configuration?: Co
|
|
|
1255
1477
|
* @throws {RequiredError}
|
|
1256
1478
|
*/
|
|
1257
1479
|
deleteApplicationV1: (id: number, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1480
|
+
/**
|
|
1481
|
+
* Deletes a custom data dictionary field. Built-in fields where required is true cannot be deleted.
|
|
1482
|
+
* @summary Delete data dictionary field
|
|
1483
|
+
* @param {string} name The field name to delete.
|
|
1484
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1485
|
+
* @throws {RequiredError}
|
|
1486
|
+
*/
|
|
1487
|
+
deleteDataDictionaryFieldV1: (name: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1258
1488
|
/**
|
|
1259
1489
|
* This endpoint deletes an identity collector from Data Access Security by its unique identifier.
|
|
1260
1490
|
* @summary Delete identity collector by identifier
|
|
@@ -1298,6 +1528,23 @@ export declare const DataAccessSecurityApiAxiosParamCreator: (configuration?: Co
|
|
|
1298
1528
|
* @throws {RequiredError}
|
|
1299
1529
|
*/
|
|
1300
1530
|
getApplicationsV1: (filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1531
|
+
/**
|
|
1532
|
+
* Returns the built-in source attribute names for users and groups collections. When no filter is provided, built-in properties for all public identity collector types are returned (the same base types listed by [List Identity Collector Types](https://developer.sailpoint.com/docs/api/get-identity-collector-types-v-1)). When filtered by `type`, only the matching type is returned; the filter accepts any supported type display name, including SaaS variants such as `Box SaaS` or `AWS SaaS`. These attributes are always available for field mapping without being listed in `properties`.
|
|
1533
|
+
* @summary List built-in identity collector properties
|
|
1534
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq*
|
|
1535
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1536
|
+
* @throws {RequiredError}
|
|
1537
|
+
*/
|
|
1538
|
+
getIdentityCollectorBuiltinPropertiesV1: (filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1539
|
+
/**
|
|
1540
|
+
* Returns the public identity collector type display names exposed for metadata and UI discovery. This endpoint lists base types only (for example, `Box` rather than `Box SaaS`). SaaS variants are not listed here; the identity collector type is derived from `sourceId` when creating an identity collector. Existing identity collectors may still report SaaS variant types in list and update responses. Pagination is not supported for this endpoint; the full set of public types is always returned.
|
|
1541
|
+
* @summary List identity collector types
|
|
1542
|
+
* @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.
|
|
1543
|
+
* @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.
|
|
1544
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1545
|
+
* @throws {RequiredError}
|
|
1546
|
+
*/
|
|
1547
|
+
getIdentityCollectorTypesV1: (limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1301
1548
|
/**
|
|
1302
1549
|
*
|
|
1303
1550
|
* @summary Retrieve owners per application.
|
|
@@ -1346,6 +1593,17 @@ export declare const DataAccessSecurityApiAxiosParamCreator: (configuration?: Co
|
|
|
1346
1593
|
* @throws {RequiredError}
|
|
1347
1594
|
*/
|
|
1348
1595
|
getTasksV1: (filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1596
|
+
/**
|
|
1597
|
+
* Returns custom data dictionary fields that can be used when configuring identity collector field mappings and other permission-related settings. Built-in fields are not included in list responses; only custom fields created via [Create Data Dictionary Field](https://developer.sailpoint.com/docs/api/create-data-dictionary-field-v-1) are returned. All listed fields have `required: false`.
|
|
1598
|
+
* @summary List data dictionary fields
|
|
1599
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **dataDictionaryType**: *eq* **name**: *eq* Supported composite operators are *and*
|
|
1600
|
+
* @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.
|
|
1601
|
+
* @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.
|
|
1602
|
+
* @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.
|
|
1603
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1604
|
+
* @throws {RequiredError}
|
|
1605
|
+
*/
|
|
1606
|
+
listDataDictionaryFieldsV1: (filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1349
1607
|
/**
|
|
1350
1608
|
* This endpoint lists the identity collectors in Data Access Security with optional filtering and pagination. Sorting is not supported for this endpoint; supplying the `sorters` query parameter results in a validation error.
|
|
1351
1609
|
* @summary List identity collectors
|
|
@@ -1367,10 +1625,19 @@ export declare const DataAccessSecurityApiAxiosParamCreator: (configuration?: Co
|
|
|
1367
1625
|
*/
|
|
1368
1626
|
putApplicationV1: (id: number, baseCreateApplicationRequest: BaseCreateApplicationRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1369
1627
|
/**
|
|
1370
|
-
* This
|
|
1371
|
-
* @summary
|
|
1372
|
-
* @param {
|
|
1373
|
-
* @param {
|
|
1628
|
+
* Fully replaces a custom data dictionary field. This is a PUT operation, not a partial update: the request body must contain the complete resource representation. Omitted properties are rejected. For custom fields, `fieldType`, `dataDictionaryType`, and `required` must match the current values; only `name` may change. Built-in fields where `required` is true cannot be updated. List the field first with [List Data Dictionary Fields](https://developer.sailpoint.com/docs/api/list-data-dictionary-fields-v-1) to obtain the current representation before replacing it.
|
|
1629
|
+
* @summary Replace data dictionary field
|
|
1630
|
+
* @param {string} name The current field name.
|
|
1631
|
+
* @param {Updatedatadictionaryfieldrequest} updatedatadictionaryfieldrequest Complete data dictionary field representation used to fully replace the existing field.
|
|
1632
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1633
|
+
* @throws {RequiredError}
|
|
1634
|
+
*/
|
|
1635
|
+
putDataDictionaryFieldV1: (name: string, updatedatadictionaryfieldrequest: Updatedatadictionaryfieldrequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1636
|
+
/**
|
|
1637
|
+
* Fully replaces an existing identity collector in Data Access Security. This is a PUT operation, not a partial update: the request body must contain the complete resource representation. Omitted or null top-level properties are rejected. After a successful request, a subsequent list request returns exactly the configuration that was sent. Retrieve the current configuration with [List Identity Collectors](https://developer.sailpoint.com/docs/api/list-identity-collectors-v-1) before replacing it. The `sourceId` and `type` cannot be changed and must match the current values.
|
|
1638
|
+
* @summary Replace identity collector
|
|
1639
|
+
* @param {number} id The unique identifier of the identity collector to replace.
|
|
1640
|
+
* @param {Updateidentitycollectorrequest} updateidentitycollectorrequest Complete identity collector representation used to fully replace the existing resource. Partial updates are not supported.
|
|
1374
1641
|
* @param {*} [axiosOptions] Override http request option.
|
|
1375
1642
|
* @throws {RequiredError}
|
|
1376
1643
|
*/
|
|
@@ -1415,7 +1682,15 @@ export declare const DataAccessSecurityApiFp: (configuration?: Configuration) =>
|
|
|
1415
1682
|
*/
|
|
1416
1683
|
createApplicationV1(baseCreateApplicationRequest: BaseCreateApplicationRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1417
1684
|
/**
|
|
1418
|
-
*
|
|
1685
|
+
* Creates a custom data dictionary field. The server assigns fieldType String and required false; callers do not supply those values.
|
|
1686
|
+
* @summary Create data dictionary field
|
|
1687
|
+
* @param {Createdatadictionaryfieldrequest} createdatadictionaryfieldrequest Custom data dictionary field to create.
|
|
1688
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1689
|
+
* @throws {RequiredError}
|
|
1690
|
+
*/
|
|
1691
|
+
createDataDictionaryFieldV1(createdatadictionaryfieldrequest: Createdatadictionaryfieldrequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Datadictionaryfieldlistitem>>;
|
|
1692
|
+
/**
|
|
1693
|
+
* This endpoint creates a new identity collector in Data Access Security for the specified source. The identity collector type is derived from the source. Optionally configure `users` and `groups` to register source attributes (`properties`) and map them to data dictionary fields by name (`fieldMappings.fieldDictionaryName`). When omitted, both collections are created with fixed columns only.
|
|
1419
1694
|
* @summary Create identity collector
|
|
1420
1695
|
* @param {Createidentitycollectorrequest} createidentitycollectorrequest Request body containing the details required to create a new identity collector.
|
|
1421
1696
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1483,6 +1758,14 @@ export declare const DataAccessSecurityApiFp: (configuration?: Configuration) =>
|
|
|
1483
1758
|
* @throws {RequiredError}
|
|
1484
1759
|
*/
|
|
1485
1760
|
deleteApplicationV1(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1761
|
+
/**
|
|
1762
|
+
* Deletes a custom data dictionary field. Built-in fields where required is true cannot be deleted.
|
|
1763
|
+
* @summary Delete data dictionary field
|
|
1764
|
+
* @param {string} name The field name to delete.
|
|
1765
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1766
|
+
* @throws {RequiredError}
|
|
1767
|
+
*/
|
|
1768
|
+
deleteDataDictionaryFieldV1(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1486
1769
|
/**
|
|
1487
1770
|
* This endpoint deletes an identity collector from Data Access Security by its unique identifier.
|
|
1488
1771
|
* @summary Delete identity collector by identifier
|
|
@@ -1526,6 +1809,23 @@ export declare const DataAccessSecurityApiFp: (configuration?: Configuration) =>
|
|
|
1526
1809
|
* @throws {RequiredError}
|
|
1527
1810
|
*/
|
|
1528
1811
|
getApplicationsV1(filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ApplicationItem>>>;
|
|
1812
|
+
/**
|
|
1813
|
+
* Returns the built-in source attribute names for users and groups collections. When no filter is provided, built-in properties for all public identity collector types are returned (the same base types listed by [List Identity Collector Types](https://developer.sailpoint.com/docs/api/get-identity-collector-types-v-1)). When filtered by `type`, only the matching type is returned; the filter accepts any supported type display name, including SaaS variants such as `Box SaaS` or `AWS SaaS`. These attributes are always available for field mapping without being listed in `properties`.
|
|
1814
|
+
* @summary List built-in identity collector properties
|
|
1815
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq*
|
|
1816
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1817
|
+
* @throws {RequiredError}
|
|
1818
|
+
*/
|
|
1819
|
+
getIdentityCollectorBuiltinPropertiesV1(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Identitycollectorbuiltinpropertiesresponse>>;
|
|
1820
|
+
/**
|
|
1821
|
+
* Returns the public identity collector type display names exposed for metadata and UI discovery. This endpoint lists base types only (for example, `Box` rather than `Box SaaS`). SaaS variants are not listed here; the identity collector type is derived from `sourceId` when creating an identity collector. Existing identity collectors may still report SaaS variant types in list and update responses. Pagination is not supported for this endpoint; the full set of public types is always returned.
|
|
1822
|
+
* @summary List identity collector types
|
|
1823
|
+
* @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.
|
|
1824
|
+
* @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.
|
|
1825
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1826
|
+
* @throws {RequiredError}
|
|
1827
|
+
*/
|
|
1828
|
+
getIdentityCollectorTypesV1(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
1529
1829
|
/**
|
|
1530
1830
|
*
|
|
1531
1831
|
* @summary Retrieve owners per application.
|
|
@@ -1574,6 +1874,17 @@ export declare const DataAccessSecurityApiFp: (configuration?: Configuration) =>
|
|
|
1574
1874
|
* @throws {RequiredError}
|
|
1575
1875
|
*/
|
|
1576
1876
|
getTasksV1(filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TaskInfo>>>;
|
|
1877
|
+
/**
|
|
1878
|
+
* Returns custom data dictionary fields that can be used when configuring identity collector field mappings and other permission-related settings. Built-in fields are not included in list responses; only custom fields created via [Create Data Dictionary Field](https://developer.sailpoint.com/docs/api/create-data-dictionary-field-v-1) are returned. All listed fields have `required: false`.
|
|
1879
|
+
* @summary List data dictionary fields
|
|
1880
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **dataDictionaryType**: *eq* **name**: *eq* Supported composite operators are *and*
|
|
1881
|
+
* @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.
|
|
1882
|
+
* @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.
|
|
1883
|
+
* @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.
|
|
1884
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1885
|
+
* @throws {RequiredError}
|
|
1886
|
+
*/
|
|
1887
|
+
listDataDictionaryFieldsV1(filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Datadictionaryfieldlistitem>>>;
|
|
1577
1888
|
/**
|
|
1578
1889
|
* This endpoint lists the identity collectors in Data Access Security with optional filtering and pagination. Sorting is not supported for this endpoint; supplying the `sorters` query parameter results in a validation error.
|
|
1579
1890
|
* @summary List identity collectors
|
|
@@ -1595,10 +1906,19 @@ export declare const DataAccessSecurityApiFp: (configuration?: Configuration) =>
|
|
|
1595
1906
|
*/
|
|
1596
1907
|
putApplicationV1(id: number, baseCreateApplicationRequest: BaseCreateApplicationRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1597
1908
|
/**
|
|
1598
|
-
* This
|
|
1599
|
-
* @summary
|
|
1600
|
-
* @param {
|
|
1601
|
-
* @param {
|
|
1909
|
+
* Fully replaces a custom data dictionary field. This is a PUT operation, not a partial update: the request body must contain the complete resource representation. Omitted properties are rejected. For custom fields, `fieldType`, `dataDictionaryType`, and `required` must match the current values; only `name` may change. Built-in fields where `required` is true cannot be updated. List the field first with [List Data Dictionary Fields](https://developer.sailpoint.com/docs/api/list-data-dictionary-fields-v-1) to obtain the current representation before replacing it.
|
|
1910
|
+
* @summary Replace data dictionary field
|
|
1911
|
+
* @param {string} name The current field name.
|
|
1912
|
+
* @param {Updatedatadictionaryfieldrequest} updatedatadictionaryfieldrequest Complete data dictionary field representation used to fully replace the existing field.
|
|
1913
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1914
|
+
* @throws {RequiredError}
|
|
1915
|
+
*/
|
|
1916
|
+
putDataDictionaryFieldV1(name: string, updatedatadictionaryfieldrequest: Updatedatadictionaryfieldrequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Datadictionaryfieldlistitem>>;
|
|
1917
|
+
/**
|
|
1918
|
+
* Fully replaces an existing identity collector in Data Access Security. This is a PUT operation, not a partial update: the request body must contain the complete resource representation. Omitted or null top-level properties are rejected. After a successful request, a subsequent list request returns exactly the configuration that was sent. Retrieve the current configuration with [List Identity Collectors](https://developer.sailpoint.com/docs/api/list-identity-collectors-v-1) before replacing it. The `sourceId` and `type` cannot be changed and must match the current values.
|
|
1919
|
+
* @summary Replace identity collector
|
|
1920
|
+
* @param {number} id The unique identifier of the identity collector to replace.
|
|
1921
|
+
* @param {Updateidentitycollectorrequest} updateidentitycollectorrequest Complete identity collector representation used to fully replace the existing resource. Partial updates are not supported.
|
|
1602
1922
|
* @param {*} [axiosOptions] Override http request option.
|
|
1603
1923
|
* @throws {RequiredError}
|
|
1604
1924
|
*/
|
|
@@ -1643,7 +1963,15 @@ export declare const DataAccessSecurityApiFactory: (configuration?: Configuratio
|
|
|
1643
1963
|
*/
|
|
1644
1964
|
createApplicationV1(requestParameters: DataAccessSecurityApiCreateApplicationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1645
1965
|
/**
|
|
1646
|
-
*
|
|
1966
|
+
* Creates a custom data dictionary field. The server assigns fieldType String and required false; callers do not supply those values.
|
|
1967
|
+
* @summary Create data dictionary field
|
|
1968
|
+
* @param {DataAccessSecurityApiCreateDataDictionaryFieldV1Request} requestParameters Request parameters.
|
|
1969
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1970
|
+
* @throws {RequiredError}
|
|
1971
|
+
*/
|
|
1972
|
+
createDataDictionaryFieldV1(requestParameters: DataAccessSecurityApiCreateDataDictionaryFieldV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Datadictionaryfieldlistitem>;
|
|
1973
|
+
/**
|
|
1974
|
+
* This endpoint creates a new identity collector in Data Access Security for the specified source. The identity collector type is derived from the source. Optionally configure `users` and `groups` to register source attributes (`properties`) and map them to data dictionary fields by name (`fieldMappings.fieldDictionaryName`). When omitted, both collections are created with fixed columns only.
|
|
1647
1975
|
* @summary Create identity collector
|
|
1648
1976
|
* @param {DataAccessSecurityApiCreateIdentityCollectorV1Request} requestParameters Request parameters.
|
|
1649
1977
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -1706,6 +2034,14 @@ export declare const DataAccessSecurityApiFactory: (configuration?: Configuratio
|
|
|
1706
2034
|
* @throws {RequiredError}
|
|
1707
2035
|
*/
|
|
1708
2036
|
deleteApplicationV1(requestParameters: DataAccessSecurityApiDeleteApplicationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2037
|
+
/**
|
|
2038
|
+
* Deletes a custom data dictionary field. Built-in fields where required is true cannot be deleted.
|
|
2039
|
+
* @summary Delete data dictionary field
|
|
2040
|
+
* @param {DataAccessSecurityApiDeleteDataDictionaryFieldV1Request} requestParameters Request parameters.
|
|
2041
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2042
|
+
* @throws {RequiredError}
|
|
2043
|
+
*/
|
|
2044
|
+
deleteDataDictionaryFieldV1(requestParameters: DataAccessSecurityApiDeleteDataDictionaryFieldV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1709
2045
|
/**
|
|
1710
2046
|
* This endpoint deletes an identity collector from Data Access Security by its unique identifier.
|
|
1711
2047
|
* @summary Delete identity collector by identifier
|
|
@@ -1746,6 +2082,22 @@ export declare const DataAccessSecurityApiFactory: (configuration?: Configuratio
|
|
|
1746
2082
|
* @throws {RequiredError}
|
|
1747
2083
|
*/
|
|
1748
2084
|
getApplicationsV1(requestParameters?: DataAccessSecurityApiGetApplicationsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<ApplicationItem>>;
|
|
2085
|
+
/**
|
|
2086
|
+
* Returns the built-in source attribute names for users and groups collections. When no filter is provided, built-in properties for all public identity collector types are returned (the same base types listed by [List Identity Collector Types](https://developer.sailpoint.com/docs/api/get-identity-collector-types-v-1)). When filtered by `type`, only the matching type is returned; the filter accepts any supported type display name, including SaaS variants such as `Box SaaS` or `AWS SaaS`. These attributes are always available for field mapping without being listed in `properties`.
|
|
2087
|
+
* @summary List built-in identity collector properties
|
|
2088
|
+
* @param {DataAccessSecurityApiGetIdentityCollectorBuiltinPropertiesV1Request} requestParameters Request parameters.
|
|
2089
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2090
|
+
* @throws {RequiredError}
|
|
2091
|
+
*/
|
|
2092
|
+
getIdentityCollectorBuiltinPropertiesV1(requestParameters?: DataAccessSecurityApiGetIdentityCollectorBuiltinPropertiesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Identitycollectorbuiltinpropertiesresponse>;
|
|
2093
|
+
/**
|
|
2094
|
+
* Returns the public identity collector type display names exposed for metadata and UI discovery. This endpoint lists base types only (for example, `Box` rather than `Box SaaS`). SaaS variants are not listed here; the identity collector type is derived from `sourceId` when creating an identity collector. Existing identity collectors may still report SaaS variant types in list and update responses. Pagination is not supported for this endpoint; the full set of public types is always returned.
|
|
2095
|
+
* @summary List identity collector types
|
|
2096
|
+
* @param {DataAccessSecurityApiGetIdentityCollectorTypesV1Request} requestParameters Request parameters.
|
|
2097
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2098
|
+
* @throws {RequiredError}
|
|
2099
|
+
*/
|
|
2100
|
+
getIdentityCollectorTypesV1(requestParameters?: DataAccessSecurityApiGetIdentityCollectorTypesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
1749
2101
|
/**
|
|
1750
2102
|
*
|
|
1751
2103
|
* @summary Retrieve owners per application.
|
|
@@ -1786,6 +2138,14 @@ export declare const DataAccessSecurityApiFactory: (configuration?: Configuratio
|
|
|
1786
2138
|
* @throws {RequiredError}
|
|
1787
2139
|
*/
|
|
1788
2140
|
getTasksV1(requestParameters?: DataAccessSecurityApiGetTasksV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<TaskInfo>>;
|
|
2141
|
+
/**
|
|
2142
|
+
* Returns custom data dictionary fields that can be used when configuring identity collector field mappings and other permission-related settings. Built-in fields are not included in list responses; only custom fields created via [Create Data Dictionary Field](https://developer.sailpoint.com/docs/api/create-data-dictionary-field-v-1) are returned. All listed fields have `required: false`.
|
|
2143
|
+
* @summary List data dictionary fields
|
|
2144
|
+
* @param {DataAccessSecurityApiListDataDictionaryFieldsV1Request} requestParameters Request parameters.
|
|
2145
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2146
|
+
* @throws {RequiredError}
|
|
2147
|
+
*/
|
|
2148
|
+
listDataDictionaryFieldsV1(requestParameters?: DataAccessSecurityApiListDataDictionaryFieldsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Datadictionaryfieldlistitem>>;
|
|
1789
2149
|
/**
|
|
1790
2150
|
* This endpoint lists the identity collectors in Data Access Security with optional filtering and pagination. Sorting is not supported for this endpoint; supplying the `sorters` query parameter results in a validation error.
|
|
1791
2151
|
* @summary List identity collectors
|
|
@@ -1803,8 +2163,16 @@ export declare const DataAccessSecurityApiFactory: (configuration?: Configuratio
|
|
|
1803
2163
|
*/
|
|
1804
2164
|
putApplicationV1(requestParameters: DataAccessSecurityApiPutApplicationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1805
2165
|
/**
|
|
1806
|
-
* This
|
|
1807
|
-
* @summary
|
|
2166
|
+
* Fully replaces a custom data dictionary field. This is a PUT operation, not a partial update: the request body must contain the complete resource representation. Omitted properties are rejected. For custom fields, `fieldType`, `dataDictionaryType`, and `required` must match the current values; only `name` may change. Built-in fields where `required` is true cannot be updated. List the field first with [List Data Dictionary Fields](https://developer.sailpoint.com/docs/api/list-data-dictionary-fields-v-1) to obtain the current representation before replacing it.
|
|
2167
|
+
* @summary Replace data dictionary field
|
|
2168
|
+
* @param {DataAccessSecurityApiPutDataDictionaryFieldV1Request} requestParameters Request parameters.
|
|
2169
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2170
|
+
* @throws {RequiredError}
|
|
2171
|
+
*/
|
|
2172
|
+
putDataDictionaryFieldV1(requestParameters: DataAccessSecurityApiPutDataDictionaryFieldV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Datadictionaryfieldlistitem>;
|
|
2173
|
+
/**
|
|
2174
|
+
* Fully replaces an existing identity collector in Data Access Security. This is a PUT operation, not a partial update: the request body must contain the complete resource representation. Omitted or null top-level properties are rejected. After a successful request, a subsequent list request returns exactly the configuration that was sent. Retrieve the current configuration with [List Identity Collectors](https://developer.sailpoint.com/docs/api/list-identity-collectors-v-1) before replacing it. The `sourceId` and `type` cannot be changed and must match the current values.
|
|
2175
|
+
* @summary Replace identity collector
|
|
1808
2176
|
* @param {DataAccessSecurityApiPutIdentityCollectorV1Request} requestParameters Request parameters.
|
|
1809
2177
|
* @param {*} [axiosOptions] Override http request option.
|
|
1810
2178
|
* @throws {RequiredError}
|
|
@@ -1853,6 +2221,19 @@ export interface DataAccessSecurityApiCreateApplicationV1Request {
|
|
|
1853
2221
|
*/
|
|
1854
2222
|
readonly baseCreateApplicationRequest: BaseCreateApplicationRequest;
|
|
1855
2223
|
}
|
|
2224
|
+
/**
|
|
2225
|
+
* Request parameters for createDataDictionaryFieldV1 operation in DataAccessSecurityApi.
|
|
2226
|
+
* @export
|
|
2227
|
+
* @interface DataAccessSecurityApiCreateDataDictionaryFieldV1Request
|
|
2228
|
+
*/
|
|
2229
|
+
export interface DataAccessSecurityApiCreateDataDictionaryFieldV1Request {
|
|
2230
|
+
/**
|
|
2231
|
+
* Custom data dictionary field to create.
|
|
2232
|
+
* @type {Createdatadictionaryfieldrequest}
|
|
2233
|
+
* @memberof DataAccessSecurityApiCreateDataDictionaryFieldV1
|
|
2234
|
+
*/
|
|
2235
|
+
readonly createdatadictionaryfieldrequest: Createdatadictionaryfieldrequest;
|
|
2236
|
+
}
|
|
1856
2237
|
/**
|
|
1857
2238
|
* Request parameters for createIdentityCollectorV1 operation in DataAccessSecurityApi.
|
|
1858
2239
|
* @export
|
|
@@ -1987,6 +2368,19 @@ export interface DataAccessSecurityApiDeleteApplicationV1Request {
|
|
|
1987
2368
|
*/
|
|
1988
2369
|
readonly id: number;
|
|
1989
2370
|
}
|
|
2371
|
+
/**
|
|
2372
|
+
* Request parameters for deleteDataDictionaryFieldV1 operation in DataAccessSecurityApi.
|
|
2373
|
+
* @export
|
|
2374
|
+
* @interface DataAccessSecurityApiDeleteDataDictionaryFieldV1Request
|
|
2375
|
+
*/
|
|
2376
|
+
export interface DataAccessSecurityApiDeleteDataDictionaryFieldV1Request {
|
|
2377
|
+
/**
|
|
2378
|
+
* The field name to delete.
|
|
2379
|
+
* @type {string}
|
|
2380
|
+
* @memberof DataAccessSecurityApiDeleteDataDictionaryFieldV1
|
|
2381
|
+
*/
|
|
2382
|
+
readonly name: string;
|
|
2383
|
+
}
|
|
1990
2384
|
/**
|
|
1991
2385
|
* Request parameters for deleteIdentityCollectorV1 operation in DataAccessSecurityApi.
|
|
1992
2386
|
* @export
|
|
@@ -2070,6 +2464,38 @@ export interface DataAccessSecurityApiGetApplicationsV1Request {
|
|
|
2070
2464
|
*/
|
|
2071
2465
|
readonly count?: boolean;
|
|
2072
2466
|
}
|
|
2467
|
+
/**
|
|
2468
|
+
* Request parameters for getIdentityCollectorBuiltinPropertiesV1 operation in DataAccessSecurityApi.
|
|
2469
|
+
* @export
|
|
2470
|
+
* @interface DataAccessSecurityApiGetIdentityCollectorBuiltinPropertiesV1Request
|
|
2471
|
+
*/
|
|
2472
|
+
export interface DataAccessSecurityApiGetIdentityCollectorBuiltinPropertiesV1Request {
|
|
2473
|
+
/**
|
|
2474
|
+
* 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: **type**: *eq*
|
|
2475
|
+
* @type {string}
|
|
2476
|
+
* @memberof DataAccessSecurityApiGetIdentityCollectorBuiltinPropertiesV1
|
|
2477
|
+
*/
|
|
2478
|
+
readonly filters?: string;
|
|
2479
|
+
}
|
|
2480
|
+
/**
|
|
2481
|
+
* Request parameters for getIdentityCollectorTypesV1 operation in DataAccessSecurityApi.
|
|
2482
|
+
* @export
|
|
2483
|
+
* @interface DataAccessSecurityApiGetIdentityCollectorTypesV1Request
|
|
2484
|
+
*/
|
|
2485
|
+
export interface DataAccessSecurityApiGetIdentityCollectorTypesV1Request {
|
|
2486
|
+
/**
|
|
2487
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
2488
|
+
* @type {number}
|
|
2489
|
+
* @memberof DataAccessSecurityApiGetIdentityCollectorTypesV1
|
|
2490
|
+
*/
|
|
2491
|
+
readonly limit?: number;
|
|
2492
|
+
/**
|
|
2493
|
+
* 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.
|
|
2494
|
+
* @type {number}
|
|
2495
|
+
* @memberof DataAccessSecurityApiGetIdentityCollectorTypesV1
|
|
2496
|
+
*/
|
|
2497
|
+
readonly offset?: number;
|
|
2498
|
+
}
|
|
2073
2499
|
/**
|
|
2074
2500
|
* Request parameters for getOwnersV1 operation in DataAccessSecurityApi.
|
|
2075
2501
|
* @export
|
|
@@ -2183,6 +2609,37 @@ export interface DataAccessSecurityApiGetTasksV1Request {
|
|
|
2183
2609
|
*/
|
|
2184
2610
|
readonly count?: boolean;
|
|
2185
2611
|
}
|
|
2612
|
+
/**
|
|
2613
|
+
* Request parameters for listDataDictionaryFieldsV1 operation in DataAccessSecurityApi.
|
|
2614
|
+
* @export
|
|
2615
|
+
* @interface DataAccessSecurityApiListDataDictionaryFieldsV1Request
|
|
2616
|
+
*/
|
|
2617
|
+
export interface DataAccessSecurityApiListDataDictionaryFieldsV1Request {
|
|
2618
|
+
/**
|
|
2619
|
+
* 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: **dataDictionaryType**: *eq* **name**: *eq* Supported composite operators are *and*
|
|
2620
|
+
* @type {string}
|
|
2621
|
+
* @memberof DataAccessSecurityApiListDataDictionaryFieldsV1
|
|
2622
|
+
*/
|
|
2623
|
+
readonly filters?: string;
|
|
2624
|
+
/**
|
|
2625
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
2626
|
+
* @type {number}
|
|
2627
|
+
* @memberof DataAccessSecurityApiListDataDictionaryFieldsV1
|
|
2628
|
+
*/
|
|
2629
|
+
readonly limit?: number;
|
|
2630
|
+
/**
|
|
2631
|
+
* 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.
|
|
2632
|
+
* @type {number}
|
|
2633
|
+
* @memberof DataAccessSecurityApiListDataDictionaryFieldsV1
|
|
2634
|
+
*/
|
|
2635
|
+
readonly offset?: number;
|
|
2636
|
+
/**
|
|
2637
|
+
* 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.
|
|
2638
|
+
* @type {boolean}
|
|
2639
|
+
* @memberof DataAccessSecurityApiListDataDictionaryFieldsV1
|
|
2640
|
+
*/
|
|
2641
|
+
readonly count?: boolean;
|
|
2642
|
+
}
|
|
2186
2643
|
/**
|
|
2187
2644
|
* Request parameters for listIdentityCollectorsV1 operation in DataAccessSecurityApi.
|
|
2188
2645
|
* @export
|
|
@@ -2233,6 +2690,25 @@ export interface DataAccessSecurityApiPutApplicationV1Request {
|
|
|
2233
2690
|
*/
|
|
2234
2691
|
readonly baseCreateApplicationRequest: BaseCreateApplicationRequest;
|
|
2235
2692
|
}
|
|
2693
|
+
/**
|
|
2694
|
+
* Request parameters for putDataDictionaryFieldV1 operation in DataAccessSecurityApi.
|
|
2695
|
+
* @export
|
|
2696
|
+
* @interface DataAccessSecurityApiPutDataDictionaryFieldV1Request
|
|
2697
|
+
*/
|
|
2698
|
+
export interface DataAccessSecurityApiPutDataDictionaryFieldV1Request {
|
|
2699
|
+
/**
|
|
2700
|
+
* The current field name.
|
|
2701
|
+
* @type {string}
|
|
2702
|
+
* @memberof DataAccessSecurityApiPutDataDictionaryFieldV1
|
|
2703
|
+
*/
|
|
2704
|
+
readonly name: string;
|
|
2705
|
+
/**
|
|
2706
|
+
* Complete data dictionary field representation used to fully replace the existing field.
|
|
2707
|
+
* @type {Updatedatadictionaryfieldrequest}
|
|
2708
|
+
* @memberof DataAccessSecurityApiPutDataDictionaryFieldV1
|
|
2709
|
+
*/
|
|
2710
|
+
readonly updatedatadictionaryfieldrequest: Updatedatadictionaryfieldrequest;
|
|
2711
|
+
}
|
|
2236
2712
|
/**
|
|
2237
2713
|
* Request parameters for putIdentityCollectorV1 operation in DataAccessSecurityApi.
|
|
2238
2714
|
* @export
|
|
@@ -2240,13 +2716,13 @@ export interface DataAccessSecurityApiPutApplicationV1Request {
|
|
|
2240
2716
|
*/
|
|
2241
2717
|
export interface DataAccessSecurityApiPutIdentityCollectorV1Request {
|
|
2242
2718
|
/**
|
|
2243
|
-
* The unique identifier of the identity collector to
|
|
2719
|
+
* The unique identifier of the identity collector to replace.
|
|
2244
2720
|
* @type {number}
|
|
2245
2721
|
* @memberof DataAccessSecurityApiPutIdentityCollectorV1
|
|
2246
2722
|
*/
|
|
2247
2723
|
readonly id: number;
|
|
2248
2724
|
/**
|
|
2249
|
-
*
|
|
2725
|
+
* Complete identity collector representation used to fully replace the existing resource. Partial updates are not supported.
|
|
2250
2726
|
* @type {Updateidentitycollectorrequest}
|
|
2251
2727
|
* @memberof DataAccessSecurityApiPutIdentityCollectorV1
|
|
2252
2728
|
*/
|
|
@@ -2310,7 +2786,16 @@ export declare class DataAccessSecurityApi extends BaseAPI {
|
|
|
2310
2786
|
*/
|
|
2311
2787
|
createApplicationV1(requestParameters: DataAccessSecurityApiCreateApplicationV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2312
2788
|
/**
|
|
2313
|
-
*
|
|
2789
|
+
* Creates a custom data dictionary field. The server assigns fieldType String and required false; callers do not supply those values.
|
|
2790
|
+
* @summary Create data dictionary field
|
|
2791
|
+
* @param {DataAccessSecurityApiCreateDataDictionaryFieldV1Request} requestParameters Request parameters.
|
|
2792
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2793
|
+
* @throws {RequiredError}
|
|
2794
|
+
* @memberof DataAccessSecurityApi
|
|
2795
|
+
*/
|
|
2796
|
+
createDataDictionaryFieldV1(requestParameters: DataAccessSecurityApiCreateDataDictionaryFieldV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Datadictionaryfieldlistitem, any>>;
|
|
2797
|
+
/**
|
|
2798
|
+
* This endpoint creates a new identity collector in Data Access Security for the specified source. The identity collector type is derived from the source. Optionally configure `users` and `groups` to register source attributes (`properties`) and map them to data dictionary fields by name (`fieldMappings.fieldDictionaryName`). When omitted, both collections are created with fixed columns only.
|
|
2314
2799
|
* @summary Create identity collector
|
|
2315
2800
|
* @param {DataAccessSecurityApiCreateIdentityCollectorV1Request} requestParameters Request parameters.
|
|
2316
2801
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -2381,6 +2866,15 @@ export declare class DataAccessSecurityApi extends BaseAPI {
|
|
|
2381
2866
|
* @memberof DataAccessSecurityApi
|
|
2382
2867
|
*/
|
|
2383
2868
|
deleteApplicationV1(requestParameters: DataAccessSecurityApiDeleteApplicationV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2869
|
+
/**
|
|
2870
|
+
* Deletes a custom data dictionary field. Built-in fields where required is true cannot be deleted.
|
|
2871
|
+
* @summary Delete data dictionary field
|
|
2872
|
+
* @param {DataAccessSecurityApiDeleteDataDictionaryFieldV1Request} requestParameters Request parameters.
|
|
2873
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2874
|
+
* @throws {RequiredError}
|
|
2875
|
+
* @memberof DataAccessSecurityApi
|
|
2876
|
+
*/
|
|
2877
|
+
deleteDataDictionaryFieldV1(requestParameters: DataAccessSecurityApiDeleteDataDictionaryFieldV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2384
2878
|
/**
|
|
2385
2879
|
* This endpoint deletes an identity collector from Data Access Security by its unique identifier.
|
|
2386
2880
|
* @summary Delete identity collector by identifier
|
|
@@ -2426,6 +2920,24 @@ export declare class DataAccessSecurityApi extends BaseAPI {
|
|
|
2426
2920
|
* @memberof DataAccessSecurityApi
|
|
2427
2921
|
*/
|
|
2428
2922
|
getApplicationsV1(requestParameters?: DataAccessSecurityApiGetApplicationsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationItem[], any>>;
|
|
2923
|
+
/**
|
|
2924
|
+
* Returns the built-in source attribute names for users and groups collections. When no filter is provided, built-in properties for all public identity collector types are returned (the same base types listed by [List Identity Collector Types](https://developer.sailpoint.com/docs/api/get-identity-collector-types-v-1)). When filtered by `type`, only the matching type is returned; the filter accepts any supported type display name, including SaaS variants such as `Box SaaS` or `AWS SaaS`. These attributes are always available for field mapping without being listed in `properties`.
|
|
2925
|
+
* @summary List built-in identity collector properties
|
|
2926
|
+
* @param {DataAccessSecurityApiGetIdentityCollectorBuiltinPropertiesV1Request} requestParameters Request parameters.
|
|
2927
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2928
|
+
* @throws {RequiredError}
|
|
2929
|
+
* @memberof DataAccessSecurityApi
|
|
2930
|
+
*/
|
|
2931
|
+
getIdentityCollectorBuiltinPropertiesV1(requestParameters?: DataAccessSecurityApiGetIdentityCollectorBuiltinPropertiesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Identitycollectorbuiltinpropertiesresponse, any>>;
|
|
2932
|
+
/**
|
|
2933
|
+
* Returns the public identity collector type display names exposed for metadata and UI discovery. This endpoint lists base types only (for example, `Box` rather than `Box SaaS`). SaaS variants are not listed here; the identity collector type is derived from `sourceId` when creating an identity collector. Existing identity collectors may still report SaaS variant types in list and update responses. Pagination is not supported for this endpoint; the full set of public types is always returned.
|
|
2934
|
+
* @summary List identity collector types
|
|
2935
|
+
* @param {DataAccessSecurityApiGetIdentityCollectorTypesV1Request} requestParameters Request parameters.
|
|
2936
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2937
|
+
* @throws {RequiredError}
|
|
2938
|
+
* @memberof DataAccessSecurityApi
|
|
2939
|
+
*/
|
|
2940
|
+
getIdentityCollectorTypesV1(requestParameters?: DataAccessSecurityApiGetIdentityCollectorTypesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
|
|
2429
2941
|
/**
|
|
2430
2942
|
*
|
|
2431
2943
|
* @summary Retrieve owners per application.
|
|
@@ -2471,6 +2983,15 @@ export declare class DataAccessSecurityApi extends BaseAPI {
|
|
|
2471
2983
|
* @memberof DataAccessSecurityApi
|
|
2472
2984
|
*/
|
|
2473
2985
|
getTasksV1(requestParameters?: DataAccessSecurityApiGetTasksV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaskInfo[], any>>;
|
|
2986
|
+
/**
|
|
2987
|
+
* Returns custom data dictionary fields that can be used when configuring identity collector field mappings and other permission-related settings. Built-in fields are not included in list responses; only custom fields created via [Create Data Dictionary Field](https://developer.sailpoint.com/docs/api/create-data-dictionary-field-v-1) are returned. All listed fields have `required: false`.
|
|
2988
|
+
* @summary List data dictionary fields
|
|
2989
|
+
* @param {DataAccessSecurityApiListDataDictionaryFieldsV1Request} requestParameters Request parameters.
|
|
2990
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2991
|
+
* @throws {RequiredError}
|
|
2992
|
+
* @memberof DataAccessSecurityApi
|
|
2993
|
+
*/
|
|
2994
|
+
listDataDictionaryFieldsV1(requestParameters?: DataAccessSecurityApiListDataDictionaryFieldsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Datadictionaryfieldlistitem[], any>>;
|
|
2474
2995
|
/**
|
|
2475
2996
|
* This endpoint lists the identity collectors in Data Access Security with optional filtering and pagination. Sorting is not supported for this endpoint; supplying the `sorters` query parameter results in a validation error.
|
|
2476
2997
|
* @summary List identity collectors
|
|
@@ -2490,8 +3011,17 @@ export declare class DataAccessSecurityApi extends BaseAPI {
|
|
|
2490
3011
|
*/
|
|
2491
3012
|
putApplicationV1(requestParameters: DataAccessSecurityApiPutApplicationV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2492
3013
|
/**
|
|
2493
|
-
* This
|
|
2494
|
-
* @summary
|
|
3014
|
+
* Fully replaces a custom data dictionary field. This is a PUT operation, not a partial update: the request body must contain the complete resource representation. Omitted properties are rejected. For custom fields, `fieldType`, `dataDictionaryType`, and `required` must match the current values; only `name` may change. Built-in fields where `required` is true cannot be updated. List the field first with [List Data Dictionary Fields](https://developer.sailpoint.com/docs/api/list-data-dictionary-fields-v-1) to obtain the current representation before replacing it.
|
|
3015
|
+
* @summary Replace data dictionary field
|
|
3016
|
+
* @param {DataAccessSecurityApiPutDataDictionaryFieldV1Request} requestParameters Request parameters.
|
|
3017
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
3018
|
+
* @throws {RequiredError}
|
|
3019
|
+
* @memberof DataAccessSecurityApi
|
|
3020
|
+
*/
|
|
3021
|
+
putDataDictionaryFieldV1(requestParameters: DataAccessSecurityApiPutDataDictionaryFieldV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Datadictionaryfieldlistitem, any>>;
|
|
3022
|
+
/**
|
|
3023
|
+
* Fully replaces an existing identity collector in Data Access Security. This is a PUT operation, not a partial update: the request body must contain the complete resource representation. Omitted or null top-level properties are rejected. After a successful request, a subsequent list request returns exactly the configuration that was sent. Retrieve the current configuration with [List Identity Collectors](https://developer.sailpoint.com/docs/api/list-identity-collectors-v-1) before replacing it. The `sourceId` and `type` cannot be changed and must match the current values.
|
|
3024
|
+
* @summary Replace identity collector
|
|
2495
3025
|
* @param {DataAccessSecurityApiPutIdentityCollectorV1Request} requestParameters Request parameters.
|
|
2496
3026
|
* @param {*} [axiosOptions] Override http request option.
|
|
2497
3027
|
* @throws {RequiredError}
|