Update to python SDK docs: 13820107626

2025-12-09 12:27:47 +00:00 · 2025-03-12 19:41:45 +00:00
parent 184517209d
commit 113200f5fe
221 changed files with 8723 additions and 7883 deletions
--- a/docs/tools/sdk/python/Reference/V2024/Methods/IAIOutliersApi.md
+++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIOutliersApi.md
@@ -30,6 +30,14 @@ Method | HTTP request | Description
 :::warning experimental 
 This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
 :::
+:::tip setting x-sailpoint-experimental header
+ on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
+ Example:
+ ```python
+   configuration = Configuration()
+   configuration.experimental = True
+ ```
+:::
 IAI Identity Outliers Export
 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.

@@ -65,13 +73,14 @@ Code | Description  | Data Type | Response headers |
 ### Example

 ```python
-import sailpoint.v2024
 from sailpoint.v2024.api.iai_outliers_api import IAIOutliersApi
 from sailpoint.v2024.api_client import ApiClient
 from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

+configuration.experimental = true
+
 with ApiClient(configuration) as api_client:
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    type = 'LOW_SIMILARITY' # str | Type of the identity outliers snapshot to filter on (optional) # str | Type of the identity outliers snapshot to filter on (optional)
@@ -79,12 +88,12 @@ with ApiClient(configuration) as api_client:
    try:
        # IAI Identity Outliers Export
        
-        results =IAIOutliersApi(api_client).export_outliers_zip(x_sail_point_experimental, )
+        results = IAIOutliersApi(api_client).export_outliers_zip(x_sail_point_experimental=x_sail_point_experimental)
        # Below is a request that includes all optional parameters
        # results = IAIOutliersApi(api_client).export_outliers_zip(x_sail_point_experimental, type)
        print("The response of IAIOutliersApi->export_outliers_zip:\n")
        pprint(results)
-        except Exception as e:
+    except Exception as e:
        print("Exception when calling IAIOutliersApi->export_outliers_zip: %s\n" % e)
 ```

@@ -96,6 +105,14 @@ with ApiClient(configuration) as api_client:
 :::warning experimental 
 This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
 :::
+:::tip setting x-sailpoint-experimental header
+ on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
+ Example:
+ ```python
+   configuration = Configuration()
+   configuration.experimental = True
+ ```
+:::
 IAI Identity Outliers Summary
 This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier.

@@ -133,7 +150,6 @@ Code | Description  | Data Type | Response headers |
 ### Example

 ```python
-import sailpoint.v2024
 from sailpoint.v2024.api.iai_outliers_api import IAIOutliersApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.outlier_summary import OutlierSummary
@@ -141,6 +157,8 @@ from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

+configuration.experimental = true
+
 with ApiClient(configuration) as api_client:
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
@@ -152,12 +170,12 @@ with ApiClient(configuration) as api_client:
    try:
        # IAI Identity Outliers Summary
        
-        results =IAIOutliersApi(api_client).get_identity_outlier_snapshots(x_sail_point_experimental, )
+        results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(x_sail_point_experimental=x_sail_point_experimental)
        # Below is a request that includes all optional parameters
        # results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(x_sail_point_experimental, limit, offset, type, filters, sorters)
        print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n")
        pprint(results)
-        except Exception as e:
+    except Exception as e:
        print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e)
 ```

@@ -169,6 +187,14 @@ with ApiClient(configuration) as api_client:
 :::warning experimental 
 This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
 :::
+:::tip setting x-sailpoint-experimental header
+ on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
+ Example:
+ ```python
+   configuration = Configuration()
+   configuration.experimental = True
+ ```
+:::
 IAI Get Identity Outliers
 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.

@@ -206,7 +232,6 @@ Code | Description  | Data Type | Response headers |
 ### Example

 ```python
-import sailpoint.v2024
 from sailpoint.v2024.api.iai_outliers_api import IAIOutliersApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.outlier import Outlier
@@ -214,6 +239,8 @@ from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

+configuration.experimental = true
+
 with ApiClient(configuration) as api_client:
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
@@ -226,12 +253,12 @@ with ApiClient(configuration) as api_client:
    try:
        # IAI Get Identity Outliers
        
-        results =IAIOutliersApi(api_client).get_identity_outliers(x_sail_point_experimental, )
+        results = IAIOutliersApi(api_client).get_identity_outliers(x_sail_point_experimental=x_sail_point_experimental)
        # Below is a request that includes all optional parameters
        # results = IAIOutliersApi(api_client).get_identity_outliers(x_sail_point_experimental, limit, offset, count, type, filters, sorters)
        print("The response of IAIOutliersApi->get_identity_outliers:\n")
        pprint(results)
-        except Exception as e:
+    except Exception as e:
        print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e)
 ```

