Update to python SDK docs: 13995602131

This commit is contained in:
developer-relations-sp
2025-03-21 15:48:51 +00:00
parent 5109bc43f7
commit 7c85cb6669
213 changed files with 20334 additions and 23488 deletions

View File

@@ -82,7 +82,6 @@ from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_potential_role_provision_request import RoleMiningPotentialRoleProvisionRequest
from sailpoint.beta.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -107,7 +106,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).create_potential_role_provision_request(session_id, potential_role_id, min_entitlement_popularity, include_common_access, new_role_mining_potential_role_provision_request)
print("The response of IAIRoleMiningApi->create_potential_role_provision_request:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->create_potential_role_provision_request: %s\n" % e)
```
@@ -152,7 +151,6 @@ from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_session_dto import RoleMiningSessionDto
from sailpoint.beta.models.role_mining_session_response import RoleMiningSessionResponse
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -198,7 +196,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).create_role_mining_sessions(new_role_mining_session_dto)
print("The response of IAIRoleMiningApi->create_role_mining_sessions:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->create_role_mining_sessions: %s\n" % e)
```
@@ -242,7 +240,6 @@ Code | Description | Data Type | Response headers |
```python
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -259,7 +256,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).download_role_mining_potential_role_zip(session_id, potential_role_id, export_id)
print("The response of IAIRoleMiningApi->download_role_mining_potential_role_zip:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->download_role_mining_potential_role_zip: %s\n" % e)
```
@@ -302,7 +299,6 @@ Code | Description | Data Type | Response headers |
```python
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -318,7 +314,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).export_role_mining_potential_role(session_id, potential_role_id)
print("The response of IAIRoleMiningApi->export_role_mining_potential_role:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role: %s\n" % e)
```
@@ -364,7 +360,6 @@ from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_potential_role_export_request import RoleMiningPotentialRoleExportRequest
from sailpoint.beta.models.role_mining_potential_role_export_response import RoleMiningPotentialRoleExportResponse
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -384,7 +379,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_async(session_id, potential_role_id, new_role_mining_potential_role_export_request)
print("The response of IAIRoleMiningApi->export_role_mining_potential_role_async:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_async: %s\n" % e)
```
@@ -429,7 +424,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_potential_role_export_response import RoleMiningPotentialRoleExportResponse
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -446,7 +440,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_status(session_id, potential_role_id, export_id)
print("The response of IAIRoleMiningApi->export_role_mining_potential_role_status:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_status: %s\n" % e)
```
@@ -494,7 +488,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -513,7 +506,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(sorters, filters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e)
```
@@ -557,7 +550,6 @@ Code | Description | Data Type | Response headers |
```python
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -574,7 +566,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_entitlement_distribution_potential_role(session_id, potential_role_id, include_common_access)
print("The response of IAIRoleMiningApi->get_entitlement_distribution_potential_role:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_entitlement_distribution_potential_role: %s\n" % e)
```
@@ -625,7 +617,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_entitlement import RoleMiningEntitlement
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -647,7 +638,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, include_common_access, sorters, filters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e)
```
@@ -696,7 +687,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_entitlement import RoleMiningEntitlement
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -717,7 +707,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e)
```
@@ -766,7 +756,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_identity import RoleMiningIdentity
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -787,7 +776,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_identities_potential_role:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e)
```
@@ -832,7 +821,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_potential_role import RoleMiningPotentialRole
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -848,7 +836,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_potential_role(session_id, potential_role_id)
print("The response of IAIRoleMiningApi->get_potential_role:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_potential_role: %s\n" % e)
```
@@ -897,7 +885,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_potential_role_application import RoleMiningPotentialRoleApplication
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -917,7 +904,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, filters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_potential_role_applications:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e)
```
@@ -966,7 +953,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_potential_role_entitlements import RoleMiningPotentialRoleEntitlements
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -986,7 +972,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, filters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e)
```
@@ -1035,7 +1021,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_potential_role_source_usage import RoleMiningPotentialRoleSourceUsage
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -1055,7 +1040,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, sorters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e)
```
@@ -1104,7 +1089,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -1124,7 +1108,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, sorters, filters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e)
```
@@ -1168,7 +1152,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_potential_role import RoleMiningPotentialRole
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -1183,7 +1166,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_role_mining_potential_role(potential_role_id)
print("The response of IAIRoleMiningApi->get_role_mining_potential_role:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_role_mining_potential_role: %s\n" % e)
```
@@ -1228,7 +1211,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_session_response import RoleMiningSessionResponse
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -1243,7 +1225,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_role_mining_session(session_id)
print("The response of IAIRoleMiningApi->get_role_mining_session:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_role_mining_session: %s\n" % e)
```
@@ -1286,7 +1268,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_session_status import RoleMiningSessionStatus
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -1301,7 +1282,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_role_mining_session_status(session_id)
print("The response of IAIRoleMiningApi->get_role_mining_session_status:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_role_mining_session_status: %s\n" % e)
```
@@ -1349,7 +1330,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_session_response import RoleMiningSessionResponse
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -1368,7 +1348,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_role_mining_sessions(filters, sorters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e)
```
@@ -1415,7 +1395,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_session_draft_role_dto import RoleMiningSessionDraftRoleDto
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -1433,7 +1412,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_saved_potential_roles(sorters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e)
```
@@ -1492,7 +1471,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.patch_potential_role_request_inner import PatchPotentialRoleRequestInner
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -1509,7 +1487,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).patch_potential_role(session_id, potential_role_id, new_patch_potential_role_request_inner)
print("The response of IAIRoleMiningApi->patch_potential_role:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->patch_potential_role: %s\n" % e)
```
@@ -1567,7 +1545,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.patch_potential_role_request_inner import PatchPotentialRoleRequestInner
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -1583,7 +1560,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).patch_role_mining_potential_role(potential_role_id, new_patch_potential_role_request_inner)
print("The response of IAIRoleMiningApi->patch_role_mining_potential_role:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->patch_role_mining_potential_role: %s\n" % e)
```
@@ -1629,7 +1606,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -1645,7 +1621,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).patch_role_mining_session(session_id, new_json_patch_operation)
print("The response of IAIRoleMiningApi->patch_role_mining_session:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->patch_role_mining_session: %s\n" % e)
```
@@ -1691,7 +1667,6 @@ from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_potential_role import RoleMiningPotentialRole
from sailpoint.beta.models.role_mining_potential_role_edit_entitlements import RoleMiningPotentialRoleEditEntitlements
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -1711,7 +1686,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).update_entitlements_potential_role(session_id, potential_role_id, new_role_mining_potential_role_edit_entitlements)
print("The response of IAIRoleMiningApi->update_entitlements_potential_role:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IAIRoleMiningApi->update_entitlements_potential_role: %s\n" % e)
```