LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to python SDK docs: 13820107626

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-12 19:41:45 +00:00
parent 184517209d
commit 113200f5fe
221 changed files with 8723 additions and 7883 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
docs/tools/sdk/python/Reference/Beta/Methods/IAIOutliersApi.md
View File

@@ -61,25 +61,25 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
try:
# IAI Identity Outliers Export
results =IAIOutliersApi(api_client).export_outliers_zip()
results = IAIOutliersApi(api_client).export_outliers_zip()
# Below is a request that includes all optional parameters
# results = IAIOutliersApi(api_client).export_outliers_zip(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)
```
@@ -124,7 +124,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.outlier_summary import OutlierSummary
@@ -132,6 +131,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
offset = 0 # int | 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. (optional) (default to 0) # int | 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. (optional) (default to 0)
@@ -142,12 +142,12 @@ with ApiClient(configuration) as api_client:
try:
# IAI Identity Outliers Summary
results =IAIOutliersApi(api_client).get_identity_outlier_snapshots()
results = IAIOutliersApi(api_client).get_identity_outlier_snapshots()
# Below is a request that includes all optional parameters
# results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(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)
```
@@ -192,7 +192,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.outlier import Outlier
@@ -200,6 +199,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
offset = 0 # int | 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. (optional) (default to 0) # int | 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. (optional) (default to 0)
@@ -211,12 +211,12 @@ with ApiClient(configuration) as api_client:
try:
# IAI Get Identity Outliers
results =IAIOutliersApi(api_client).get_identity_outliers()
results = IAIOutliersApi(api_client).get_identity_outliers()
# Below is a request that includes all optional parameters
# results = IAIOutliersApi(api_client).get_identity_outliers(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)
```
@@ -257,7 +257,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.latest_outlier_summary import LatestOutlierSummary
@@ -265,18 +264,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
try:
# IAI Identity Outliers Latest Summary
results =IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots()
results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots()
# Below is a request that includes all optional parameters
# results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(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)
```
@@ -320,7 +320,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.outlier_feature_summary import OutlierFeatureSummary
@@ -328,18 +327,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
outlier_feature_id = '04654b66-7561-4090-94f9-abee0722a1af' # str | Contributing feature id # str | Contributing feature id
try:
# Get identity outlier contibuting feature summary
results =IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id)
results = IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id=outlier_feature_id)
# Below is a request that includes all optional parameters
# results = IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id)
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)
```
@@ -388,7 +388,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.outlier_contributing_feature import OutlierContributingFeature
@@ -396,6 +395,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id
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)
@@ -407,12 +407,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, )
results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id=outlier_id)
# Below is a request that includes all optional parameters
# results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, 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)
```
@@ -452,26 +452,23 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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(new_request_body)
new_request_body = RequestBody.from_json(request_body)
IAIOutliersApi(api_client).ignore_identity_outliers(request_body=new_request_body)
# Below is a request that includes all optional parameters
# IAIOutliersApi(api_client).ignore_identity_outliers(new_request_body)
except Exception as e:
except Exception as e:
print("Exception when calling IAIOutliersApi->ignore_identity_outliers: %s\n" % e)
```
@@ -521,7 +518,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.outliers_contributing_feature_access_items import OutliersContributingFeatureAccessItems
@@ -529,6 +525,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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
@@ -541,12 +538,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, )
results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id=outlier_id, contributing_feature_name=contributing_feature_name)
# Below is a request that includes all optional parameters
# results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, 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)
```
@@ -586,26 +583,23 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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(new_request_body)
new_request_body = RequestBody.from_json(request_body)
IAIOutliersApi(api_client).un_ignore_identity_outliers(request_body=new_request_body)
# Below is a request that includes all optional parameters
# IAIOutliersApi(api_client).un_ignore_identity_outliers(new_request_body)
except Exception as e:
except Exception as e:
print("Exception when calling IAIOutliersApi->un_ignore_identity_outliers: %s\n" % e)
```