@@ -243,6 +270,14 @@ with ApiClient(configuration) as api_client:
 :::warning experimental 
 This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
 :::
+:::tip setting x-sailpoint-experimental header
+ on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
+ Example:
+ ```python
+   configuration = Configuration()
+   configuration.experimental = True
+ ```
+:::
 IAI Identity Outliers Latest Summary
 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.

@@ -276,7 +311,6 @@ Code | Description  | Data Type | Response headers |
 ### Example

 ```python
-import sailpoint.v2024
 from sailpoint.v2024.api.iai_outliers_api import IAIOutliersApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.latest_outlier_summary import LatestOutlierSummary
@@ -284,6 +318,8 @@ from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

+configuration.experimental = true
+
 with ApiClient(configuration) as api_client:
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    type = 'LOW_SIMILARITY' # str | Type of the identity outliers snapshot to filter on (optional) # str | Type of the identity outliers snapshot to filter on (optional)
@@ -291,12 +327,12 @@ with ApiClient(configuration) as api_client:
    try:
        # IAI Identity Outliers Latest Summary
        
-        results =IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(x_sail_point_experimental, )
+        results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(x_sail_point_experimental=x_sail_point_experimental)
        # Below is a request that includes all optional parameters
        # results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(x_sail_point_experimental, type)
        print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n")
        pprint(results)
-        except Exception as e:
+    except Exception as e:
        print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e)
 ```

@@ -308,6 +344,14 @@ with ApiClient(configuration) as api_client:
 :::warning experimental 
 This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
 :::
+:::tip setting x-sailpoint-experimental header
+ on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
+ Example:
+ ```python
+   configuration = Configuration()
+   configuration.experimental = True
+ ```
+:::
 Get identity outlier contibuting feature summary
 This API returns a summary of a contributing feature for an identity outlier.

@@ -344,7 +388,6 @@ Code | Description  | Data Type | Response headers |
 ### Example

 ```python
-import sailpoint.v2024
 from sailpoint.v2024.api.iai_outliers_api import IAIOutliersApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.outlier_feature_summary import OutlierFeatureSummary
@@ -352,6 +395,8 @@ from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

+configuration.experimental = true
+
 with ApiClient(configuration) as api_client:
    outlier_feature_id = '04654b66-7561-4090-94f9-abee0722a1af' # str | Contributing feature id # str | Contributing feature id
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
@@ -359,12 +404,12 @@ with ApiClient(configuration) as api_client:
    try:
        # Get identity outlier contibuting feature summary
        
-        results =IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id, x_sail_point_experimental)
+        results = IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id=outlier_feature_id, x_sail_point_experimental=x_sail_point_experimental)
        # Below is a request that includes all optional parameters
        # results = IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id, x_sail_point_experimental)
        print("The response of IAIOutliersApi->get_outlier_contributing_feature_summary:\n")
        pprint(results)
-        except Exception as e:
+    except Exception as e:
        print("Exception when calling IAIOutliersApi->get_outlier_contributing_feature_summary: %s\n" % e)
 ```

@@ -376,6 +421,14 @@ with ApiClient(configuration) as api_client:
 :::warning experimental 
 This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
 :::
+:::tip setting x-sailpoint-experimental header
+ on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
+ Example:
+ ```python
+   configuration = Configuration()
+   configuration.experimental = True
+ ```
+:::
 Get identity outlier's contibuting features
 This API returns a list of contributing feature objects for a single outlier.

@@ -417,7 +470,6 @@ Code | Description  | Data Type | Response headers |
 ### Example

 ```python
-import sailpoint.v2024
 from sailpoint.v2024.api.iai_outliers_api import IAIOutliersApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.outlier_contributing_feature import OutlierContributingFeature
@@ -425,6 +477,8 @@ from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

+configuration.experimental = true
+
 with ApiClient(configuration) as api_client:
    outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
@@ -437,12 +491,12 @@ with ApiClient(configuration) as api_client:
    try:
        # Get identity outlier's contibuting features
        
-        results =IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, x_sail_point_experimental, )
+        results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id=outlier_id, x_sail_point_experimental=x_sail_point_experimental)
        # Below is a request that includes all optional parameters
        # results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, x_sail_point_experimental, limit, offset, count, include_translation_messages, sorters)
        print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n")
        pprint(results)
-        except Exception as e:
+    except Exception as e:
        print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e)
 ```

@@ -454,6 +508,14 @@ with ApiClient(configuration) as api_client:
 :::warning experimental 
 This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
 :::
