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.
package/v2024/api.ts CHANGED
@@ -14609,6 +14609,12 @@ export interface EventAttributesV2024 {
14609
14609
  * @memberof EventAttributesV2024
14610
14610
  */
14611
14611
  'description'?: string;
14612
+ /**
14613
+ * The attribute to filter on
14614
+ * @type {string}
14615
+ * @memberof EventAttributesV2024
14616
+ */
14617
+ 'attributeToFilter'?: string;
14612
14618
  }
14613
14619
  /**
14614
14620
  *
@@ -40628,6 +40634,12 @@ export interface WorkflowTriggerAttributesV2024 {
40628
40634
  * @memberof WorkflowTriggerAttributesV2024
40629
40635
  */
40630
40636
  'description'?: string;
40637
+ /**
40638
+ * The attribute to filter on
40639
+ * @type {string}
40640
+ * @memberof WorkflowTriggerAttributesV2024
40641
+ */
40642
+ 'attributeToFilter'?: string;
40631
40643
  /**
40632
40644
  * A unique name for the external trigger
40633
40645
  * @type {string}
@@ -67221,7 +67233,7 @@ export class IAICommonAccessV2024Api extends BaseAPI {
67221
67233
  export const IAIOutliersV2024ApiAxiosParamCreator = function (configuration?: Configuration) {
67222
67234
  return {
67223
67235
  /**
67224
- * 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\'
67236
+ * 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).
67225
67237
  * @summary IAI Identity Outliers Export
67226
67238
  * @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
67227
67239
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -67245,13 +67257,17 @@ export const IAIOutliersV2024ApiAxiosParamCreator = function (configuration?: Co
67245
67257
  const localVarHeaderParameter = {} as any;
67246
67258
  const localVarQueryParameter = {} as any;
67247
67259
 
67260
+ // authentication applicationAuth required
67261
+ // oauth required
67262
+ await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration)
67263
+
67248
67264
  // authentication userAuth required
67249
67265
  // oauth required
67250
- await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration)
67266
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
67251
67267
 
67252
67268
  // authentication userAuth required
67253
67269
  // oauth required
67254
- await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration)
67270
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
67255
67271
 
67256
67272
  if (type !== undefined) {
67257
67273
  localVarQueryParameter['type'] = type;
@@ -67273,7 +67289,7 @@ export const IAIOutliersV2024ApiAxiosParamCreator = function (configuration?: Co
67273
67289
  };
67274
67290
  },
67275
67291
  /**
67276
- * 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\'
67292
+ * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier.
67277
67293
  * @summary IAI Identity Outliers Summary
67278
67294
  * @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.
67279
67295
  * @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.
@@ -67301,13 +67317,17 @@ export const IAIOutliersV2024ApiAxiosParamCreator = function (configuration?: Co
67301
67317
  const localVarHeaderParameter = {} as any;
67302
67318
  const localVarQueryParameter = {} as any;
67303
67319
 
67320
+ // authentication applicationAuth required
67321
+ // oauth required
67322
+ await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration)
67323
+
67304
67324
  // authentication userAuth required
67305
67325
  // oauth required
67306
- await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration)
67326
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
67307
67327
 
67308
67328
  // authentication userAuth required
67309
67329
  // oauth required
67310
- await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration)
67330
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
67311
67331
 
67312
67332
  if (limit !== undefined) {
67313
67333
  localVarQueryParameter['limit'] = limit;
@@ -67345,7 +67365,7 @@ export const IAIOutliersV2024ApiAxiosParamCreator = function (configuration?: Co
67345
67365
  };
67346
67366
  },
67347
67367
  /**
67348
- * 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\'
67368
+ * 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.
67349
67369
  * @summary IAI Get Identity Outliers
67350
67370
  * @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.
67351
67371
  * @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.
@@ -67374,13 +67394,17 @@ export const IAIOutliersV2024ApiAxiosParamCreator = function (configuration?: Co
67374
67394
  const localVarHeaderParameter = {} as any;
67375
67395
  const localVarQueryParameter = {} as any;
67376
67396
 
67397
+ // authentication applicationAuth required
67398
+ // oauth required
67399
+ await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration)
67400
+
67377
67401
  // authentication userAuth required
67378
67402
  // oauth required
67379
- await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration)
67403
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
67380
67404
 
67381
67405
  // authentication userAuth required
67382
67406
  // oauth required
67383
- await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration)
67407
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
67384
67408
 
67385
67409
  if (limit !== undefined) {
67386
67410
  localVarQueryParameter['limit'] = limit;
@@ -67422,7 +67446,7 @@ export const IAIOutliersV2024ApiAxiosParamCreator = function (configuration?: Co
67422
67446
  };
67423
67447
  },
67424
67448
  /**
67425
- * 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\'
67449
+ * 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.
67426
67450
  * @summary IAI Identity Outliers Latest Summary
67427
67451
  * @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
67428
67452
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -67446,13 +67470,17 @@ export const IAIOutliersV2024ApiAxiosParamCreator = function (configuration?: Co
67446
67470
  const localVarHeaderParameter = {} as any;
67447
67471
  const localVarQueryParameter = {} as any;
67448
67472
 
67473
+ // authentication applicationAuth required
67474
+ // oauth required
67475
+ await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration)
67476
+
67449
67477
  // authentication userAuth required
67450
67478
  // oauth required
67451
- await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration)
67479
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
67452
67480
 
67453
67481
  // authentication userAuth required
67454
67482
  // oauth required
67455
- await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration)
67483
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
67456
67484
 
67457
67485
  if (type !== undefined) {
67458
67486
  localVarQueryParameter['type'] = type;
@@ -67474,7 +67502,7 @@ export const IAIOutliersV2024ApiAxiosParamCreator = function (configuration?: Co
67474
67502
  };
67475
67503
  },
67476
67504
  /**
67477
- * 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\'
67505
+ * 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.
67478
67506
  * @summary Get identity outlier contibuting feature summary
67479
67507
  * @param {string} outlierFeatureId Contributing feature id
67480
67508
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -67501,6 +67529,10 @@ export const IAIOutliersV2024ApiAxiosParamCreator = function (configuration?: Co
67501
67529
  const localVarHeaderParameter = {} as any;
67502
67530
  const localVarQueryParameter = {} as any;
67503
67531
 
67532
+ // authentication applicationAuth required
67533
+ // oauth required
67534
+ await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration)
67535
+
67504
67536
  // authentication userAuth required
67505
67537
  // oauth required
67506
67538
  await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
@@ -67525,7 +67557,7 @@ export const IAIOutliersV2024ApiAxiosParamCreator = function (configuration?: Co
67525
67557
  };
67526
67558
  },
67527
67559
  /**
67528
- * 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\'
67560
+ * 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.
67529
67561
  * @summary Get identity outlier\'s contibuting features
67530
67562
  * @param {string} outlierId The outlier id
67531
67563
  * @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.
@@ -67557,13 +67589,17 @@ export const IAIOutliersV2024ApiAxiosParamCreator = function (configuration?: Co
67557
67589
  const localVarHeaderParameter = {} as any;
67558
67590
  const localVarQueryParameter = {} as any;
67559
67591
 
67592
+ // authentication applicationAuth required
67593
+ // oauth required
67594
+ await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration)
67595
+
67560
67596
  // authentication userAuth required
67561
67597
  // oauth required
67562
- await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration)
67598
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
67563
67599
 
67564
67600
  // authentication userAuth required
67565
67601
  // oauth required
67566
- await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration)
67602
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
67567
67603
 
67568
67604
  if (limit !== undefined) {
67569
67605
  localVarQueryParameter['limit'] = limit;
@@ -67601,7 +67637,7 @@ export const IAIOutliersV2024ApiAxiosParamCreator = function (configuration?: Co
67601
67637
  };
67602
67638
  },
67603
67639
  /**
67604
- * 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\'
67640
+ * This API receives a list of identity IDs in the request, changes the outliers to be ignored.
67605
67641
  * @summary IAI Identity Outliers Ignore
67606
67642
  * @param {Array<string>} requestBody
67607
67643
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -67627,13 +67663,17 @@ export const IAIOutliersV2024ApiAxiosParamCreator = function (configuration?: Co
67627
67663
  const localVarHeaderParameter = {} as any;
67628
67664
  const localVarQueryParameter = {} as any;
67629
67665
 
67666
+ // authentication applicationAuth required
67667
+ // oauth required
67668
+ await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration)
67669
+
67630
67670
  // authentication userAuth required
67631
67671
  // oauth required
67632
- await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration)
67672
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
67633
67673
 
67634
67674
  // authentication userAuth required
67635
67675
  // oauth required
67636
- await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration)
67676
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
67637
67677
 
67638
67678
  if (xSailPointExperimental !== undefined && xSailPointExperimental !== null) {
67639
67679
  localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
@@ -67654,14 +67694,14 @@ export const IAIOutliersV2024ApiAxiosParamCreator = function (configuration?: Co
67654
67694
  };
67655
67695
  },
67656
67696
  /**
67657
- * 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\'
67697
+ * 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.
67658
67698
  * @summary Gets a list of access items associated with each identity outlier contributing feature
67659
67699
  * @param {string} outlierId The outlier id
67660
67700
  * @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
67661
67701
  * @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.
67662
67702
  * @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.
67663
67703
  * @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.
67664
- * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all
67704
+ * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all.
67665
67705
  * @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**
67666
67706
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
67667
67707
  * @param {*} [axiosOptions] Override http request option.
@@ -67690,6 +67730,10 @@ export const IAIOutliersV2024ApiAxiosParamCreator = function (configuration?: Co
67690
67730
  const localVarHeaderParameter = {} as any;
67691
67731
  const localVarQueryParameter = {} as any;
67692
67732
 
67733
+ // authentication applicationAuth required
67734
+ // oauth required
67735
+ await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration)
67736
+
67693
67737
  // authentication userAuth required
67694
67738
  // oauth required
67695
67739
  await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
@@ -67734,7 +67778,7 @@ export const IAIOutliersV2024ApiAxiosParamCreator = function (configuration?: Co
67734
67778
  };
67735
67779
  },
67736
67780
  /**
67737
- * 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\'
67781
+ * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored.
67738
67782
  * @summary IAI Identity Outliers Unignore
67739
67783
  * @param {Array<string>} requestBody
67740
67784
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -67760,13 +67804,17 @@ export const IAIOutliersV2024ApiAxiosParamCreator = function (configuration?: Co
67760
67804
  const localVarHeaderParameter = {} as any;
67761
67805
  const localVarQueryParameter = {} as any;
67762
67806
 
67807
+ // authentication applicationAuth required
67808
+ // oauth required
67809
+ await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration)
67810
+
67763
67811
  // authentication userAuth required
67764
67812
  // oauth required
67765
- await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration)
67813
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
67766
67814
 
67767
67815
  // authentication userAuth required
67768
67816
  // oauth required
67769
- await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration)
67817
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
67770
67818
 
67771
67819
  if (xSailPointExperimental !== undefined && xSailPointExperimental !== null) {
67772
67820
  localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental);
@@ -67797,7 +67845,7 @@ export const IAIOutliersV2024ApiFp = function(configuration?: Configuration) {
67797
67845
  const localVarAxiosParamCreator = IAIOutliersV2024ApiAxiosParamCreator(configuration)
67798
67846
  return {
67799
67847
  /**
67800
- * 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\'
67848
+ * 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).
67801
67849
  * @summary IAI Identity Outliers Export
67802
67850
  * @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
67803
67851
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -67809,7 +67857,7 @@ export const IAIOutliersV2024ApiFp = function(configuration?: Configuration) {
67809
67857
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
67810
67858
  },
67811
67859
  /**
67812
- * 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\'
67860
+ * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier.
67813
67861
  * @summary IAI Identity Outliers Summary
67814
67862
  * @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.
67815
67863
  * @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.
@@ -67825,7 +67873,7 @@ export const IAIOutliersV2024ApiFp = function(configuration?: Configuration) {
67825
67873
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
67826
67874
  },
67827
67875
  /**
67828
- * 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\'
67876
+ * 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.
67829
67877
  * @summary IAI Get Identity Outliers
67830
67878
  * @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.
67831
67879
  * @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.
@@ -67842,7 +67890,7 @@ export const IAIOutliersV2024ApiFp = function(configuration?: Configuration) {
67842
67890
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
67843
67891
  },
67844
67892
  /**
67845
- * 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\'
67893
+ * 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.
67846
67894
  * @summary IAI Identity Outliers Latest Summary
67847
67895
  * @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
67848
67896
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -67854,7 +67902,7 @@ export const IAIOutliersV2024ApiFp = function(configuration?: Configuration) {
67854
67902
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
67855
67903
  },
67856
67904
  /**
67857
- * 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\'
67905
+ * 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.
67858
67906
  * @summary Get identity outlier contibuting feature summary
67859
67907
  * @param {string} outlierFeatureId Contributing feature id
67860
67908
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -67866,7 +67914,7 @@ export const IAIOutliersV2024ApiFp = function(configuration?: Configuration) {
67866
67914
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
67867
67915
  },
67868
67916
  /**
67869
- * 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\'
67917
+ * 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.
67870
67918
  * @summary Get identity outlier\'s contibuting features
67871
67919
  * @param {string} outlierId The outlier id
67872
67920
  * @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.
@@ -67883,7 +67931,7 @@ export const IAIOutliersV2024ApiFp = function(configuration?: Configuration) {
67883
67931
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
67884
67932
  },
67885
67933
  /**
67886
- * 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\'
67934
+ * This API receives a list of identity IDs in the request, changes the outliers to be ignored.
67887
67935
  * @summary IAI Identity Outliers Ignore
67888
67936
  * @param {Array<string>} requestBody
67889
67937
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -67895,14 +67943,14 @@ export const IAIOutliersV2024ApiFp = function(configuration?: Configuration) {
67895
67943
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
67896
67944
  },
67897
67945
  /**
67898
- * 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\'
67946
+ * 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.
67899
67947
  * @summary Gets a list of access items associated with each identity outlier contributing feature
67900
67948
  * @param {string} outlierId The outlier id
67901
67949
  * @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
67902
67950
  * @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.
67903
67951
  * @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.
67904
67952
  * @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.
67905
- * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all
67953
+ * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all.
67906
67954
  * @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**
67907
67955
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
67908
67956
  * @param {*} [axiosOptions] Override http request option.
@@ -67913,7 +67961,7 @@ export const IAIOutliersV2024ApiFp = function(configuration?: Configuration) {
67913
67961
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
67914
67962
  },
67915
67963
  /**
67916
- * 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\'
67964
+ * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored.
67917
67965
  * @summary IAI Identity Outliers Unignore
67918
67966
  * @param {Array<string>} requestBody
67919
67967
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -67935,7 +67983,7 @@ export const IAIOutliersV2024ApiFactory = function (configuration?: Configuratio
67935
67983
  const localVarFp = IAIOutliersV2024ApiFp(configuration)
67936
67984
  return {
67937
67985
  /**
67938
- * 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\'
67986
+ * 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).
67939
67987
  * @summary IAI Identity Outliers Export
67940
67988
  * @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
67941
67989
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -67946,7 +67994,7 @@ export const IAIOutliersV2024ApiFactory = function (configuration?: Configuratio
67946
67994
  return localVarFp.exportOutliersZip(type, xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath));
67947
67995
  },
67948
67996
  /**
67949
- * 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\'
67997
+ * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier.
67950
67998
  * @summary IAI Identity Outliers Summary
67951
67999
  * @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.
67952
68000
  * @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.
@@ -67961,7 +68009,7 @@ export const IAIOutliersV2024ApiFactory = function (configuration?: Configuratio
67961
68009
  return localVarFp.getIdentityOutlierSnapshots(limit, offset, type, filters, sorters, xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath));
67962
68010
  },
67963
68011
  /**
67964
- * 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\'
68012
+ * 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.
67965
68013
  * @summary IAI Get Identity Outliers
67966
68014
  * @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.
67967
68015
  * @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.
@@ -67977,7 +68025,7 @@ export const IAIOutliersV2024ApiFactory = function (configuration?: Configuratio
67977
68025
  return localVarFp.getIdentityOutliers(limit, offset, count, type, filters, sorters, xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath));
67978
68026
  },
67979
68027
  /**
67980
- * 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\'
68028
+ * 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.
67981
68029
  * @summary IAI Identity Outliers Latest Summary
67982
68030
  * @param {'LOW_SIMILARITY' | 'STRUCTURAL'} [type] Type of the identity outliers snapshot to filter on
67983
68031
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -67988,7 +68036,7 @@ export const IAIOutliersV2024ApiFactory = function (configuration?: Configuratio
67988
68036
  return localVarFp.getLatestIdentityOutlierSnapshots(type, xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath));
67989
68037
  },
67990
68038
  /**
67991
- * 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\'
68039
+ * 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.
67992
68040
  * @summary Get identity outlier contibuting feature summary
67993
68041
  * @param {string} outlierFeatureId Contributing feature id
67994
68042
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -67999,7 +68047,7 @@ export const IAIOutliersV2024ApiFactory = function (configuration?: Configuratio
67999
68047
  return localVarFp.getOutlierContributingFeatureSummary(outlierFeatureId, xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath));
68000
68048
  },
68001
68049
  /**
68002
- * 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\'
68050
+ * 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.
68003
68051
  * @summary Get identity outlier\'s contibuting features
68004
68052
  * @param {string} outlierId The outlier id
68005
68053
  * @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.
@@ -68015,7 +68063,7 @@ export const IAIOutliersV2024ApiFactory = function (configuration?: Configuratio
68015
68063
  return localVarFp.getPeerGroupOutliersContributingFeatures(outlierId, limit, offset, count, includeTranslationMessages, sorters, xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath));
68016
68064
  },
68017
68065
  /**
68018
- * 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\'
68066
+ * This API receives a list of identity IDs in the request, changes the outliers to be ignored.
68019
68067
  * @summary IAI Identity Outliers Ignore
68020
68068
  * @param {Array<string>} requestBody
68021
68069
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -68026,14 +68074,14 @@ export const IAIOutliersV2024ApiFactory = function (configuration?: Configuratio
68026
68074
  return localVarFp.ignoreIdentityOutliers(requestBody, xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath));
68027
68075
  },
68028
68076
  /**
68029
- * 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\'
68077
+ * 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.
68030
68078
  * @summary Gets a list of access items associated with each identity outlier contributing feature
68031
68079
  * @param {string} outlierId The outlier id
68032
68080
  * @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
68033
68081
  * @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.
68034
68082
  * @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.
68035
68083
  * @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.
68036
- * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all
68084
+ * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all.
68037
68085
  * @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**
68038
68086
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
68039
68087
  * @param {*} [axiosOptions] Override http request option.
@@ -68043,7 +68091,7 @@ export const IAIOutliersV2024ApiFactory = function (configuration?: Configuratio
68043
68091
  return localVarFp.listOutliersContributingFeatureAccessItems(outlierId, contributingFeatureName, limit, offset, count, accessType, sorters, xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath));
68044
68092
  },
68045
68093
  /**
68046
- * 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\'
68094
+ * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored.
68047
68095
  * @summary IAI Identity Outliers Unignore
68048
68096
  * @param {Array<string>} requestBody
68049
68097
  * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
@@ -68343,7 +68391,7 @@ export interface IAIOutliersV2024ApiListOutliersContributingFeatureAccessItemsRe
68343
68391
  readonly count?: boolean
68344
68392
 
68345
68393
  /**
68346
- * The type of access item for the identity outlier contributing feature. If not provided, it returns all
68394
+ * The type of access item for the identity outlier contributing feature. If not provided, it returns all.
68347
68395
  * @type {string}
68348
68396
  * @memberof IAIOutliersV2024ApiListOutliersContributingFeatureAccessItems
68349
68397
  */
