sailpoint-api-client 1.4.10 → 1.4.12

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.
@@ -14213,6 +14213,12 @@ export interface EventAttributesV2024 {
14213
14213
  * @memberof EventAttributesV2024
14214
14214
  */
14215
14215
  'description'?: string;
14216
+ /**
14217
+ * The attribute to filter on
14218
+ * @type {string}
14219
+ * @memberof EventAttributesV2024
14220
+ */
14221
+ 'attributeToFilter'?: string;
14216
14222
  }
14217
14223
  /**
14218
14224
  *
@@ -28380,6 +28386,45 @@ export interface RoleDocumentV2024 {
28380
28386
  */
28381
28387
  'entitlementCount'?: number;
28382
28388
  }
28389
+ /**
28390
+ *
28391
+ * @export
28392
+ * @interface RoleGetAllBulkUpdateResponseV2024
28393
+ */
28394
+ export interface RoleGetAllBulkUpdateResponseV2024 {
28395
+ /**
28396
+ * ID of the task which is executing the bulk update. This also used in to the bulk-update/_** API to track status.
28397
+ * @type {string}
28398
+ * @memberof RoleGetAllBulkUpdateResponseV2024
28399
+ */
28400
+ 'id'?: string;
28401
+ /**
28402
+ * Type of the bulk update object.
28403
+ * @type {string}
28404
+ * @memberof RoleGetAllBulkUpdateResponseV2024
28405
+ */
28406
+ 'type'?: string;
28407
+ /**
28408
+ * The status of the bulk update request, only list unfinished request\'s status, the status could also checked by getBulkUpdateStatus API
28409
+ * @type {string}
28410
+ * @memberof RoleGetAllBulkUpdateResponseV2024
28411
+ */
28412
+ 'status'?: RoleGetAllBulkUpdateResponseV2024StatusEnum;
28413
+ /**
28414
+ * Time when the bulk update request was created
28415
+ * @type {string}
28416
+ * @memberof RoleGetAllBulkUpdateResponseV2024
28417
+ */
28418
+ 'created'?: string;
28419
+ }
28420
+ export declare const RoleGetAllBulkUpdateResponseV2024StatusEnum: {
28421
+ readonly Created: "CREATED";
28422
+ readonly PreProcess: "PRE_PROCESS";
28423
+ readonly PostProcess: "POST_PROCESS";
28424
+ readonly ChunkPending: "CHUNK_PENDING";
28425
+ readonly ChunkProcessing: "CHUNK_PROCESSING";
28426
+ };
28427
+ export type RoleGetAllBulkUpdateResponseV2024StatusEnum = typeof RoleGetAllBulkUpdateResponseV2024StatusEnum[keyof typeof RoleGetAllBulkUpdateResponseV2024StatusEnum];
28383
28428
  /**
28384
28429
  * A subset of the fields of an Identity which is a member of a Role.
28385
28430
  * @export
@@ -28901,9 +28946,9 @@ export interface RoleMetadataBulkUpdateByFilterRequestV2024 {
28901
28946
  'values': Array<RoleMetadataBulkUpdateByFilterRequestValuesInnerV2024>;
28902
28947
  }
28903
28948
  export declare const RoleMetadataBulkUpdateByFilterRequestV2024OperationEnum: {
28904
- readonly Add: "add";
28905
- readonly Remove: "remove";
28906
- readonly Replace: "replace";
28949
+ readonly Add: "ADD";
28950
+ readonly Remove: "REMOVE";
28951
+ readonly Replace: "REPLACE";
28907
28952
  };
28908
28953
  export type RoleMetadataBulkUpdateByFilterRequestV2024OperationEnum = typeof RoleMetadataBulkUpdateByFilterRequestV2024OperationEnum[keyof typeof RoleMetadataBulkUpdateByFilterRequestV2024OperationEnum];
28909
28954
  export declare const RoleMetadataBulkUpdateByFilterRequestV2024ReplaceScopeEnum: {
@@ -28962,9 +29007,9 @@ export interface RoleMetadataBulkUpdateByIdRequestV2024 {
28962
29007
  'values': Array<RoleMetadataBulkUpdateByIdRequestValuesInnerV2024>;
28963
29008
  }
28964
29009
  export declare const RoleMetadataBulkUpdateByIdRequestV2024OperationEnum: {
28965
- readonly Add: "add";
28966
- readonly Remove: "remove";
28967
- readonly Replace: "replace";
29010
+ readonly Add: "ADD";
29011
+ readonly Remove: "REMOVE";
29012
+ readonly Replace: "REPLACE";
28968
29013
  };
28969
29014
  export type RoleMetadataBulkUpdateByIdRequestV2024OperationEnum = typeof RoleMetadataBulkUpdateByIdRequestV2024OperationEnum[keyof typeof RoleMetadataBulkUpdateByIdRequestV2024OperationEnum];
28970
29015
  export declare const RoleMetadataBulkUpdateByIdRequestV2024ReplaceScopeEnum: {
@@ -29023,9 +29068,9 @@ export interface RoleMetadataBulkUpdateByQueryRequestV2024 {
29023
29068
  'values': Array<RoleMetadataBulkUpdateByQueryRequestValuesInnerV2024>;
29024
29069
  }
29025
29070
  export declare const RoleMetadataBulkUpdateByQueryRequestV2024OperationEnum: {
29026
- readonly Add: "add";
29027
- readonly Remove: "remove";
29028
- readonly Replace: "replace";
29071
+ readonly Add: "ADD";
29072
+ readonly Remove: "REMOVE";
29073
+ readonly Replace: "REPLACE";
29029
29074
  };
29030
29075
  export type RoleMetadataBulkUpdateByQueryRequestV2024OperationEnum = typeof RoleMetadataBulkUpdateByQueryRequestV2024OperationEnum[keyof typeof RoleMetadataBulkUpdateByQueryRequestV2024OperationEnum];
29031
29076
  export declare const RoleMetadataBulkUpdateByQueryRequestV2024ReplaceScopeEnum: {
@@ -39619,6 +39664,12 @@ export interface WorkflowTriggerAttributesV2024 {
39619
39664
  * @memberof WorkflowTriggerAttributesV2024
39620
39665
  */
39621
39666
  'description'?: string;
39667
+ /**
39668
+ * The attribute to filter on
39669
+ * @type {string}
39670
+ * @memberof WorkflowTriggerAttributesV2024
39671
+ */
39672
+ 'attributeToFilter'?: string;
39622
39673
  /**
39623
39674
  * A unique name for the external trigger
39624
39675
  * @type {string}
@@ -54049,7 +54100,7 @@ export declare class IAICommonAccessV2024Api extends BaseAPI {
54049
54100
  */
