sailpoint-api-client 1.4.15 → 1.4.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/beta/README.md +2 -2
- package/beta/api.ts +514 -389
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/dist/beta/api.d.ts +462 -363
- package/dist/beta/api.js +181 -126
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/common.js +1 -1
- package/dist/v2024/api.d.ts +860 -124
- package/dist/v2024/api.js +364 -131
- package/dist/v2024/api.js.map +1 -1
- package/dist/v2024/common.js +1 -1
- package/dist/v3/api.d.ts +180 -65
- package/dist/v3/api.js +87 -62
- package/dist/v3/api.js.map +1 -1
- package/dist/v3/common.js +1 -1
- package/package.json +7 -2
- package/v2024/README.md +2 -2
- package/v2024/api.ts +994 -144
- package/v2024/common.ts +2 -2
- package/v2024/package.json +1 -1
- package/v3/README.md +2 -2
- package/v3/api.ts +202 -72
- package/v3/common.ts +2 -2
- package/v3/package.json +1 -1
package/v3/api.ts
CHANGED
|
@@ -8708,6 +8708,12 @@ export interface EventAttributes {
|
|
|
8708
8708
|
* @memberof EventAttributes
|
|
8709
8709
|
*/
|
|
8710
8710
|
'attributeToFilter'?: string;
|
|
8711
|
+
/**
|
|
8712
|
+
* Form definition\'s unique identifier.
|
|
8713
|
+
* @type {string}
|
|
8714
|
+
* @memberof EventAttributes
|
|
8715
|
+
*/
|
|
8716
|
+
'formDefinitionId'?: string;
|
|
8711
8717
|
}
|
|
8712
8718
|
/**
|
|
8713
8719
|
* Event
|
|
@@ -12621,7 +12627,7 @@ export interface ManagedCluster {
|
|
|
12621
12627
|
* @type {string}
|
|
12622
12628
|
* @memberof ManagedCluster
|
|
12623
12629
|
*/
|
|
12624
|
-
'status'?:
|
|
12630
|
+
'status'?: ManagedClusterStatusV3;
|
|
12625
12631
|
/**
|
|
12626
12632
|
* Public key certificate
|
|
12627
12633
|
* @type {string}
|
|
@@ -12678,6 +12684,15 @@ export interface ManagedCluster {
|
|
|
12678
12684
|
'updatedAt'?: string | null;
|
|
12679
12685
|
}
|
|
12680
12686
|
|
|
12687
|
+
export const ManagedClusterStatusV3 = {
|
|
12688
|
+
Configuring: 'CONFIGURING',
|
|
12689
|
+
Failed: 'FAILED',
|
|
12690
|
+
NoClients: 'NO_CLIENTS',
|
|
12691
|
+
Normal: 'NORMAL',
|
|
12692
|
+
Warning: 'WARNING'
|
|
12693
|
+
} as const;
|
|
12694
|
+
|
|
12695
|
+
export type ManagedClusterStatusV3 = typeof ManagedClusterStatusV3[keyof typeof ManagedClusterStatusV3];
|
|
12681
12696
|
|
|
12682
12697
|
/**
|
|
12683
12698
|
* Managed Cluster Attributes for Cluster Configuration. Supported Cluster Types [sqsCluster, spConnectCluster]
|
|
@@ -16700,11 +16715,73 @@ export const ReportDetailsReportTypeV3 = {
|
|
|
16700
16715
|
export type ReportDetailsReportTypeV3 = typeof ReportDetailsReportTypeV3[keyof typeof ReportDetailsReportTypeV3];
|
|
16701
16716
|
|
|
16702
16717
|
/**
|
|
16703
|
-
* @type ReportDetailsArguments
|
|
16704
16718
|
* The string-object map(dictionary) with the arguments needed for report processing.
|
|
16705
16719
|
* @export
|
|
16720
|
+
* @interface ReportDetailsArguments
|
|
16706
16721
|
*/
|
|
16707
|
-
export
|
|
16722
|
+
export interface ReportDetailsArguments {
|
|
16723
|
+
/**
|
|
16724
|
+
* Source ID.
|
|
16725
|
+
* @type {string}
|
|
16726
|
+
* @memberof ReportDetailsArguments
|
|
16727
|
+
*/
|
|
16728
|
+
'application': string;
|
|
16729
|
+
/**
|
|
16730
|
+
* Source name.
|
|
16731
|
+
* @type {string}
|
|
16732
|
+
* @memberof ReportDetailsArguments
|
|
16733
|
+
*/
|
|
16734
|
+
'sourceName': string;
|
|
16735
|
+
/**
|
|
16736
|
+
* Flag to specify if only correlated identities are included in report.
|
|
16737
|
+
* @type {boolean}
|
|
16738
|
+
* @memberof ReportDetailsArguments
|
|
16739
|
+
*/
|
|
16740
|
+
'correlatedOnly': boolean;
|
|
16741
|
+
/**
|
|
16742
|
+
* Source ID.
|
|
16743
|
+
* @type {string}
|
|
16744
|
+
* @memberof ReportDetailsArguments
|
|
16745
|
+
*/
|
|
16746
|
+
'authoritativeSource': string;
|
|
16747
|
+
/**
|
|
16748
|
+
* Output report file formats. These are formats for calling GET endpoint as query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default.
|
|
16749
|
+
* @type {Array<string>}
|
|
16750
|
+
* @memberof ReportDetailsArguments
|
|
16751
|
+
*/
|
|
16752
|
+
'selectedFormats'?: Array<ReportDetailsArgumentsSelectedFormatsV3>;
|
|
16753
|
+
/**
|
|
16754
|
+
* The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched.
|
|
16755
|
+
* @type {Array<Index>}
|
|
16756
|
+
* @memberof ReportDetailsArguments
|
|
16757
|
+
*/
|
|
16758
|
+
'indices'?: Array<Index>;
|
|
16759
|
+
/**
|
|
16760
|
+
* The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.
|
|
16761
|
+
* @type {string}
|
|
16762
|
+
* @memberof ReportDetailsArguments
|
|
16763
|
+
*/
|
|
16764
|
+
'query': string;
|
|
16765
|
+
/**
|
|
16766
|
+
* Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details.
|
|
16767
|
+
* @type {string}
|
|
16768
|
+
* @memberof ReportDetailsArguments
|
|
16769
|
+
*/
|
|
16770
|
+
'columns'?: string;
|
|
16771
|
+
/**
|
|
16772
|
+
* The fields to be used to sort the search results. Use + or - to specify the sort direction.
|
|
16773
|
+
* @type {Array<string>}
|
|
16774
|
+
* @memberof ReportDetailsArguments
|
|
16775
|
+
*/
|
|
16776
|
+
'sort'?: Array<string>;
|
|
16777
|
+
}
|
|
16778
|
+
|
|
16779
|
+
export const ReportDetailsArgumentsSelectedFormatsV3 = {
|
|
16780
|
+
Csv: 'CSV',
|
|
16781
|
+
Pdf: 'PDF'
|
|
16782
|
+
} as const;
|
|
16783
|
+
|
|
16784
|
+
export type ReportDetailsArgumentsSelectedFormatsV3 = typeof ReportDetailsArgumentsSelectedFormatsV3[keyof typeof ReportDetailsArgumentsSelectedFormatsV3];
|
|
16708
16785
|
|
|
16709
16786
|
/**
|
|
16710
16787
|
*
|
|
@@ -17046,7 +17123,7 @@ export type RequestableObjectRequestStatus = typeof RequestableObjectRequestStat
|
|
|
17046
17123
|
|
|
17047
17124
|
|
|
17048
17125
|
/**
|
|
17049
|
-
*
|
|
17126
|
+
* Currently supported requestable object types.
|
|
17050
17127
|
* @export
|
|
17051
17128
|
* @enum {string}
|
|
17052
17129
|
*/
|
|
@@ -19524,6 +19601,12 @@ export interface ScheduledAttributes {
|
|
|
19524
19601
|
* @memberof ScheduledAttributes
|
|
19525
19602
|
*/
|
|
19526
19603
|
'weeklyTimes'?: Array<string>;
|
|
19604
|
+
/**
|
|
19605
|
+
* Scheduled execution times
|
|
19606
|
+
* @type {Array<string>}
|
|
19607
|
+
* @memberof ScheduledAttributes
|
|
19608
|
+
*/
|
|
19609
|
+
'yearlyTimes'?: Array<string>;
|
|
19527
19610
|
}
|
|
19528
19611
|
|
|
19529
19612
|
export const ScheduledAttributesFrequencyV3 = {
|
|
@@ -21714,11 +21797,11 @@ export interface SourceConnectionsDto {
|
|
|
21714
21797
|
*/
|
|
21715
21798
|
'mappingProfiles'?: Array<string>;
|
|
21716
21799
|
/**
|
|
21717
|
-
*
|
|
21718
|
-
* @type {Array<
|
|
21800
|
+
* A list of custom transforms associated with this source. A transform will be considered associated with a source if any attributes of the transform specify the source as the sourceName.
|
|
21801
|
+
* @type {Array<TransformRead>}
|
|
21719
21802
|
* @memberof SourceConnectionsDto
|
|
21720
21803
|
*/
|
|
21721
|
-
'dependentCustomTransforms'?: Array<
|
|
21804
|
+
'dependentCustomTransforms'?: Array<TransformRead>;
|
|
21722
21805
|
/**
|
|
21723
21806
|
*
|
|
21724
21807
|
* @type {Array<DependantAppConnections>}
|
|
@@ -22330,7 +22413,7 @@ export interface TaskResultDetails {
|
|
|
22330
22413
|
'id'?: string;
|
|
22331
22414
|
/**
|
|
22332
22415
|
* Use this property to define what report should be processed in the RDE service.
|
|
22333
|
-
* @type {
|
|
22416
|
+
* @type {string}
|
|
22334
22417
|
* @memberof TaskResultDetails
|
|
22335
22418
|
*/
|
|
22336
22419
|
'reportType'?: TaskResultDetailsReportTypeV3;
|
|
@@ -22390,10 +22473,10 @@ export interface TaskResultDetails {
|
|
|
22390
22473
|
'returns'?: Array<TaskResultDetailsReturnsInner>;
|
|
22391
22474
|
/**
|
|
22392
22475
|
* Extra attributes map(dictionary) needed for the report.
|
|
22393
|
-
* @type {
|
|
22476
|
+
* @type {object}
|
|
22394
22477
|
* @memberof TaskResultDetails
|
|
22395
22478
|
*/
|
|
22396
|
-
'attributes'?:
|
|
22479
|
+
'attributes'?: object;
|
|
22397
22480
|
/**
|
|
22398
22481
|
* Current report state.
|
|
22399
22482
|
* @type {string}
|
|
@@ -24600,6 +24683,12 @@ export interface WorkflowTriggerAttributes {
|
|
|
24600
24683
|
* @memberof WorkflowTriggerAttributes
|
|
24601
24684
|
*/
|
|
24602
24685
|
'attributeToFilter'?: string;
|
|
24686
|
+
/**
|
|
24687
|
+
* Form definition\'s unique identifier.
|
|
24688
|
+
* @type {string}
|
|
24689
|
+
* @memberof WorkflowTriggerAttributes
|
|
24690
|
+
*/
|
|
24691
|
+
'formDefinitionId'?: string;
|
|
24603
24692
|
/**
|
|
24604
24693
|
* A unique name for the external trigger
|
|
24605
24694
|
* @type {string}
|
|
@@ -24648,6 +24737,12 @@ export interface WorkflowTriggerAttributes {
|
|
|
24648
24737
|
* @memberof WorkflowTriggerAttributes
|
|
24649
24738
|
*/
|
|
24650
24739
|
'weeklyTimes'?: Array<string>;
|
|
24740
|
+
/**
|
|
24741
|
+
* Scheduled execution times
|
|
24742
|
+
* @type {Array<string>}
|
|
24743
|
+
* @memberof WorkflowTriggerAttributes
|
|
24744
|
+
*/
|
|
24745
|
+
'yearlyTimes'?: Array<string>;
|
|
24651
24746
|
}
|
|
24652
24747
|
|
|
24653
24748
|
export const WorkflowTriggerAttributesFrequencyV3 = {
|
|
@@ -24668,7 +24763,7 @@ export type WorkflowTriggerAttributesFrequencyV3 = typeof WorkflowTriggerAttribu
|
|
|
24668
24763
|
export const AccessProfilesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
24669
24764
|
return {
|
|
24670
24765
|
/**
|
|
24671
|
-
*
|
|
24766
|
+
* Create an access profile. A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters.
|
|
24672
24767
|
* @summary Create Access Profile
|
|
24673
24768
|
* @param {AccessProfile} accessProfile
|
|
24674
24769
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -24927,16 +25022,16 @@ export const AccessProfilesApiAxiosParamCreator = function (configuration?: Conf
|
|
|
24927
25022
|
};
|
|
24928
25023
|
},
|
|
24929
25024
|
/**
|
|
24930
|
-
*
|
|
25025
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
24931
25026
|
* @summary List Access Profiles
|
|
24932
|
-
* @param {string} [forSubadmin]
|
|
24933
|
-
* @param {number} [limit]
|
|
25027
|
+
* @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error.
|
|
25028
|
+
* @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.
|
|
24934
25029
|
* @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.
|
|
24935
25030
|
* @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.
|
|
24936
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in*
|
|
25031
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names.
|
|
24937
25032
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified**
|
|
24938
|
-
* @param {string} [forSegmentIds]
|
|
24939
|
-
* @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If
|
|
25033
|
+
* @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
25034
|
+
* @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error.
|
|
24940
25035
|
* @param {*} [axiosOptions] Override http request option.
|
|
24941
25036
|
* @throws {RequiredError}
|
|
24942
25037
|
*/
|
|
@@ -25071,7 +25166,7 @@ export const AccessProfilesApiFp = function(configuration?: Configuration) {
|
|
|
25071
25166
|
const localVarAxiosParamCreator = AccessProfilesApiAxiosParamCreator(configuration)
|
|
25072
25167
|
return {
|
|
25073
25168
|
/**
|
|
25074
|
-
*
|
|
25169
|
+
* Create an access profile. A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters.
|
|
25075
25170
|
* @summary Create Access Profile
|
|
25076
25171
|
* @param {AccessProfile} accessProfile
|
|
25077
25172
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25141,16 +25236,16 @@ export const AccessProfilesApiFp = function(configuration?: Configuration) {
|
|
|
25141
25236
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25142
25237
|
},
|
|
25143
25238
|
/**
|
|
25144
|
-
*
|
|
25239
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
25145
25240
|
* @summary List Access Profiles
|
|
25146
|
-
* @param {string} [forSubadmin]
|
|
25147
|
-
* @param {number} [limit]
|
|
25241
|
+
* @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error.
|
|
25242
|
+
* @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.
|
|
25148
25243
|
* @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.
|
|
25149
25244
|
* @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.
|
|
25150
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in*
|
|
25245
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names.
|
|
25151
25246
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified**
|
|
25152
|
-
* @param {string} [forSegmentIds]
|
|
25153
|
-
* @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If
|
|
25247
|
+
* @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
25248
|
+
* @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error.
|
|
25154
25249
|
* @param {*} [axiosOptions] Override http request option.
|
|
25155
25250
|
* @throws {RequiredError}
|
|
25156
25251
|
*/
|
|
@@ -25185,7 +25280,7 @@ export const AccessProfilesApiFactory = function (configuration?: Configuration,
|
|
|
25185
25280
|
const localVarFp = AccessProfilesApiFp(configuration)
|
|
25186
25281
|
return {
|
|
25187
25282
|
/**
|
|
25188
|
-
*
|
|
25283
|
+
* Create an access profile. A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters.
|
|
25189
25284
|
* @summary Create Access Profile
|
|
25190
25285
|
* @param {AccessProfilesApiCreateAccessProfileRequest} requestParameters Request parameters.
|
|
25191
25286
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25235,7 +25330,7 @@ export const AccessProfilesApiFactory = function (configuration?: Configuration,
|
|
|
25235
25330
|
return localVarFp.getAccessProfileEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath));
|
|
25236
25331
|
},
|
|
25237
25332
|
/**
|
|
25238
|
-
*
|
|
25333
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
25239
25334
|
* @summary List Access Profiles
|
|
25240
25335
|
* @param {AccessProfilesApiListAccessProfilesRequest} requestParameters Request parameters.
|
|
25241
25336
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25369,14 +25464,14 @@ export interface AccessProfilesApiGetAccessProfileEntitlementsRequest {
|
|
|
25369
25464
|
*/
|
|
25370
25465
|
export interface AccessProfilesApiListAccessProfilesRequest {
|
|
25371
25466
|
/**
|
|
25372
|
-
*
|
|
25467
|
+
* Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error.
|
|
25373
25468
|
* @type {string}
|
|
25374
25469
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
25375
25470
|
*/
|
|
25376
25471
|
readonly forSubadmin?: string
|
|
25377
25472
|
|
|
25378
25473
|
/**
|
|
25379
|
-
*
|
|
25474
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
25380
25475
|
* @type {number}
|
|
25381
25476
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
25382
25477
|
*/
|
|
@@ -25397,7 +25492,7 @@ export interface AccessProfilesApiListAccessProfilesRequest {
|
|
|
25397
25492
|
readonly count?: boolean
|
|
25398
25493
|
|
|
25399
25494
|
/**
|
|
25400
|
-
* 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, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in*
|
|
25495
|
+
* 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, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names.
|
|
25401
25496
|
* @type {string}
|
|
25402
25497
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
25403
25498
|
*/
|
|
@@ -25411,14 +25506,14 @@ export interface AccessProfilesApiListAccessProfilesRequest {
|
|
|
25411
25506
|
readonly sorters?: string
|
|
25412
25507
|
|
|
25413
25508
|
/**
|
|
25414
|
-
*
|
|
25509
|
+
* Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
25415
25510
|
* @type {string}
|
|
25416
25511
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
25417
25512
|
*/
|
|
25418
25513
|
readonly forSegmentIds?: string
|
|
25419
25514
|
|
|
25420
25515
|
/**
|
|
25421
|
-
* Indicates whether the response list should contain unsegmented access profiles. If
|
|
25516
|
+
* Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error.
|
|
25422
25517
|
* @type {boolean}
|
|
25423
25518
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
25424
25519
|
*/
|
|
@@ -25454,7 +25549,7 @@ export interface AccessProfilesApiPatchAccessProfileRequest {
|
|
|
25454
25549
|
*/
|
|
25455
25550
|
export class AccessProfilesApi extends BaseAPI {
|
|
25456
25551
|
/**
|
|
25457
|
-
*
|
|
25552
|
+
* Create an access profile. A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters.
|
|
25458
25553
|
* @summary Create Access Profile
|
|
25459
25554
|
* @param {AccessProfilesApiCreateAccessProfileRequest} requestParameters Request parameters.
|
|
25460
25555
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25514,7 +25609,7 @@ export class AccessProfilesApi extends BaseAPI {
|
|
|
25514
25609
|
}
|
|
25515
25610
|
|
|
25516
25611
|
/**
|
|
25517
|
-
*
|
|
25612
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
25518
25613
|
* @summary List Access Profiles
|
|
25519
25614
|
* @param {AccessProfilesApiListAccessProfilesRequest} requestParameters Request parameters.
|
|
25520
25615
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -49522,12 +49617,12 @@ export type GetReportFileFormatV3 = typeof GetReportFileFormatV3[keyof typeof Ge
|
|
|
49522
49617
|
export const RequestableObjectsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
49523
49618
|
return {
|
|
49524
49619
|
/**
|
|
49525
|
-
*
|
|
49620
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
49526
49621
|
* @summary Requestable Objects List
|
|
49527
49622
|
* @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result.
|
|
49528
|
-
* @param {Array<RequestableObjectType>} [types] Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE
|
|
49529
|
-
* @param {string} [term]
|
|
49530
|
-
* @param {Array<RequestableObjectRequestStatus>} [statuses] Filters the result to the specified status/statuses, where each status is one of AVAILABLE
|
|
49623
|
+
* @param {Array<RequestableObjectType>} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice.
|
|
49624
|
+
* @param {string} [term] Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter.
|
|
49625
|
+
* @param {Array<RequestableObjectRequestStatus>} [statuses] Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice.
|
|
49531
49626
|
* @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.
|
|
49532
49627
|
* @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.
|
|
49533
49628
|
* @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.
|
|
@@ -49615,12 +49710,12 @@ export const RequestableObjectsApiFp = function(configuration?: Configuration) {
|
|
|
49615
49710
|
const localVarAxiosParamCreator = RequestableObjectsApiAxiosParamCreator(configuration)
|
|
49616
49711
|
return {
|
|
49617
49712
|
/**
|
|
49618
|
-
*
|
|
49713
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
49619
49714
|
* @summary Requestable Objects List
|
|
49620
49715
|
* @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result.
|
|
49621
|
-
* @param {Array<RequestableObjectType>} [types] Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE
|
|
49622
|
-
* @param {string} [term]
|
|
49623
|
-
* @param {Array<RequestableObjectRequestStatus>} [statuses] Filters the result to the specified status/statuses, where each status is one of AVAILABLE
|
|
49716
|
+
* @param {Array<RequestableObjectType>} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice.
|
|
49717
|
+
* @param {string} [term] Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter.
|
|
49718
|
+
* @param {Array<RequestableObjectRequestStatus>} [statuses] Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice.
|
|
49624
49719
|
* @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.
|
|
49625
49720
|
* @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.
|
|
49626
49721
|
* @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.
|
|
@@ -49646,7 +49741,7 @@ export const RequestableObjectsApiFactory = function (configuration?: Configurat
|
|
|
49646
49741
|
const localVarFp = RequestableObjectsApiFp(configuration)
|
|
49647
49742
|
return {
|
|
49648
49743
|
/**
|
|
49649
|
-
*
|
|
49744
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
49650
49745
|
* @summary Requestable Objects List
|
|
49651
49746
|
* @param {RequestableObjectsApiListRequestableObjectsRequest} requestParameters Request parameters.
|
|
49652
49747
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -49672,21 +49767,21 @@ export interface RequestableObjectsApiListRequestableObjectsRequest {
|
|
|
49672
49767
|
readonly identityId?: string
|
|
49673
49768
|
|
|
49674
49769
|
/**
|
|
49675
|
-
* Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE
|
|
49770
|
+
* Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice.
|
|
49676
49771
|
* @type {Array<RequestableObjectType>}
|
|
49677
49772
|
* @memberof RequestableObjectsApiListRequestableObjects
|
|
49678
49773
|
*/
|
|
49679
49774
|
readonly types?: Array<RequestableObjectType>
|
|
49680
49775
|
|
|
49681
49776
|
/**
|
|
49682
|
-
*
|
|
49777
|
+
* Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter.
|
|
49683
49778
|
* @type {string}
|
|
49684
49779
|
* @memberof RequestableObjectsApiListRequestableObjects
|
|
49685
49780
|
*/
|
|
49686
49781
|
readonly term?: string
|
|
49687
49782
|
|
|
49688
49783
|
/**
|
|
49689
|
-
* Filters the result to the specified status/statuses, where each status is one of AVAILABLE
|
|
49784
|
+
* Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice.
|
|
49690
49785
|
* @type {Array<RequestableObjectRequestStatus>}
|
|
49691
49786
|
* @memberof RequestableObjectsApiListRequestableObjects
|
|
49692
49787
|
*/
|
|
@@ -49736,7 +49831,7 @@ export interface RequestableObjectsApiListRequestableObjectsRequest {
|
|
|
49736
49831
|
*/
|
|
49737
49832
|
export class RequestableObjectsApi extends BaseAPI {
|
|
49738
49833
|
/**
|
|
49739
|
-
*
|
|
49834
|
+
* Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. Any authenticated token can call this endpoint to see their requestable access items.
|
|
49740
49835
|
* @summary Requestable Objects List
|
|
49741
49836
|
* @param {RequestableObjectsApiListRequestableObjectsRequest} requestParameters Request parameters.
|
|
49742
49837
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -54353,7 +54448,7 @@ export type SearchGetIndexV3 = typeof SearchGetIndexV3[keyof typeof SearchGetInd
|
|
|
54353
54448
|
export const SearchAttributeConfigurationApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
54354
54449
|
return {
|
|
54355
54450
|
/**
|
|
54356
|
-
* Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create
|
|
54451
|
+
* Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.**
|
|
54357
54452
|
* @summary Create Extended Search Attributes
|
|
54358
54453
|
* @param {SearchAttributeConfig} searchAttributeConfig
|
|
54359
54454
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -54439,12 +54534,14 @@ export const SearchAttributeConfigurationApiAxiosParamCreator = function (config
|
|
|
54439
54534
|
};
|
|
54440
54535
|
},
|
|
54441
54536
|
/**
|
|
54442
|
-
* Get a list of attribute/application
|
|
54537
|
+
* Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
|
|
54443
54538
|
* @summary List Extended Search Attributes
|
|
54539
|
+
* @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.
|
|
54540
|
+
* @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.
|
|
54444
54541
|
* @param {*} [axiosOptions] Override http request option.
|
|
54445
54542
|
* @throws {RequiredError}
|
|
54446
54543
|
*/
|
|
54447
|
-
getSearchAttributeConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
54544
|
+
getSearchAttributeConfig: async (limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
54448
54545
|
const localVarPath = `/accounts/search-attribute-config`;
|
|
54449
54546
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
54450
54547
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -54465,6 +54562,14 @@ export const SearchAttributeConfigurationApiAxiosParamCreator = function (config
|
|
|
54465
54562
|
// oauth required
|
|
54466
54563
|
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
54467
54564
|
|
|
54565
|
+
if (limit !== undefined) {
|
|
54566
|
+
localVarQueryParameter['limit'] = limit;
|
|
54567
|
+
}
|
|
54568
|
+
|
|
54569
|
+
if (offset !== undefined) {
|
|
54570
|
+
localVarQueryParameter['offset'] = offset;
|
|
54571
|
+
}
|
|
54572
|
+
|
|
54468
54573
|
|
|
54469
54574
|
|
|
54470
54575
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -54577,7 +54682,7 @@ export const SearchAttributeConfigurationApiFp = function(configuration?: Config
|
|
|
54577
54682
|
const localVarAxiosParamCreator = SearchAttributeConfigurationApiAxiosParamCreator(configuration)
|
|
54578
54683
|
return {
|
|
54579
54684
|
/**
|
|
54580
|
-
* Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create
|
|
54685
|
+
* Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.**
|
|
54581
54686
|
* @summary Create Extended Search Attributes
|
|
54582
54687
|
* @param {SearchAttributeConfig} searchAttributeConfig
|
|
54583
54688
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -54603,13 +54708,15 @@ export const SearchAttributeConfigurationApiFp = function(configuration?: Config
|
|
|
54603
54708
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
54604
54709
|
},
|
|
54605
54710
|
/**
|
|
54606
|
-
* Get a list of attribute/application
|
|
54711
|
+
* Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
|
|
54607
54712
|
* @summary List Extended Search Attributes
|
|
54713
|
+
* @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.
|
|
54714
|
+
* @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.
|
|
54608
54715
|
* @param {*} [axiosOptions] Override http request option.
|
|
54609
54716
|
* @throws {RequiredError}
|
|
54610
54717
|
*/
|
|
54611
|
-
async getSearchAttributeConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SearchAttributeConfig>>> {
|
|
54612
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getSearchAttributeConfig(axiosOptions);
|
|
54718
|
+
async getSearchAttributeConfig(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SearchAttributeConfig>>> {
|
|
54719
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getSearchAttributeConfig(limit, offset, axiosOptions);
|
|
54613
54720
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
54614
54721
|
const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationApi.getSearchAttributeConfig']?.[localVarOperationServerIndex]?.url;
|
|
54615
54722
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -54652,7 +54759,7 @@ export const SearchAttributeConfigurationApiFactory = function (configuration?:
|
|
|
54652
54759
|
const localVarFp = SearchAttributeConfigurationApiFp(configuration)
|
|
54653
54760
|
return {
|
|
54654
54761
|
/**
|
|
54655
|
-
* Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create
|
|
54762
|
+
* Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.**
|
|
54656
54763
|
* @summary Create Extended Search Attributes
|
|
54657
54764
|
* @param {SearchAttributeConfigurationApiCreateSearchAttributeConfigRequest} requestParameters Request parameters.
|
|
54658
54765
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -54672,13 +54779,14 @@ export const SearchAttributeConfigurationApiFactory = function (configuration?:
|
|
|
54672
54779
|
return localVarFp.deleteSearchAttributeConfig(requestParameters.name, axiosOptions).then((request) => request(axios, basePath));
|
|
54673
54780
|
},
|
|
54674
54781
|
/**
|
|
54675
|
-
* Get a list of attribute/application
|
|
54782
|
+
* Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
|
|
54676
54783
|
* @summary List Extended Search Attributes
|
|
54784
|
+
* @param {SearchAttributeConfigurationApiGetSearchAttributeConfigRequest} requestParameters Request parameters.
|
|
54677
54785
|
* @param {*} [axiosOptions] Override http request option.
|
|
54678
54786
|
* @throws {RequiredError}
|
|
54679
54787
|
*/
|
|
54680
|
-
getSearchAttributeConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<SearchAttributeConfig>> {
|
|
54681
|
-
return localVarFp.getSearchAttributeConfig(axiosOptions).then((request) => request(axios, basePath));
|
|
54788
|
+
getSearchAttributeConfig(requestParameters: SearchAttributeConfigurationApiGetSearchAttributeConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<SearchAttributeConfig>> {
|
|
54789
|
+
return localVarFp.getSearchAttributeConfig(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath));
|
|
54682
54790
|
},
|
|
54683
54791
|
/**
|
|
54684
54792
|
* Get an extended attribute configuration by name.
|
|
@@ -54731,6 +54839,27 @@ export interface SearchAttributeConfigurationApiDeleteSearchAttributeConfigReque
|
|
|
54731
54839
|
readonly name: string
|
|
54732
54840
|
}
|
|
54733
54841
|
|
|
54842
|
+
/**
|
|
54843
|
+
* Request parameters for getSearchAttributeConfig operation in SearchAttributeConfigurationApi.
|
|
54844
|
+
* @export
|
|
54845
|
+
* @interface SearchAttributeConfigurationApiGetSearchAttributeConfigRequest
|
|
54846
|
+
*/
|
|
54847
|
+
export interface SearchAttributeConfigurationApiGetSearchAttributeConfigRequest {
|
|
54848
|
+
/**
|
|
54849
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
54850
|
+
* @type {number}
|
|
54851
|
+
* @memberof SearchAttributeConfigurationApiGetSearchAttributeConfig
|
|
54852
|
+
*/
|
|
54853
|
+
readonly limit?: number
|
|
54854
|
+
|
|
54855
|
+
/**
|
|
54856
|
+
* 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.
|
|
54857
|
+
* @type {number}
|
|
54858
|
+
* @memberof SearchAttributeConfigurationApiGetSearchAttributeConfig
|
|
54859
|
+
*/
|
|
54860
|
+
readonly offset?: number
|
|
54861
|
+
}
|
|
54862
|
+
|
|
54734
54863
|
/**
|
|
54735
54864
|
* Request parameters for getSingleSearchAttributeConfig operation in SearchAttributeConfigurationApi.
|
|
54736
54865
|
* @export
|
|
@@ -54774,7 +54903,7 @@ export interface SearchAttributeConfigurationApiPatchSearchAttributeConfigReques
|
|
|
54774
54903
|
*/
|
|
54775
54904
|
export class SearchAttributeConfigurationApi extends BaseAPI {
|
|
54776
54905
|
/**
|
|
54777
|
-
* Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create
|
|
54906
|
+
* Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.**
|
|
54778
54907
|
* @summary Create Extended Search Attributes
|
|
54779
54908
|
* @param {SearchAttributeConfigurationApiCreateSearchAttributeConfigRequest} requestParameters Request parameters.
|
|
54780
54909
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -54798,14 +54927,15 @@ export class SearchAttributeConfigurationApi extends BaseAPI {
|
|
|
54798
54927
|
}
|
|
54799
54928
|
|
|
54800
54929
|
/**
|
|
54801
|
-
* Get a list of attribute/application
|
|
54930
|
+
* Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
|
|
54802
54931
|
* @summary List Extended Search Attributes
|
|
54932
|
+
* @param {SearchAttributeConfigurationApiGetSearchAttributeConfigRequest} requestParameters Request parameters.
|
|
54803
54933
|
* @param {*} [axiosOptions] Override http request option.
|
|
54804
54934
|
* @throws {RequiredError}
|
|
54805
54935
|
* @memberof SearchAttributeConfigurationApi
|
|
54806
54936
|
*/
|
|
54807
|
-
public getSearchAttributeConfig(axiosOptions?: RawAxiosRequestConfig) {
|
|
54808
|
-
return SearchAttributeConfigurationApiFp(this.configuration).getSearchAttributeConfig(axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
54937
|
+
public getSearchAttributeConfig(requestParameters: SearchAttributeConfigurationApiGetSearchAttributeConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig) {
|
|
54938
|
+
return SearchAttributeConfigurationApiFp(this.configuration).getSearchAttributeConfig(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
54809
54939
|
}
|
|
54810
54940
|
|
|
54811
54941
|
/**
|
|
@@ -57130,15 +57260,15 @@ export const SourcesApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
57130
57260
|
/**
|
|
57131
57261
|
* Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC).
|
|
57132
57262
|
* @summary Get Source Connections by ID
|
|
57133
|
-
* @param {string}
|
|
57263
|
+
* @param {string} sourceId Source ID.
|
|
57134
57264
|
* @param {*} [axiosOptions] Override http request option.
|
|
57135
57265
|
* @throws {RequiredError}
|
|
57136
57266
|
*/
|
|
57137
|
-
getSourceConnections: async (
|
|
57138
|
-
// verify required parameter '
|
|
57139
|
-
assertParamExists('getSourceConnections', '
|
|
57267
|
+
getSourceConnections: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
57268
|
+
// verify required parameter 'sourceId' is not null or undefined
|
|
57269
|
+
assertParamExists('getSourceConnections', 'sourceId', sourceId)
|
|
57140
57270
|
const localVarPath = `/sources/{sourceId}/connections`
|
|
57141
|
-
.replace(`{${"
|
|
57271
|
+
.replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId)));
|
|
57142
57272
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
57143
57273
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
57144
57274
|
let baseOptions;
|
|
@@ -58104,12 +58234,12 @@ export const SourcesApiFp = function(configuration?: Configuration) {
|
|
|
58104
58234
|
/**
|
|
58105
58235
|
* Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC).
|
|
58106
58236
|
* @summary Get Source Connections by ID
|
|
58107
|
-
* @param {string}
|
|
58237
|
+
* @param {string} sourceId Source ID.
|
|
58108
58238
|
* @param {*} [axiosOptions] Override http request option.
|
|
58109
58239
|
* @throws {RequiredError}
|
|
58110
58240
|
*/
|
|
58111
|
-
async getSourceConnections(
|
|
58112
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceConnections(
|
|
58241
|
+
async getSourceConnections(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SourceConnectionsDto>> {
|
|
58242
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceConnections(sourceId, axiosOptions);
|
|
58113
58243
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
58114
58244
|
const localVarOperationServerBasePath = operationServerMap['SourcesApi.getSourceConnections']?.[localVarOperationServerIndex]?.url;
|
|
58115
58245
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -58451,7 +58581,7 @@ export const SourcesApiFactory = function (configuration?: Configuration, basePa
|
|
|
58451
58581
|
* @throws {RequiredError}
|
|
58452
58582
|
*/
|
|
58453
58583
|
getSourceConnections(requestParameters: SourcesApiGetSourceConnectionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SourceConnectionsDto> {
|
|
58454
|
-
return localVarFp.getSourceConnections(requestParameters.
|
|
58584
|
+
return localVarFp.getSourceConnections(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath));
|
|
58455
58585
|
},
|
|
58456
58586
|
/**
|
|
58457
58587
|
* This endpoint fetches source health by source\'s id
|
|
@@ -58806,7 +58936,7 @@ export interface SourcesApiGetSourceConnectionsRequest {
|
|
|
58806
58936
|
* @type {string}
|
|
58807
58937
|
* @memberof SourcesApiGetSourceConnections
|
|
58808
58938
|
*/
|
|
58809
|
-
readonly
|
|
58939
|
+
readonly sourceId: string
|
|
58810
58940
|
}
|
|
58811
58941
|
|
|
58812
58942
|
/**
|
|
@@ -59323,7 +59453,7 @@ export class SourcesApi extends BaseAPI {
|
|
|
59323
59453
|
* @memberof SourcesApi
|
|
59324
59454
|
*/
|
|
59325
59455
|
public getSourceConnections(requestParameters: SourcesApiGetSourceConnectionsRequest, axiosOptions?: RawAxiosRequestConfig) {
|
|
59326
|
-
return SourcesApiFp(this.configuration).getSourceConnections(requestParameters.
|
|
59456
|
+
return SourcesApiFp(this.configuration).getSourceConnections(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
59327
59457
|
}
|
|
59328
59458
|
|
|
59329
59459
|
/**
|