@@ -68393,7 +68441,7 @@ export interface IAIOutliersV2024ApiUnIgnoreIdentityOutliersRequest {
68393
68441
  */
68394
68442
  export class IAIOutliersV2024Api extends BaseAPI {
68395
68443
  /**
68396
- * 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\'
68444
+ * 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).
68397
68445
  * @summary IAI Identity Outliers Export
68398
68446
  * @param {IAIOutliersV2024ApiExportOutliersZipRequest} requestParameters Request parameters.
68399
68447
  * @param {*} [axiosOptions] Override http request option.
@@ -68405,7 +68453,7 @@ export class IAIOutliersV2024Api extends BaseAPI {
68405
68453
  }
68406
68454
 
68407
68455
  /**
68408
- * 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\'
68456
+ * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier.
68409
68457
  * @summary IAI Identity Outliers Summary
68410
68458
  * @param {IAIOutliersV2024ApiGetIdentityOutlierSnapshotsRequest} requestParameters Request parameters.
68411
68459
  * @param {*} [axiosOptions] Override http request option.
@@ -68417,7 +68465,7 @@ export class IAIOutliersV2024Api extends BaseAPI {
68417
68465
  }
68418
68466
 
68419
68467
  /**
68420
- * 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\'
68468
+ * 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.
68421
68469
  * @summary IAI Get Identity Outliers
68422
68470
  * @param {IAIOutliersV2024ApiGetIdentityOutliersRequest} requestParameters Request parameters.
68423
68471
  * @param {*} [axiosOptions] Override http request option.
@@ -68429,7 +68477,7 @@ export class IAIOutliersV2024Api extends BaseAPI {
68429
68477
  }
68430
68478
 
68431
68479
  /**
68432
- * 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\'
68480
+ * 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.
68433
68481
  * @summary IAI Identity Outliers Latest Summary
68434
68482
  * @param {IAIOutliersV2024ApiGetLatestIdentityOutlierSnapshotsRequest} requestParameters Request parameters.
68435
68483
  * @param {*} [axiosOptions] Override http request option.
@@ -68441,7 +68489,7 @@ export class IAIOutliersV2024Api extends BaseAPI {
68441
68489
  }
68442
68490
 
68443
68491
  /**
68444
- * 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\'
68492
+ * 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.
68445
68493
  * @summary Get identity outlier contibuting feature summary
68446
68494
  * @param {IAIOutliersV2024ApiGetOutlierContributingFeatureSummaryRequest} requestParameters Request parameters.
68447
68495
  * @param {*} [axiosOptions] Override http request option.
@@ -68453,7 +68501,7 @@ export class IAIOutliersV2024Api extends BaseAPI {
68453
68501
  }
68454
68502
 
68455
68503
  /**
68456
- * 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\'
68504
+ * 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.
68457
68505
  * @summary Get identity outlier\'s contibuting features
68458
68506
  * @param {IAIOutliersV2024ApiGetPeerGroupOutliersContributingFeaturesRequest} requestParameters Request parameters.
68459
68507
  * @param {*} [axiosOptions] Override http request option.
@@ -68465,7 +68513,7 @@ export class IAIOutliersV2024Api extends BaseAPI {
68465
68513
  }
68466
68514
 
68467
68515
  /**
68468
- * 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\'
68516
+ * This API receives a list of identity IDs in the request, changes the outliers to be ignored.
68469
68517
  * @summary IAI Identity Outliers Ignore
68470
68518
  * @param {IAIOutliersV2024ApiIgnoreIdentityOutliersRequest} requestParameters Request parameters.
68471
68519
  * @param {*} [axiosOptions] Override http request option.
@@ -68477,7 +68525,7 @@ export class IAIOutliersV2024Api extends BaseAPI {
68477
68525
  }
68478
68526
 
68479
68527
  /**
68480
- * 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\'
68528
+ * 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.
68481
68529
  * @summary Gets a list of access items associated with each identity outlier contributing feature
68482
68530
  * @param {IAIOutliersV2024ApiListOutliersContributingFeatureAccessItemsRequest} requestParameters Request parameters.
68483
68531
  * @param {*} [axiosOptions] Override http request option.
@@ -68489,7 +68537,7 @@ export class IAIOutliersV2024Api extends BaseAPI {
68489
68537
  }
68490
68538
 
68491
68539
  /**
68492
- * 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\'
68540
+ * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored.
68493
68541
  * @summary IAI Identity Outliers Unignore
68494
68542
  * @param {IAIOutliersV2024ApiUnIgnoreIdentityOutliersRequest} requestParameters Request parameters.
68495
68543
  * @param {*} [axiosOptions] Override http request option.
@@ -79190,8 +79238,8 @@ export class MFAConfigurationV2024Api extends BaseAPI {
79190
79238
  export const ManagedClientsV2024ApiAxiosParamCreator = function (configuration?: Configuration) {
79191
79239
  return {
79192
79240
  /**
79193
- * Create a new Managed Client. The API returns a result that includes the Managed Client ID.
79194
- * @summary Create a new Managed Client
79241
+ * Create a new managed client. The API returns a result that includes the managed client ID.
79242
+ * @summary Create Managed Client
79195
79243
  * @param {ManagedClientRequestV2024} managedClientRequestV2024
79196
79244
  * @param {*} [axiosOptions] Override http request option.
79197
79245
  * @throws {RequiredError}
@@ -79234,9 +79282,9 @@ export const ManagedClientsV2024ApiAxiosParamCreator = function (configuration?:
79234
79282
  };
79235
79283
  },
79236
79284
  /**
79237
- * Delete an existing Managed Client.
79238
- * @summary Delete a Managed Client
79239
- * @param {string} id Managed Client ID.
79285
+ * Delete an existing managed client.
79286
+ * @summary Delete Managed Client
79287
+ * @param {string} id Managed client ID.
79240
79288
  * @param {*} [axiosOptions] Override http request option.
79241
79289
  * @throws {RequiredError}
79242
79290
  */
@@ -79318,10 +79366,10 @@ export const ManagedClientsV2024ApiAxiosParamCreator = function (configuration?:
79318
79366
  };
79319
79367
  },
79320
79368
  /**
79321
- * Retrieve the Status of a Managed Client by ID.
79322
- * @summary Get Managed Client Status.
79323
- * @param {string} id ID of the Managed Client to get Status of
79324
- * @param {ManagedClientTypeV2024} type Type of the Managed Client to get Status of
79369
+ * Get a managed client\'s status, using its ID.
79370
+ * @summary Get Managed Client Status
79371
+ * @param {string} id Managed client ID to get status for.
79372
+ * @param {ManagedClientTypeV2024} type Managed client type to get status for.
79325
79373
  * @param {*} [axiosOptions] Override http request option.
79326
79374
  * @throws {RequiredError}
79327
79375
  */
@@ -79367,7 +79415,7 @@ export const ManagedClientsV2024ApiAxiosParamCreator = function (configuration?:
79367
79415
  };
79368
79416
  },