+:::tip setting x-sailpoint-experimental header
+ on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
+ Example:
+ ```python
+   configuration = Configuration()
+   configuration.experimental = True
+ ```
+:::
 IAI Identity Outliers Ignore
 This API receives a list of identity IDs in the request, changes the outliers to be ignored.

@@ -486,27 +548,25 @@ Code | Description  | Data Type | Response headers |
 ### Example

 ```python
-import sailpoint.v2024
 from sailpoint.v2024.api.iai_outliers_api import IAIOutliersApi
 from sailpoint.v2024.api_client import ApiClient
 from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

+configuration.experimental = true
+
 with ApiClient(configuration) as api_client:
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
-    request_body = ['request_body_example'] # List[str] | 
-     request_body = ['request_body_example'] # List[str] | 
-    
+    request_body = '''['request_body_example']''' # List[str] | 

    try:
        # IAI Identity Outliers Ignore
-        new_request_body = RequestBody()
-        new_request_body.from_json(request_body)
-        IAIOutliersApi(api_client).ignore_identity_outliers(x_sail_point_experimental, new_request_body)
+        new_request_body = RequestBody.from_json(request_body)
+        IAIOutliersApi(api_client).ignore_identity_outliers(x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body)
        # Below is a request that includes all optional parameters
        # IAIOutliersApi(api_client).ignore_identity_outliers(x_sail_point_experimental, new_request_body)
-        except Exception as e:
+    except Exception as e:
        print("Exception when calling IAIOutliersApi->ignore_identity_outliers: %s\n" % e)
 ```

@@ -518,6 +578,14 @@ with ApiClient(configuration) as api_client:
 :::warning experimental 
 This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
 :::
+:::tip setting x-sailpoint-experimental header
+ on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
+ Example:
+ ```python
+   configuration = Configuration()
+   configuration.experimental = True
+ ```
+:::
 Gets a list of access items associated with each identity outlier contributing feature
 This API returns a list of the enriched access items associated with each feature filtered by the access item type.

@@ -560,7 +628,6 @@ Code | Description  | Data Type | Response headers |
 ### Example

 ```python
-import sailpoint.v2024
 from sailpoint.v2024.api.iai_outliers_api import IAIOutliersApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.outliers_contributing_feature_access_items import OutliersContributingFeatureAccessItems
@@ -568,6 +635,8 @@ from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

+configuration.experimental = true
+
 with ApiClient(configuration) as api_client:
    outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id
    contributing_feature_name = 'entitlement_count' # str | The name of contributing feature # str | The name of contributing feature
@@ -581,12 +650,12 @@ with ApiClient(configuration) as api_client:
    try:
        # Gets a list of access items associated with each identity outlier contributing feature
        
-        results =IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, x_sail_point_experimental, )
+        results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id=outlier_id, contributing_feature_name=contributing_feature_name, x_sail_point_experimental=x_sail_point_experimental)
        # Below is a request that includes all optional parameters
        # results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, x_sail_point_experimental, limit, offset, count, access_type, sorters)
        print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n")
        pprint(results)
-        except Exception as e:
+    except Exception as e:
        print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e)
 ```

@@ -598,6 +667,14 @@ with ApiClient(configuration) as api_client:
 :::warning experimental 
 This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
 :::
+:::tip setting x-sailpoint-experimental header
+ on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
+ Example:
+ ```python
+   configuration = Configuration()
+   configuration.experimental = True
+ ```
+:::
 IAI Identity Outliers Unignore
 This API receives a list of identity IDs in the request, changes the outliers to be un-ignored.

@@ -630,27 +707,25 @@ Code | Description  | Data Type | Response headers |
 ### Example

 ```python
-import sailpoint.v2024
 from sailpoint.v2024.api.iai_outliers_api import IAIOutliersApi
 from sailpoint.v2024.api_client import ApiClient
 from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

+configuration.experimental = true
+
 with ApiClient(configuration) as api_client:
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
-    request_body = ['request_body_example'] # List[str] | 
-     request_body = ['request_body_example'] # List[str] | 
-    
+    request_body = '''['request_body_example']''' # List[str] | 

    try:
        # IAI Identity Outliers Unignore
-        new_request_body = RequestBody()
-        new_request_body.from_json(request_body)
-        IAIOutliersApi(api_client).un_ignore_identity_outliers(x_sail_point_experimental, new_request_body)
+        new_request_body = RequestBody.from_json(request_body)
+        IAIOutliersApi(api_client).un_ignore_identity_outliers(x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body)
        # Below is a request that includes all optional parameters
        # IAIOutliersApi(api_client).un_ignore_identity_outliers(x_sail_point_experimental, new_request_body)
-        except Exception as e:
+    except Exception as e:
        print("Exception when calling IAIOutliersApi->un_ignore_identity_outliers: %s\n" % e)
 ```