sailpoint-api-client 1.4.11 → 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
  *
@@ -39658,6 +39664,12 @@ export interface WorkflowTriggerAttributesV2024 {
39658
39664
  * @memberof WorkflowTriggerAttributesV2024
39659
39665
  */
39660
39666
  'description'?: string;
39667
+ /**
39668
+ * The attribute to filter on
39669
+ * @type {string}
39670
+ * @memberof WorkflowTriggerAttributesV2024
39671
+ */
39672
+ 'attributeToFilter'?: string;
39661
39673
  /**
39662
39674
  * A unique name for the external trigger
39663
39675
  * @type {string}
@@ -54088,7 +54100,7 @@ export declare class IAICommonAccessV2024Api extends BaseAPI {
54088
54100
  */
54089
54101
  export declare const IAIOutliersV2024ApiAxiosParamCreator: (configuration?: Configuration) => {
54090
54102
  /**
54091
- * 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).
54092
54104
  * @summary IAI Identity Outliers Export
54093
54105
  * @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
54094
54106
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54097,7 +54109,7 @@ export declare const IAIOutliersV2024ApiAxiosParamCreator: (configuration?: Conf
54097
54109
  */
54098
54110
  exportOutliersZip: (type?: 'LOW_SIMILARITY' | 'STRUCTURAL', xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
54099
54111
  /**
54100
- * 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.
54101
54113
  * @summary IAI Identity Outliers Summary
54102
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.
54103
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.
@@ -54110,7 +54122,7 @@ export declare const IAIOutliersV2024ApiAxiosParamCreator: (configuration?: Conf
54110
54122
  */
54111
54123
  getIdentityOutlierSnapshots: (limit?: number, offset?: number, type?: 'LOW_SIMILARITY' | 'STRUCTURAL', filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
54112
54124
  /**
54113
- * 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.
54114
54126
  * @summary IAI Get Identity Outliers
54115
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.
54116
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.
@@ -54124,7 +54136,7 @@ export declare const IAIOutliersV2024ApiAxiosParamCreator: (configuration?: Conf
54124
54136
  */
54125
54137
  getIdentityOutliers: (limit?: number, offset?: number, count?: boolean, type?: 'LOW_SIMILARITY' | 'STRUCTURAL', filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
54126
54138
  /**
54127
- * 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.
54128
54140
  * @summary IAI Identity Outliers Latest Summary
54129
54141
  * @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
54130
54142
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54133,7 +54145,7 @@ export declare const IAIOutliersV2024ApiAxiosParamCreator: (configuration?: Conf
54133
54145
  */
54134
54146
  getLatestIdentityOutlierSnapshots: (type?: 'LOW_SIMILARITY' | 'STRUCTURAL', xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
54135
54147
  /**
54136
- * 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.
54137
54149
  * @summary Get identity outlier contibuting feature summary
54138
54150
  * @param {string} outlierFeatureId Contributing feature id
54139
54151
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54142,7 +54154,7 @@ export declare const IAIOutliersV2024ApiAxiosParamCreator: (configuration?: Conf
54142
54154
  */
54143
54155
  getOutlierContributingFeatureSummary: (outlierFeatureId: string, xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
54144
54156
  /**
54145
- * 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.
54146
54158
  * @summary Get identity outlier\'s contibuting features
54147
54159
  * @param {string} outlierId The outlier id
54148
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.
@@ -54156,7 +54168,7 @@ export declare const IAIOutliersV2024ApiAxiosParamCreator: (configuration?: Conf
54156
54168
  */
54157
54169
  getPeerGroupOutliersContributingFeatures: (outlierId: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
54158
54170
  /**
54159
- * 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.
54160
54172
  * @summary IAI Identity Outliers Ignore
54161
54173
  * @param {Array<string>} requestBody
54162
54174
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54165,14 +54177,14 @@ export declare const IAIOutliersV2024ApiAxiosParamCreator: (configuration?: Conf
54165
54177
  */
54166
54178
  ignoreIdentityOutliers: (requestBody: Array<string>, xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
54167
54179
  /**
54168
- * 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.
54169
54181
  * @summary Gets a list of access items associated with each identity outlier contributing feature
54170
54182
  * @param {string} outlierId The outlier id
54171
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
54172
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.
54173
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.
54174
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.
54175
- * @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.
54176
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**
54177
54189
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
54178
54190
  * @param {*} [axiosOptions] Override http request option.
@@ -54180,7 +54192,7 @@ export declare const IAIOutliersV2024ApiAxiosParamCreator: (configuration?: Conf
54180
54192
  */
54181
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>;
54182
54194
  /**
54183
- * 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.
54184
54196
  * @summary IAI Identity Outliers Unignore
54185
54197
  * @param {Array<string>} requestBody
54186
54198
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54195,7 +54207,7 @@ export declare const IAIOutliersV2024ApiAxiosParamCreator: (configuration?: Conf
54195
54207
  */
54196
54208
  export declare const IAIOutliersV2024ApiFp: (configuration?: Configuration) => {
54197
54209
  /**
54198
- * 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).
54199
54211
  * @summary IAI Identity Outliers Export
54200
54212
  * @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
54201
54213
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54204,7 +54216,7 @@ export declare const IAIOutliersV2024ApiFp: (configuration?: Configuration) => {
54204
54216
  */
54205
54217
  exportOutliersZip(type?: 'LOW_SIMILARITY' | 'STRUCTURAL', xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
54206
54218
  /**
54207
- * 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.
54208
54220
  * @summary IAI Identity Outliers Summary
54209
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.
54210
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.
@@ -54217,7 +54229,7 @@ export declare const IAIOutliersV2024ApiFp: (configuration?: Configuration) => {
54217
54229
  */
54218
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>>>;
54219
54231
  /**
54220
- * 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.
54221
54233
  * @summary IAI Get Identity Outliers
54222
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.
54223
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.
@@ -54231,7 +54243,7 @@ export declare const IAIOutliersV2024ApiFp: (configuration?: Configuration) => {
54231
54243
  */
54232
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>>>;
54233
54245
  /**
54234
- * 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.
54235
54247
  * @summary IAI Identity Outliers Latest Summary
54236
54248
  * @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
54237
54249
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54240,7 +54252,7 @@ export declare const IAIOutliersV2024ApiFp: (configuration?: Configuration) => {
54240
54252
  */
54241
54253
  getLatestIdentityOutlierSnapshots(type?: 'LOW_SIMILARITY' | 'STRUCTURAL', xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<LatestOutlierSummaryV2024>>>;
54242
54254
  /**
54243
- * 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.
54244
54256
  * @summary Get identity outlier contibuting feature summary
54245
54257
  * @param {string} outlierFeatureId Contributing feature id
54246
54258
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54249,7 +54261,7 @@ export declare const IAIOutliersV2024ApiFp: (configuration?: Configuration) => {
54249
54261
  */
54250
54262
  getOutlierContributingFeatureSummary(outlierFeatureId: string, xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OutlierFeatureSummaryV2024>>;
54251
54263
  /**
54252
- * 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.
54253
54265
  * @summary Get identity outlier\'s contibuting features
54254
54266
  * @param {string} outlierId The outlier id
54255
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.
@@ -54263,7 +54275,7 @@ export declare const IAIOutliersV2024ApiFp: (configuration?: Configuration) => {
54263
54275
  */
54264
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>>>;
54265
54277
  /**
54266
- * 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.
54267
54279
  * @summary IAI Identity Outliers Ignore
54268
54280
  * @param {Array<string>} requestBody
54269
54281
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54272,14 +54284,14 @@ export declare const IAIOutliersV2024ApiFp: (configuration?: Configuration) => {
54272
54284
  */
54273
54285
  ignoreIdentityOutliers(requestBody: Array<string>, xSailPointExperimental?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
54274
54286
  /**
54275
- * 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.
54276
54288
  * @summary Gets a list of access items associated with each identity outlier contributing feature
54277
54289
  * @param {string} outlierId The outlier id
54278
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
54279
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.
54280
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.
54281
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.
54282
- * @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.
54283
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**
54284
54296
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
54285
54297
  * @param {*} [axiosOptions] Override http request option.
@@ -54287,7 +54299,7 @@ export declare const IAIOutliersV2024ApiFp: (configuration?: Configuration) => {
54287
54299
  */
54288
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>>>;
54289
54301
  /**
54290
- * 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.
54291
54303
  * @summary IAI Identity Outliers Unignore
54292
54304
  * @param {Array<string>} requestBody
54293
54305
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54302,7 +54314,7 @@ export declare const IAIOutliersV2024ApiFp: (configuration?: Configuration) => {
54302
54314
  */
54303
54315
  export declare const IAIOutliersV2024ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
54304
54316
  /**
54305
- * 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).
54306
54318
  * @summary IAI Identity Outliers Export
54307
54319
  * @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
54308
54320
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54311,7 +54323,7 @@ export declare const IAIOutliersV2024ApiFactory: (configuration?: Configuration,
54311
54323
  */
54312
54324
  exportOutliersZip(type?: 'LOW_SIMILARITY' | 'STRUCTURAL', xSailPointExperimental?: string, axiosOptions?: any): AxiosPromise<any>;
54313
54325
  /**
54314
- * 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.
54315
54327
  * @summary IAI Identity Outliers Summary
54316
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.
54317
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.
@@ -54324,7 +54336,7 @@ export declare const IAIOutliersV2024ApiFactory: (configuration?: Configuration,
54324
54336
  */
54325
54337
  getIdentityOutlierSnapshots(limit?: number, offset?: number, type?: 'LOW_SIMILARITY' | 'STRUCTURAL', filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: any): AxiosPromise<Array<OutlierSummaryV2024>>;
54326
54338
  /**
54327
- * 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.
54328
54340
  * @summary IAI Get Identity Outliers
54329
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.
54330
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.
@@ -54338,7 +54350,7 @@ export declare const IAIOutliersV2024ApiFactory: (configuration?: Configuration,
54338
54350
  */
54339
54351
  getIdentityOutliers(limit?: number, offset?: number, count?: boolean, type?: 'LOW_SIMILARITY' | 'STRUCTURAL', filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: any): AxiosPromise<Array<OutlierV2024>>;
54340
54352
  /**
54341
- * 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.
54342
54354
  * @summary IAI Identity Outliers Latest Summary
54343
54355
  * @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
54344
54356
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54347,7 +54359,7 @@ export declare const IAIOutliersV2024ApiFactory: (configuration?: Configuration,
54347
54359
  */
54348
54360
  getLatestIdentityOutlierSnapshots(type?: 'LOW_SIMILARITY' | 'STRUCTURAL', xSailPointExperimental?: string, axiosOptions?: any): AxiosPromise<Array<LatestOutlierSummaryV2024>>;
54349
54361
  /**
54350
- * 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.
54351
54363
  * @summary Get identity outlier contibuting feature summary
54352
54364
  * @param {string} outlierFeatureId Contributing feature id
54353
54365
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54356,7 +54368,7 @@ export declare const IAIOutliersV2024ApiFactory: (configuration?: Configuration,
54356
54368
  */
54357
54369
  getOutlierContributingFeatureSummary(outlierFeatureId: string, xSailPointExperimental?: string, axiosOptions?: any): AxiosPromise<OutlierFeatureSummaryV2024>;
54358
54370
  /**
54359
- * 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.
54360
54372
  * @summary Get identity outlier\'s contibuting features
54361
54373
  * @param {string} outlierId The outlier id
54362
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.
@@ -54370,7 +54382,7 @@ export declare const IAIOutliersV2024ApiFactory: (configuration?: Configuration,
54370
54382
  */
54371
54383
  getPeerGroupOutliersContributingFeatures(outlierId: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: any): AxiosPromise<Array<OutlierContributingFeatureV2024>>;
54372
54384
  /**
54373
- * 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.
54374
54386
  * @summary IAI Identity Outliers Ignore
54375
54387
  * @param {Array<string>} requestBody
54376
54388
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54379,14 +54391,14 @@ export declare const IAIOutliersV2024ApiFactory: (configuration?: Configuration,
54379
54391
  */
54380
54392
  ignoreIdentityOutliers(requestBody: Array<string>, xSailPointExperimental?: string, axiosOptions?: any): AxiosPromise<void>;
54381
54393
  /**
54382
- * 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.
54383
54395
  * @summary Gets a list of access items associated with each identity outlier contributing feature
54384
54396
  * @param {string} outlierId The outlier id
54385
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
54386
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.
54387
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.
54388
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.
54389
- * @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.
54390
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**
54391
54403
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
54392
54404
  * @param {*} [axiosOptions] Override http request option.
@@ -54394,7 +54406,7 @@ export declare const IAIOutliersV2024ApiFactory: (configuration?: Configuration,
54394
54406
  */
54395
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>>;
54396
54408
  /**
54397
- * 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.
54398
54410
  * @summary IAI Identity Outliers Unignore
54399
54411
  * @param {Array<string>} requestBody
54400
54412
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -54657,7 +54669,7 @@ export interface IAIOutliersV2024ApiListOutliersContributingFeatureAccessItemsRe
54657
54669
  */
54658
54670
  readonly count?: boolean;
54659
54671
  /**
54660
- * 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.
54661
54673
  * @type {string}
54662
54674
  * @memberof IAIOutliersV2024ApiListOutliersContributingFeatureAccessItems
54663
54675
  */
@@ -54702,7 +54714,7 @@ export interface IAIOutliersV2024ApiUnIgnoreIdentityOutliersRequest {
54702
54714
  */
54703
54715
  export declare class IAIOutliersV2024Api extends BaseAPI {
54704
54716
  /**
54705
- * 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).
54706
54718
  * @summary IAI Identity Outliers Export
54707
54719
  * @param {IAIOutliersV2024ApiExportOutliersZipRequest} requestParameters Request parameters.
54708
54720
  * @param {*} [axiosOptions] Override http request option.
@@ -54711,7 +54723,7 @@ export declare class IAIOutliersV2024Api extends BaseAPI {
54711
54723
  */
54712
54724
  exportOutliersZip(requestParameters?: IAIOutliersV2024ApiExportOutliersZipRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
54713
54725
  /**
54714
- * 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.
54715
54727
  * @summary IAI Identity Outliers Summary
54716
54728
  * @param {IAIOutliersV2024ApiGetIdentityOutlierSnapshotsRequest} requestParameters Request parameters.
54717
54729
  * @param {*} [axiosOptions] Override http request option.
@@ -54720,7 +54732,7 @@ export declare class IAIOutliersV2024Api extends BaseAPI {
54720
54732
  */
54721
54733
  getIdentityOutlierSnapshots(requestParameters?: IAIOutliersV2024ApiGetIdentityOutlierSnapshotsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OutlierSummaryV2024[], any>>;
54722
54734
  /**
54723
- * 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.
54724
54736
  * @summary IAI Get Identity Outliers
54725
54737
  * @param {IAIOutliersV2024ApiGetIdentityOutliersRequest} requestParameters Request parameters.
54726
54738
  * @param {*} [axiosOptions] Override http request option.
@@ -54729,7 +54741,7 @@ export declare class IAIOutliersV2024Api extends BaseAPI {
54729
54741
  */
54730
54742
  getIdentityOutliers(requestParameters?: IAIOutliersV2024ApiGetIdentityOutliersRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OutlierV2024[], any>>;
54731
54743
  /**
54732
- * 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.
54733
54745
  * @summary IAI Identity Outliers Latest Summary
54734
54746
  * @param {IAIOutliersV2024ApiGetLatestIdentityOutlierSnapshotsRequest} requestParameters Request parameters.
54735
54747
  * @param {*} [axiosOptions] Override http request option.
@@ -54738,7 +54750,7 @@ export declare class IAIOutliersV2024Api extends BaseAPI {
54738
54750
  */
54739
54751
  getLatestIdentityOutlierSnapshots(requestParameters?: IAIOutliersV2024ApiGetLatestIdentityOutlierSnapshotsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LatestOutlierSummaryV2024[], any>>;
54740
54752
  /**
54741
- * 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.
54742
54754
  * @summary Get identity outlier contibuting feature summary
54743
54755
  * @param {IAIOutliersV2024ApiGetOutlierContributingFeatureSummaryRequest} requestParameters Request parameters.
54744
54756
  * @param {*} [axiosOptions] Override http request option.
@@ -54747,7 +54759,7 @@ export declare class IAIOutliersV2024Api extends BaseAPI {
54747
54759
  */
54748
54760
  getOutlierContributingFeatureSummary(requestParameters: IAIOutliersV2024ApiGetOutlierContributingFeatureSummaryRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OutlierFeatureSummaryV2024, any>>;
54749
54761
  /**
54750
- * 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.
54751
54763
  * @summary Get identity outlier\'s contibuting features
54752
54764
  * @param {IAIOutliersV2024ApiGetPeerGroupOutliersContributingFeaturesRequest} requestParameters Request parameters.
54753
54765
  * @param {*} [axiosOptions] Override http request option.
@@ -54756,7 +54768,7 @@ export declare class IAIOutliersV2024Api extends BaseAPI {
54756
54768
  */
54757
54769
  getPeerGroupOutliersContributingFeatures(requestParameters: IAIOutliersV2024ApiGetPeerGroupOutliersContributingFeaturesRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OutlierContributingFeatureV2024[], any>>;
54758
54770
  /**
54759
- * 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.
54760
54772
  * @summary IAI Identity Outliers Ignore
54761
54773
  * @param {IAIOutliersV2024ApiIgnoreIdentityOutliersRequest} requestParameters Request parameters.
54762
54774
  * @param {*} [axiosOptions] Override http request option.
@@ -54765,7 +54777,7 @@ export declare class IAIOutliersV2024Api extends BaseAPI {
54765
54777
  */
54766
54778
  ignoreIdentityOutliers(requestParameters: IAIOutliersV2024ApiIgnoreIdentityOutliersRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
54767
54779
  /**
54768
- * 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.
54769
54781
  * @summary Gets a list of access items associated with each identity outlier contributing feature
54770
54782
  * @param {IAIOutliersV2024ApiListOutliersContributingFeatureAccessItemsRequest} requestParameters Request parameters.
54771
54783
  * @param {*} [axiosOptions] Override http request option.
@@ -54774,7 +54786,7 @@ export declare class IAIOutliersV2024Api extends BaseAPI {
54774
54786
  */
54775
54787
  listOutliersContributingFeatureAccessItems(requestParameters: IAIOutliersV2024ApiListOutliersContributingFeatureAccessItemsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OutliersContributingFeatureAccessItemsV2024[], any>>;
54776
54788
  /**
54777
- * 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.
54778
54790
  * @summary IAI Identity Outliers Unignore
54779
54791
  * @param {IAIOutliersV2024ApiUnIgnoreIdentityOutliersRequest} requestParameters Request parameters.
54780
54792
  * @param {*} [axiosOptions] Override http request option.
@@ -60569,17 +60581,17 @@ export declare class MFAConfigurationV2024Api extends BaseAPI {
60569
60581
  */
60570
60582
  export declare const ManagedClientsV2024ApiAxiosParamCreator: (configuration?: Configuration) => {
60571
60583
  /**
60572
- * Create a new Managed Client. The API returns a result that includes the Managed Client ID.
60573
- * @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
60574
60586
  * @param {ManagedClientRequestV2024} managedClientRequestV2024
60575
60587
  * @param {*} [axiosOptions] Override http request option.
60576
60588
  * @throws {RequiredError}
60577
60589
  */
60578
60590
  createManagedClient: (managedClientRequestV2024: ManagedClientRequestV2024, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
60579
60591
  /**
60580
- * Delete an existing Managed Client.
60581
- * @summary Delete a Managed Client
60582
- * @param {string} id Managed Client ID.
60592
+ * Delete an existing managed client.
60593
+ * @summary Delete Managed Client
60594
+ * @param {string} id Managed client ID.
60583
60595
  * @param {*} [axiosOptions] Override http request option.
60584
60596
  * @throws {RequiredError}
60585
60597
  */
@@ -60593,16 +60605,16 @@ export declare const ManagedClientsV2024ApiAxiosParamCreator: (configuration?: C
60593
60605
  */
60594
60606
  getManagedClient: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
60595
60607
  /**
60596
- * Retrieve the Status of a Managed Client by ID.
60597
- * @summary Get Managed Client Status.
60598
- * @param {string} id ID of the Managed Client to get Status of
60599
- * @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.
60600
60612
  * @param {*} [axiosOptions] Override http request option.
60601
60613
  * @throws {RequiredError}
60602
60614
  */
60603
60615
  getManagedClientStatus: (id: string, type: ManagedClientTypeV2024, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
60604
60616
  /**
60605
- * Get a list of Managed Clients.
60617
+ * List managed clients.
60606
60618
  * @summary Get Managed Clients
60607
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.
60608
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.
@@ -60613,10 +60625,10 @@ export declare const ManagedClientsV2024ApiAxiosParamCreator: (configuration?: C
60613
60625
  */
60614
60626
  getManagedClients: (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
60615
60627
  /**
60616
- * Update an existing Managed Client.
60617
- * @summary Update a Managed Client
60618
- * @param {string} id Managed Client ID.
60619
- * @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.
60620
60632
  * @param {*} [axiosOptions] Override http request option.
60621
60633
  * @throws {RequiredError}
60622
60634
  */
@@ -60628,17 +60640,17 @@ export declare const ManagedClientsV2024ApiAxiosParamCreator: (configuration?: C
60628
60640
  */
60629
60641
  export declare const ManagedClientsV2024ApiFp: (configuration?: Configuration) => {
60630
60642
  /**
60631
- * Create a new Managed Client. The API returns a result that includes the Managed Client ID.
60632
- * @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
60633
60645
  * @param {ManagedClientRequestV2024} managedClientRequestV2024
60634
60646
  * @param {*} [axiosOptions] Override http request option.
60635
60647
  * @throws {RequiredError}
60636
60648
  */
60637
60649
  createManagedClient(managedClientRequestV2024: ManagedClientRequestV2024, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManagedClientV2024>>;
60638
60650
  /**
60639
- * Delete an existing Managed Client.
60640
- * @summary Delete a Managed Client
60641
- * @param {string} id Managed Client ID.
60651
+ * Delete an existing managed client.
60652
+ * @summary Delete Managed Client
60653
+ * @param {string} id Managed client ID.
60642
60654
  * @param {*} [axiosOptions] Override http request option.
60643
60655
  * @throws {RequiredError}
60644
60656
  */
@@ -60652,16 +60664,16 @@ export declare const ManagedClientsV2024ApiFp: (configuration?: Configuration) =
60652
60664
  */
60653
60665
  getManagedClient(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManagedClientV2024>>;
60654
60666
  /**
60655
- * Retrieve the Status of a Managed Client by ID.
60656
- * @summary Get Managed Client Status.
60657
- * @param {string} id ID of the Managed Client to get Status of
60658
- * @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.
60659
60671
  * @param {*} [axiosOptions] Override http request option.
60660
60672
  * @throws {RequiredError}
60661
60673
  */
60662
60674
  getManagedClientStatus(id: string, type: ManagedClientTypeV2024, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManagedClientStatusV2024>>;
60663
60675
  /**
60664
- * Get a list of Managed Clients.
60676
+ * List managed clients.
60665
60677
  * @summary Get Managed Clients
60666
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.
60667
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.
@@ -60672,10 +60684,10 @@ export declare const ManagedClientsV2024ApiFp: (configuration?: Configuration) =
60672
60684
  */
60673
60685
  getManagedClients(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ManagedClientV2024>>>;
60674
60686
  /**
60675
- * Update an existing Managed Client.
60676
- * @summary Update a Managed Client
60677
- * @param {string} id Managed Client ID.
60678
- * @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.
60679
60691
  * @param {*} [axiosOptions] Override http request option.
60680
60692
  * @throws {RequiredError}
60681
60693
  */
@@ -60687,17 +60699,17 @@ export declare const ManagedClientsV2024ApiFp: (configuration?: Configuration) =
60687
60699
  */
60688
60700
  export declare const ManagedClientsV2024ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
60689
60701
  /**
60690
- * Create a new Managed Client. The API returns a result that includes the Managed Client ID.
60691
- * @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
60692
60704
  * @param {ManagedClientRequestV2024} managedClientRequestV2024
60693
60705
  * @param {*} [axiosOptions] Override http request option.
60694
60706
  * @throws {RequiredError}
60695
60707
  */
60696
60708
  createManagedClient(managedClientRequestV2024: ManagedClientRequestV2024, axiosOptions?: any): AxiosPromise<ManagedClientV2024>;
60697
60709
  /**
60698
- * Delete an existing Managed Client.
60699
- * @summary Delete a Managed Client
60700
- * @param {string} id Managed Client ID.
60710
+ * Delete an existing managed client.
60711
+ * @summary Delete Managed Client
60712
+ * @param {string} id Managed client ID.
60701
60713
  * @param {*} [axiosOptions] Override http request option.
60702
60714
  * @throws {RequiredError}
60703
60715
  */
@@ -60711,16 +60723,16 @@ export declare const ManagedClientsV2024ApiFactory: (configuration?: Configurati
60711
60723
  */
60712
60724
  getManagedClient(id: string, axiosOptions?: any): AxiosPromise<ManagedClientV2024>;
60713
60725
  /**
60714
- * Retrieve the Status of a Managed Client by ID.
60715
- * @summary Get Managed Client Status.
60716
- * @param {string} id ID of the Managed Client to get Status of
60717
- * @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.
60718
60730
  * @param {*} [axiosOptions] Override http request option.
60719
60731
  * @throws {RequiredError}
60720
60732
  */
60721
60733
  getManagedClientStatus(id: string, type: ManagedClientTypeV2024, axiosOptions?: any): AxiosPromise<ManagedClientStatusV2024>;
60722
60734
  /**
60723
- * Get a list of Managed Clients.
60735
+ * List managed clients.
60724
60736
  * @summary Get Managed Clients
60725
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.
60726
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.
@@ -60731,10 +60743,10 @@ export declare const ManagedClientsV2024ApiFactory: (configuration?: Configurati
60731
60743
  */
60732
60744
  getManagedClients(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: any): AxiosPromise<Array<ManagedClientV2024>>;
60733
60745
  /**
60734
- * Update an existing Managed Client.
60735
- * @summary Update a Managed Client
60736
- * @param {string} id Managed Client ID.
60737
- * @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.
60738
60750
  * @param {*} [axiosOptions] Override http request option.
60739
60751
  * @throws {RequiredError}
60740
60752
  */
@@ -60760,7 +60772,7 @@ export interface ManagedClientsV2024ApiCreateManagedClientRequest {
60760
60772
  */
60761
60773
  export interface ManagedClientsV2024ApiDeleteManagedClientRequest {
60762
60774
  /**
60763
- * Managed Client ID.
60775
+ * Managed client ID.
60764
60776
  * @type {string}
60765
60777
  * @memberof ManagedClientsV2024ApiDeleteManagedClient
60766
60778
  */
@@ -60786,13 +60798,13 @@ export interface ManagedClientsV2024ApiGetManagedClientRequest {
60786
60798
  */
60787
60799
  export interface ManagedClientsV2024ApiGetManagedClientStatusRequest {
60788
60800
  /**
60789
- * ID of the Managed Client to get Status of
60801
+ * Managed client ID to get status for.
60790
60802
  * @type {string}
60791
60803
  * @memberof ManagedClientsV2024ApiGetManagedClientStatus
60792
60804
  */
60793
60805
  readonly id: string;
60794
60806
  /**
60795
- * Type of the Managed Client to get Status of
60807
+ * Managed client type to get status for.
60796
60808
  * @type {ManagedClientTypeV2024}
60797
60809
  * @memberof ManagedClientsV2024ApiGetManagedClientStatus
60798
60810
  */
@@ -60836,13 +60848,13 @@ export interface ManagedClientsV2024ApiGetManagedClientsRequest {
60836
60848
  */
60837
60849
  export interface ManagedClientsV2024ApiUpdateManagedClientRequest {
60838
60850
  /**
60839
- * Managed Client ID.
60851
+ * Managed client ID.
60840
60852
  * @type {string}
60841
60853
  * @memberof ManagedClientsV2024ApiUpdateManagedClient
60842
60854
  */
60843
60855
  readonly id: string;
60844
60856
  /**
60845
- * The JSONPatch payload used to update the object.
60857
+ * JSONPatch payload used to update the object.
60846
60858
  * @type {Array<JsonPatchOperationV2024>}
60847
60859
  * @memberof ManagedClientsV2024ApiUpdateManagedClient
60848
60860
  */
@@ -60856,8 +60868,8 @@ export interface ManagedClientsV2024ApiUpdateManagedClientRequest {
60856
60868
  */
60857
60869
  export declare class ManagedClientsV2024Api extends BaseAPI {
60858
60870
  /**
60859
- * Create a new Managed Client. The API returns a result that includes the Managed Client ID.
60860
- * @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
60861
60873
  * @param {ManagedClientsV2024ApiCreateManagedClientRequest} requestParameters Request parameters.
60862
60874
  * @param {*} [axiosOptions] Override http request option.
60863
60875
  * @throws {RequiredError}
@@ -60865,8 +60877,8 @@ export declare class ManagedClientsV2024Api extends BaseAPI {
60865
60877
  */
60866
60878
  createManagedClient(requestParameters: ManagedClientsV2024ApiCreateManagedClientRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManagedClientV2024, any>>;
60867
60879
  /**
60868
- * Delete an existing Managed Client.
60869
- * @summary Delete a Managed Client
60880
+ * Delete an existing managed client.
60881
+ * @summary Delete Managed Client
60870
60882
  * @param {ManagedClientsV2024ApiDeleteManagedClientRequest} requestParameters Request parameters.
60871
60883
  * @param {*} [axiosOptions] Override http request option.
60872
60884
  * @throws {RequiredError}
@@ -60883,8 +60895,8 @@ export declare class ManagedClientsV2024Api extends BaseAPI {
60883
60895
  */
60884
60896
  getManagedClient(requestParameters: ManagedClientsV2024ApiGetManagedClientRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManagedClientV2024, any>>;
60885
60897
  /**
60886
- * Retrieve the Status of a Managed Client by ID.
60887
- * @summary Get Managed Client Status.
60898
+ * Get a managed client\'s status, using its ID.
60899
+ * @summary Get Managed Client Status
60888
60900
  * @param {ManagedClientsV2024ApiGetManagedClientStatusRequest} requestParameters Request parameters.
60889
60901
  * @param {*} [axiosOptions] Override http request option.
60890
60902
  * @throws {RequiredError}
@@ -60892,7 +60904,7 @@ export declare class ManagedClientsV2024Api extends BaseAPI {
60892
60904
  */
60893
60905
  getManagedClientStatus(requestParameters: ManagedClientsV2024ApiGetManagedClientStatusRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManagedClientStatusV2024, any>>;
60894
60906
  /**
60895
- * Get a list of Managed Clients.
60907
+ * List managed clients.
60896
60908
  * @summary Get Managed Clients
60897
60909
  * @param {ManagedClientsV2024ApiGetManagedClientsRequest} requestParameters Request parameters.
60898
60910
  * @param {*} [axiosOptions] Override http request option.
@@ -60901,8 +60913,8 @@ export declare class ManagedClientsV2024Api extends BaseAPI {
60901
60913
  */
60902
60914
  getManagedClients(requestParameters?: ManagedClientsV2024ApiGetManagedClientsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManagedClientV2024[], any>>;
60903
60915
  /**
60904
- * Update an existing Managed Client.
60905
- * @summary Update a Managed Client
60916
+ * Update an existing managed client.
60917
+ * @summary Update Managed Client
60906
60918
  * @param {ManagedClientsV2024ApiUpdateManagedClientRequest} requestParameters Request parameters.
60907
60919
  * @param {*} [axiosOptions] Override http request option.
60908
60920
  * @throws {RequiredError}
@@ -64702,7 +64714,7 @@ export declare const PasswordManagementV2024ApiAxiosParamCreator: (configuration
64702
64714
  */
64703
64715
  queryPasswordInfo: (passwordInfoQueryDTOV2024: PasswordInfoQueryDTOV2024, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
64704
64716
  /**
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.
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.
64706
64718
  * @summary Set Identity\'s Password
64707
64719
  * @param {PasswordChangeRequestV2024} passwordChangeRequestV2024
64708
64720
  * @param {*} [axiosOptions] Override http request option.
@@ -64741,7 +64753,7 @@ export declare const PasswordManagementV2024ApiFp: (configuration?: Configuratio
64741
64753
  */
64742
64754
  queryPasswordInfo(passwordInfoQueryDTOV2024: PasswordInfoQueryDTOV2024, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasswordInfoV2024>>;
64743
64755
  /**
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.
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.
64745
64757
  * @summary Set Identity\'s Password
64746
64758
  * @param {PasswordChangeRequestV2024} passwordChangeRequestV2024
64747
64759
  * @param {*} [axiosOptions] Override http request option.
@@ -64780,7 +64792,7 @@ export declare const PasswordManagementV2024ApiFactory: (configuration?: Configu
64780
64792
  */
64781
64793
  queryPasswordInfo(passwordInfoQueryDTOV2024: PasswordInfoQueryDTOV2024, axiosOptions?: any): AxiosPromise<PasswordInfoV2024>;
64782
64794
  /**
64783
- * 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.
64784
64796
  * @summary Set Identity\'s Password
64785
64797
  * @param {PasswordChangeRequestV2024} passwordChangeRequestV2024
64786
64798
  * @param {*} [axiosOptions] Override http request option.
@@ -64881,7 +64893,7 @@ export declare class PasswordManagementV2024Api extends BaseAPI {
64881
64893
  */
64882
64894
  queryPasswordInfo(requestParameters: PasswordManagementV2024ApiQueryPasswordInfoRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordInfoV2024, any>>;
64883
64895
  /**
64884
- * 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.
64885
64897
  * @summary Set Identity\'s Password
64886
64898
  * @param {PasswordManagementV2024ApiSetPasswordRequest} requestParameters Request parameters.
64887
64899
  * @param {*} [axiosOptions] Override http request option.
@@ -70529,7 +70541,7 @@ export declare const SearchV2024ApiAxiosParamCreator: (configuration?: Configura
70529
70541
  */
70530
70542
  searchGet: (index: string, id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
70531
70543
  /**
70532
- * 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.
70533
70545
  * @summary Perform Search
70534
70546
  * @param {SearchV2024} searchV2024
70535
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.
@@ -70574,7 +70586,7 @@ export declare const SearchV2024ApiFp: (configuration?: Configuration) => {
70574
70586
  */
70575
70587
  searchGet(index: string, id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchDocumentV2024>>;
70576
70588
  /**
70577
- * 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.
70578
70590
  * @summary Perform Search
70579
70591
  * @param {SearchV2024} searchV2024
70580
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.
@@ -70619,7 +70631,7 @@ export declare const SearchV2024ApiFactory: (configuration?: Configuration, base
70619
70631
  */
70620
70632
  searchGet(index: string, id: string, axiosOptions?: any): AxiosPromise<SearchDocumentV2024>;
70621
70633
  /**
70622
- * 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.
70623
70635
  * @summary Perform Search
70624
70636
  * @param {SearchV2024} searchV2024
70625
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.
@@ -70759,7 +70771,7 @@ export declare class SearchV2024Api extends BaseAPI {
70759
70771
  */
70760
70772
  searchGet(requestParameters: SearchV2024ApiSearchGetRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchDocumentV2024, any>>;
70761
70773
  /**
70762
- * 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.
70763
70775
  * @summary Perform Search
70764
70776
  * @param {SearchV2024ApiSearchPostRequest} requestParameters Request parameters.
70765
70777
  * @param {*} [axiosOptions] Override http request option.