79369
79417
  /**
79370
- * Get a list of Managed Clients.
79418
+ * List managed clients.
79371
79419
  * @summary Get Managed Clients
79372
79420
  * @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.
79373
79421
  * @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.
@@ -79425,10 +79473,10 @@ export const ManagedClientsV2024ApiAxiosParamCreator = function (configuration?:
79425
79473
  };
79426
79474
  },
79427
79475
  /**
79428
- * Update an existing Managed Client.
79429
- * @summary Update a Managed Client
79430
- * @param {string} id Managed Client ID.
79431
- * @param {Array<JsonPatchOperationV2024>} jsonPatchOperationV2024 The JSONPatch payload used to update the object.
79476
+ * Update an existing managed client.
79477
+ * @summary Update Managed Client
79478
+ * @param {string} id Managed client ID.
79479
+ * @param {Array<JsonPatchOperationV2024>} jsonPatchOperationV2024 JSONPatch payload used to update the object.
79432
79480
  * @param {*} [axiosOptions] Override http request option.
79433
79481
  * @throws {RequiredError}
79434
79482
  */
@@ -79483,8 +79531,8 @@ export const ManagedClientsV2024ApiFp = function(configuration?: Configuration)
79483
79531
  const localVarAxiosParamCreator = ManagedClientsV2024ApiAxiosParamCreator(configuration)