54050
54101
  export declare const IAIOutliersV2024ApiAxiosParamCreator: (configuration?: Configuration) => {
54051
54102
  /**
54052
- * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported Columns will include: identityID, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes) Requires authorization scope of \'iai:outliers-management:read\'
54103
+ * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes).
54053
54104
  * @summary IAI Identity Outliers Export
54054
54105
  * @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
54055
54106
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54058,7 +54109,7 @@ export declare const IAIOutliersV2024ApiAxiosParamCreator: (configuration?: Conf
54058
54109
  */
54059
54110
  exportOutliersZip: (type?: 'LOW_SIMILARITY' | 'STRUCTURAL', xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
54060
54111
  /**
54061
- * This API receives a summary containing: the number of identities that customer has, the number of outliers, and the type of outlier Requires authorization scope of \'iai:outliers-management:read\'
54112
+ * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier.
54062
54113
  * @summary IAI Identity Outliers Summary
54063
54114
  * @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.
54064
54115
  * @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.
@@ -54071,7 +54122,7 @@ export declare const IAIOutliersV2024ApiAxiosParamCreator: (configuration?: Conf
54071
54122
  */
54072
54123
  getIdentityOutlierSnapshots: (limit?: number, offset?: number, type?: 'LOW_SIMILARITY' | 'STRUCTURAL', filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
54073
54124
  /**
54074
- * This API receives a list of outliers, containing data such as: identityId, outlier type, detection dates, identity attributes, if identity is ignore, and certification information Requires authorization scope of \'iai:outliers-management:read\'
54125
+ * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information.
54075
54126
  * @summary IAI Get Identity Outliers
54076
54127
  * @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.
54077
54128
  * @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.
@@ -54085,7 +54136,7 @@ export declare const IAIOutliersV2024ApiAxiosParamCreator: (configuration?: Conf
54085
54136
  */
54086
54137
  getIdentityOutliers: (limit?: number, offset?: number, count?: boolean, type?: 'LOW_SIMILARITY' | 'STRUCTURAL', filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
54087
54138
  /**
54088
- * This API returns a most recent snapshot of each outlier type, each containing: the number of identities that customer has, the number of outliers, and the type of outlier Requires authorization scope of \'iai:outliers-management:read\'
54139
+ * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier.
54089
54140
  * @summary IAI Identity Outliers Latest Summary
54090
54141
  * @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
54091
54142
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54094,7 +54145,7 @@ export declare const IAIOutliersV2024ApiAxiosParamCreator: (configuration?: Conf
54094
54145
  */
54095
54146
  getLatestIdentityOutlierSnapshots: (type?: 'LOW_SIMILARITY' | 'STRUCTURAL', xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
54096
54147
  /**
54097
- * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object Requires authorization scope of \'iai:outliers-management:read\'
54148
+ * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object.
54098
54149
  * @summary Get identity outlier contibuting feature summary
54099
54150
  * @param {string} outlierFeatureId Contributing feature id
54100
54151
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54103,7 +54154,7 @@ export declare const IAIOutliersV2024ApiAxiosParamCreator: (configuration?: Conf
54103
54154
  */
54104
54155
  getOutlierContributingFeatureSummary: (outlierFeatureId: string, xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
54105
54156
  /**
54106
- * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object Requires authorization scope of \'iai:outliers-management:read\'
54157
+ * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object.
54107
54158
  * @summary Get identity outlier\'s contibuting features
54108
54159
  * @param {string} outlierId The outlier id
54109
54160
  * @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.
@@ -54117,7 +54168,7 @@ export declare const IAIOutliersV2024ApiAxiosParamCreator: (configuration?: Conf
54117
54168
  */
54118
54169
  getPeerGroupOutliersContributingFeatures: (outlierId: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
54119
54170
  /**
54120
- * This API receives a list of IdentityIDs in the request, changes the outliers to be ignored--returning a 204 if successful. Requires authorization scope of \'iai:outliers-management:update\'
54171
+ * This API receives a list of identity IDs in the request, changes the outliers to be ignored.
54121
54172
  * @summary IAI Identity Outliers Ignore
54122
54173
  * @param {Array<string>} requestBody
54123
54174
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54126,14 +54177,14 @@ export declare const IAIOutliersV2024ApiAxiosParamCreator: (configuration?: Conf
54126
54177
  */
54127
54178
  ignoreIdentityOutliers: (requestBody: Array<string>, xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
54128
54179
  /**
54129
- * This API returns a list of the enriched access items associated with each feature filtered by the access item type The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare Requires authorization scope of \'iai:outliers-management:read\'
54180
+ * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare.
54130
54181
  * @summary Gets a list of access items associated with each identity outlier contributing feature
54131
54182
  * @param {string} outlierId The outlier id
54132
54183
  * @param {'radical_entitlement_count' | 'entitlement_count' | 'max_jaccard_similarity' | 'mean_max_bundle_concurrency' | 'single_entitlement_bundle_count' | 'peerless_score'} contributingFeatureName The name of contributing feature
54133
54184
  * @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.
54134
54185
  * @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.
54135
54186
  * @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&#x3D;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.
54136
- * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all
54187
+ * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all.
54137
54188
  * @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: **displayName**
54138
54189
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
54139
54190
  * @param {*} [axiosOptions] Override http request option.
@@ -54141,7 +54192,7 @@ export declare const IAIOutliersV2024ApiAxiosParamCreator: (configuration?: Conf
54141
54192
  */
54142
54193
  listOutliersContributingFeatureAccessItems: (outlierId: string, contributingFeatureName: 'radical_entitlement_count' | 'entitlement_count' | 'max_jaccard_similarity' | 'mean_max_bundle_concurrency' | 'single_entitlement_bundle_count' | 'peerless_score', limit?: number, offset?: number, count?: boolean, accessType?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
54143
54194
  /**
54144
- * This API receives a list of IdentityIDs in the request, changes the outliers to be un-ignored--returning a 204 if successful. Requires authorization scope of \'iai:outliers-management:update\'
54195
+ * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored.
54145
54196
  * @summary IAI Identity Outliers Unignore
54146
54197
  * @param {Array<string>} requestBody
54147
54198
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54156,7 +54207,7 @@ export declare const IAIOutliersV2024ApiAxiosParamCreator: (configuration?: Conf
54156
54207
  */
54157
54208
  export declare const IAIOutliersV2024ApiFp: (configuration?: Configuration) => {
54158
54209
  /**
54159
- * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported Columns will include: identityID, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes) Requires authorization scope of \'iai:outliers-management:read\'
54210
+ * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes).
54160
54211
  * @summary IAI Identity Outliers Export
54161
54212
  * @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
54162
54213
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54165,7 +54216,7 @@ export declare const IAIOutliersV2024ApiFp: (configuration?: Configuration) => {
54165
54216
  */
54166
54217
  exportOutliersZip(type?: 'LOW_SIMILARITY' | 'STRUCTURAL', xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
54167
54218
  /**
54168
- * This API receives a summary containing: the number of identities that customer has, the number of outliers, and the type of outlier Requires authorization scope of \'iai:outliers-management:read\'
54219
+ * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier.
54169
54220
  * @summary IAI Identity Outliers Summary
54170
54221
  * @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.
54171
54222
  * @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.
@@ -54178,7 +54229,7 @@ export declare const IAIOutliersV2024ApiFp: (configuration?: Configuration) => {
54178
54229
  */
54179
54230
  getIdentityOutlierSnapshots(limit?: number, offset?: number, type?: 'LOW_SIMILARITY' | 'STRUCTURAL', filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OutlierSummaryV2024>>>;
54180
54231
  /**
54181
- * This API receives a list of outliers, containing data such as: identityId, outlier type, detection dates, identity attributes, if identity is ignore, and certification information Requires authorization scope of \'iai:outliers-management:read\'
54232
+ * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information.
54182
54233
  * @summary IAI Get Identity Outliers
54183
54234
  * @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.
54184
54235
  * @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.
@@ -54192,7 +54243,7 @@ export declare const IAIOutliersV2024ApiFp: (configuration?: Configuration) => {
54192
54243
  */
54193
54244
  getIdentityOutliers(limit?: number, offset?: number, count?: boolean, type?: 'LOW_SIMILARITY' | 'STRUCTURAL', filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OutlierV2024>>>;
54194
54245
  /**
54195
- * This API returns a most recent snapshot of each outlier type, each containing: the number of identities that customer has, the number of outliers, and the type of outlier Requires authorization scope of \'iai:outliers-management:read\'
54246
+ * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier.
54196
54247
  * @summary IAI Identity Outliers Latest Summary
54197
54248
  * @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
54198
54249
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54201,7 +54252,7 @@ export declare const IAIOutliersV2024ApiFp: (configuration?: Configuration) => {
54201
54252
  */
54202
54253
  getLatestIdentityOutlierSnapshots(type?: 'LOW_SIMILARITY' | 'STRUCTURAL', xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<LatestOutlierSummaryV2024>>>;
54203
54254
  /**
54204
- * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object Requires authorization scope of \'iai:outliers-management:read\'
54255
+ * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object.
54205
54256
  * @summary Get identity outlier contibuting feature summary
54206
54257
  * @param {string} outlierFeatureId Contributing feature id
54207
54258
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54210,7 +54261,7 @@ export declare const IAIOutliersV2024ApiFp: (configuration?: Configuration) => {
54210
54261
  */
54211
54262
  getOutlierContributingFeatureSummary(outlierFeatureId: string, xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OutlierFeatureSummaryV2024>>;
54212
54263
  /**
54213
- * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object Requires authorization scope of \'iai:outliers-management:read\'
54264
+ * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object.
54214
54265
  * @summary Get identity outlier\'s contibuting features
54215
54266
  * @param {string} outlierId The outlier id
54216
54267
  * @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.
@@ -54224,7 +54275,7 @@ export declare const IAIOutliersV2024ApiFp: (configuration?: Configuration) => {
54224
54275
  */
54225
54276
  getPeerGroupOutliersContributingFeatures(outlierId: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OutlierContributingFeatureV2024>>>;
54226
54277
  /**
54227
- * This API receives a list of IdentityIDs in the request, changes the outliers to be ignored--returning a 204 if successful. Requires authorization scope of \'iai:outliers-management:update\'
54278
+ * This API receives a list of identity IDs in the request, changes the outliers to be ignored.
54228
54279
  * @summary IAI Identity Outliers Ignore
54229
54280
  * @param {Array<string>} requestBody
54230
54281
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54233,14 +54284,14 @@ export declare const IAIOutliersV2024ApiFp: (configuration?: Configuration) => {
54233
54284
  */
54234
54285
  ignoreIdentityOutliers(requestBody: Array<string>, xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
54235
54286
  /**
54236
- * This API returns a list of the enriched access items associated with each feature filtered by the access item type The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare Requires authorization scope of \'iai:outliers-management:read\'
54287
+ * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare.
54237
54288
  * @summary Gets a list of access items associated with each identity outlier contributing feature
54238
54289
  * @param {string} outlierId The outlier id
54239
54290
  * @param {'radical_entitlement_count' | 'entitlement_count' | 'max_jaccard_similarity' | 'mean_max_bundle_concurrency' | 'single_entitlement_bundle_count' | 'peerless_score'} contributingFeatureName The name of contributing feature
54240
54291
  * @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.
54241
54292
  * @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.
54242
54293
  * @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&#x3D;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.
54243
- * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all
54294
+ * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all.
54244
54295
  * @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: **displayName**
54245
54296
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
54246
54297
  * @param {*} [axiosOptions] Override http request option.
@@ -54248,7 +54299,7 @@ export declare const IAIOutliersV2024ApiFp: (configuration?: Configuration) => {
54248
54299
  */
54249
54300
  listOutliersContributingFeatureAccessItems(outlierId: string, contributingFeatureName: 'radical_entitlement_count' | 'entitlement_count' | 'max_jaccard_similarity' | 'mean_max_bundle_concurrency' | 'single_entitlement_bundle_count' | 'peerless_score', limit?: number, offset?: number, count?: boolean, accessType?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OutliersContributingFeatureAccessItemsV2024>>>;
54250
54301
  /**
54251
- * This API receives a list of IdentityIDs in the request, changes the outliers to be un-ignored--returning a 204 if successful. Requires authorization scope of \'iai:outliers-management:update\'
54302
+ * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored.
54252
54303
  * @summary IAI Identity Outliers Unignore
54253
54304
  * @param {Array<string>} requestBody
54254
54305
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54263,7 +54314,7 @@ export declare const IAIOutliersV2024ApiFp: (configuration?: Configuration) => {
54263
54314
  */
54264
54315
  export declare const IAIOutliersV2024ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
54265
54316
  /**
54266
- * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported Columns will include: identityID, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes) Requires authorization scope of \'iai:outliers-management:read\'
54317
+ * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes).
54267
54318
  * @summary IAI Identity Outliers Export
54268
54319
  * @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
54269
54320
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54272,7 +54323,7 @@ export declare const IAIOutliersV2024ApiFactory: (configuration?: Configuration,
54272
54323
  */
54273
54324
  exportOutliersZip(type?: 'LOW_SIMILARITY' | 'STRUCTURAL', xSailPointExperimental?: string, axiosOptions?: any): AxiosPromise<any>;
54274
54325
  /**
54275
- * This API receives a summary containing: the number of identities that customer has, the number of outliers, and the type of outlier Requires authorization scope of \'iai:outliers-management:read\'
54326
+ * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier.
54276
54327
  * @summary IAI Identity Outliers Summary
54277
54328
  * @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.
54278
54329
  * @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.
@@ -54285,7 +54336,7 @@ export declare const IAIOutliersV2024ApiFactory: (configuration?: Configuration,
54285
54336
  */
54286
54337
  getIdentityOutlierSnapshots(limit?: number, offset?: number, type?: 'LOW_SIMILARITY' | 'STRUCTURAL', filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: any): AxiosPromise<Array<OutlierSummaryV2024>>;
54287
54338
  /**
54288
- * This API receives a list of outliers, containing data such as: identityId, outlier type, detection dates, identity attributes, if identity is ignore, and certification information Requires authorization scope of \'iai:outliers-management:read\'
54339
+ * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information.
54289
54340
  * @summary IAI Get Identity Outliers
54290
54341
  * @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.
54291
54342
  * @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.
@@ -54299,7 +54350,7 @@ export declare const IAIOutliersV2024ApiFactory: (configuration?: Configuration,
54299
54350
  */
54300
54351
  getIdentityOutliers(limit?: number, offset?: number, count?: boolean, type?: 'LOW_SIMILARITY' | 'STRUCTURAL', filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: any): AxiosPromise<Array<OutlierV2024>>;
54301
54352
  /**
54302
- * This API returns a most recent snapshot of each outlier type, each containing: the number of identities that customer has, the number of outliers, and the type of outlier Requires authorization scope of \'iai:outliers-management:read\'
54353
+ * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier.
54303
54354
  * @summary IAI Identity Outliers Latest Summary
54304
54355
  * @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
54305
54356
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54308,7 +54359,7 @@ export declare const IAIOutliersV2024ApiFactory: (configuration?: Configuration,
54308
54359
  */
54309
54360
  getLatestIdentityOutlierSnapshots(type?: 'LOW_SIMILARITY' | 'STRUCTURAL', xSailPointExperimental?: string, axiosOptions?: any): AxiosPromise<Array<LatestOutlierSummaryV2024>>;
54310
54361
  /**
54311
- * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object Requires authorization scope of \'iai:outliers-management:read\'
54362
+ * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object.
54312
54363
  * @summary Get identity outlier contibuting feature summary
54313
54364
  * @param {string} outlierFeatureId Contributing feature id
54314
54365
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54317,7 +54368,7 @@ export declare const IAIOutliersV2024ApiFactory: (configuration?: Configuration,
54317
54368
  */
54318
54369
  getOutlierContributingFeatureSummary(outlierFeatureId: string, xSailPointExperimental?: string, axiosOptions?: any): AxiosPromise<OutlierFeatureSummaryV2024>;
54319
54370
  /**
54320
- * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object Requires authorization scope of \'iai:outliers-management:read\'
54371
+ * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object.
54321
54372
  * @summary Get identity outlier\'s contibuting features
54322
54373
  * @param {string} outlierId The outlier id
54323
54374
  * @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.
@@ -54331,7 +54382,7 @@ export declare const IAIOutliersV2024ApiFactory: (configuration?: Configuration,
54331
54382
  */
54332
54383
  getPeerGroupOutliersContributingFeatures(outlierId: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: any): AxiosPromise<Array<OutlierContributingFeatureV2024>>;
54333
54384
  /**
54334
- * This API receives a list of IdentityIDs in the request, changes the outliers to be ignored--returning a 204 if successful. Requires authorization scope of \'iai:outliers-management:update\'
54385
+ * This API receives a list of identity IDs in the request, changes the outliers to be ignored.
54335
54386
  * @summary IAI Identity Outliers Ignore
54336
54387
  * @param {Array<string>} requestBody
54337
54388
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54340,14 +54391,14 @@ export declare const IAIOutliersV2024ApiFactory: (configuration?: Configuration,
54340
54391
  */
54341
54392
  ignoreIdentityOutliers(requestBody: Array<string>, xSailPointExperimental?: string, axiosOptions?: any): AxiosPromise<void>;
54342
54393
  /**
54343
- * This API returns a list of the enriched access items associated with each feature filtered by the access item type The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare Requires authorization scope of \'iai:outliers-management:read\'
54394
+ * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare.
54344
54395
  * @summary Gets a list of access items associated with each identity outlier contributing feature
54345
54396
  * @param {string} outlierId The outlier id
54346
54397
  * @param {'radical_entitlement_count' | 'entitlement_count' | 'max_jaccard_similarity' | 'mean_max_bundle_concurrency' | 'single_entitlement_bundle_count' | 'peerless_score'} contributingFeatureName The name of contributing feature
54347
54398
  * @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.
54348
54399
  * @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.
54349
54400
  * @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&#x3D;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.
54350
- * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all
54401
+ * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all.
54351
54402
  * @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: **displayName**
54352
54403
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
54353
54404
  * @param {*} [axiosOptions] Override http request option.
@@ -54355,7 +54406,7 @@ export declare const IAIOutliersV2024ApiFactory: (configuration?: Configuration,
54355
54406
  */
54356
54407
  listOutliersContributingFeatureAccessItems(outlierId: string, contributingFeatureName: 'radical_entitlement_count' | 'entitlement_count' | 'max_jaccard_similarity' | 'mean_max_bundle_concurrency' | 'single_entitlement_bundle_count' | 'peerless_score', limit?: number, offset?: number, count?: boolean, accessType?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: any): AxiosPromise<Array<OutliersContributingFeatureAccessItemsV2024>>;
54357
54408
  /**
54358
- * This API receives a list of IdentityIDs in the request, changes the outliers to be un-ignored--returning a 204 if successful. Requires authorization scope of \'iai:outliers-management:update\'
54409
+ * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored.
54359
54410
  * @summary IAI Identity Outliers Unignore
54360
54411
  * @param {Array<string>} requestBody
54361
54412
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54618,7 +54669,7 @@ export interface IAIOutliersV2024ApiListOutliersContributingFeatureAccessItemsRe
54618
54669
  */
54619
54670
  readonly count?: boolean;
54620
54671
  /**
54621
- * The type of access item for the identity outlier contributing feature. If not provided, it returns all
54672
+ * The type of access item for the identity outlier contributing feature. If not provided, it returns all.
54622
54673
  * @type {string}
54623
54674
  * @memberof IAIOutliersV2024ApiListOutliersContributingFeatureAccessItems
54624
54675
  */
@@ -54663,7 +54714,7 @@ export interface IAIOutliersV2024ApiUnIgnoreIdentityOutliersRequest {
54663
54714
  */
54664
54715
  export declare class IAIOutliersV2024Api extends BaseAPI {
54665
54716
  /**
54666
- * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported Columns will include: identityID, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes) Requires authorization scope of \'iai:outliers-management:read\'
54717
+ * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes).
54667
54718
  * @summary IAI Identity Outliers Export
54668
54719
  * @param {IAIOutliersV2024ApiExportOutliersZipRequest} requestParameters Request parameters.
54669
54720
  * @param {*} [axiosOptions] Override http request option.
@@ -54672,7 +54723,7 @@ export declare class IAIOutliersV2024Api extends BaseAPI {
54672
54723
  */
54673
54724
  exportOutliersZip(requestParameters?: IAIOutliersV2024ApiExportOutliersZipRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
54674
54725
  /**
54675
- * This API receives a summary containing: the number of identities that customer has, the number of outliers, and the type of outlier Requires authorization scope of \'iai:outliers-management:read\'
54726
+ * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier.
54676
54727
  * @summary IAI Identity Outliers Summary
54677
54728
  * @param {IAIOutliersV2024ApiGetIdentityOutlierSnapshotsRequest} requestParameters Request parameters.
54678
54729
  * @param {*} [axiosOptions] Override http request option.
@@ -54681,7 +54732,7 @@ export declare class IAIOutliersV2024Api extends BaseAPI {
54681
54732
  */
54682
54733
  getIdentityOutlierSnapshots(requestParameters?: IAIOutliersV2024ApiGetIdentityOutlierSnapshotsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OutlierSummaryV2024[], any>>;
54683
54734
  /**
54684
- * This API receives a list of outliers, containing data such as: identityId, outlier type, detection dates, identity attributes, if identity is ignore, and certification information Requires authorization scope of \'iai:outliers-management:read\'
54735
+ * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information.
54685
54736
  * @summary IAI Get Identity Outliers
54686
54737
  * @param {IAIOutliersV2024ApiGetIdentityOutliersRequest} requestParameters Request parameters.
54687
54738
  * @param {*} [axiosOptions] Override http request option.
@@ -54690,7 +54741,7 @@ export declare class IAIOutliersV2024Api extends BaseAPI {
54690
54741
  */
54691
54742
  getIdentityOutliers(requestParameters?: IAIOutliersV2024ApiGetIdentityOutliersRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OutlierV2024[], any>>;
54692
54743
  /**
54693
- * This API returns a most recent snapshot of each outlier type, each containing: the number of identities that customer has, the number of outliers, and the type of outlier Requires authorization scope of \'iai:outliers-management:read\'
54744
+ * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier.
54694
54745
  * @summary IAI Identity Outliers Latest Summary
54695
54746
  * @param {IAIOutliersV2024ApiGetLatestIdentityOutlierSnapshotsRequest} requestParameters Request parameters.
54696
54747
  * @param {*} [axiosOptions] Override http request option.
@@ -54699,7 +54750,7 @@ export declare class IAIOutliersV2024Api extends BaseAPI {
54699
54750
  */
54700
54751
  getLatestIdentityOutlierSnapshots(requestParameters?: IAIOutliersV2024ApiGetLatestIdentityOutlierSnapshotsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LatestOutlierSummaryV2024[], any>>;
54701
54752
  /**
54702
- * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object Requires authorization scope of \'iai:outliers-management:read\'
54753
+ * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object.
54703
54754
  * @summary Get identity outlier contibuting feature summary
54704
54755
  * @param {IAIOutliersV2024ApiGetOutlierContributingFeatureSummaryRequest} requestParameters Request parameters.
54705
54756
  * @param {*} [axiosOptions] Override http request option.
@@ -54708,7 +54759,7 @@ export declare class IAIOutliersV2024Api extends BaseAPI {
54708
54759
  */
54709
54760
  getOutlierContributingFeatureSummary(requestParameters: IAIOutliersV2024ApiGetOutlierContributingFeatureSummaryRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OutlierFeatureSummaryV2024, any>>;
54710
54761
  /**
54711
- * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object Requires authorization scope of \'iai:outliers-management:read\'
54762
+ * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object.
54712
54763
  * @summary Get identity outlier\'s contibuting features
54713
54764
  * @param {IAIOutliersV2024ApiGetPeerGroupOutliersContributingFeaturesRequest} requestParameters Request parameters.
54714
54765
  * @param {*} [axiosOptions] Override http request option.
@@ -54717,7 +54768,7 @@ export declare class IAIOutliersV2024Api extends BaseAPI {
54717
54768
  */
54718
54769
  getPeerGroupOutliersContributingFeatures(requestParameters: IAIOutliersV2024ApiGetPeerGroupOutliersContributingFeaturesRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OutlierContributingFeatureV2024[], any>>;
54719
54770
  /**
54720
- * This API receives a list of IdentityIDs in the request, changes the outliers to be ignored--returning a 204 if successful. Requires authorization scope of \'iai:outliers-management:update\'
54771
+ * This API receives a list of identity IDs in the request, changes the outliers to be ignored.
54721
54772
  * @summary IAI Identity Outliers Ignore
54722
54773
  * @param {IAIOutliersV2024ApiIgnoreIdentityOutliersRequest} requestParameters Request parameters.
54723
54774
  * @param {*} [axiosOptions] Override http request option.
@@ -54726,7 +54777,7 @@ export declare class IAIOutliersV2024Api extends BaseAPI {
54726
54777
  */
54727
54778
  ignoreIdentityOutliers(requestParameters: IAIOutliersV2024ApiIgnoreIdentityOutliersRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
54728
54779
  /**
54729
- * This API returns a list of the enriched access items associated with each feature filtered by the access item type The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare Requires authorization scope of \'iai:outliers-management:read\'
54780
+ * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare.
54730
54781
  * @summary Gets a list of access items associated with each identity outlier contributing feature
54731
54782
  * @param {IAIOutliersV2024ApiListOutliersContributingFeatureAccessItemsRequest} requestParameters Request parameters.
54732
54783
  * @param {*} [axiosOptions] Override http request option.
@@ -54735,7 +54786,7 @@ export declare class IAIOutliersV2024Api extends BaseAPI {
54735
54786
  */
54736
54787
  listOutliersContributingFeatureAccessItems(requestParameters: IAIOutliersV2024ApiListOutliersContributingFeatureAccessItemsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OutliersContributingFeatureAccessItemsV2024[], any>>;
54737
54788
  /**
54738
- * This API receives a list of IdentityIDs in the request, changes the outliers to be un-ignored--returning a 204 if successful. Requires authorization scope of \'iai:outliers-management:update\'
54789
+ * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored.
54739
54790
  * @summary IAI Identity Outliers Unignore
54740
54791
  * @param {IAIOutliersV2024ApiUnIgnoreIdentityOutliersRequest} requestParameters Request parameters.
54741
54792
  * @param {*} [axiosOptions] Override http request option.
@@ -60530,17 +60581,17 @@ export declare class MFAConfigurationV2024Api extends BaseAPI {
60530
60581
  */
60531
60582
  export declare const ManagedClientsV2024ApiAxiosParamCreator: (configuration?: Configuration) => {
60532
60583
  /**
60533
- * Create a new Managed Client. The API returns a result that includes the Managed Client ID.
60534
- * @summary Create a new Managed Client
60584
+ * Create a new managed client. The API returns a result that includes the managed client ID.
60585
+ * @summary Create Managed Client
60535
60586
  * @param {ManagedClientRequestV2024} managedClientRequestV2024
60536
60587
  * @param {*} [axiosOptions] Override http request option.
60537
60588
  * @throws {RequiredError}
60538
60589
  */
60539
60590
  createManagedClient: (managedClientRequestV2024: ManagedClientRequestV2024, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
60540
60591
  /**
60541
- * Delete an existing Managed Client.
60542
- * @summary Delete a Managed Client
60543
- * @param {string} id Managed Client ID.
60592
+ * Delete an existing managed client.
60593
+ * @summary Delete Managed Client
60594
+ * @param {string} id Managed client ID.
60544
60595
  * @param {*} [axiosOptions] Override http request option.
60545
60596
  * @throws {RequiredError}
60546
60597
  */
@@ -60554,16 +60605,16 @@ export declare const ManagedClientsV2024ApiAxiosParamCreator: (configuration?: C
60554
60605
  */
60555
60606
  getManagedClient: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
60556
60607
  /**
60557
- * Retrieve the Status of a Managed Client by ID.
60558
- * @summary Get Managed Client Status.
60559
- * @param {string} id ID of the Managed Client to get Status of
60560
- * @param {ManagedClientTypeV2024} type Type of the Managed Client to get Status of
60608
+ * Get a managed client\'s status, using its ID.
60609
+ * @summary Get Managed Client Status
60610
+ * @param {string} id Managed client ID to get status for.
60611
+ * @param {ManagedClientTypeV2024} type Managed client type to get status for.
60561
60612
  * @param {*} [axiosOptions] Override http request option.
60562
60613
  * @throws {RequiredError}
60563
60614
  */
60564
60615
  getManagedClientStatus: (id: string, type: ManagedClientTypeV2024, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
60565
60616
  /**
60566
- * Get a list of Managed Clients.
60617
+ * List managed clients.
60567
60618
  * @summary Get Managed Clients
60568
60619
  * @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.
60569
60620
  * @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.
@@ -60574,10 +60625,10 @@ export declare const ManagedClientsV2024ApiAxiosParamCreator: (configuration?: C
60574
60625
  */
60575
60626
  getManagedClients: (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
60576
60627
  /**
60577
- * Update an existing Managed Client.
60578
- * @summary Update a Managed Client
60579
- * @param {string} id Managed Client ID.
60580
- * @param {Array<JsonPatchOperationV2024>} jsonPatchOperationV2024 The JSONPatch payload used to update the object.
60628
+ * Update an existing managed client.
60629
+ * @summary Update Managed Client
60630
+ * @param {string} id Managed client ID.
60631
+ * @param {Array<JsonPatchOperationV2024>} jsonPatchOperationV2024 JSONPatch payload used to update the object.
60581
60632
  * @param {*} [axiosOptions] Override http request option.
60582
60633
  * @throws {RequiredError}
60583
60634
  */
@@ -60589,17 +60640,17 @@ export declare const ManagedClientsV2024ApiAxiosParamCreator: (configuration?: C
60589
60640
  */
60590
60641
  export declare const ManagedClientsV2024ApiFp: (configuration?: Configuration) => {
60591
60642
  /**
60592
- * Create a new Managed Client. The API returns a result that includes the Managed Client ID.
60593
- * @summary Create a new Managed Client
60643
+ * Create a new managed client. The API returns a result that includes the managed client ID.
60644
+ * @summary Create Managed Client
60594
60645
  * @param {ManagedClientRequestV2024} managedClientRequestV2024
60595
60646
  * @param {*} [axiosOptions] Override http request option.
60596
60647
  * @throws {RequiredError}
60597
60648
  */
60598
60649
  createManagedClient(managedClientRequestV2024: ManagedClientRequestV2024, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManagedClientV2024>>;
60599
60650
  /**
60600
- * Delete an existing Managed Client.
60601
- * @summary Delete a Managed Client
60602
- * @param {string} id Managed Client ID.
60651
+ * Delete an existing managed client.
60652
+ * @summary Delete Managed Client
60653
+ * @param {string} id Managed client ID.
60603
60654
  * @param {*} [axiosOptions] Override http request option.
60604
60655
  * @throws {RequiredError}
60605
60656
  */
@@ -60613,16 +60664,16 @@ export declare const ManagedClientsV2024ApiFp: (configuration?: Configuration) =
60613
60664
  */
60614
60665
  getManagedClient(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManagedClientV2024>>;
60615
60666
  /**
60616
- * Retrieve the Status of a Managed Client by ID.
60617
- * @summary Get Managed Client Status.
60618
- * @param {string} id ID of the Managed Client to get Status of
60619
- * @param {ManagedClientTypeV2024} type Type of the Managed Client to get Status of
60667
+ * Get a managed client\'s status, using its ID.
60668
+ * @summary Get Managed Client Status
60669
+ * @param {string} id Managed client ID to get status for.
60670
+ * @param {ManagedClientTypeV2024} type Managed client type to get status for.
60620
60671
  * @param {*} [axiosOptions] Override http request option.
60621
60672
  * @throws {RequiredError}
60622
60673
  */
60623
60674
  getManagedClientStatus(id: string, type: ManagedClientTypeV2024, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManagedClientStatusV2024>>;
60624
60675
  /**
60625
- * Get a list of Managed Clients.
60676
+ * List managed clients.
60626
60677
  * @summary Get Managed Clients
60627
60678
  * @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.
60628
60679
  * @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.
@@ -60633,10 +60684,10 @@ export declare const ManagedClientsV2024ApiFp: (configuration?: Configuration) =
60633
60684
  */
60634
60685
  getManagedClients(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ManagedClientV2024>>>;
60635
60686
  /**
60636
- * Update an existing Managed Client.
60637
- * @summary Update a Managed Client
60638
- * @param {string} id Managed Client ID.
60639
- * @param {Array<JsonPatchOperationV2024>} jsonPatchOperationV2024 The JSONPatch payload used to update the object.
60687
+ * Update an existing managed client.
60688
+ * @summary Update Managed Client
60689
+ * @param {string} id Managed client ID.
60690
+ * @param {Array<JsonPatchOperationV2024>} jsonPatchOperationV2024 JSONPatch payload used to update the object.
60640
60691
  * @param {*} [axiosOptions] Override http request option.
60641
60692
  * @throws {RequiredError}
60642
60693
  */
@@ -60648,17 +60699,17 @@ export declare const ManagedClientsV2024ApiFp: (configuration?: Configuration) =
60648
60699
  */
60649
60700
  export declare const ManagedClientsV2024ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
60650
60701
  /**
60651
- * Create a new Managed Client. The API returns a result that includes the Managed Client ID.
60652
- * @summary Create a new Managed Client
60702
+ * Create a new managed client. The API returns a result that includes the managed client ID.
60703
+ * @summary Create Managed Client
60653
60704
  * @param {ManagedClientRequestV2024} managedClientRequestV2024
60654
60705
  * @param {*} [axiosOptions] Override http request option.
60655
60706
  * @throws {RequiredError}
60656
60707
  */
60657
60708
  createManagedClient(managedClientRequestV2024: ManagedClientRequestV2024, axiosOptions?: any): AxiosPromise<ManagedClientV2024>;
60658
60709
  /**
60659
- * Delete an existing Managed Client.
60660
- * @summary Delete a Managed Client
60661
- * @param {string} id Managed Client ID.
60710
+ * Delete an existing managed client.
60711
+ * @summary Delete Managed Client
60712
+ * @param {string} id Managed client ID.
60662
60713
  * @param {*} [axiosOptions] Override http request option.
60663
60714
  * @throws {RequiredError}
60664
60715
  */
@@ -60672,16 +60723,16 @@ export declare const ManagedClientsV2024ApiFactory: (configuration?: Configurati
60672
60723
  */
60673
60724
  getManagedClient(id: string, axiosOptions?: any): AxiosPromise<ManagedClientV2024>;
60674
60725
  /**
60675
- * Retrieve the Status of a Managed Client by ID.
60676
- * @summary Get Managed Client Status.
60677
- * @param {string} id ID of the Managed Client to get Status of
60678
- * @param {ManagedClientTypeV2024} type Type of the Managed Client to get Status of
60726
+ * Get a managed client\'s status, using its ID.
60727
+ * @summary Get Managed Client Status
60728
+ * @param {string} id Managed client ID to get status for.
60729
+ * @param {ManagedClientTypeV2024} type Managed client type to get status for.
60679
60730
  * @param {*} [axiosOptions] Override http request option.
60680
60731
  * @throws {RequiredError}
60681
60732
  */
60682
60733
  getManagedClientStatus(id: string, type: ManagedClientTypeV2024, axiosOptions?: any): AxiosPromise<ManagedClientStatusV2024>;
60683
60734
  /**
60684
- * Get a list of Managed Clients.
60735
+ * List managed clients.
60685
60736
  * @summary Get Managed Clients
60686
60737
  * @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.
60687
60738
  * @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.
@@ -60692,10 +60743,10 @@ export declare const ManagedClientsV2024ApiFactory: (configuration?: Configurati
60692
60743
  */
60693
60744
  getManagedClients(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: any): AxiosPromise<Array<ManagedClientV2024>>;
60694
60745
  /**
60695
- * Update an existing Managed Client.
60696
- * @summary Update a Managed Client
60697
- * @param {string} id Managed Client ID.
60698
- * @param {Array<JsonPatchOperationV2024>} jsonPatchOperationV2024 The JSONPatch payload used to update the object.
60746
+ * Update an existing managed client.
60747
+ * @summary Update Managed Client
60748
+ * @param {string} id Managed client ID.
60749
+ * @param {Array<JsonPatchOperationV2024>} jsonPatchOperationV2024 JSONPatch payload used to update the object.
60699
60750
  * @param {*} [axiosOptions] Override http request option.
60700
60751
  * @throws {RequiredError}
60701
60752
  */
@@ -60721,7 +60772,7 @@ export interface ManagedClientsV2024ApiCreateManagedClientRequest {
60721
60772
  */
60722
60773
  export interface ManagedClientsV2024ApiDeleteManagedClientRequest {
60723
60774
  /**
60724
- * Managed Client ID.
60775
+ * Managed client ID.
60725
60776
  * @type {string}
60726
60777
  * @memberof ManagedClientsV2024ApiDeleteManagedClient
60727
60778
  */
@@ -60747,13 +60798,13 @@ export interface ManagedClientsV2024ApiGetManagedClientRequest {
60747
60798
  */
60748
60799
  export interface ManagedClientsV2024ApiGetManagedClientStatusRequest {
60749
60800
  /**
60750
- * ID of the Managed Client to get Status of
60801
+ * Managed client ID to get status for.
60751
60802
  * @type {string}
60752
60803
  * @memberof ManagedClientsV2024ApiGetManagedClientStatus
60753
60804
  */
60754
60805
  readonly id: string;
60755
60806
  /**
60756
- * Type of the Managed Client to get Status of
60807
+ * Managed client type to get status for.
60757
60808
  * @type {ManagedClientTypeV2024}
60758
60809
  * @memberof ManagedClientsV2024ApiGetManagedClientStatus
60759
60810
  */
@@ -60797,13 +60848,13 @@ export interface ManagedClientsV2024ApiGetManagedClientsRequest {
60797
60848
  */
60798
60849
  export interface ManagedClientsV2024ApiUpdateManagedClientRequest {
60799
60850
  /**
60800
- * Managed Client ID.
60851
+ * Managed client ID.
60801
60852
  * @type {string}
60802
60853
  * @memberof ManagedClientsV2024ApiUpdateManagedClient
60803
60854
  */
60804
60855
  readonly id: string;
60805
60856
  /**
60806
- * The JSONPatch payload used to update the object.
60857
+ * JSONPatch payload used to update the object.
60807
60858
  * @type {Array<JsonPatchOperationV2024>}
60808
60859
  * @memberof ManagedClientsV2024ApiUpdateManagedClient
60809
60860
  */
@@ -60817,8 +60868,8 @@ export interface ManagedClientsV2024ApiUpdateManagedClientRequest {
60817
60868
  */
60818
60869
  export declare class ManagedClientsV2024Api extends BaseAPI {
60819
60870
  /**
60820
- * Create a new Managed Client. The API returns a result that includes the Managed Client ID.
60821
- * @summary Create a new Managed Client
60871
+ * Create a new managed client. The API returns a result that includes the managed client ID.
60872
+ * @summary Create Managed Client
60822
60873
  * @param {ManagedClientsV2024ApiCreateManagedClientRequest} requestParameters Request parameters.
60823
60874
  * @param {*} [axiosOptions] Override http request option.
60824
60875
  * @throws {RequiredError}
@@ -60826,8 +60877,8 @@ export declare class ManagedClientsV2024Api extends BaseAPI {
60826
60877
  */
60827
60878
  createManagedClient(requestParameters: ManagedClientsV2024ApiCreateManagedClientRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManagedClientV2024, any>>;
60828
60879
  /**
60829
- * Delete an existing Managed Client.
60830
- * @summary Delete a Managed Client
60880
+ * Delete an existing managed client.
60881
+ * @summary Delete Managed Client
60831
60882
  * @param {ManagedClientsV2024ApiDeleteManagedClientRequest} requestParameters Request parameters.
60832
60883
  * @param {*} [axiosOptions] Override http request option.
60833
60884
  * @throws {RequiredError}
@@ -60844,8 +60895,8 @@ export declare class ManagedClientsV2024Api extends BaseAPI {
60844
60895
  */
60845
60896
  getManagedClient(requestParameters: ManagedClientsV2024ApiGetManagedClientRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManagedClientV2024, any>>;
60846
60897
  /**
60847
- * Retrieve the Status of a Managed Client by ID.
60848
- * @summary Get Managed Client Status.
60898
+ * Get a managed client\'s status, using its ID.
60899
+ * @summary Get Managed Client Status
60849
60900
  * @param {ManagedClientsV2024ApiGetManagedClientStatusRequest} requestParameters Request parameters.
60850
60901
  * @param {*} [axiosOptions] Override http request option.
60851
60902
  * @throws {RequiredError}
@@ -60853,7 +60904,7 @@ export declare class ManagedClientsV2024Api extends BaseAPI {
60853
60904
  */
60854
60905
  getManagedClientStatus(requestParameters: ManagedClientsV2024ApiGetManagedClientStatusRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManagedClientStatusV2024, any>>;
60855
60906
  /**
60856
- * Get a list of Managed Clients.
60907
+ * List managed clients.
60857
60908
  * @summary Get Managed Clients
60858
60909
  * @param {ManagedClientsV2024ApiGetManagedClientsRequest} requestParameters Request parameters.
60859
60910
  * @param {*} [axiosOptions] Override http request option.
@@ -60862,8 +60913,8 @@ export declare class ManagedClientsV2024Api extends BaseAPI {
60862
60913
  */
60863
60914
  getManagedClients(requestParameters?: ManagedClientsV2024ApiGetManagedClientsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManagedClientV2024[], any>>;
60864
60915
  /**
60865
- * Update an existing Managed Client.
60866
- * @summary Update a Managed Client
60916
+ * Update an existing managed client.
60917
+ * @summary Update Managed Client
60867
60918
  * @param {ManagedClientsV2024ApiUpdateManagedClientRequest} requestParameters Request parameters.
60868
60919
  * @param {*} [axiosOptions] Override http request option.
60869
60920
  * @throws {RequiredError}
@@ -64663,7 +64714,7 @@ export declare const PasswordManagementV2024ApiAxiosParamCreator: (configuration
64663
64714
  */
64664
64715
  queryPasswordInfo: (passwordInfoQueryDTOV2024: PasswordInfoQueryDTOV2024, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
64665
64716
  /**
64666
- * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** You can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). To do so, follow these steps: 1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. 2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. 3. Use [Set Identity\'s Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password: ```java import javax.crypto.Cipher; import java.security.KeyFactory; import java.security.PublicKey; import java.security.spec.X509EncodedKeySpec; import java util.Base64; String encrypt(String publicKey, String toEncrypt) throws Exception { byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey); byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes(\"UTF-8\")); return Base64.getEncoder().encodeToString(encryptedBytes); } private byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception { PublicKey key = KeyFactory.getInstance(\"RSA\").generatePublic(new X509EncodedKeySpec(publicKeyBytes)); String transformation = \"RSA/ECB/PKCS1Padding\"; Cipher cipher = Cipher.getInstance(transformation); cipher.init(1, key); return cipher.doFinal(toEncryptBytes); } ``` In this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password.
64717
+ * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password.
64667
64718
  * @summary Set Identity\'s Password
64668
64719
  * @param {PasswordChangeRequestV2024} passwordChangeRequestV2024
64669
64720
  * @param {*} [axiosOptions] Override http request option.
@@ -64702,7 +64753,7 @@ export declare const PasswordManagementV2024ApiFp: (configuration?: Configuratio
64702
64753
  */
64703
64754
  queryPasswordInfo(passwordInfoQueryDTOV2024: PasswordInfoQueryDTOV2024, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasswordInfoV2024>>;
64704
64755
  /**
64705
- * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** You can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). To do so, follow these steps: 1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. 2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. 3. Use [Set Identity\'s Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password: ```java import javax.crypto.Cipher; import java.security.KeyFactory; import java.security.PublicKey; import java.security.spec.X509EncodedKeySpec; import java util.Base64; String encrypt(String publicKey, String toEncrypt) throws Exception { byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey); byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes(\"UTF-8\")); return Base64.getEncoder().encodeToString(encryptedBytes); } private byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception { PublicKey key = KeyFactory.getInstance(\"RSA\").generatePublic(new X509EncodedKeySpec(publicKeyBytes)); String transformation = \"RSA/ECB/PKCS1Padding\"; Cipher cipher = Cipher.getInstance(transformation); cipher.init(1, key); return cipher.doFinal(toEncryptBytes); } ``` In this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password.
64756
+ * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password.
64706
64757
  * @summary Set Identity\'s Password
64707
64758
  * @param {PasswordChangeRequestV2024} passwordChangeRequestV2024
64708
64759
  * @param {*} [axiosOptions] Override http request option.
@@ -64741,7 +64792,7 @@ export declare const PasswordManagementV2024ApiFactory: (configuration?: Configu
64741
64792
  */
64742
64793
  queryPasswordInfo(passwordInfoQueryDTOV2024: PasswordInfoQueryDTOV2024, axiosOptions?: any): AxiosPromise<PasswordInfoV2024>;
64743
64794
  /**
64744
- * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** You can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). To do so, follow these steps: 1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. 2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. 3. Use [Set Identity\'s Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password: ```java import javax.crypto.Cipher; import java.security.KeyFactory; import java.security.PublicKey; import java.security.spec.X509EncodedKeySpec; import java util.Base64; String encrypt(String publicKey, String toEncrypt) throws Exception { byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey); byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes(\"UTF-8\")); return Base64.getEncoder().encodeToString(encryptedBytes); } private byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception { PublicKey key = KeyFactory.getInstance(\"RSA\").generatePublic(new X509EncodedKeySpec(publicKeyBytes)); String transformation = \"RSA/ECB/PKCS1Padding\"; Cipher cipher = Cipher.getInstance(transformation); cipher.init(1, key); return cipher.doFinal(toEncryptBytes); } ``` In this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password.
64795
+ * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password.
64745
64796
  * @summary Set Identity\'s Password
64746
64797
  * @param {PasswordChangeRequestV2024} passwordChangeRequestV2024
64747
64798
  * @param {*} [axiosOptions] Override http request option.
@@ -64842,7 +64893,7 @@ export declare class PasswordManagementV2024Api extends BaseAPI {
64842
64893
  */
64843
64894
  queryPasswordInfo(requestParameters: PasswordManagementV2024ApiQueryPasswordInfoRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordInfoV2024, any>>;
64844
64895
  /**
64845
- * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** You can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). To do so, follow these steps: 1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. 2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. 3. Use [Set Identity\'s Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password: ```java import javax.crypto.Cipher; import java.security.KeyFactory; import java.security.PublicKey; import java.security.spec.X509EncodedKeySpec; import java util.Base64; String encrypt(String publicKey, String toEncrypt) throws Exception { byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey); byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes(\"UTF-8\")); return Base64.getEncoder().encodeToString(encryptedBytes); } private byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception { PublicKey key = KeyFactory.getInstance(\"RSA\").generatePublic(new X509EncodedKeySpec(publicKeyBytes)); String transformation = \"RSA/ECB/PKCS1Padding\"; Cipher cipher = Cipher.getInstance(transformation); cipher.init(1, key); return cipher.doFinal(toEncryptBytes); } ``` In this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password.
64896
+ * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password.
64846
64897
  * @summary Set Identity\'s Password
64847
64898
  * @param {PasswordManagementV2024ApiSetPasswordRequest} requestParameters Request parameters.
64848
64899
  * @param {*} [axiosOptions] Override http request option.
@@ -66948,7 +66999,7 @@ export declare const RolesV2024ApiAxiosParamCreator: (configuration?: Configurat
66948
66999
  */
66949
67000
  deleteRole: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
66950
67001
  /**
66951
- * This API returns a list of all bulk update process status of the tenant. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API.
67002
+ * This API returns a list of all unfinished bulk update process status of the tenant.
66952
67003
  * @summary Get Bulk-Update Statuses
66953
67004
  * @param {*} [axiosOptions] Override http request option.
66954
67005
  * @throws {RequiredError}
@@ -67037,7 +67088,7 @@ export declare const RolesV2024ApiAxiosParamCreator: (configuration?: Configurat
67037
67088
  */
67038
67089
  searchRolesByFilter: (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, roleListFilterDTOV2024?: RoleListFilterDTOV2024, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
67039
67090
  /**
67040
- * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. Custom metadata update, including ADD and REPLACE need suit licensed.
67091
+ * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed.
67041
67092
  * @summary Add a Metadata to Role.
67042
67093
  * @param {string} id The Id of a role
67043
67094
  * @param {string} attributeKey Technical name of the Attribute.
@@ -67111,12 +67162,12 @@ export declare const RolesV2024ApiFp: (configuration?: Configuration) => {
67111
67162
  */
67112
67163
  deleteRole(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
67113
67164
  /**
67114
- * This API returns a list of all bulk update process status of the tenant. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API.
67165
+ * This API returns a list of all unfinished bulk update process status of the tenant.
67115
67166
  * @summary Get Bulk-Update Statuses
67116
67167
  * @param {*} [axiosOptions] Override http request option.
67117
67168
  * @throws {RequiredError}
67118
67169
  */
67119
- getBulkUpdateStatus(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RoleBulkUpdateResponseV2024>>>;
67170
+ getBulkUpdateStatus(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RoleGetAllBulkUpdateResponseV2024>>>;
67120
67171
  /**
67121
67172
  * This API initial a request for one bulk update\'s status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API.
67122
67173
  * @summary Get Bulk-Update Status by ID
@@ -67200,7 +67251,7 @@ export declare const RolesV2024ApiFp: (configuration?: Configuration) => {
67200
67251
  */
67201
67252
  searchRolesByFilter(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, roleListFilterDTOV2024?: RoleListFilterDTOV2024, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchRolesByFilter200ResponseV2024>>;
67202
67253
  /**
67203
- * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. Custom metadata update, including ADD and REPLACE need suit licensed.
67254
+ * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed.
67204
67255
  * @summary Add a Metadata to Role.
67205
67256
  * @param {string} id The Id of a role
67206
67257
  * @param {string} attributeKey Technical name of the Attribute.
@@ -67274,12 +67325,12 @@ export declare const RolesV2024ApiFactory: (configuration?: Configuration, baseP
67274
67325
  */
67275
67326
  deleteRole(id: string, axiosOptions?: any): AxiosPromise<void>;
67276
67327
  /**
67277
- * This API returns a list of all bulk update process status of the tenant. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API.
67328
+ * This API returns a list of all unfinished bulk update process status of the tenant.
67278
67329
  * @summary Get Bulk-Update Statuses
67279
67330
  * @param {*} [axiosOptions] Override http request option.
67280
67331
  * @throws {RequiredError}
67281
67332
  */
67282
- getBulkUpdateStatus(axiosOptions?: any): AxiosPromise<Array<RoleBulkUpdateResponseV2024>>;
67333
+ getBulkUpdateStatus(axiosOptions?: any): AxiosPromise<Array<RoleGetAllBulkUpdateResponseV2024>>;
67283
67334
  /**
67284
67335
  * This API initial a request for one bulk update\'s status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API.
67285
67336
  * @summary Get Bulk-Update Status by ID
@@ -67363,7 +67414,7 @@ export declare const RolesV2024ApiFactory: (configuration?: Configuration, baseP
67363
67414
  */
67364
67415
  searchRolesByFilter(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, roleListFilterDTOV2024?: RoleListFilterDTOV2024, axiosOptions?: any): AxiosPromise<SearchRolesByFilter200ResponseV2024>;
67365
67416
  /**
67366
- * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. Custom metadata update, including ADD and REPLACE need suit licensed.
67417
+ * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed.
67367
67418
  * @summary Add a Metadata to Role.
67368
67419
  * @param {string} id The Id of a role
67369
67420
  * @param {string} attributeKey Technical name of the Attribute.
@@ -67816,13 +67867,13 @@ export declare class RolesV2024Api extends BaseAPI {
67816
67867
  */
67817
67868
  deleteRole(requestParameters: RolesV2024ApiDeleteRoleRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
67818
67869
  /**
67819
- * This API returns a list of all bulk update process status of the tenant. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API.
67870
+ * This API returns a list of all unfinished bulk update process status of the tenant.
67820
67871
  * @summary Get Bulk-Update Statuses
67821
67872
  * @param {*} [axiosOptions] Override http request option.
67822
67873
  * @throws {RequiredError}
67823
67874
  * @memberof RolesV2024Api
67824
67875
  */
67825
- getBulkUpdateStatus(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RoleBulkUpdateResponseV2024[], any>>;
67876
+ getBulkUpdateStatus(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RoleGetAllBulkUpdateResponseV2024[], any>>;
67826
67877
  /**
67827
67878
  * This API initial a request for one bulk update\'s status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API.
67828
67879
  * @summary Get Bulk-Update Status by ID
@@ -67887,7 +67938,7 @@ export declare class RolesV2024Api extends BaseAPI {
67887
67938
  */
67888
67939
  searchRolesByFilter(requestParameters?: RolesV2024ApiSearchRolesByFilterRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchRolesByFilter200ResponseV2024, any>>;
67889
67940
  /**
67890
- * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. Custom metadata update, including ADD and REPLACE need suit licensed.
67941
+ * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed.
67891
67942
  * @summary Add a Metadata to Role.
67892
67943
  * @param {RolesV2024ApiUpdateAttributeKeyAndValueToRoleRequest} requestParameters Request parameters.
67893
67944
  * @param {*} [axiosOptions] Override http request option.
@@ -70490,7 +70541,7 @@ export declare const SearchV2024ApiAxiosParamCreator: (configuration?: Configura
70490
70541
  */
70491
70542
  searchGet: (index: string, id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
70492
70543
  /**
70493
- * Performs a search with the provided query and returns a matching result collection. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging.
70544
+ * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging.
70494
70545
  * @summary Perform Search
70495
70546
  * @param {SearchV2024} searchV2024
70496
70547
  * @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.
@@ -70535,7 +70586,7 @@ export declare const SearchV2024ApiFp: (configuration?: Configuration) => {
70535
70586
  */
70536
70587
  searchGet(index: string, id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchDocumentV2024>>;
70537
70588
  /**
70538
- * Performs a search with the provided query and returns a matching result collection. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging.
70589
+ * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging.
70539
70590
  * @summary Perform Search
70540
70591
  * @param {SearchV2024} searchV2024
70541
70592
  * @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.
@@ -70580,7 +70631,7 @@ export declare const SearchV2024ApiFactory: (configuration?: Configuration, base
70580
70631
  */
70581
70632
  searchGet(index: string, id: string, axiosOptions?: any): AxiosPromise<SearchDocumentV2024>;
70582
70633
  /**
70583
- * Performs a search with the provided query and returns a matching result collection. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging.
70634
+ * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging.
70584
70635
  * @summary Perform Search
70585
70636
  * @param {SearchV2024} searchV2024
70586
70637
  * @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.
@@ -70720,7 +70771,7 @@ export declare class SearchV2024Api extends BaseAPI {
70720
70771
  */
70721
70772
  searchGet(requestParameters: SearchV2024ApiSearchGetRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchDocumentV2024, any>>;
70722
70773
  /**
70723
- * Performs a search with the provided query and returns a matching result collection. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging.
70774
+ * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging.
70724
70775
  * @summary Perform Search
70725
70776
  * @param {SearchV2024ApiSearchPostRequest} requestParameters Request parameters.
70726
70777
  * @param {*} [axiosOptions] Override http request option.