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/dist/v2024/common.js
CHANGED
|
@@ -250,7 +250,7 @@ var createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configu
|
|
|
250
250
|
if (axios === void 0) { axios = globalAxios; }
|
|
251
251
|
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
252
252
|
(0, axios_retry_1.default)(axios, configuration.retriesConfig);
|
|
253
|
-
var headers = __assign(__assign({ 'User-Agent': 'OpenAPI-Generator/1.4.
|
|
253
|
+
var headers = __assign(__assign({ 'User-Agent': 'OpenAPI-Generator/1.4.16/ts' }, axiosArgs.axiosOptions.headers), { 'X-SailPoint-SDK': 'typescript-1.4.16' });
|
|
254
254
|
if (!configuration.experimental && ("X-SailPoint-Experimental" in headers)) {
|
|
255
255
|
throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.");
|
|
256
256
|
}
|
package/dist/v3/api.d.ts
CHANGED
|
@@ -8461,6 +8461,12 @@ export interface EventAttributes {
|
|
|
8461
8461
|
* @memberof EventAttributes
|
|
8462
8462
|
*/
|
|
8463
8463
|
'attributeToFilter'?: string;
|
|
8464
|
+
/**
|
|
8465
|
+
* Form definition\'s unique identifier.
|
|
8466
|
+
* @type {string}
|
|
8467
|
+
* @memberof EventAttributes
|
|
8468
|
+
*/
|
|
8469
|
+
'formDefinitionId'?: string;
|
|
8464
8470
|
}
|
|
8465
8471
|
/**
|
|
8466
8472
|
* Event
|
|
@@ -12306,7 +12312,7 @@ export interface ManagedCluster {
|
|
|
12306
12312
|
* @type {string}
|
|
12307
12313
|
* @memberof ManagedCluster
|
|
12308
12314
|
*/
|
|
12309
|
-
'status'?:
|
|
12315
|
+
'status'?: ManagedClusterStatusV3;
|
|
12310
12316
|
/**
|
|
12311
12317
|
* Public key certificate
|
|
12312
12318
|
* @type {string}
|
|
@@ -12362,6 +12368,14 @@ export interface ManagedCluster {
|
|
|
12362
12368
|
*/
|
|
12363
12369
|
'updatedAt'?: string | null;
|
|
12364
12370
|
}
|
|
12371
|
+
export declare const ManagedClusterStatusV3: {
|
|
12372
|
+
readonly Configuring: "CONFIGURING";
|
|
12373
|
+
readonly Failed: "FAILED";
|
|
12374
|
+
readonly NoClients: "NO_CLIENTS";
|
|
12375
|
+
readonly Normal: "NORMAL";
|
|
12376
|
+
readonly Warning: "WARNING";
|
|
12377
|
+
};
|
|
12378
|
+
export type ManagedClusterStatusV3 = typeof ManagedClusterStatusV3[keyof typeof ManagedClusterStatusV3];
|
|
12365
12379
|
/**
|
|
12366
12380
|
* Managed Cluster Attributes for Cluster Configuration. Supported Cluster Types [sqsCluster, spConnectCluster]
|
|
12367
12381
|
* @export
|
|
@@ -16268,11 +16282,71 @@ export declare const ReportDetailsReportTypeV3: {
|
|
|
16268
16282
|
};
|
|
16269
16283
|
export type ReportDetailsReportTypeV3 = typeof ReportDetailsReportTypeV3[keyof typeof ReportDetailsReportTypeV3];
|
|
16270
16284
|
/**
|
|
16271
|
-
* @type ReportDetailsArguments
|
|
16272
16285
|
* The string-object map(dictionary) with the arguments needed for report processing.
|
|
16273
16286
|
* @export
|
|
16287
|
+
* @interface ReportDetailsArguments
|
|
16274
16288
|
*/
|
|
16275
|
-
export
|
|
16289
|
+
export interface ReportDetailsArguments {
|
|
16290
|
+
/**
|
|
16291
|
+
* Source ID.
|
|
16292
|
+
* @type {string}
|
|
16293
|
+
* @memberof ReportDetailsArguments
|
|
16294
|
+
*/
|
|
16295
|
+
'application': string;
|
|
16296
|
+
/**
|
|
16297
|
+
* Source name.
|
|
16298
|
+
* @type {string}
|
|
16299
|
+
* @memberof ReportDetailsArguments
|
|
16300
|
+
*/
|
|
16301
|
+
'sourceName': string;
|
|
16302
|
+
/**
|
|
16303
|
+
* Flag to specify if only correlated identities are included in report.
|
|
16304
|
+
* @type {boolean}
|
|
16305
|
+
* @memberof ReportDetailsArguments
|
|
16306
|
+
*/
|
|
16307
|
+
'correlatedOnly': boolean;
|
|
16308
|
+
/**
|
|
16309
|
+
* Source ID.
|
|
16310
|
+
* @type {string}
|
|
16311
|
+
* @memberof ReportDetailsArguments
|
|
16312
|
+
*/
|
|
16313
|
+
'authoritativeSource': string;
|
|
16314
|
+
/**
|
|
16315
|
+
* 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.
|
|
16316
|
+
* @type {Array<string>}
|
|
16317
|
+
* @memberof ReportDetailsArguments
|
|
16318
|
+
*/
|
|
16319
|
+
'selectedFormats'?: Array<ReportDetailsArgumentsSelectedFormatsV3>;
|
|
16320
|
+
/**
|
|
16321
|
+
* The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched.
|
|
16322
|
+
* @type {Array<Index>}
|
|
16323
|
+
* @memberof ReportDetailsArguments
|
|
16324
|
+
*/
|
|
16325
|
+
'indices'?: Array<Index>;
|
|
16326
|
+
/**
|
|
16327
|
+
* 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.
|
|
16328
|
+
* @type {string}
|
|
16329
|
+
* @memberof ReportDetailsArguments
|
|
16330
|
+
*/
|
|
16331
|
+
'query': string;
|
|
16332
|
+
/**
|
|
16333
|
+
* 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.
|
|
16334
|
+
* @type {string}
|
|
16335
|
+
* @memberof ReportDetailsArguments
|
|
16336
|
+
*/
|
|
16337
|
+
'columns'?: string;
|
|
16338
|
+
/**
|
|
16339
|
+
* The fields to be used to sort the search results. Use + or - to specify the sort direction.
|
|
16340
|
+
* @type {Array<string>}
|
|
16341
|
+
* @memberof ReportDetailsArguments
|
|
16342
|
+
*/
|
|
16343
|
+
'sort'?: Array<string>;
|
|
16344
|
+
}
|
|
16345
|
+
export declare const ReportDetailsArgumentsSelectedFormatsV3: {
|
|
16346
|
+
readonly Csv: "CSV";
|
|
16347
|
+
readonly Pdf: "PDF";
|
|
16348
|
+
};
|
|
16349
|
+
export type ReportDetailsArgumentsSelectedFormatsV3 = typeof ReportDetailsArgumentsSelectedFormatsV3[keyof typeof ReportDetailsArgumentsSelectedFormatsV3];
|
|
16276
16350
|
/**
|
|
16277
16351
|
*
|
|
16278
16352
|
* @export
|
|
@@ -16591,7 +16665,7 @@ export declare const RequestableObjectRequestStatus: {
|
|
|
16591
16665
|
};
|
|
16592
16666
|
export type RequestableObjectRequestStatus = typeof RequestableObjectRequestStatus[keyof typeof RequestableObjectRequestStatus];
|
|
16593
16667
|
/**
|
|
16594
|
-
*
|
|
16668
|
+
* Currently supported requestable object types.
|
|
16595
16669
|
* @export
|
|
16596
16670
|
* @enum {string}
|
|
16597
16671
|
*/
|
|
@@ -18991,6 +19065,12 @@ export interface ScheduledAttributes {
|
|
|
18991
19065
|
* @memberof ScheduledAttributes
|
|
18992
19066
|
*/
|
|
18993
19067
|
'weeklyTimes'?: Array<string>;
|
|
19068
|
+
/**
|
|
19069
|
+
* Scheduled execution times
|
|
19070
|
+
* @type {Array<string>}
|
|
19071
|
+
* @memberof ScheduledAttributes
|
|
19072
|
+
*/
|
|
19073
|
+
'yearlyTimes'?: Array<string>;
|
|
18994
19074
|
}
|
|
18995
19075
|
export declare const ScheduledAttributesFrequencyV3: {
|
|
18996
19076
|
readonly Daily: "daily";
|
|
@@ -21108,11 +21188,11 @@ export interface SourceConnectionsDto {
|
|
|
21108
21188
|
*/
|
|
21109
21189
|
'mappingProfiles'?: Array<string>;
|
|
21110
21190
|
/**
|
|
21111
|
-
*
|
|
21112
|
-
* @type {Array<
|
|
21191
|
+
* 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.
|
|
21192
|
+
* @type {Array<TransformRead>}
|
|
21113
21193
|
* @memberof SourceConnectionsDto
|
|
21114
21194
|
*/
|
|
21115
|
-
'dependentCustomTransforms'?: Array<
|
|
21195
|
+
'dependentCustomTransforms'?: Array<TransformRead>;
|
|
21116
21196
|
/**
|
|
21117
21197
|
*
|
|
21118
21198
|
* @type {Array<DependantAppConnections>}
|
|
@@ -21699,7 +21779,7 @@ export interface TaskResultDetails {
|
|
|
21699
21779
|
'id'?: string;
|
|
21700
21780
|
/**
|
|
21701
21781
|
* Use this property to define what report should be processed in the RDE service.
|
|
21702
|
-
* @type {
|
|
21782
|
+
* @type {string}
|
|
21703
21783
|
* @memberof TaskResultDetails
|
|
21704
21784
|
*/
|
|
21705
21785
|
'reportType'?: TaskResultDetailsReportTypeV3;
|
|
@@ -21759,12 +21839,10 @@ export interface TaskResultDetails {
|
|
|
21759
21839
|
'returns'?: Array<TaskResultDetailsReturnsInner>;
|
|
21760
21840
|
/**
|
|
21761
21841
|
* Extra attributes map(dictionary) needed for the report.
|
|
21762
|
-
* @type {
|
|
21842
|
+
* @type {object}
|
|
21763
21843
|
* @memberof TaskResultDetails
|
|
21764
21844
|
*/
|
|
21765
|
-
'attributes'?:
|
|
21766
|
-
[key: string]: object;
|
|
21767
|
-
};
|
|
21845
|
+
'attributes'?: object;
|
|
21768
21846
|
/**
|
|
21769
21847
|
* Current report state.
|
|
21770
21848
|
* @type {string}
|
|
@@ -23885,6 +23963,12 @@ export interface WorkflowTriggerAttributes {
|
|
|
23885
23963
|
* @memberof WorkflowTriggerAttributes
|
|
23886
23964
|
*/
|
|
23887
23965
|
'attributeToFilter'?: string;
|
|
23966
|
+
/**
|
|
23967
|
+
* Form definition\'s unique identifier.
|
|
23968
|
+
* @type {string}
|
|
23969
|
+
* @memberof WorkflowTriggerAttributes
|
|
23970
|
+
*/
|
|
23971
|
+
'formDefinitionId'?: string;
|
|
23888
23972
|
/**
|
|
23889
23973
|
* A unique name for the external trigger
|
|
23890
23974
|
* @type {string}
|
|
@@ -23933,6 +24017,12 @@ export interface WorkflowTriggerAttributes {
|
|
|
23933
24017
|
* @memberof WorkflowTriggerAttributes
|
|
23934
24018
|
*/
|
|
23935
24019
|
'weeklyTimes'?: Array<string>;
|
|
24020
|
+
/**
|
|
24021
|
+
* Scheduled execution times
|
|
24022
|
+
* @type {Array<string>}
|
|
24023
|
+
* @memberof WorkflowTriggerAttributes
|
|
24024
|
+
*/
|
|
24025
|
+
'yearlyTimes'?: Array<string>;
|
|
23936
24026
|
}
|
|
23937
24027
|
export declare const WorkflowTriggerAttributesFrequencyV3: {
|
|
23938
24028
|
readonly Daily: "daily";
|
|
@@ -23948,7 +24038,7 @@ export type WorkflowTriggerAttributesFrequencyV3 = typeof WorkflowTriggerAttribu
|
|
|
23948
24038
|
*/
|
|
23949
24039
|
export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
23950
24040
|
/**
|
|
23951
|
-
*
|
|
24041
|
+
* 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.
|
|
23952
24042
|
* @summary Create Access Profile
|
|
23953
24043
|
* @param {AccessProfile} accessProfile
|
|
23954
24044
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -23993,16 +24083,16 @@ export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Config
|
|
|
23993
24083
|
*/
|
|
23994
24084
|
getAccessProfileEntitlements: (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23995
24085
|
/**
|
|
23996
|
-
*
|
|
24086
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
23997
24087
|
* @summary List Access Profiles
|
|
23998
|
-
* @param {string} [forSubadmin]
|
|
23999
|
-
* @param {number} [limit]
|
|
24088
|
+
* @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.
|
|
24089
|
+
* @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.
|
|
24000
24090
|
* @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.
|
|
24001
24091
|
* @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.
|
|
24002
|
-
* @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*
|
|
24092
|
+
* @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.
|
|
24003
24093
|
* @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**
|
|
24004
|
-
* @param {string} [forSegmentIds]
|
|
24005
|
-
* @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If
|
|
24094
|
+
* @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.
|
|
24095
|
+
* @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.
|
|
24006
24096
|
* @param {*} [axiosOptions] Override http request option.
|
|
24007
24097
|
* @throws {RequiredError}
|
|
24008
24098
|
*/
|
|
@@ -24023,7 +24113,7 @@ export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Config
|
|
|
24023
24113
|
*/
|
|
24024
24114
|
export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
24025
24115
|
/**
|
|
24026
|
-
*
|
|
24116
|
+
* 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.
|
|
24027
24117
|
* @summary Create Access Profile
|
|
24028
24118
|
* @param {AccessProfile} accessProfile
|
|
24029
24119
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -24068,16 +24158,16 @@ export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
|
24068
24158
|
*/
|
|
24069
24159
|
getAccessProfileEntitlements(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Entitlement>>>;
|
|
24070
24160
|
/**
|
|
24071
|
-
*
|
|
24161
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
24072
24162
|
* @summary List Access Profiles
|
|
24073
|
-
* @param {string} [forSubadmin]
|
|
24074
|
-
* @param {number} [limit]
|
|
24163
|
+
* @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.
|
|
24164
|
+
* @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.
|
|
24075
24165
|
* @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.
|
|
24076
24166
|
* @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.
|
|
24077
|
-
* @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*
|
|
24167
|
+
* @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.
|
|
24078
24168
|
* @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**
|
|
24079
|
-
* @param {string} [forSegmentIds]
|
|
24080
|
-
* @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If
|
|
24169
|
+
* @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.
|
|
24170
|
+
* @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.
|
|
24081
24171
|
* @param {*} [axiosOptions] Override http request option.
|
|
24082
24172
|
* @throws {RequiredError}
|
|
24083
24173
|
*/
|
|
@@ -24098,7 +24188,7 @@ export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
|
24098
24188
|
*/
|
|
24099
24189
|
export declare const AccessProfilesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
24100
24190
|
/**
|
|
24101
|
-
*
|
|
24191
|
+
* 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.
|
|
24102
24192
|
* @summary Create Access Profile
|
|
24103
24193
|
* @param {AccessProfilesApiCreateAccessProfileRequest} requestParameters Request parameters.
|
|
24104
24194
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -24138,7 +24228,7 @@ export declare const AccessProfilesApiFactory: (configuration?: Configuration, b
|
|
|
24138
24228
|
*/
|
|
24139
24229
|
getAccessProfileEntitlements(requestParameters: AccessProfilesApiGetAccessProfileEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Entitlement>>;
|
|
24140
24230
|
/**
|
|
24141
|
-
*
|
|
24231
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
24142
24232
|
* @summary List Access Profiles
|
|
24143
24233
|
* @param {AccessProfilesApiListAccessProfilesRequest} requestParameters Request parameters.
|
|
24144
24234
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -24256,13 +24346,13 @@ export interface AccessProfilesApiGetAccessProfileEntitlementsRequest {
|
|
|
24256
24346
|
*/
|
|
24257
24347
|
export interface AccessProfilesApiListAccessProfilesRequest {
|
|
24258
24348
|
/**
|
|
24259
|
-
*
|
|
24349
|
+
* 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.
|
|
24260
24350
|
* @type {string}
|
|
24261
24351
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
24262
24352
|
*/
|
|
24263
24353
|
readonly forSubadmin?: string;
|
|
24264
24354
|
/**
|
|
24265
|
-
*
|
|
24355
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
24266
24356
|
* @type {number}
|
|
24267
24357
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
24268
24358
|
*/
|
|
@@ -24280,7 +24370,7 @@ export interface AccessProfilesApiListAccessProfilesRequest {
|
|
|
24280
24370
|
*/
|
|
24281
24371
|
readonly count?: boolean;
|
|
24282
24372
|
/**
|
|
24283
|
-
* 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*
|
|
24373
|
+
* 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.
|
|
24284
24374
|
* @type {string}
|
|
24285
24375
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
24286
24376
|
*/
|
|
@@ -24292,13 +24382,13 @@ export interface AccessProfilesApiListAccessProfilesRequest {
|
|
|
24292
24382
|
*/
|
|
24293
24383
|
readonly sorters?: string;
|
|
24294
24384
|
/**
|
|
24295
|
-
*
|
|
24385
|
+
* 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.
|
|
24296
24386
|
* @type {string}
|
|
24297
24387
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
24298
24388
|
*/
|
|
24299
24389
|
readonly forSegmentIds?: string;
|
|
24300
24390
|
/**
|
|
24301
|
-
* Indicates whether the response list should contain unsegmented access profiles. If
|
|
24391
|
+
* 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.
|
|
24302
24392
|
* @type {boolean}
|
|
24303
24393
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
24304
24394
|
*/
|
|
@@ -24331,7 +24421,7 @@ export interface AccessProfilesApiPatchAccessProfileRequest {
|
|
|
24331
24421
|
*/
|
|
24332
24422
|
export declare class AccessProfilesApi extends BaseAPI {
|
|
24333
24423
|
/**
|
|
24334
|
-
*
|
|
24424
|
+
* 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.
|
|
24335
24425
|
* @summary Create Access Profile
|
|
24336
24426
|
* @param {AccessProfilesApiCreateAccessProfileRequest} requestParameters Request parameters.
|
|
24337
24427
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -24376,7 +24466,7 @@ export declare class AccessProfilesApi extends BaseAPI {
|
|
|
24376
24466
|
*/
|
|
24377
24467
|
getAccessProfileEntitlements(requestParameters: AccessProfilesApiGetAccessProfileEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Entitlement[], any>>;
|
|
24378
24468
|
/**
|
|
24379
|
-
*
|
|
24469
|
+
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
24380
24470
|
* @summary List Access Profiles
|
|
24381
24471
|
* @param {AccessProfilesApiListAccessProfilesRequest} requestParameters Request parameters.
|
|
24382
24472
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -36923,12 +37013,12 @@ export type GetReportFileFormatV3 = typeof GetReportFileFormatV3[keyof typeof Ge
|
|
|
36923
37013
|
*/
|
|
36924
37014
|
export declare const RequestableObjectsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
36925
37015
|
/**
|
|
36926
|
-
*
|
|
37016
|
+
* 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.
|
|
36927
37017
|
* @summary Requestable Objects List
|
|
36928
37018
|
* @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.
|
|
36929
|
-
* @param {Array<RequestableObjectType>} [types] Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE
|
|
36930
|
-
* @param {string} [term]
|
|
36931
|
-
* @param {Array<RequestableObjectRequestStatus>} [statuses] Filters the result to the specified status/statuses, where each status is one of AVAILABLE
|
|
37019
|
+
* @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.
|
|
37020
|
+
* @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.
|
|
37021
|
+
* @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.
|
|
36932
37022
|
* @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.
|
|
36933
37023
|
* @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.
|
|
36934
37024
|
* @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.
|
|
@@ -36945,12 +37035,12 @@ export declare const RequestableObjectsApiAxiosParamCreator: (configuration?: Co
|
|
|
36945
37035
|
*/
|
|
36946
37036
|
export declare const RequestableObjectsApiFp: (configuration?: Configuration) => {
|
|
36947
37037
|
/**
|
|
36948
|
-
*
|
|
37038
|
+
* 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.
|
|
36949
37039
|
* @summary Requestable Objects List
|
|
36950
37040
|
* @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.
|
|
36951
|
-
* @param {Array<RequestableObjectType>} [types] Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE
|
|
36952
|
-
* @param {string} [term]
|
|
36953
|
-
* @param {Array<RequestableObjectRequestStatus>} [statuses] Filters the result to the specified status/statuses, where each status is one of AVAILABLE
|
|
37041
|
+
* @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.
|
|
37042
|
+
* @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.
|
|
37043
|
+
* @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.
|
|
36954
37044
|
* @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.
|
|
36955
37045
|
* @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.
|
|
36956
37046
|
* @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.
|
|
@@ -36967,7 +37057,7 @@ export declare const RequestableObjectsApiFp: (configuration?: Configuration) =>
|
|
|
36967
37057
|
*/
|
|
36968
37058
|
export declare const RequestableObjectsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
36969
37059
|
/**
|
|
36970
|
-
*
|
|
37060
|
+
* 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.
|
|
36971
37061
|
* @summary Requestable Objects List
|
|
36972
37062
|
* @param {RequestableObjectsApiListRequestableObjectsRequest} requestParameters Request parameters.
|
|
36973
37063
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -36988,19 +37078,19 @@ export interface RequestableObjectsApiListRequestableObjectsRequest {
|
|
|
36988
37078
|
*/
|
|
36989
37079
|
readonly identityId?: string;
|
|
36990
37080
|
/**
|
|
36991
|
-
* Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE
|
|
37081
|
+
* 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.
|
|
36992
37082
|
* @type {Array<RequestableObjectType>}
|
|
36993
37083
|
* @memberof RequestableObjectsApiListRequestableObjects
|
|
36994
37084
|
*/
|
|
36995
37085
|
readonly types?: Array<RequestableObjectType>;
|
|
36996
37086
|
/**
|
|
36997
|
-
*
|
|
37087
|
+
* 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.
|
|
36998
37088
|
* @type {string}
|
|
36999
37089
|
* @memberof RequestableObjectsApiListRequestableObjects
|
|
37000
37090
|
*/
|
|
37001
37091
|
readonly term?: string;
|
|
37002
37092
|
/**
|
|
37003
|
-
* Filters the result to the specified status/statuses, where each status is one of AVAILABLE
|
|
37093
|
+
* 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.
|
|
37004
37094
|
* @type {Array<RequestableObjectRequestStatus>}
|
|
37005
37095
|
* @memberof RequestableObjectsApiListRequestableObjects
|
|
37006
37096
|
*/
|
|
@@ -37044,7 +37134,7 @@ export interface RequestableObjectsApiListRequestableObjectsRequest {
|
|
|
37044
37134
|
*/
|
|
37045
37135
|
export declare class RequestableObjectsApi extends BaseAPI {
|
|
37046
37136
|
/**
|
|
37047
|
-
*
|
|
37137
|
+
* 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.
|
|
37048
37138
|
* @summary Requestable Objects List
|
|
37049
37139
|
* @param {RequestableObjectsApiListRequestableObjectsRequest} requestParameters Request parameters.
|
|
37050
37140
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39454,7 +39544,7 @@ export type SearchGetIndexV3 = typeof SearchGetIndexV3[keyof typeof SearchGetInd
|
|
|
39454
39544
|
*/
|
|
39455
39545
|
export declare const SearchAttributeConfigurationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
39456
39546
|
/**
|
|
39457
|
-
* 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
|
|
39547
|
+
* 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`.**
|
|
39458
39548
|
* @summary Create Extended Search Attributes
|
|
39459
39549
|
* @param {SearchAttributeConfig} searchAttributeConfig
|
|
39460
39550
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39470,12 +39560,14 @@ export declare const SearchAttributeConfigurationApiAxiosParamCreator: (configur
|
|
|
39470
39560
|
*/
|
|
39471
39561
|
deleteSearchAttributeConfig: (name: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39472
39562
|
/**
|
|
39473
|
-
* Get a list of attribute/application
|
|
39563
|
+
* Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
|
|
39474
39564
|
* @summary List Extended Search Attributes
|
|
39565
|
+
* @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.
|
|
39566
|
+
* @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.
|
|
39475
39567
|
* @param {*} [axiosOptions] Override http request option.
|
|
39476
39568
|
* @throws {RequiredError}
|
|
39477
39569
|
*/
|
|
39478
|
-
getSearchAttributeConfig: (axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39570
|
+
getSearchAttributeConfig: (limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39479
39571
|
/**
|
|
39480
39572
|
* Get an extended attribute configuration by name.
|
|
39481
39573
|
* @summary Get Extended Search Attribute
|
|
@@ -39500,7 +39592,7 @@ export declare const SearchAttributeConfigurationApiAxiosParamCreator: (configur
|
|
|
39500
39592
|
*/
|
|
39501
39593
|
export declare const SearchAttributeConfigurationApiFp: (configuration?: Configuration) => {
|
|
39502
39594
|
/**
|
|
39503
|
-
* 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
|
|
39595
|
+
* 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`.**
|
|
39504
39596
|
* @summary Create Extended Search Attributes
|
|
39505
39597
|
* @param {SearchAttributeConfig} searchAttributeConfig
|
|
39506
39598
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39516,12 +39608,14 @@ export declare const SearchAttributeConfigurationApiFp: (configuration?: Configu
|
|
|
39516
39608
|
*/
|
|
39517
39609
|
deleteSearchAttributeConfig(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
39518
39610
|
/**
|
|
39519
|
-
* Get a list of attribute/application
|
|
39611
|
+
* Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
|
|
39520
39612
|
* @summary List Extended Search Attributes
|
|
39613
|
+
* @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.
|
|
39614
|
+
* @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.
|
|
39521
39615
|
* @param {*} [axiosOptions] Override http request option.
|
|
39522
39616
|
* @throws {RequiredError}
|
|
39523
39617
|
*/
|
|
39524
|
-
getSearchAttributeConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SearchAttributeConfig>>>;
|
|
39618
|
+
getSearchAttributeConfig(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SearchAttributeConfig>>>;
|
|
39525
39619
|
/**
|
|
39526
39620
|
* Get an extended attribute configuration by name.
|
|
39527
39621
|
* @summary Get Extended Search Attribute
|
|
@@ -39546,7 +39640,7 @@ export declare const SearchAttributeConfigurationApiFp: (configuration?: Configu
|
|
|
39546
39640
|
*/
|
|
39547
39641
|
export declare const SearchAttributeConfigurationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
39548
39642
|
/**
|
|
39549
|
-
* 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
|
|
39643
|
+
* 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`.**
|
|
39550
39644
|
* @summary Create Extended Search Attributes
|
|
39551
39645
|
* @param {SearchAttributeConfigurationApiCreateSearchAttributeConfigRequest} requestParameters Request parameters.
|
|
39552
39646
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39562,12 +39656,13 @@ export declare const SearchAttributeConfigurationApiFactory: (configuration?: Co
|
|
|
39562
39656
|
*/
|
|
39563
39657
|
deleteSearchAttributeConfig(requestParameters: SearchAttributeConfigurationApiDeleteSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
39564
39658
|
/**
|
|
39565
|
-
* Get a list of attribute/application
|
|
39659
|
+
* Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
|
|
39566
39660
|
* @summary List Extended Search Attributes
|
|
39661
|
+
* @param {SearchAttributeConfigurationApiGetSearchAttributeConfigRequest} requestParameters Request parameters.
|
|
39567
39662
|
* @param {*} [axiosOptions] Override http request option.
|
|
39568
39663
|
* @throws {RequiredError}
|
|
39569
39664
|
*/
|
|
39570
|
-
getSearchAttributeConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<SearchAttributeConfig>>;
|
|
39665
|
+
getSearchAttributeConfig(requestParameters?: SearchAttributeConfigurationApiGetSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<SearchAttributeConfig>>;
|
|
39571
39666
|
/**
|
|
39572
39667
|
* Get an extended attribute configuration by name.
|
|
39573
39668
|
* @summary Get Extended Search Attribute
|
|
@@ -39611,6 +39706,25 @@ export interface SearchAttributeConfigurationApiDeleteSearchAttributeConfigReque
|
|
|
39611
39706
|
*/
|
|
39612
39707
|
readonly name: string;
|
|
39613
39708
|
}
|
|
39709
|
+
/**
|
|
39710
|
+
* Request parameters for getSearchAttributeConfig operation in SearchAttributeConfigurationApi.
|
|
39711
|
+
* @export
|
|
39712
|
+
* @interface SearchAttributeConfigurationApiGetSearchAttributeConfigRequest
|
|
39713
|
+
*/
|
|
39714
|
+
export interface SearchAttributeConfigurationApiGetSearchAttributeConfigRequest {
|
|
39715
|
+
/**
|
|
39716
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
39717
|
+
* @type {number}
|
|
39718
|
+
* @memberof SearchAttributeConfigurationApiGetSearchAttributeConfig
|
|
39719
|
+
*/
|
|
39720
|
+
readonly limit?: number;
|
|
39721
|
+
/**
|
|
39722
|
+
* 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.
|
|
39723
|
+
* @type {number}
|
|
39724
|
+
* @memberof SearchAttributeConfigurationApiGetSearchAttributeConfig
|
|
39725
|
+
*/
|
|
39726
|
+
readonly offset?: number;
|
|
39727
|
+
}
|
|
39614
39728
|
/**
|
|
39615
39729
|
* Request parameters for getSingleSearchAttributeConfig operation in SearchAttributeConfigurationApi.
|
|
39616
39730
|
* @export
|
|
@@ -39651,7 +39765,7 @@ export interface SearchAttributeConfigurationApiPatchSearchAttributeConfigReques
|
|
|
39651
39765
|
*/
|
|
39652
39766
|
export declare class SearchAttributeConfigurationApi extends BaseAPI {
|
|
39653
39767
|
/**
|
|
39654
|
-
* 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
|
|
39768
|
+
* 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`.**
|
|
39655
39769
|
* @summary Create Extended Search Attributes
|
|
39656
39770
|
* @param {SearchAttributeConfigurationApiCreateSearchAttributeConfigRequest} requestParameters Request parameters.
|
|
39657
39771
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -39669,13 +39783,14 @@ export declare class SearchAttributeConfigurationApi extends BaseAPI {
|
|
|
39669
39783
|
*/
|
|
39670
39784
|
deleteSearchAttributeConfig(requestParameters: SearchAttributeConfigurationApiDeleteSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
39671
39785
|
/**
|
|
39672
|
-
* Get a list of attribute/application
|
|
39786
|
+
* Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
|
|
39673
39787
|
* @summary List Extended Search Attributes
|
|
39788
|
+
* @param {SearchAttributeConfigurationApiGetSearchAttributeConfigRequest} requestParameters Request parameters.
|
|
39674
39789
|
* @param {*} [axiosOptions] Override http request option.
|
|
39675
39790
|
* @throws {RequiredError}
|
|
39676
39791
|
* @memberof SearchAttributeConfigurationApi
|
|
39677
39792
|
*/
|
|
39678
|
-
getSearchAttributeConfig(axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchAttributeConfig[], any>>;
|
|
39793
|
+
getSearchAttributeConfig(requestParameters?: SearchAttributeConfigurationApiGetSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchAttributeConfig[], any>>;
|
|
39679
39794
|
/**
|
|
39680
39795
|
* Get an extended attribute configuration by name.
|
|
39681
39796
|
* @summary Get Extended Search Attribute
|
|
@@ -40720,11 +40835,11 @@ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
40720
40835
|
/**
|
|
40721
40836
|
* 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).
|
|
40722
40837
|
* @summary Get Source Connections by ID
|
|
40723
|
-
* @param {string}
|
|
40838
|
+
* @param {string} sourceId Source ID.
|
|
40724
40839
|
* @param {*} [axiosOptions] Override http request option.
|
|
40725
40840
|
* @throws {RequiredError}
|
|
40726
40841
|
*/
|
|
40727
|
-
getSourceConnections: (
|
|
40842
|
+
getSourceConnections: (sourceId: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
40728
40843
|
/**
|
|
40729
40844
|
* This endpoint fetches source health by source\'s id
|
|
40730
40845
|
* @summary Fetches source health by id
|
|
@@ -40965,11 +41080,11 @@ export declare const SourcesApiFp: (configuration?: Configuration) => {
|
|
|
40965
41080
|
/**
|
|
40966
41081
|
* 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).
|
|
40967
41082
|
* @summary Get Source Connections by ID
|
|
40968
|
-
* @param {string}
|
|
41083
|
+
* @param {string} sourceId Source ID.
|
|
40969
41084
|
* @param {*} [axiosOptions] Override http request option.
|
|
40970
41085
|
* @throws {RequiredError}
|
|
40971
41086
|
*/
|
|
40972
|
-
getSourceConnections(
|
|
41087
|
+
getSourceConnections(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SourceConnectionsDto>>;
|
|
40973
41088
|
/**
|
|
40974
41089
|
* This endpoint fetches source health by source\'s id
|
|
40975
41090
|
* @summary Fetches source health by id
|
|
@@ -41512,7 +41627,7 @@ export interface SourcesApiGetSourceConnectionsRequest {
|
|
|
41512
41627
|
* @type {string}
|
|
41513
41628
|
* @memberof SourcesApiGetSourceConnections
|
|
41514
41629
|
*/
|
|
41515
|
-
readonly
|
|
41630
|
+
readonly sourceId: string;
|
|
41516
41631
|
}
|
|
41517
41632
|
/**
|
|
41518
41633
|
* Request parameters for getSourceHealth operation in SourcesApi.
|