79484
79532
  return {
79485
79533
  /**
79486
- * Create a new Managed Client. The API returns a result that includes the Managed Client ID.
79487
- * @summary Create a new Managed Client
79534
+ * Create a new managed client. The API returns a result that includes the managed client ID.
79535
+ * @summary Create Managed Client
79488
79536
  * @param {ManagedClientRequestV2024} managedClientRequestV2024
79489
79537
  * @param {*} [axiosOptions] Override http request option.
79490
79538
  * @throws {RequiredError}
@@ -79494,9 +79542,9 @@ export const ManagedClientsV2024ApiFp = function(configuration?: Configuration)
79494
79542
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
79495
79543
  },
79496
79544
  /**
79497
- * Delete an existing Managed Client.
79498
- * @summary Delete a Managed Client
79499
- * @param {string} id Managed Client ID.
79545
+ * Delete an existing managed client.
79546
+ * @summary Delete Managed Client
79547
+ * @param {string} id Managed client ID.
79500
79548
  * @param {*} [axiosOptions] Override http request option.
79501
79549
  * @throws {RequiredError}
79502
79550
  */
@@ -79516,10 +79564,10 @@ export const ManagedClientsV2024ApiFp = function(configuration?: Configuration)
79516
79564
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
79517
79565
  },
79518
79566
  /**
79519
- * Retrieve the Status of a Managed Client by ID.
79520
- * @summary Get Managed Client Status.
79521
- * @param {string} id ID of the Managed Client to get Status of
79522
- * @param {ManagedClientTypeV2024} type Type of the Managed Client to get Status of
79567
+ * Get a managed client\'s status, using its ID.
79568
+ * @summary Get Managed Client Status
79569
+ * @param {string} id Managed client ID to get status for.
79570
+ * @param {ManagedClientTypeV2024} type Managed client type to get status for.
79523
79571
  * @param {*} [axiosOptions] Override http request option.
79524
79572
  * @throws {RequiredError}
79525
79573
  */
@@ -79528,7 +79576,7 @@ export const ManagedClientsV2024ApiFp = function(configuration?: Configuration)
79528
79576
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
79529
79577
  },
79530
79578
  /**
79531
- * Get a list of Managed Clients.
79579
+ * List managed clients.
79532
79580
  * @summary Get Managed Clients
79533
79581
  * @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.
79534
79582
  * @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.
@@ -79542,10 +79590,10 @@ export const ManagedClientsV2024ApiFp = function(configuration?: Configuration)
79542
79590
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
79543
79591
  },
79544
79592
  /**
79545
- * Update an existing Managed Client.
79546
- * @summary Update a Managed Client
79547
- * @param {string} id Managed Client ID.
79548
- * @param {Array<JsonPatchOperationV2024>} jsonPatchOperationV2024 The JSONPatch payload used to update the object.
79593
+ * Update an existing managed client.
79594
+ * @summary Update Managed Client
79595
+ * @param {string} id Managed client ID.
79596
+ * @param {Array<JsonPatchOperationV2024>} jsonPatchOperationV2024 JSONPatch payload used to update the object.
79549
79597
  * @param {*} [axiosOptions] Override http request option.
79550
79598
  * @throws {RequiredError}
79551
79599
  */
@@ -79564,8 +79612,8 @@ export const ManagedClientsV2024ApiFactory = function (configuration?: Configura
79564
79612
  const localVarFp = ManagedClientsV2024ApiFp(configuration)
79565
79613
  return {
79566
79614
  /**
79567
- * Create a new Managed Client. The API returns a result that includes the Managed Client ID.
79568
- * @summary Create a new Managed Client
79615
+ * Create a new managed client. The API returns a result that includes the managed client ID.
79616
+ * @summary Create Managed Client
79569
79617
  * @param {ManagedClientRequestV2024} managedClientRequestV2024
79570
79618
  * @param {*} [axiosOptions] Override http request option.
79571
79619
  * @throws {RequiredError}
@@ -79574,9 +79622,9 @@ export const ManagedClientsV2024ApiFactory = function (configuration?: Configura
79574
79622
  return localVarFp.createManagedClient(managedClientRequestV2024, axiosOptions).then((request) => request(axios, basePath));
79575
79623
  },
79576
79624
  /**
79577
- * Delete an existing Managed Client.
79578
- * @summary Delete a Managed Client
79579
- * @param {string} id Managed Client ID.
79625
+ * Delete an existing managed client.
79626
+ * @summary Delete Managed Client
79627
+ * @param {string} id Managed client ID.
79580
79628
  * @param {*} [axiosOptions] Override http request option.
79581
79629
  * @throws {RequiredError}
79582
79630
  */
@@ -79594,10 +79642,10 @@ export const ManagedClientsV2024ApiFactory = function (configuration?: Configura
79594
79642
  return localVarFp.getManagedClient(id, axiosOptions).then((request) => request(axios, basePath));
79595
79643
  },
79596
79644
  /**
79597
- * Retrieve the Status of a Managed Client by ID.
79598
- * @summary Get Managed Client Status.
79599
- * @param {string} id ID of the Managed Client to get Status of
79600
- * @param {ManagedClientTypeV2024} type Type of the Managed Client to get Status of
79645
+ * Get a managed client\'s status, using its ID.
79646
+ * @summary Get Managed Client Status
79647
+ * @param {string} id Managed client ID to get status for.
79648
+ * @param {ManagedClientTypeV2024} type Managed client type to get status for.
79601
79649
  * @param {*} [axiosOptions] Override http request option.
79602
79650
  * @throws {RequiredError}
79603
79651
  */
@@ -79605,7 +79653,7 @@ export const ManagedClientsV2024ApiFactory = function (configuration?: Configura
79605
79653
  return localVarFp.getManagedClientStatus(id, type, axiosOptions).then((request) => request(axios, basePath));
79606
79654
  },
79607
79655
  /**
79608
- * Get a list of Managed Clients.
79656
+ * List managed clients.
79609
79657
  * @summary Get Managed Clients
79610
79658
  * @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.
79611
79659
  * @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.
@@ -79618,10 +79666,10 @@ export const ManagedClientsV2024ApiFactory = function (configuration?: Configura
79618
79666
  return localVarFp.getManagedClients(offset, limit, count, filters, axiosOptions).then((request) => request(axios, basePath));
79619
79667
  },
79620
79668
  /**
79621
- * Update an existing Managed Client.
79622
- * @summary Update a Managed Client
79623
- * @param {string} id Managed Client ID.
79624
- * @param {Array<JsonPatchOperationV2024>} jsonPatchOperationV2024 The JSONPatch payload used to update the object.
79669
+ * Update an existing managed client.
79670
+ * @summary Update Managed Client
79671
+ * @param {string} id Managed client ID.
79672
+ * @param {Array<JsonPatchOperationV2024>} jsonPatchOperationV2024 JSONPatch payload used to update the object.
79625
79673
  * @param {*} [axiosOptions] Override http request option.
79626
79674
  * @throws {RequiredError}
79627
79675
  */
@@ -79652,7 +79700,7 @@ export interface ManagedClientsV2024ApiCreateManagedClientRequest {
79652
79700
  */
79653
79701
  export interface ManagedClientsV2024ApiDeleteManagedClientRequest {
79654
79702
  /**
79655
- * Managed Client ID.
79703
+ * Managed client ID.
79656
79704
  * @type {string}
79657
79705
  * @memberof ManagedClientsV2024ApiDeleteManagedClient
79658
79706
  */
@@ -79680,14 +79728,14 @@ export interface ManagedClientsV2024ApiGetManagedClientRequest {
79680
79728
  */
79681
79729
  export interface ManagedClientsV2024ApiGetManagedClientStatusRequest {
79682
79730
  /**
79683
- * ID of the Managed Client to get Status of
79731
+ * Managed client ID to get status for.
79684
79732
  * @type {string}
79685
79733
  * @memberof ManagedClientsV2024ApiGetManagedClientStatus
79686
79734
  */
79687
79735
  readonly id: string
79688
79736
 
79689
79737
  /**
79690
- * Type of the Managed Client to get Status of
79738
+ * Managed client type to get status for.
79691
79739
  * @type {ManagedClientTypeV2024}
79692
79740
  * @memberof ManagedClientsV2024ApiGetManagedClientStatus
79693
79741
  */
@@ -79736,14 +79784,14 @@ export interface ManagedClientsV2024ApiGetManagedClientsRequest {
79736
79784
  */
79737
79785
  export interface ManagedClientsV2024ApiUpdateManagedClientRequest {
79738
79786
  /**
79739
- * Managed Client ID.
79787
+ * Managed client ID.
79740
79788
  * @type {string}
79741
79789
  * @memberof ManagedClientsV2024ApiUpdateManagedClient
79742
79790
  */
79743
79791
  readonly id: string
79744
79792
 
79745
79793
  /**
79746
- * The JSONPatch payload used to update the object.
79794
+ * JSONPatch payload used to update the object.
79747
79795
  * @type {Array<JsonPatchOperationV2024>}
79748
79796
  * @memberof ManagedClientsV2024ApiUpdateManagedClient
79749
79797
  */
@@ -79758,8 +79806,8 @@ export interface ManagedClientsV2024ApiUpdateManagedClientRequest {
79758
79806
  */
79759
79807
  export class ManagedClientsV2024Api extends BaseAPI {
79760
79808
  /**
79761
- * Create a new Managed Client. The API returns a result that includes the Managed Client ID.
79762
- * @summary Create a new Managed Client
79809
+ * Create a new managed client. The API returns a result that includes the managed client ID.
79810
+ * @summary Create Managed Client
79763
79811
  * @param {ManagedClientsV2024ApiCreateManagedClientRequest} requestParameters Request parameters.
79764
79812
  * @param {*} [axiosOptions] Override http request option.
79765
79813
  * @throws {RequiredError}
@@ -79770,8 +79818,8 @@ export class ManagedClientsV2024Api extends BaseAPI {
79770
79818
  }
79771
79819
 
79772
79820
  /**
79773
- * Delete an existing Managed Client.
79774
- * @summary Delete a Managed Client
79821
+ * Delete an existing managed client.
79822
+ * @summary Delete Managed Client
79775
79823
  * @param {ManagedClientsV2024ApiDeleteManagedClientRequest} requestParameters Request parameters.
79776
79824
  * @param {*} [axiosOptions] Override http request option.
79777
79825
  * @throws {RequiredError}
@@ -79794,8 +79842,8 @@ export class ManagedClientsV2024Api extends BaseAPI {
79794
79842
  }
79795
79843
 
79796
79844
  /**
79797
- * Retrieve the Status of a Managed Client by ID.
79798
- * @summary Get Managed Client Status.
79845
+ * Get a managed client\'s status, using its ID.
79846
+ * @summary Get Managed Client Status
79799
79847
  * @param {ManagedClientsV2024ApiGetManagedClientStatusRequest} requestParameters Request parameters.
79800
79848
  * @param {*} [axiosOptions] Override http request option.
79801
79849
  * @throws {RequiredError}
@@ -79806,7 +79854,7 @@ export class ManagedClientsV2024Api extends BaseAPI {
79806
79854
  }
79807
79855
 
79808
79856
  /**
79809
- * Get a list of Managed Clients.
79857
+ * List managed clients.
79810
79858
  * @summary Get Managed Clients
79811
79859
  * @param {ManagedClientsV2024ApiGetManagedClientsRequest} requestParameters Request parameters.
79812
79860
  * @param {*} [axiosOptions] Override http request option.
@@ -79818,8 +79866,8 @@ export class ManagedClientsV2024Api extends BaseAPI {
79818
79866
  }
79819
79867
 
79820
79868
  /**
79821
- * Update an existing Managed Client.
79822
- * @summary Update a Managed Client
79869
+ * Update an existing managed client.
79870
+ * @summary Update Managed Client
79823
79871
  * @param {ManagedClientsV2024ApiUpdateManagedClientRequest} requestParameters Request parameters.
79824
79872
  * @param {*} [axiosOptions] Override http request option.
79825
79873
  * @throws {RequiredError}
@@ -87139,7 +87187,7 @@ export const PasswordManagementV2024ApiAxiosParamCreator = function (configurati
87139
87187
  };
87140
87188
  },
87141
87189
  /**
87142
- * 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.
87190
+ * 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.
87143
87191
  * @summary Set Identity\'s Password
87144
87192
  * @param {PasswordChangeRequestV2024} passwordChangeRequestV2024
87145
87193
  * @param {*} [axiosOptions] Override http request option.
@@ -87223,7 +87271,7 @@ export const PasswordManagementV2024ApiFp = function(configuration?: Configurati
87223
87271
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
87224
87272
  },
87225
87273
  /**
87226
- * 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.
87274
+ * 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.
87227
87275
  * @summary Set Identity\'s Password
87228
87276
  * @param {PasswordChangeRequestV2024} passwordChangeRequestV2024
87229
87277
  * @param {*} [axiosOptions] Override http request option.
@@ -87275,7 +87323,7 @@ export const PasswordManagementV2024ApiFactory = function (configuration?: Confi
87275
87323
  return localVarFp.queryPasswordInfo(passwordInfoQueryDTOV2024, axiosOptions).then((request) => request(axios, basePath));
87276
87324
  },
87277
87325
  /**
87278
- * 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.
87326
+ * 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.
87279
87327
  * @summary Set Identity\'s Password
87280
87328
  * @param {PasswordChangeRequestV2024} passwordChangeRequestV2024
87281
87329
  * @param {*} [axiosOptions] Override http request option.
@@ -87394,7 +87442,7 @@ export class PasswordManagementV2024Api extends BaseAPI {
87394
87442
  }
87395
87443
 
87396
87444
  /**
87397
- * 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.
87445
+ * 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.
87398
87446
  * @summary Set Identity\'s Password
87399
87447
  * @param {PasswordManagementV2024ApiSetPasswordRequest} requestParameters Request parameters.
87400
87448
  * @param {*} [axiosOptions] Override http request option.
@@ -98063,7 +98111,7 @@ export const SearchV2024ApiAxiosParamCreator = function (configuration?: Configu
98063
98111
  };
98064
98112
  },
98065
98113
  /**
98066
- * 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.
98114
+ * 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.
98067
98115
  * @summary Perform Search
98068
98116
  * @param {SearchV2024} searchV2024
98069
98117
  * @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.
@@ -98169,7 +98217,7 @@ export const SearchV2024ApiFp = function(configuration?: Configuration) {
98169
98217
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
98170
98218
  },
98171
98219
  /**
98172
- * 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.
98220
+ * 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.
98173
98221
  * @summary Perform Search
98174
98222
  * @param {SearchV2024} searchV2024
98175
98223
  * @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.
@@ -98227,7 +98275,7 @@ export const SearchV2024ApiFactory = function (configuration?: Configuration, ba
98227
98275
  return localVarFp.searchGet(index, id, axiosOptions).then((request) => request(axios, basePath));
98228
98276
  },
98229
98277
  /**
98230
- * 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.
98278
+ * 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.
98231
98279
  * @summary Perform Search
98232
98280
  * @param {SearchV2024} searchV2024
98233
98281
  * @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.
@@ -98391,7 +98439,7 @@ export class SearchV2024Api extends BaseAPI {
98391
98439
  }
98392
98440
 
98393
98441
  /**
98394
- * 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.
98442
+ * 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.
98395
98443
  * @summary Perform Search
98396
98444
  * @param {SearchV2024ApiSearchPostRequest} requestParameters Request parameters.
98397
98445
  * @param {*} [axiosOptions] Override http request option.