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

update layout for method examples

Browse Source
This commit is contained in:
darrell-thobe-sp
2025-02-25 11:46:14 -05:00
parent a4e2ab4717
commit aa76768244
208 changed files with 14924 additions and 9712 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md
View File

@@ -68,23 +68,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_model_metadata_api import AccessModelMetadataApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.attribute_dto import AttributeDTO
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
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')
try:
# Get Access Model Metadata Attribute
api_response = api_instance.get_access_model_metadata_attribute(key, x_sail_point_experimental)
results =AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_access_model_metadata_attribute(key, x_sail_point_experimental)
# results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key, x_sail_point_experimental)
print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute: %s\n" % e)
```
@@ -130,10 +133,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_model_metadata_api import AccessModelMetadataApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.attribute_value_dto import AttributeValueDTO
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
value = 'public' # str | Technical name of the Attribute value. # str | Technical name of the Attribute value.
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')
@@ -141,13 +148,12 @@ from pprint import pprint
try:
# Get Access Model Metadata Value
api_response = api_instance.get_access_model_metadata_attribute_value(key, value, x_sail_point_experimental)
results =AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key, value, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_access_model_metadata_attribute_value(key, value, x_sail_point_experimental)
# results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key, value, x_sail_point_experimental)
print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute_value:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute_value: %s\n" % e)
```
@@ -192,23 +198,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_model_metadata_api import AccessModelMetadataApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.attribute_dto import AttributeDTO
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
filters = 'name eq \"Privacy\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional)
try:
# List Access Model Metadata Attributes
api_response = api_instance.list_access_model_metadata_attribute(x_sail_point_experimental, )
results =AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_access_model_metadata_attribute(x_sail_point_experimental, filters)
# results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental, filters)
print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e)
```
@@ -253,23 +262,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_model_metadata_api import AccessModelMetadataApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.attribute_value_dto import AttributeValueDTO
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
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')
try:
# List Access Model Metadata Values
api_response = api_instance.list_access_model_metadata_attribute_value(key, x_sail_point_experimental)
results =AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.list_access_model_metadata_attribute_value(key, x_sail_point_experimental)
# results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key, x_sail_point_experimental)
print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e)
```

130
docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md
View File

@@ -94,10 +94,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_profile import AccessProfile
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_profile = {
"owner" : {
"name" : "support",
@@ -186,14 +190,14 @@ from pprint import pprint
try:
# Create Access Profile
Result = access_profile.from_json(access_profile)
api_response = api_instance.create_access_profile(Result)
new_access_profile = AccessProfile()
new_access_profile.from_json(access_profile)
results =AccessProfilesApi(api_client).create_access_profile(new_access_profile)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_access_profile(Result)
# results = AccessProfilesApi(api_client).create_access_profile(new_access_profile)
print("The response of AccessProfilesApi->create_access_profile:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessProfilesApi->create_access_profile: %s\n" % e)
```
@@ -238,19 +242,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to delete # str | ID of the Access Profile to delete
try:
# Delete the specified Access Profile
api_instance.delete_access_profile(id)
AccessProfilesApi(api_client).delete_access_profile(id)
# Below is a request that includes all optional parameters
# api_instance.delete_access_profile(id)
except Exception as e:
# AccessProfilesApi(api_client).delete_access_profile(id)
except Exception as e:
print("Exception when calling AccessProfilesApi->delete_access_profile: %s\n" % e)
```
@@ -296,11 +303,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_profile_bulk_delete_request import AccessProfileBulkDeleteRequest
from sailpoint.v2024.models.access_profile_bulk_delete_response import AccessProfileBulkDeleteResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_profile_bulk_delete_request = {
"accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ],
"bestEffortOnly" : true
@@ -308,14 +319,14 @@ from pprint import pprint
try:
# Delete Access Profile(s)
Result = access_profile_bulk_delete_request.from_json(access_profile_bulk_delete_request)
api_response = api_instance.delete_access_profiles_in_bulk(Result)
new_access_profile_bulk_delete_request = AccessProfileBulkDeleteRequest()
new_access_profile_bulk_delete_request.from_json(access_profile_bulk_delete_request)
results =AccessProfilesApi(api_client).delete_access_profiles_in_bulk(new_access_profile_bulk_delete_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_access_profiles_in_bulk(Result)
# results = AccessProfilesApi(api_client).delete_access_profiles_in_bulk(new_access_profile_bulk_delete_request)
print("The response of AccessProfilesApi->delete_access_profiles_in_bulk:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessProfilesApi->delete_access_profiles_in_bulk: %s\n" % e)
```
@@ -356,22 +367,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_profile import AccessProfile
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Access Profile # str | ID of the Access Profile
try:
# Get an Access Profile
api_response = api_instance.get_access_profile(id)
results =AccessProfilesApi(api_client).get_access_profile(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_access_profile(id)
# results = AccessProfilesApi(api_client).get_access_profile(id)
print("The response of AccessProfilesApi->get_access_profile:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessProfilesApi->get_access_profile: %s\n" % e)
```
@@ -419,10 +433,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.entitlement import Entitlement
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121919ecca' # str | ID of the access profile containing the entitlements. # str | ID of the access profile containing the entitlements.
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)
@@ -433,13 +451,12 @@ from pprint import pprint
try:
# List Access Profile's Entitlements
api_response = api_instance.get_access_profile_entitlements(id, )
results =AccessProfilesApi(api_client).get_access_profile_entitlements(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_access_profile_entitlements(id, limit, offset, count, filters, sorters)
# results = AccessProfilesApi(api_client).get_access_profile_entitlements(id, limit, offset, count, filters, sorters)
print("The response of AccessProfilesApi->get_access_profile_entitlements:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e)
```
@@ -488,10 +505,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_profile import AccessProfile
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
for_subadmin = '8c190e6787aa4ed9a90bd9d5344523fb' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin. (optional) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin. (optional)
limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50)
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)
@@ -504,13 +525,12 @@ from pprint import pprint
try:
# List Access Profiles
api_response = api_instance.list_access_profiles()
results =AccessProfilesApi(api_client).list_access_profiles()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented)
# results = AccessProfilesApi(api_client).list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented)
print("The response of AccessProfilesApi->list_access_profiles:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e)
```
@@ -581,11 +601,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_profile import AccessProfile
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to patch # str | ID of the Access Profile to patch
[{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}] # List[JsonPatchOperation] |
json_patch_operation = {
@@ -597,14 +621,14 @@ from pprint import pprint
try:
# Patch a specified Access Profile
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_access_profile(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =AccessProfilesApi(api_client).patch_access_profile(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_access_profile(id, Result)
# results = AccessProfilesApi(api_client).patch_access_profile(id, new_json_patch_operation)
print("The response of AccessProfilesApi->patch_access_profile:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessProfilesApi->patch_access_profile: %s\n" % e)
```
@@ -656,11 +680,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_profile_bulk_update_request_inner import AccessProfileBulkUpdateRequestInner
from sailpoint.v2024.models.access_profile_update_item import AccessProfileUpdateItem
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}] # List[AccessProfileBulkUpdateRequestInner] |
access_profile_bulk_update_request_inner = [{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}] # List[AccessProfileBulkUpdateRequestInner] |
@@ -668,14 +696,14 @@ from pprint import pprint
try:
# Update Access Profile(s) requestable field.
Result = access_profile_bulk_update_request_inner.from_json(access_profile_bulk_update_request_inner)
api_response = api_instance.update_access_profiles_in_bulk(x_sail_point_experimental, Result)
new_access_profile_bulk_update_request_inner = AccessProfileBulkUpdateRequestInner()
new_access_profile_bulk_update_request_inner.from_json(access_profile_bulk_update_request_inner)
results =AccessProfilesApi(api_client).update_access_profiles_in_bulk(x_sail_point_experimental, new_access_profile_bulk_update_request_inner)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_access_profiles_in_bulk(x_sail_point_experimental, Result)
# results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(x_sail_point_experimental, new_access_profile_bulk_update_request_inner)
print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e)
```

111
docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestApprovalsApi.md
View File

@@ -76,10 +76,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.comment_dto import CommentDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID.
comment_dto = {
"created" : "2017-07-11T18:45:37.098Z",
@@ -94,13 +98,12 @@ from pprint import pprint
try:
# Approve Access Request Approval
api_response = api_instance.approve_access_request(approval_id, )
results =AccessRequestApprovalsApi(api_client).approve_access_request(approval_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.approve_access_request(approval_id, Result)
# results = AccessRequestApprovalsApi(api_client).approve_access_request(approval_id, new_comment_dto)
print("The response of AccessRequestApprovalsApi->approve_access_request:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestApprovalsApi->approve_access_request: %s\n" % e)
```
@@ -143,10 +146,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.forward_approval_dto import ForwardApprovalDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID.
forward_approval_dto = {
"newOwnerId" : "2c91808568c529c60168cca6f90c1314",
@@ -155,14 +162,14 @@ from pprint import pprint
try:
# Forward Access Request Approval
Result = forward_approval_dto.from_json(forward_approval_dto)
api_response = api_instance.forward_access_request(approval_id, Result)
new_forward_approval_dto = ForwardApprovalDto()
new_forward_approval_dto.from_json(forward_approval_dto)
results =AccessRequestApprovalsApi(api_client).forward_access_request(approval_id, new_forward_approval_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.forward_access_request(approval_id, Result)
# results = AccessRequestApprovalsApi(api_client).forward_access_request(approval_id, new_forward_approval_dto)
print("The response of AccessRequestApprovalsApi->forward_access_request:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestApprovalsApi->forward_access_request: %s\n" % e)
```
@@ -204,23 +211,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.approval_summary import ApprovalSummary
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = '2c91808568c529c60168cca6f90c1313' # str | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # str | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional)
from_date = 'from-date=2020-03-19T19:59:11Z' # str | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) # str | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional)
try:
# Get Access Requests Approvals Number
api_response = api_instance.get_access_request_approval_summary()
results =AccessRequestApprovalsApi(api_client).get_access_request_approval_summary()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_access_request_approval_summary(owner_id, from_date)
# results = AccessRequestApprovalsApi(api_client).get_access_request_approval_summary(owner_id, from_date)
print("The response of AccessRequestApprovalsApi->get_access_request_approval_summary:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestApprovalsApi->get_access_request_approval_summary: %s\n" % e)
```
@@ -266,10 +276,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_request_approvers_list_response import AccessRequestApproversListResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_request_id = '2c91808568c529c60168cca6f90c1313' # str | Access Request ID. # str | Access Request ID.
limit = 250 # int | Max number of results to return. (optional) (default to 250) # int | Max number of results to return. (optional) (default to 250)
offset = 10 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional)
@@ -278,13 +292,12 @@ from pprint import pprint
try:
# Access Request Approvers
api_response = api_instance.list_access_request_approvers(access_request_id, )
results =AccessRequestApprovalsApi(api_client).list_access_request_approvers(access_request_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_access_request_approvers(access_request_id, limit, offset, count)
# results = AccessRequestApprovalsApi(api_client).list_access_request_approvers(access_request_id, limit, offset, count)
print("The response of AccessRequestApprovalsApi->list_access_request_approvers:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestApprovalsApi->list_access_request_approvers: %s\n" % e)
```
@@ -330,10 +343,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.completed_approval import CompletedApproval
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = '2c91808568c529c60168cca6f90c1313' # str | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # str | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional)
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)
@@ -344,13 +361,12 @@ from pprint import pprint
try:
# Completed Access Request Approvals List
api_response = api_instance.list_completed_approvals()
results =AccessRequestApprovalsApi(api_client).list_completed_approvals()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_completed_approvals(owner_id, limit, offset, count, filters, sorters)
# results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters)
print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e)
```
@@ -396,10 +412,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.pending_approval import PendingApproval
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = '2c91808568c529c60168cca6f90c1313' # str | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # str | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional)
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)
@@ -410,13 +430,12 @@ from pprint import pprint
try:
# Pending Access Request Approvals List
api_response = api_instance.list_pending_approvals()
results =AccessRequestApprovalsApi(api_client).list_pending_approvals()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_pending_approvals(owner_id, limit, offset, count, filters, sorters)
# results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters)
print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e)
```
@@ -459,10 +478,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.comment_dto import CommentDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID.
comment_dto = {
"created" : "2017-07-11T18:45:37.098Z",
@@ -476,14 +499,14 @@ from pprint import pprint
try:
# Reject Access Request Approval
Result = comment_dto.from_json(comment_dto)
api_response = api_instance.reject_access_request(approval_id, Result)
new_comment_dto = CommentDto()
new_comment_dto.from_json(comment_dto)
results =AccessRequestApprovalsApi(api_client).reject_access_request(approval_id, new_comment_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.reject_access_request(approval_id, Result)
# results = AccessRequestApprovalsApi(api_client).reject_access_request(approval_id, new_comment_dto)
print("The response of AccessRequestApprovalsApi->reject_access_request:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestApprovalsApi->reject_access_request: %s\n" % e)
```

15
docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestIdentityMetricsApi.md
View File

@@ -61,9 +61,13 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.access_request_identity_metrics_api import AccessRequestIdentityMetricsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = '7025c863-c270-4ba6-beea-edf3cb091573' # str | Manager's identity ID. # str | Manager's identity ID.
requested_object_id = '2db501be-f0fb-4cc5-a695-334133c52891' # str | Requested access item's ID. # str | Requested access item's ID.
type = 'ENTITLEMENT' # str | Requested access item's type. # str | Requested access item's type.
@@ -72,13 +76,12 @@ from pprint import pprint
try:
# Return access request identity metrics
api_response = api_instance.get_access_request_identity_metrics(identity_id, requested_object_id, type, x_sail_point_experimental)
results =AccessRequestIdentityMetricsApi(api_client).get_access_request_identity_metrics(identity_id, requested_object_id, type, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_access_request_identity_metrics(identity_id, requested_object_id, type, x_sail_point_experimental)
# results = AccessRequestIdentityMetricsApi(api_client).get_access_request_identity_metrics(identity_id, requested_object_id, type, x_sail_point_experimental)
print("The response of AccessRequestIdentityMetricsApi->get_access_request_identity_metrics:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestIdentityMetricsApi->get_access_request_identity_metrics: %s\n" % e)
```

153
docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md
View File

@@ -75,10 +75,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.bulk_approve_access_request import BulkApproveAccessRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
bulk_approve_access_request = {
"comment" : "I approve these request items",
"approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ]
@@ -86,14 +90,14 @@ from pprint import pprint
try:
# Bulk Approve Access Request
Result = bulk_approve_access_request.from_json(bulk_approve_access_request)
api_response = api_instance.approve_bulk_access_request(Result)
new_bulk_approve_access_request = BulkApproveAccessRequest()
new_bulk_approve_access_request.from_json(bulk_approve_access_request)
results =AccessRequestsApi(api_client).approve_bulk_access_request(new_bulk_approve_access_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.approve_bulk_access_request(Result)
# results = AccessRequestsApi(api_client).approve_bulk_access_request(new_bulk_approve_access_request)
print("The response of AccessRequestsApi->approve_bulk_access_request:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestsApi->approve_bulk_access_request: %s\n" % e)
```
@@ -136,10 +140,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.cancel_access_request import CancelAccessRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
cancel_access_request = {
"accountActivityId" : "2c9180835d2e5168015d32f890ca1581",
"comment" : "I requested this role by mistake."
@@ -147,14 +155,14 @@ from pprint import pprint
try:
# Cancel Access Request
Result = cancel_access_request.from_json(cancel_access_request)
api_response = api_instance.cancel_access_request(Result)
new_cancel_access_request = CancelAccessRequest()
new_cancel_access_request.from_json(cancel_access_request)
results =AccessRequestsApi(api_client).cancel_access_request(new_cancel_access_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.cancel_access_request(Result)
# results = AccessRequestsApi(api_client).cancel_access_request(new_cancel_access_request)
print("The response of AccessRequestsApi->cancel_access_request:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e)
```
@@ -197,10 +205,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.bulk_cancel_access_request import BulkCancelAccessRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
bulk_cancel_access_request = {
"accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ],
"comment" : "I requested this role by mistake."
@@ -208,14 +220,14 @@ from pprint import pprint
try:
# Bulk Cancel Access Request
Result = bulk_cancel_access_request.from_json(bulk_cancel_access_request)
api_response = api_instance.cancel_access_request_in_bulk(Result)
new_bulk_cancel_access_request = BulkCancelAccessRequest()
new_bulk_cancel_access_request.from_json(bulk_cancel_access_request)
results =AccessRequestsApi(api_client).cancel_access_request_in_bulk(new_bulk_cancel_access_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.cancel_access_request_in_bulk(Result)
# results = AccessRequestsApi(api_client).cancel_access_request_in_bulk(new_bulk_cancel_access_request)
print("The response of AccessRequestsApi->cancel_access_request_in_bulk:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestsApi->cancel_access_request_in_bulk: %s\n" % e)
```
@@ -271,10 +283,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.close_access_request import CloseAccessRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
close_access_request = {
"executionStatus" : "Terminated",
@@ -285,14 +301,14 @@ from pprint import pprint
try:
# Close Access Request
Result = close_access_request.from_json(close_access_request)
api_response = api_instance.close_access_request(x_sail_point_experimental, Result)
new_close_access_request = CloseAccessRequest()
new_close_access_request.from_json(close_access_request)
results =AccessRequestsApi(api_client).close_access_request(x_sail_point_experimental, new_close_access_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.close_access_request(x_sail_point_experimental, Result)
# results = AccessRequestsApi(api_client).close_access_request(x_sail_point_experimental, new_close_access_request)
print("The response of AccessRequestsApi->close_access_request:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestsApi->close_access_request: %s\n" % e)
```
@@ -363,11 +379,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_request import AccessRequest
from sailpoint.v2024.models.access_request_response import AccessRequestResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_request = {
"requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ],
"clientMetadata" : {
@@ -425,14 +445,14 @@ from pprint import pprint
try:
# Submit Access Request
Result = access_request.from_json(access_request)
api_response = api_instance.create_access_request(Result)
new_access_request = AccessRequest()
new_access_request.from_json(access_request)
results =AccessRequestsApi(api_client).create_access_request(new_access_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_access_request(Result)
# results = AccessRequestsApi(api_client).create_access_request(new_access_request)
print("The response of AccessRequestsApi->create_access_request:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestsApi->create_access_request: %s\n" % e)
```
@@ -470,21 +490,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_request_config import AccessRequestConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Access Request Configuration
api_response = api_instance.get_access_request_config()
results =AccessRequestsApi(api_client).get_access_request_config()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_access_request_config()
# results = AccessRequestsApi(api_client).get_access_request_config()
print("The response of AccessRequestsApi->get_access_request_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e)
```
@@ -536,10 +559,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.requested_item_status import RequestedItemStatus
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
requested_for = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
requested_by = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
regarding_identity = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # str | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional)
@@ -554,13 +581,12 @@ from pprint import pprint
try:
# Access Request Status
api_response = api_instance.list_access_request_status()
results =AccessRequestsApi(api_client).list_access_request_status()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state)
# results = AccessRequestsApi(api_client).list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state)
print("The response of AccessRequestsApi->list_access_request_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e)
```
@@ -611,10 +637,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_request_admin_item_status import AccessRequestAdminItemStatus
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
requested_for = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
requested_by = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
regarding_identity = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # str | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional)
@@ -629,13 +659,12 @@ from pprint import pprint
try:
# Access Request Status for Administrators
api_response = api_instance.list_administrators_access_request_status()
results =AccessRequestsApi(api_client).list_administrators_access_request_status()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_administrators_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state)
# results = AccessRequestsApi(api_client).list_administrators_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state)
print("The response of AccessRequestsApi->list_administrators_access_request_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestsApi->list_administrators_access_request_status: %s\n" % e)
```
@@ -676,10 +705,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_request_config import AccessRequestConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_request_config = {
"requestOnBehalfOfConfig" : {
"allowRequestOnBehalfOfEmployeeByManager" : true,
@@ -709,14 +742,14 @@ from pprint import pprint
try:
# Update Access Request Configuration
Result = access_request_config.from_json(access_request_config)
api_response = api_instance.set_access_request_config(Result)
new_access_request_config = AccessRequestConfig()
new_access_request_config.from_json(access_request_config)
results =AccessRequestsApi(api_client).set_access_request_config(new_access_request_config)
# Below is a request that includes all optional parameters
# api_response = api_instance.set_access_request_config(Result)
# results = AccessRequestsApi(api_client).set_access_request_config(new_access_request_config)
print("The response of AccessRequestsApi->set_access_request_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestsApi->set_access_request_config: %s\n" % e)
```

30
docs/tools/sdk/python/Reference/V2024/Methods/AccountActivitiesApi.md
View File

@@ -86,22 +86,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.account_activities_api import AccountActivitiesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.account_activity import AccountActivity
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account activity id # str | The account activity id
try:
# Get an Account Activity
api_response = api_instance.get_account_activity(id)
results =AccountActivitiesApi(api_client).get_account_activity(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_account_activity(id)
# results = AccountActivitiesApi(api_client).get_account_activity(id)
print("The response of AccountActivitiesApi->get_account_activity:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountActivitiesApi->get_account_activity: %s\n" % e)
```
@@ -149,10 +152,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.account_activities_api import AccountActivitiesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.account_activity import AccountActivity
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
requested_for = '2c91808568c529c60168cca6f90c1313' # str | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
requested_by = '2c91808568c529c60168cca6f90c1313' # str | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
regarding_identity = '2c91808568c529c60168cca6f90c1313' # str | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # str | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional)
@@ -165,13 +172,12 @@ from pprint import pprint
try:
# List Account Activities
api_response = api_instance.list_account_activities()
results =AccountActivitiesApi(api_client).list_account_activities()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters)
# results = AccountActivitiesApi(api_client).list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters)
print("The response of AccountActivitiesApi->list_account_activities:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e)
```

15
docs/tools/sdk/python/Reference/V2024/Methods/AccountAggregationsApi.md
View File

@@ -72,23 +72,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.account_aggregations_api import AccountAggregationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.account_aggregation_status import AccountAggregationStatus
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808477a6b0c60177a81146b8110b' # str | The account aggregation id # str | The account aggregation 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')
try:
# In-progress Account Aggregation status
api_response = api_instance.get_account_aggregation_status(id, x_sail_point_experimental)
results =AccountAggregationsApi(api_client).get_account_aggregation_status(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_account_aggregation_status(id, x_sail_point_experimental)
# results = AccountAggregationsApi(api_client).get_account_aggregation_status(id, x_sail_point_experimental)
print("The response of AccountAggregationsApi->get_account_aggregation_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e)
```

15
docs/tools/sdk/python/Reference/V2024/Methods/AccountUsagesApi.md
View File

@@ -58,10 +58,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.account_usages_api import AccountUsagesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.account_usage import AccountUsage
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account
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)
@@ -71,13 +75,12 @@ from pprint import pprint
try:
# Returns account usage insights
api_response = api_instance.get_usages_by_account_id(account_id, )
results =AccountUsagesApi(api_client).get_usages_by_account_id(account_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_usages_by_account_id(account_id, limit, offset, count, sorters)
# results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters)
print("The response of AccountUsagesApi->get_usages_by_account_id:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e)
```

264
docs/tools/sdk/python/Reference/V2024/Methods/AccountsApi.md
View File

@@ -104,11 +104,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.account_attributes_create import AccountAttributesCreate
from sailpoint.v2024.models.accounts_async_result import AccountsAsyncResult
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
account_attributes_create = {
"attributes" : {
"sourceId" : "34bfcbe116c9407464af37acbaf7a4dc",
@@ -122,14 +126,14 @@ from pprint import pprint
try:
# Create Account
Result = account_attributes_create.from_json(account_attributes_create)
api_response = api_instance.create_account(Result)
new_account_attributes_create = AccountAttributesCreate()
new_account_attributes_create.from_json(account_attributes_create)
results =AccountsApi(api_client).create_account(new_account_attributes_create)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_account(Result)
# results = AccountsApi(api_client).create_account(new_account_attributes_create)
print("The response of AccountsApi->create_account:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->create_account: %s\n" % e)
```
@@ -174,22 +178,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.accounts_async_result import AccountsAsyncResult
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID.
try:
# Delete Account
api_response = api_instance.delete_account(id)
results =AccountsApi(api_client).delete_account(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_account(id)
# results = AccountsApi(api_client).delete_account(id)
print("The response of AccountsApi->delete_account:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->delete_account: %s\n" % e)
```
@@ -240,23 +247,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.task_result_dto import TaskResultDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c350d6aa4f104c61b062cb632421ad10' # str | The account id # str | The account 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')
try:
# Remove Account
api_response = api_instance.delete_account_async(id, x_sail_point_experimental)
results =AccountsApi(api_client).delete_account_async(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_account_async(id, x_sail_point_experimental)
# results = AccountsApi(api_client).delete_account_async(id, x_sail_point_experimental)
print("The response of AccountsApi->delete_account_async:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->delete_account_async: %s\n" % e)
```
@@ -299,11 +309,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.account_toggle_request import AccountToggleRequest
from sailpoint.v2024.models.accounts_async_result import AccountsAsyncResult
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id
account_toggle_request = {
"forceProvisioning" : false,
@@ -312,14 +326,14 @@ from pprint import pprint
try:
# Disable Account
Result = account_toggle_request.from_json(account_toggle_request)
api_response = api_instance.disable_account(id, Result)
new_account_toggle_request = AccountToggleRequest()
new_account_toggle_request.from_json(account_toggle_request)
results =AccountsApi(api_client).disable_account(id, new_account_toggle_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.disable_account(id, Result)
# results = AccountsApi(api_client).disable_account(id, new_account_toggle_request)
print("The response of AccountsApi->disable_account:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->disable_account: %s\n" % e)
```
@@ -365,22 +379,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity 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')
try:
# Disable IDN Account for Identity
api_response = api_instance.disable_account_for_identity(id, x_sail_point_experimental)
results =AccountsApi(api_client).disable_account_for_identity(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.disable_account_for_identity(id, x_sail_point_experimental)
# results = AccountsApi(api_client).disable_account_for_identity(id, x_sail_point_experimental)
print("The response of AccountsApi->disable_account_for_identity:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->disable_account_for_identity: %s\n" % e)
```
@@ -425,11 +442,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.bulk_identities_accounts_response import BulkIdentitiesAccountsResponse
from sailpoint.v2024.models.identities_accounts_bulk_request import IdentitiesAccountsBulkRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
identities_accounts_bulk_request = {
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
@@ -437,14 +458,14 @@ from pprint import pprint
try:
# Disable IDN Accounts for Identities
Result = identities_accounts_bulk_request.from_json(identities_accounts_bulk_request)
api_response = api_instance.disable_accounts_for_identities(x_sail_point_experimental, Result)
new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest()
new_identities_accounts_bulk_request.from_json(identities_accounts_bulk_request)
results =AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.disable_accounts_for_identities(x_sail_point_experimental, Result)
# results = AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request)
print("The response of AccountsApi->disable_accounts_for_identities:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e)
```
@@ -487,11 +508,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.account_toggle_request import AccountToggleRequest
from sailpoint.v2024.models.accounts_async_result import AccountsAsyncResult
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id
account_toggle_request = {
"forceProvisioning" : false,
@@ -500,14 +525,14 @@ from pprint import pprint
try:
# Enable Account
Result = account_toggle_request.from_json(account_toggle_request)
api_response = api_instance.enable_account(id, Result)
new_account_toggle_request = AccountToggleRequest()
new_account_toggle_request.from_json(account_toggle_request)
results =AccountsApi(api_client).enable_account(id, new_account_toggle_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.enable_account(id, Result)
# results = AccountsApi(api_client).enable_account(id, new_account_toggle_request)
print("The response of AccountsApi->enable_account:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->enable_account: %s\n" % e)
```
@@ -553,22 +578,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity 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')
try:
# Enable IDN Account for Identity
api_response = api_instance.enable_account_for_identity(id, x_sail_point_experimental)
results =AccountsApi(api_client).enable_account_for_identity(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.enable_account_for_identity(id, x_sail_point_experimental)
# results = AccountsApi(api_client).enable_account_for_identity(id, x_sail_point_experimental)
print("The response of AccountsApi->enable_account_for_identity:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->enable_account_for_identity: %s\n" % e)
```
@@ -613,11 +641,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.bulk_identities_accounts_response import BulkIdentitiesAccountsResponse
from sailpoint.v2024.models.identities_accounts_bulk_request import IdentitiesAccountsBulkRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
identities_accounts_bulk_request = {
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
@@ -625,14 +657,14 @@ from pprint import pprint
try:
# Enable IDN Accounts for Identities
Result = identities_accounts_bulk_request.from_json(identities_accounts_bulk_request)
api_response = api_instance.enable_accounts_for_identities(x_sail_point_experimental, Result)
new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest()
new_identities_accounts_bulk_request.from_json(identities_accounts_bulk_request)
results =AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.enable_accounts_for_identities(x_sail_point_experimental, Result)
# results = AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request)
print("The response of AccountsApi->enable_accounts_for_identities:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e)
```
@@ -674,22 +706,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.account import Account
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID.
try:
# Account Details
api_response = api_instance.get_account(id)
results =AccountsApi(api_client).get_account(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_account(id)
# results = AccountsApi(api_client).get_account(id)
print("The response of AccountsApi->get_account:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->get_account: %s\n" % e)
```
@@ -734,10 +769,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.entitlement_dto import EntitlementDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account 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)
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)
@@ -746,13 +785,12 @@ from pprint import pprint
try:
# Account Entitlements
api_response = api_instance.get_account_entitlements(id, )
results =AccountsApi(api_client).get_account_entitlements(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_account_entitlements(id, limit, offset, count)
# results = AccountsApi(api_client).get_account_entitlements(id, limit, offset, count)
print("The response of AccountsApi->get_account_entitlements:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e)
```
@@ -798,10 +836,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.account import Account
from sailpoint.v2024.rest import ApiException
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)
count = False # bool | 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=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. (optional) (default to False) # bool | 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=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. (optional) (default to False)
@@ -812,13 +854,12 @@ from pprint import pprint
try:
# Accounts List
api_response = api_instance.list_accounts()
results =AccountsApi(api_client).list_accounts()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_accounts(limit, offset, count, detail_level, filters, sorters)
# results = AccountsApi(api_client).list_accounts(limit, offset, count, detail_level, filters, sorters)
print("The response of AccountsApi->list_accounts:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->list_accounts: %s\n" % e)
```
@@ -866,11 +907,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.account_attributes import AccountAttributes
from sailpoint.v2024.models.accounts_async_result import AccountsAsyncResult
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID.
account_attributes = {
"attributes" : {
@@ -884,14 +929,14 @@ from pprint import pprint
try:
# Update Account
Result = account_attributes.from_json(account_attributes)
api_response = api_instance.put_account(id, Result)
new_account_attributes = AccountAttributes()
new_account_attributes.from_json(account_attributes)
results =AccountsApi(api_client).put_account(id, new_account_attributes)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_account(id, Result)
# results = AccountsApi(api_client).put_account(id, new_account_attributes)
print("The response of AccountsApi->put_account:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->put_account: %s\n" % e)
```
@@ -933,22 +978,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.accounts_async_result import AccountsAsyncResult
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id
try:
# Reload Account
api_response = api_instance.submit_reload_account(id)
results =AccountsApi(api_client).submit_reload_account(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.submit_reload_account(id)
# results = AccountsApi(api_client).submit_reload_account(id)
print("The response of AccountsApi->submit_reload_account:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->submit_reload_account: %s\n" % e)
```
@@ -992,11 +1040,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.account_unlock_request import AccountUnlockRequest
from sailpoint.v2024.models.accounts_async_result import AccountsAsyncResult
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. # str | The account ID.
account_unlock_request = {
"forceProvisioning" : false,
@@ -1006,14 +1058,14 @@ from pprint import pprint
try:
# Unlock Account
Result = account_unlock_request.from_json(account_unlock_request)
api_response = api_instance.unlock_account(id, Result)
new_account_unlock_request = AccountUnlockRequest()
new_account_unlock_request.from_json(account_unlock_request)
results =AccountsApi(api_client).unlock_account(id, new_account_unlock_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.unlock_account(id, Result)
# results = AccountsApi(api_client).unlock_account(id, new_account_unlock_request)
print("The response of AccountsApi->unlock_account:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->unlock_account: %s\n" % e)
```
@@ -1066,9 +1118,13 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID.
request_body = [{op=remove, path=/identityId}] # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
request_body = [{op=remove, path=/identityId}] # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
@@ -1076,14 +1132,14 @@ from pprint import pprint
try:
# Update Account
Result = request_body.from_json(request_body)
api_response = api_instance.update_account(id, Result)
new_request_body = RequestBody()
new_request_body.from_json(request_body)
results =AccountsApi(api_client).update_account(id, new_request_body)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_account(id, Result)
# results = AccountsApi(api_client).update_account(id, new_request_body)
print("The response of AccountsApi->update_account:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->update_account: %s\n" % e)
```

43
docs/tools/sdk/python/Reference/V2024/Methods/ApplicationDiscoveryApi.md
View File

@@ -60,10 +60,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.application_discovery_api import ApplicationDiscoveryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.get_discovered_applications200_response_inner import GetDiscoveredApplications200ResponseInner
from sailpoint.v2024.rest import ApiException
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)
detail = 'FULL' # str | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) # str | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional)
@@ -73,13 +77,12 @@ from pprint import pprint
try:
# Get Discovered Applications for Tenant
api_response = api_instance.get_discovered_applications()
results =ApplicationDiscoveryApi(api_client).get_discovered_applications()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_discovered_applications(limit, offset, detail, filter, sorters)
# results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters)
print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e)
```
@@ -120,21 +123,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.application_discovery_api import ApplicationDiscoveryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.manual_discover_applications_template import ManualDiscoverApplicationsTemplate
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Download CSV Template for Discovery
api_response = api_instance.get_manual_discover_applications_csv_template()
results =ApplicationDiscoveryApi(api_client).get_manual_discover_applications_csv_template()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_manual_discover_applications_csv_template()
# results = ApplicationDiscoveryApi(api_client).get_manual_discover_applications_csv_template()
print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ApplicationDiscoveryApi->get_manual_discover_applications_csv_template: %s\n" % e)
```
@@ -176,19 +182,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.application_discovery_api import ApplicationDiscoveryApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
file = None # bytearray | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. # bytearray | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered.
try:
# Upload CSV to Discover Applications
api_instance.send_manual_discover_applications_csv_template(file)
ApplicationDiscoveryApi(api_client).send_manual_discover_applications_csv_template(file)
# Below is a request that includes all optional parameters
# api_instance.send_manual_discover_applications_csv_template(file)
except Exception as e:
# ApplicationDiscoveryApi(api_client).send_manual_discover_applications_csv_template(file)
except Exception as e:
print("Exception when calling ApplicationDiscoveryApi->send_manual_discover_applications_csv_template: %s\n" % e)
```

30
docs/tools/sdk/python/Reference/V2024/Methods/ApprovalsApi.md
View File

@@ -59,23 +59,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.approvals_api import ApprovalsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.approval import Approval
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | ID of the approval that is to be returned # str | ID of the approval that is to be returned
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')
try:
# Get an approval
api_response = api_instance.get_approval(id, x_sail_point_experimental)
results =ApprovalsApi(api_client).get_approval(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_approval(id, x_sail_point_experimental)
# results = ApprovalsApi(api_client).get_approval(id, x_sail_point_experimental)
print("The response of ApprovalsApi->get_approval:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ApprovalsApi->get_approval: %s\n" % e)
```
@@ -123,10 +126,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.approvals_api import ApprovalsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.approval import Approval
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
mine = true # bool | Returns the list of approvals for the current caller (optional) # bool | Returns the list of approvals for the current caller (optional)
requester_id = '17e633e7d57e481569df76323169deb6a' # str | Returns the list of approvals for a given requester ID (optional) # str | Returns the list of approvals for a given requester ID (optional)
@@ -135,13 +142,12 @@ from pprint import pprint
try:
# Get Approvals
api_response = api_instance.get_approvals(x_sail_point_experimental, )
results =ApprovalsApi(api_client).get_approvals(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_approvals(x_sail_point_experimental, mine, requester_id, filters)
# results = ApprovalsApi(api_client).get_approvals(x_sail_point_experimental, mine, requester_id, filters)
print("The response of ApprovalsApi->get_approvals:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e)
```

214
docs/tools/sdk/python/Reference/V2024/Methods/AppsApi.md
View File

@@ -70,11 +70,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.source_app import SourceApp
from sailpoint.v2024.models.source_app_create_dto import SourceAppCreateDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
source_app_create_dto = {
"name" : "my app",
@@ -89,14 +93,14 @@ from pprint import pprint
try:
# Create source app
Result = source_app_create_dto.from_json(source_app_create_dto)
api_response = api_instance.create_source_app(x_sail_point_experimental, Result)
new_source_app_create_dto = SourceAppCreateDto()
new_source_app_create_dto.from_json(source_app_create_dto)
results =AppsApi(api_client).create_source_app(x_sail_point_experimental, new_source_app_create_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_source_app(x_sail_point_experimental, Result)
# results = AppsApi(api_client).create_source_app(x_sail_point_experimental, new_source_app_create_dto)
print("The response of AppsApi->create_source_app:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AppsApi->create_source_app: %s\n" % e)
```
@@ -143,10 +147,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_profile_details import AccessProfileDetails
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app
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 = [c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9] # List[str] |
@@ -156,14 +164,14 @@ from pprint import pprint
try:
# Bulk remove access profiles from the specified source app
Result = request_body.from_json(request_body)
api_response = api_instance.delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, Result, )
new_request_body = RequestBody()
new_request_body.from_json(request_body)
results =AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, new_request_body, )
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, Result, limit)
# results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, new_request_body, limit)
print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e)
```
@@ -208,23 +216,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.source_app import SourceApp
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | source app ID. # str | source app 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')
try:
# Delete source app by ID
api_response = api_instance.delete_source_app(id, x_sail_point_experimental)
results =AppsApi(api_client).delete_source_app(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_source_app(id, x_sail_point_experimental)
# results = AppsApi(api_client).delete_source_app(id, x_sail_point_experimental)
print("The response of AppsApi->delete_source_app:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AppsApi->delete_source_app: %s\n" % e)
```
@@ -270,23 +281,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.source_app import SourceApp
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app
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')
try:
# Get source app by ID
api_response = api_instance.get_source_app(id, x_sail_point_experimental)
results =AppsApi(api_client).get_source_app(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_source_app(id, x_sail_point_experimental)
# results = AppsApi(api_client).get_source_app(id, x_sail_point_experimental)
print("The response of AppsApi->get_source_app:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AppsApi->get_source_app: %s\n" % e)
```
@@ -334,10 +348,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_profile_details import AccessProfileDetails
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app
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)
@@ -347,13 +365,12 @@ from pprint import pprint
try:
# List access profiles for the specified source app
api_response = api_instance.list_access_profiles_for_source_app(id, x_sail_point_experimental, )
results =AppsApi(api_client).list_access_profiles_for_source_app(id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_access_profiles_for_source_app(id, x_sail_point_experimental, limit, offset, filters)
# results = AppsApi(api_client).list_access_profiles_for_source_app(id, x_sail_point_experimental, limit, offset, filters)
print("The response of AppsApi->list_access_profiles_for_source_app:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e)
```
@@ -402,10 +419,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.source_app import SourceApp
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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)
count = False # bool | 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=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. (optional) (default to False) # bool | 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=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. (optional) (default to False)
@@ -416,13 +437,12 @@ from pprint import pprint
try:
# List all source apps
api_response = api_instance.list_all_source_app(x_sail_point_experimental, )
results =AppsApi(api_client).list_all_source_app(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_all_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters)
# results = AppsApi(api_client).list_all_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters)
print("The response of AppsApi->list_all_source_app:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AppsApi->list_all_source_app: %s\n" % e)
```
@@ -471,10 +491,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.user_app import UserApp
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
filters = 'name eq \"user app name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq*
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)
@@ -484,13 +508,12 @@ from pprint import pprint
try:
# List all user apps
api_response = api_instance.list_all_user_apps(filters, x_sail_point_experimental, )
results =AppsApi(api_client).list_all_user_apps(filters, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_all_user_apps(filters, x_sail_point_experimental, limit, count, offset)
# results = AppsApi(api_client).list_all_user_apps(filters, x_sail_point_experimental, limit, count, offset)
print("The response of AppsApi->list_all_user_apps:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e)
```
@@ -539,10 +562,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.source_app import SourceApp
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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)
count = False # bool | 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=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. (optional) (default to False) # bool | 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=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. (optional) (default to False)
@@ -553,13 +580,12 @@ from pprint import pprint
try:
# List assigned source apps
api_response = api_instance.list_assigned_source_app(x_sail_point_experimental, )
results =AppsApi(api_client).list_assigned_source_app(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_assigned_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters)
# results = AppsApi(api_client).list_assigned_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters)
print("The response of AppsApi->list_assigned_source_app:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e)
```
@@ -606,10 +632,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.app_account_details import AppAccountDetails
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the user app # str | ID of the user app
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)
@@ -618,13 +648,12 @@ from pprint import pprint
try:
# List available accounts for user app
api_response = api_instance.list_available_accounts_for_user_app(id, x_sail_point_experimental, )
results =AppsApi(api_client).list_available_accounts_for_user_app(id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_available_accounts_for_user_app(id, x_sail_point_experimental, limit, count)
# results = AppsApi(api_client).list_available_accounts_for_user_app(id, x_sail_point_experimental, limit, count)
print("The response of AppsApi->list_available_accounts_for_user_app:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e)
```
@@ -673,10 +702,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.source_app import SourceApp
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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)
count = False # bool | 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=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. (optional) (default to False) # bool | 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=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. (optional) (default to False)
@@ -687,13 +720,12 @@ from pprint import pprint
try:
# List available source apps
api_response = api_instance.list_available_source_apps(x_sail_point_experimental, )
results =AppsApi(api_client).list_available_source_apps(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_available_source_apps(x_sail_point_experimental, limit, count, offset, sorters, filters)
# results = AppsApi(api_client).list_available_source_apps(x_sail_point_experimental, limit, count, offset, sorters, filters)
print("The response of AppsApi->list_available_source_apps:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e)
```
@@ -741,10 +773,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.user_app import UserApp
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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)
count = False # bool | 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=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. (optional) (default to False) # bool | 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=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. (optional) (default to False)
@@ -754,13 +790,12 @@ from pprint import pprint
try:
# List owned user apps
api_response = api_instance.list_owned_user_apps(x_sail_point_experimental, )
results =AppsApi(api_client).list_owned_user_apps(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_owned_user_apps(x_sail_point_experimental, limit, count, offset, filters)
# results = AppsApi(api_client).list_owned_user_apps(x_sail_point_experimental, limit, count, offset, filters)
print("The response of AppsApi->list_owned_user_apps:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e)
```
@@ -809,11 +844,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.models.source_app_patch_dto import SourceAppPatchDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the source app to patch # str | ID of the source app to patch
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')
[{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}] # List[JsonPatchOperation] | (optional)
@@ -827,13 +866,12 @@ from pprint import pprint
try:
# Patch source app by ID
api_response = api_instance.patch_source_app(id, x_sail_point_experimental, )
results =AppsApi(api_client).patch_source_app(id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_source_app(id, x_sail_point_experimental, Result)
# results = AppsApi(api_client).patch_source_app(id, x_sail_point_experimental, new_json_patch_operation)
print("The response of AppsApi->patch_source_app:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AppsApi->patch_source_app: %s\n" % e)
```
@@ -881,11 +919,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.models.user_app import UserApp
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the user app to patch # str | ID of the user app to patch
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')
[sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | (optional)
@@ -899,13 +941,12 @@ from pprint import pprint
try:
# Patch user app by ID
api_response = api_instance.patch_user_app(id, x_sail_point_experimental, )
results =AppsApi(api_client).patch_user_app(id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_user_app(id, x_sail_point_experimental, Result)
# results = AppsApi(api_client).patch_user_app(id, x_sail_point_experimental, new_json_patch_operation)
print("The response of AppsApi->patch_user_app:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AppsApi->patch_user_app: %s\n" % e)
```
@@ -953,10 +994,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.source_app_bulk_update_request import SourceAppBulkUpdateRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
source_app_bulk_update_request = {
"appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ],
@@ -974,11 +1019,10 @@ from pprint import pprint
try:
# Bulk update source apps
api_instance.update_source_apps_in_bulk(x_sail_point_experimental, )
AppsApi(api_client).update_source_apps_in_bulk(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_instance.update_source_apps_in_bulk(x_sail_point_experimental, Result)
except Exception as e:
# AppsApi(api_client).update_source_apps_in_bulk(x_sail_point_experimental, new_source_app_bulk_update_request)
except Exception as e:
print("Exception when calling AppsApi->update_source_apps_in_bulk: %s\n" % e)
```

48
docs/tools/sdk/python/Reference/V2024/Methods/AuthProfileApi.md
View File

@@ -64,23 +64,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.auth_profile_api import AuthProfileApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.auth_profile import AuthProfile
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch.
try:
# Get Auth Profile.
api_response = api_instance.get_profile_config(x_sail_point_experimental, id)
results =AuthProfileApi(api_client).get_profile_config(x_sail_point_experimental, id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_profile_config(x_sail_point_experimental, id)
# results = AuthProfileApi(api_client).get_profile_config(x_sail_point_experimental, id)
print("The response of AuthProfileApi->get_profile_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AuthProfileApi->get_profile_config: %s\n" % e)
```
@@ -124,22 +127,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.auth_profile_api import AuthProfileApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.auth_profile_summary import AuthProfileSummary
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
try:
# Get list of Auth Profiles.
api_response = api_instance.get_profile_config_list(x_sail_point_experimental)
results =AuthProfileApi(api_client).get_profile_config_list(x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_profile_config_list(x_sail_point_experimental)
# results = AuthProfileApi(api_client).get_profile_config_list(x_sail_point_experimental)
print("The response of AuthProfileApi->get_profile_config_list:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e)
```
@@ -186,11 +192,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.auth_profile_api import AuthProfileApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.auth_profile import AuthProfile
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch.
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')
[sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] |
@@ -203,14 +213,14 @@ from pprint import pprint
try:
# Patch a specified Auth Profile
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_profile_config(id, x_sail_point_experimental, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =AuthProfileApi(api_client).patch_profile_config(id, x_sail_point_experimental, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_profile_config(id, x_sail_point_experimental, Result)
# results = AuthProfileApi(api_client).patch_profile_config(id, x_sail_point_experimental, new_json_patch_operation)
print("The response of AuthProfileApi->patch_profile_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AuthProfileApi->patch_profile_config: %s\n" % e)
```

33
docs/tools/sdk/python/Reference/V2024/Methods/AuthUsersApi.md
View File

@@ -58,22 +58,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.auth_users_api import AuthUsersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.auth_user import AuthUser
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID
try:
# Auth User Details
api_response = api_instance.get_auth_user(id)
results =AuthUsersApi(api_client).get_auth_user(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_auth_user(id)
# results = AuthUsersApi(api_client).get_auth_user(id)
print("The response of AuthUsersApi->get_auth_user:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AuthUsersApi->get_auth_user: %s\n" % e)
```
@@ -120,11 +123,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.auth_users_api import AuthUsersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.auth_user import AuthUser
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID
[{op=replace, path=/capabilities, value=[ORG_ADMIN]}] # List[JsonPatchOperation] | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
json_patch_operation = {
@@ -136,14 +143,14 @@ from pprint import pprint
try:
# Auth User Update
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_auth_user(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =AuthUsersApi(api_client).patch_auth_user(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_auth_user(id, Result)
# results = AuthUsersApi(api_client).patch_auth_user(id, new_json_patch_operation)
print("The response of AuthUsersApi->patch_auth_user:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AuthUsersApi->patch_auth_user: %s\n" % e)
```

73
docs/tools/sdk/python/Reference/V2024/Methods/BrandingApi.md
View File

@@ -67,10 +67,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.branding_api import BrandingApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.branding_item import BrandingItem
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
name = 'name_example' # str | name of branding item # str | name of branding item
product_name = 'product_name_example' # str | product name # str | product name
action_button_color = 'action_button_color_example' # str | hex value of color for action button (optional) # str | hex value of color for action button (optional)
@@ -83,13 +87,12 @@ from pprint import pprint
try:
# Create a branding item
api_response = api_instance.create_branding_item(name, product_name, )
results =BrandingApi(api_client).create_branding_item(name, product_name, )
# Below is a request that includes all optional parameters
# api_response = api_instance.create_branding_item(name, product_name, action_button_color, active_link_color, navigation_color, email_from_address, login_informational_message, file_standard)
# results = BrandingApi(api_client).create_branding_item(name, product_name, action_button_color, active_link_color, navigation_color, email_from_address, login_informational_message, file_standard)
print("The response of BrandingApi->create_branding_item:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling BrandingApi->create_branding_item: %s\n" % e)
```
@@ -131,19 +134,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.branding_api import BrandingApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
name = 'default' # str | The name of the branding item to be deleted # str | The name of the branding item to be deleted
try:
# Delete a branding item
api_instance.delete_branding(name)
BrandingApi(api_client).delete_branding(name)
# Below is a request that includes all optional parameters
# api_instance.delete_branding(name)
except Exception as e:
# BrandingApi(api_client).delete_branding(name)
except Exception as e:
print("Exception when calling BrandingApi->delete_branding: %s\n" % e)
```
@@ -185,22 +191,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.branding_api import BrandingApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.branding_item import BrandingItem
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
name = 'default' # str | The name of the branding item to be retrieved # str | The name of the branding item to be retrieved
try:
# Get a branding item
api_response = api_instance.get_branding(name)
results =BrandingApi(api_client).get_branding(name)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_branding(name)
# results = BrandingApi(api_client).get_branding(name)
print("The response of BrandingApi->get_branding:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling BrandingApi->get_branding: %s\n" % e)
```
@@ -238,21 +247,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.branding_api import BrandingApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.branding_item import BrandingItem
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List of branding items
api_response = api_instance.get_branding_list()
results =BrandingApi(api_client).get_branding_list()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_branding_list()
# results = BrandingApi(api_client).get_branding_list()
print("The response of BrandingApi->get_branding_list:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling BrandingApi->get_branding_list: %s\n" % e)
```
@@ -302,10 +314,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.branding_api import BrandingApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.branding_item import BrandingItem
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
name = 'default' # str | The name of the branding item to be retrieved # str | The name of the branding item to be retrieved
name2 = 'name_example' # str | name of branding item # str | name of branding item
product_name = 'product_name_example' # str | product name # str | product name
@@ -319,13 +335,12 @@ from pprint import pprint
try:
# Update a branding item
api_response = api_instance.set_branding_item(name, name2, product_name, )
results =BrandingApi(api_client).set_branding_item(name, name2, product_name, )
# Below is a request that includes all optional parameters
# api_response = api_instance.set_branding_item(name, name2, product_name, action_button_color, active_link_color, navigation_color, email_from_address, login_informational_message, file_standard)
# results = BrandingApi(api_client).set_branding_item(name, name2, product_name, action_button_color, active_link_color, navigation_color, email_from_address, login_informational_message, file_standard)
print("The response of BrandingApi->set_branding_item:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling BrandingApi->set_branding_item: %s\n" % e)
```

82
docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignFiltersApi.md
View File

@@ -82,10 +82,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaign_filters_api import CertificationCampaignFiltersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_filter_details import CampaignFilterDetails
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
campaign_filter_details = {
"owner" : "SailPoint Support",
"mode" : "INCLUSION",
@@ -107,14 +111,14 @@ from pprint import pprint
try:
# Create Campaign Filter
Result = campaign_filter_details.from_json(campaign_filter_details)
api_response = api_instance.create_campaign_filter(Result)
new_campaign_filter_details = CampaignFilterDetails()
new_campaign_filter_details.from_json(campaign_filter_details)
results =CertificationCampaignFiltersApi(api_client).create_campaign_filter(new_campaign_filter_details)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_campaign_filter(Result)
# results = CertificationCampaignFiltersApi(api_client).create_campaign_filter(new_campaign_filter_details)
print("The response of CertificationCampaignFiltersApi->create_campaign_filter:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignFiltersApi->create_campaign_filter: %s\n" % e)
```
@@ -156,21 +160,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.certification_campaign_filters_api import CertificationCampaignFiltersApi
from sailpoint.v2024.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] | A json list of IDs of campaign filters to delete.
request_body = ['request_body_example'] # List[str] | A json list of IDs of campaign filters to delete.
try:
# Deletes Campaign Filters
Result = request_body.from_json(request_body)
api_instance.delete_campaign_filters(Result)
new_request_body = RequestBody()
new_request_body.from_json(request_body)
CertificationCampaignFiltersApi(api_client).delete_campaign_filters(new_request_body)
# Below is a request that includes all optional parameters
# api_instance.delete_campaign_filters(Result)
except Exception as e:
# CertificationCampaignFiltersApi(api_client).delete_campaign_filters(new_request_body)
except Exception as e:
print("Exception when calling CertificationCampaignFiltersApi->delete_campaign_filters: %s\n" % e)
```
@@ -212,22 +220,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaign_filters_api import CertificationCampaignFiltersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_filter_details import CampaignFilterDetails
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'e9f9a1397b842fd5a65842087040d3ac' # str | The ID of the campaign filter to be retrieved. # str | The ID of the campaign filter to be retrieved.
try:
# Get Campaign Filter by ID
api_response = api_instance.get_campaign_filter_by_id(id)
results =CertificationCampaignFiltersApi(api_client).get_campaign_filter_by_id(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_campaign_filter_by_id(id)
# results = CertificationCampaignFiltersApi(api_client).get_campaign_filter_by_id(id)
print("The response of CertificationCampaignFiltersApi->get_campaign_filter_by_id:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignFiltersApi->get_campaign_filter_by_id: %s\n" % e)
```
@@ -270,10 +281,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaign_filters_api import CertificationCampaignFiltersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.list_campaign_filters200_response import ListCampaignFilters200Response
from sailpoint.v2024.rest import ApiException
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)
start = 0 # int | Start/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 | Start/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)
include_system_filters = True # bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to True) # bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to True)
@@ -281,13 +296,12 @@ from pprint import pprint
try:
# List Campaign Filters
api_response = api_instance.list_campaign_filters()
results =CertificationCampaignFiltersApi(api_client).list_campaign_filters()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_campaign_filters(limit, start, include_system_filters)
# results = CertificationCampaignFiltersApi(api_client).list_campaign_filters(limit, start, include_system_filters)
print("The response of CertificationCampaignFiltersApi->list_campaign_filters:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignFiltersApi->list_campaign_filters: %s\n" % e)
```
@@ -329,10 +343,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaign_filters_api import CertificationCampaignFiltersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_filter_details import CampaignFilterDetails
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
filter_id = 'e9f9a1397b842fd5a65842087040d3ac' # str | The ID of the campaign filter being modified. # str | The ID of the campaign filter being modified.
campaign_filter_details = {
"owner" : "SailPoint Support",
@@ -355,14 +373,14 @@ from pprint import pprint
try:
# Updates a Campaign Filter
Result = campaign_filter_details.from_json(campaign_filter_details)
api_response = api_instance.update_campaign_filter(filter_id, Result)
new_campaign_filter_details = CampaignFilterDetails()
new_campaign_filter_details.from_json(campaign_filter_details)
results =CertificationCampaignFiltersApi(api_client).update_campaign_filter(filter_id, new_campaign_filter_details)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_campaign_filter(filter_id, Result)
# results = CertificationCampaignFiltersApi(api_client).update_campaign_filter(filter_id, new_campaign_filter_details)
print("The response of CertificationCampaignFiltersApi->update_campaign_filter:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignFiltersApi->update_campaign_filter: %s\n" % e)
```

345
docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md
View File

@@ -149,10 +149,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_complete_options import CampaignCompleteOptions
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID.
campaign_complete_options = {
"autoCompleteAction" : "REVOKE"
@@ -161,13 +165,12 @@ from pprint import pprint
try:
# Complete a Campaign
api_response = api_instance.complete_campaign(id, )
results =CertificationCampaignsApi(api_client).complete_campaign(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.complete_campaign(id, Result)
# results = CertificationCampaignsApi(api_client).complete_campaign(id, new_campaign_complete_options)
print("The response of CertificationCampaignsApi->complete_campaign:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->complete_campaign: %s\n" % e)
```
@@ -209,10 +212,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign import Campaign
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
campaign = {
"totalCertifications" : 100,
"sourcesWithOrphanEntitlements" : [ {
@@ -325,14 +332,14 @@ from pprint import pprint
try:
# Create a campaign
Result = campaign.from_json(campaign)
api_response = api_instance.create_campaign(Result)
new_campaign = Campaign()
new_campaign.from_json(campaign)
results =CertificationCampaignsApi(api_client).create_campaign(new_campaign)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_campaign(Result)
# results = CertificationCampaignsApi(api_client).create_campaign(new_campaign)
print("The response of CertificationCampaignsApi->create_campaign:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->create_campaign: %s\n" % e)
```
@@ -374,10 +381,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_template import CampaignTemplate
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
campaign_template = {
"ownerRef" : {
"name" : "Mister Manager",
@@ -505,14 +516,14 @@ from pprint import pprint
try:
# Create a Campaign Template
Result = campaign_template.from_json(campaign_template)
api_response = api_instance.create_campaign_template(Result)
new_campaign_template = CampaignTemplate()
new_campaign_template.from_json(campaign_template)
results =CertificationCampaignsApi(api_client).create_campaign_template(new_campaign_template)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_campaign_template(Result)
# results = CertificationCampaignsApi(api_client).create_campaign_template(new_campaign_template)
print("The response of CertificationCampaignsApi->create_campaign_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->create_campaign_template: %s\n" % e)
```
@@ -555,19 +566,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being deleted. # str | ID of the campaign template being deleted.
try:
# Delete a Campaign Template
api_instance.delete_campaign_template(id)
CertificationCampaignsApi(api_client).delete_campaign_template(id)
# Below is a request that includes all optional parameters
# api_instance.delete_campaign_template(id)
except Exception as e:
# CertificationCampaignsApi(api_client).delete_campaign_template(id)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->delete_campaign_template: %s\n" % e)
```
@@ -610,19 +624,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '04bedce387bd47b2ae1f86eb0bb36dee' # str | ID of the campaign template whose schedule is being deleted. # str | ID of the campaign template whose schedule is being deleted.
try:
# Delete Campaign Template Schedule
api_instance.delete_campaign_template_schedule(id)
CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id)
# Below is a request that includes all optional parameters
# api_instance.delete_campaign_template_schedule(id)
except Exception as e:
# CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->delete_campaign_template_schedule: %s\n" % e)
```
@@ -665,24 +682,28 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaigns_delete_request import CampaignsDeleteRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
campaigns_delete_request = {
"ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ]
} # CampaignsDeleteRequest | IDs of the campaigns to delete.
try:
# Delete Campaigns
Result = campaigns_delete_request.from_json(campaigns_delete_request)
api_response = api_instance.delete_campaigns(Result)
new_campaigns_delete_request = CampaignsDeleteRequest()
new_campaigns_delete_request.from_json(campaigns_delete_request)
results =CertificationCampaignsApi(api_client).delete_campaigns(new_campaigns_delete_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_campaigns(Result)
# results = CertificationCampaignsApi(api_client).delete_campaigns(new_campaigns_delete_request)
print("The response of CertificationCampaignsApi->delete_campaigns:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->delete_campaigns: %s\n" % e)
```
@@ -729,10 +750,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
detail = 'FULL' # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional)
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)
@@ -743,13 +768,12 @@ from pprint import pprint
try:
# List Campaigns
api_response = api_instance.get_active_campaigns()
results =CertificationCampaignsApi(api_client).get_active_campaigns()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_active_campaigns(detail, limit, offset, count, filters, sorters)
# results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters)
print("The response of CertificationCampaignsApi->get_active_campaigns:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e)
```
@@ -793,23 +817,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign to be retrieved. # str | ID of the campaign to be retrieved.
detail = 'FULL' # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional)
try:
# Get Campaign
api_response = api_instance.get_campaign(id, )
results =CertificationCampaignsApi(api_client).get_campaign(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_campaign(id, detail)
# results = CertificationCampaignsApi(api_client).get_campaign(id, detail)
print("The response of CertificationCampaignsApi->get_campaign:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e)
```
@@ -852,22 +879,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_report import CampaignReport
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign whose reports are being fetched. # str | ID of the campaign whose reports are being fetched.
try:
# Get Campaign Reports
api_response = api_instance.get_campaign_reports(id)
results =CertificationCampaignsApi(api_client).get_campaign_reports(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_campaign_reports(id)
# results = CertificationCampaignsApi(api_client).get_campaign_reports(id)
print("The response of CertificationCampaignsApi->get_campaign_reports:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e)
```
@@ -906,21 +936,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_reports_config import CampaignReportsConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Campaign Reports Configuration
api_response = api_instance.get_campaign_reports_config()
results =CertificationCampaignsApi(api_client).get_campaign_reports_config()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_campaign_reports_config()
# results = CertificationCampaignsApi(api_client).get_campaign_reports_config()
print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e)
```
@@ -963,22 +996,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_template import CampaignTemplate
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | Requested campaign template's ID. # str | Requested campaign template's ID.
try:
# Get a Campaign Template
api_response = api_instance.get_campaign_template(id)
results =CertificationCampaignsApi(api_client).get_campaign_template(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_campaign_template(id)
# results = CertificationCampaignsApi(api_client).get_campaign_template(id)
print("The response of CertificationCampaignsApi->get_campaign_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->get_campaign_template: %s\n" % e)
```
@@ -1021,22 +1057,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.schedule import Schedule
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '04bedce387bd47b2ae1f86eb0bb36dee' # str | ID of the campaign template whose schedule is being fetched. # str | ID of the campaign template whose schedule is being fetched.
try:
# Get Campaign Template Schedule
api_response = api_instance.get_campaign_template_schedule(id)
results =CertificationCampaignsApi(api_client).get_campaign_template_schedule(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_campaign_template_schedule(id)
# results = CertificationCampaignsApi(api_client).get_campaign_template_schedule(id)
print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->get_campaign_template_schedule: %s\n" % e)
```
@@ -1084,10 +1123,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_template import CampaignTemplate
from sailpoint.v2024.rest import ApiException
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)
count = False # bool | 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=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. (optional) (default to False) # bool | 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=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. (optional) (default to False)
@@ -1097,13 +1140,12 @@ from pprint import pprint
try:
# List Campaign Templates
api_response = api_instance.get_campaign_templates()
results =CertificationCampaignsApi(api_client).get_campaign_templates()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_campaign_templates(limit, offset, count, sorters, filters)
# results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters)
print("The response of CertificationCampaignsApi->get_campaign_templates:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e)
```
@@ -1147,11 +1189,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.admin_review_reassign import AdminReviewReassign
from sailpoint.v2024.models.certification_task import CertificationTask
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification campaign ID # str | The certification campaign ID
admin_review_reassign = {
"certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ],
@@ -1164,14 +1210,14 @@ from pprint import pprint
try:
# Reassign Certifications
Result = admin_review_reassign.from_json(admin_review_reassign)
api_response = api_instance.move(id, Result)
new_admin_review_reassign = AdminReviewReassign()
new_admin_review_reassign.from_json(admin_review_reassign)
results =CertificationCampaignsApi(api_client).move(id, new_admin_review_reassign)
# Below is a request that includes all optional parameters
# api_response = api_instance.move(id, Result)
# results = CertificationCampaignsApi(api_client).move(id, new_admin_review_reassign)
print("The response of CertificationCampaignsApi->move:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->move: %s\n" % e)
```
@@ -1215,11 +1261,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_template import CampaignTemplate
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified.
[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/campaign/filter/id, value=ff80818155fe8c080155fe8d925b0316}] # List[JsonPatchOperation] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create)
json_patch_operation = {
@@ -1231,14 +1281,14 @@ from pprint import pprint
try:
# Update a Campaign Template
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_campaign_template(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =CertificationCampaignsApi(api_client).patch_campaign_template(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_campaign_template(id, Result)
# results = CertificationCampaignsApi(api_client).patch_campaign_template(id, new_json_patch_operation)
print("The response of CertificationCampaignsApi->patch_campaign_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->patch_campaign_template: %s\n" % e)
```
@@ -1280,24 +1330,28 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_reports_config import CampaignReportsConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
campaign_reports_config = {
"identityAttributeColumns" : [ "firstname", "lastname" ]
} # CampaignReportsConfig | Campaign report configuration.
try:
# Set Campaign Reports Configuration
Result = campaign_reports_config.from_json(campaign_reports_config)
api_response = api_instance.set_campaign_reports_config(Result)
new_campaign_reports_config = CampaignReportsConfig()
new_campaign_reports_config.from_json(campaign_reports_config)
results =CertificationCampaignsApi(api_client).set_campaign_reports_config(new_campaign_reports_config)
# Below is a request that includes all optional parameters
# api_response = api_instance.set_campaign_reports_config(Result)
# results = CertificationCampaignsApi(api_client).set_campaign_reports_config(new_campaign_reports_config)
print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->set_campaign_reports_config: %s\n" % e)
```
@@ -1341,10 +1395,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.schedule import Schedule
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '04bedce387bd47b2ae1f86eb0bb36dee' # str | ID of the campaign template being scheduled. # str | ID of the campaign template being scheduled.
schedule = {
"hours" : {
@@ -1370,11 +1428,10 @@ from pprint import pprint
try:
# Set Campaign Template Schedule
api_instance.set_campaign_template_schedule(id, )
CertificationCampaignsApi(api_client).set_campaign_template_schedule(id, )
# Below is a request that includes all optional parameters
# api_instance.set_campaign_template_schedule(id, Result)
except Exception as e:
# CertificationCampaignsApi(api_client).set_campaign_template_schedule(id, new_schedule)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->set_campaign_template_schedule: %s\n" % e)
```
@@ -1418,10 +1475,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.activate_campaign_options import ActivateCampaignOptions
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID.
activate_campaign_options = {
"timeZone" : "-05:00"
@@ -1430,13 +1491,12 @@ from pprint import pprint
try:
# Activate a Campaign
api_response = api_instance.start_campaign(id, )
results =CertificationCampaignsApi(api_client).start_campaign(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.start_campaign(id, Result)
# results = CertificationCampaignsApi(api_client).start_campaign(id, new_activate_campaign_options)
print("The response of CertificationCampaignsApi->start_campaign:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->start_campaign: %s\n" % e)
```
@@ -1479,21 +1539,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign the remediation scan is being run for. # str | ID of the campaign the remediation scan is being run for.
try:
# Run Campaign Remediation Scan
api_response = api_instance.start_campaign_remediation_scan(id)
results =CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.start_campaign_remediation_scan(id)
# results = CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id)
print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->start_campaign_remediation_scan: %s\n" % e)
```
@@ -1537,23 +1600,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.report_type import ReportType
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign the report is being run for. # str | ID of the campaign the report is being run for.
type = sailpoint.v2024.ReportType() # ReportType | Type of the report to run. # ReportType | Type of the report to run.
try:
# Run Campaign Report
api_response = api_instance.start_campaign_report(id, type)
results =CertificationCampaignsApi(api_client).start_campaign_report(id, type)
# Below is a request that includes all optional parameters
# api_response = api_instance.start_campaign_report(id, type)
# results = CertificationCampaignsApi(api_client).start_campaign_report(id, type)
print("The response of CertificationCampaignsApi->start_campaign_report:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e)
```
@@ -1605,22 +1671,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_reference import CampaignReference
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template to use for generation. # str | ID of the campaign template to use for generation.
try:
# Generate a Campaign from Template
api_response = api_instance.start_generate_campaign_template(id)
results =CertificationCampaignsApi(api_client).start_generate_campaign_template(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.start_generate_campaign_template(id)
# results = CertificationCampaignsApi(api_client).start_generate_campaign_template(id)
print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->start_generate_campaign_template: %s\n" % e)
```
@@ -1664,11 +1733,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.models.slim_campaign import SlimCampaign
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified.
[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}] # List[JsonPatchOperation] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline
json_patch_operation = {
@@ -1680,14 +1753,14 @@ from pprint import pprint
try:
# Update a Campaign
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.update_campaign(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =CertificationCampaignsApi(api_client).update_campaign(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_campaign(id, Result)
# results = CertificationCampaignsApi(api_client).update_campaign(id, new_json_patch_operation)
print("The response of CertificationCampaignsApi->update_campaign:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e)
```

60
docs/tools/sdk/python/Reference/V2024/Methods/CertificationSummariesApi.md
View File

@@ -75,10 +75,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_summary import AccessSummary
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID
type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for
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)
@@ -90,13 +94,12 @@ from pprint import pprint
try:
# Access Summaries
api_response = api_instance.get_identity_access_summaries(id, type, )
results =CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_access_summaries(id, type, limit, offset, count, filters, sorters)
# results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters)
print("The response of CertificationSummariesApi->get_identity_access_summaries:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e)
```
@@ -139,23 +142,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_cert_decision_summary import IdentityCertDecisionSummary
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID
filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional)
try:
# Summary of Certification Decisions
api_response = api_instance.get_identity_decision_summary(id, )
results =CertificationSummariesApi(api_client).get_identity_decision_summary(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_decision_summary(id, filters)
# results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters)
print("The response of CertificationSummariesApi->get_identity_decision_summary:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e)
```
@@ -202,10 +208,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification 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)
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)
@@ -216,13 +226,12 @@ from pprint import pprint
try:
# Identity Summaries for Campaign Certification
api_response = api_instance.get_identity_summaries(id, )
results =CertificationSummariesApi(api_client).get_identity_summaries(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_summaries(id, limit, offset, count, filters, sorters)
# results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters)
print("The response of CertificationSummariesApi->get_identity_summaries:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e)
```
@@ -265,23 +274,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID
identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID
try:
# Summary for Identity
api_response = api_instance.get_identity_summary(id, identity_summary_id)
results =CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_summary(id, identity_summary_id)
# results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id)
print("The response of CertificationSummariesApi->get_identity_summary:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e)
```

174
docs/tools/sdk/python/Reference/V2024/Methods/CertificationsApi.md
View File

@@ -85,22 +85,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certifications_api import CertificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.certification_task import CertificationTask
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '63b32151-26c0-42f4-9299-8898dc1c9daa' # str | The task ID # str | The task ID
try:
# Certification Task by ID
api_response = api_instance.get_certification_task(id)
results =CertificationsApi(api_client).get_certification_task(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_certification_task(id)
# results = CertificationsApi(api_client).get_certification_task(id)
print("The response of CertificationsApi->get_certification_task:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationsApi->get_certification_task: %s\n" % e)
```
@@ -142,22 +145,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certifications_api import CertificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_certification_dto import IdentityCertificationDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification id # str | The certification id
try:
# Identity Certification by ID
api_response = api_instance.get_identity_certification(id)
results =CertificationsApi(api_client).get_identity_certification(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_certification(id)
# results = CertificationsApi(api_client).get_identity_certification(id)
print("The response of CertificationsApi->get_identity_certification:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationsApi->get_identity_certification: %s\n" % e)
```
@@ -204,10 +210,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certifications_api import CertificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.permission_dto import PermissionDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
certification_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID
item_id = '2c91808671bcbab40171bd945d961227' # str | The certification item ID # str | The certification item ID
filters = 'target eq \"SYS.OBJAUTH2\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional)
@@ -218,13 +228,12 @@ from pprint import pprint
try:
# Permissions for Entitlement Certification Item
api_response = api_instance.get_identity_certification_item_permissions(certification_id, item_id, )
results =CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count)
# results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count)
print("The response of CertificationsApi->get_identity_certification_item_permissions:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e)
```
@@ -270,10 +279,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certifications_api import CertificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.certification_task import CertificationTask
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
reviewer_identity = 'Ada.1de82e55078344' # str | The ID of reviewer identity. *me* indicates the current user. (optional) # str | The ID of reviewer identity. *me* indicates the current user. (optional)
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)
@@ -283,13 +296,12 @@ from pprint import pprint
try:
# List of Pending Certification Tasks
api_response = api_instance.get_pending_certification_tasks()
results =CertificationsApi(api_client).get_pending_certification_tasks()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters)
# results = CertificationsApi(api_client).get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters)
print("The response of CertificationsApi->get_pending_certification_tasks:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e)
```
@@ -336,10 +348,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certifications_api import CertificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_reference_with_name_and_email import IdentityReferenceWithNameAndEmail
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification 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)
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)
@@ -350,13 +366,12 @@ from pprint import pprint
try:
# List of Reviewers for certification
api_response = api_instance.list_certification_reviewers(id, )
results =CertificationsApi(api_client).list_certification_reviewers(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_certification_reviewers(id, limit, offset, count, filters, sorters)
# results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters)
print("The response of CertificationsApi->list_certification_reviewers:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e)
```
@@ -406,10 +421,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certifications_api import CertificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_review_item import AccessReviewItem
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification 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)
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)
@@ -423,13 +442,12 @@ from pprint import pprint
try:
# List of Access Review Items
api_response = api_instance.list_identity_access_review_items(id, )
results =CertificationsApi(api_client).list_identity_access_review_items(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_identity_access_review_items(id, limit, offset, count, filters, sorters, entitlements, access_profiles, roles)
# results = CertificationsApi(api_client).list_identity_access_review_items(id, limit, offset, count, filters, sorters, entitlements, access_profiles, roles)
print("The response of CertificationsApi->list_identity_access_review_items:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e)
```
@@ -475,10 +493,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certifications_api import CertificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_certification_dto import IdentityCertificationDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
reviewer_identity = 'me' # str | Reviewer's identity. *me* indicates the current user. (optional) # str | Reviewer's identity. *me* indicates the current user. (optional)
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)
@@ -489,13 +511,12 @@ from pprint import pprint
try:
# List Identity Campaign Certifications
api_response = api_instance.list_identity_certifications()
results =CertificationsApi(api_client).list_identity_certifications()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters)
# results = CertificationsApi(api_client).list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters)
print("The response of CertificationsApi->list_identity_certifications:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e)
```
@@ -538,11 +559,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certifications_api import CertificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_certification_dto import IdentityCertificationDto
from sailpoint.v2024.models.review_decision import ReviewDecision
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the identity campaign certification on which to make decisions # str | The ID of the identity campaign certification on which to make decisions
[{id=ef38f94347e94562b5bb8424a56396b5, decision=APPROVE, bulk=true, comments=This user still needs access to this source.}, {id=ef38f94347e94562b5bb8424a56397d8, decision=APPROVE, bulk=true, comments=This user still needs access to this source too.}] # List[ReviewDecision] | A non-empty array of decisions to be made.
review_decision = {
@@ -561,14 +586,14 @@ from pprint import pprint
try:
# Decide on a Certification Item
Result = review_decision.from_json(review_decision)
api_response = api_instance.make_identity_decision(id, Result)
new_review_decision = ReviewDecision()
new_review_decision.from_json(review_decision)
results =CertificationsApi(api_client).make_identity_decision(id, new_review_decision)
# Below is a request that includes all optional parameters
# api_response = api_instance.make_identity_decision(id, Result)
# results = CertificationsApi(api_client).make_identity_decision(id, new_review_decision)
print("The response of CertificationsApi->make_identity_decision:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationsApi->make_identity_decision: %s\n" % e)
```
@@ -611,11 +636,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certifications_api import CertificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_certification_dto import IdentityCertificationDto
from sailpoint.v2024.models.review_reassign import ReviewReassign
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID
review_reassign = {
"reason" : "reassigned for some reason",
@@ -631,14 +660,14 @@ from pprint import pprint
try:
# Reassign Identities or Items
Result = review_reassign.from_json(review_reassign)
api_response = api_instance.reassign_identity_certifications(id, Result)
new_review_reassign = ReviewReassign()
new_review_reassign.from_json(review_reassign)
results =CertificationsApi(api_client).reassign_identity_certifications(id, new_review_reassign)
# Below is a request that includes all optional parameters
# api_response = api_instance.reassign_identity_certifications(id, Result)
# results = CertificationsApi(api_client).reassign_identity_certifications(id, new_review_reassign)
print("The response of CertificationsApi->reassign_identity_certifications:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationsApi->reassign_identity_certifications: %s\n" % e)
```
@@ -680,22 +709,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certifications_api import CertificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_certification_dto import IdentityCertificationDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID
try:
# Finalize Identity Certification Decisions
api_response = api_instance.sign_off_identity_certification(id)
results =CertificationsApi(api_client).sign_off_identity_certification(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.sign_off_identity_certification(id)
# results = CertificationsApi(api_client).sign_off_identity_certification(id)
print("The response of CertificationsApi->sign_off_identity_certification:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationsApi->sign_off_identity_certification: %s\n" % e)
```
@@ -743,11 +775,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.certifications_api import CertificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.certification_task import CertificationTask
from sailpoint.v2024.models.review_reassign import ReviewReassign
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID
review_reassign = {
"reason" : "reassigned for some reason",
@@ -763,14 +799,14 @@ from pprint import pprint
try:
# Reassign Certifications Asynchronously
Result = review_reassign.from_json(review_reassign)
api_response = api_instance.submit_reassign_certs_async(id, Result)
new_review_reassign = ReviewReassign()
new_review_reassign.from_json(review_reassign)
results =CertificationsApi(api_client).submit_reassign_certs_async(id, new_review_reassign)
# Below is a request that includes all optional parameters
# api_response = api_instance.submit_reassign_certs_async(id, Result)
# results = CertificationsApi(api_client).submit_reassign_certs_async(id, new_review_reassign)
print("The response of CertificationsApi->submit_reassign_certs_async:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e)
```

244
docs/tools/sdk/python/Reference/V2024/Methods/ConfigurationHubApi.md
View File

@@ -77,25 +77,29 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.deploy_request import DeployRequest
from sailpoint.v2024.models.deploy_response import DeployResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
deploy_request = {
"draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b"
} # DeployRequest | The deploy request body.
try:
# Create a Deploy
Result = deploy_request.from_json(deploy_request)
api_response = api_instance.create_deploy(Result)
new_deploy_request = DeployRequest()
new_deploy_request.from_json(deploy_request)
results =ConfigurationHubApi(api_client).create_deploy(new_deploy_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_deploy(Result)
# results = ConfigurationHubApi(api_client).create_deploy(new_deploy_request)
print("The response of ConfigurationHubApi->create_deploy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->create_deploy: %s\n" % e)
```
@@ -141,11 +145,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.object_mapping_request import ObjectMappingRequest
from sailpoint.v2024.models.object_mapping_response import ObjectMappingResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_org = 'source-org' # str | The name of the source org. # str | The name of the source org.
object_mapping_request = {
"targetValue" : "My New Governance Group Name",
@@ -157,14 +165,14 @@ from pprint import pprint
try:
# Creates an object mapping
Result = object_mapping_request.from_json(object_mapping_request)
api_response = api_instance.create_object_mapping(source_org, Result)
new_object_mapping_request = ObjectMappingRequest()
new_object_mapping_request.from_json(object_mapping_request)
results =ConfigurationHubApi(api_client).create_object_mapping(source_org, new_object_mapping_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_object_mapping(source_org, Result)
# results = ConfigurationHubApi(api_client).create_object_mapping(source_org, new_object_mapping_request)
print("The response of ConfigurationHubApi->create_object_mapping:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->create_object_mapping: %s\n" % e)
```
@@ -210,11 +218,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.object_mapping_bulk_create_request import ObjectMappingBulkCreateRequest
from sailpoint.v2024.models.object_mapping_bulk_create_response import ObjectMappingBulkCreateResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_org = 'source-org' # str | The name of the source org. # str | The name of the source org.
object_mapping_bulk_create_request = {
"newObjectsMappings" : [ {
@@ -234,14 +246,14 @@ from pprint import pprint
try:
# Bulk creates object mappings
Result = object_mapping_bulk_create_request.from_json(object_mapping_bulk_create_request)
api_response = api_instance.create_object_mappings(source_org, Result)
new_object_mapping_bulk_create_request = ObjectMappingBulkCreateRequest()
new_object_mapping_bulk_create_request.from_json(object_mapping_bulk_create_request)
results =ConfigurationHubApi(api_client).create_object_mappings(source_org, new_object_mapping_bulk_create_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_object_mappings(source_org, Result)
# results = ConfigurationHubApi(api_client).create_object_mappings(source_org, new_object_mapping_bulk_create_request)
print("The response of ConfigurationHubApi->create_object_mappings:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->create_object_mappings: %s\n" % e)
```
@@ -287,23 +299,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.backup_response import BackupResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported.
name = 'name_example' # str | Name that will be assigned to the uploaded configuration file. # str | Name that will be assigned to the uploaded configuration file.
try:
# Upload a Configuration
api_response = api_instance.create_uploaded_configuration(data, name)
results =ConfigurationHubApi(api_client).create_uploaded_configuration(data, name)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_uploaded_configuration(data, name)
# results = ConfigurationHubApi(api_client).create_uploaded_configuration(data, name)
print("The response of ConfigurationHubApi->create_uploaded_configuration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->create_uploaded_configuration: %s\n" % e)
```
@@ -349,19 +364,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '07659d7d-2cce-47c0-9e49-185787ee565a' # str | The id of the backup to delete. # str | The id of the backup to delete.
try:
# Delete a Backup
api_instance.delete_backup(id)
ConfigurationHubApi(api_client).delete_backup(id)
# Below is a request that includes all optional parameters
# api_instance.delete_backup(id)
except Exception as e:
# ConfigurationHubApi(api_client).delete_backup(id)
except Exception as e:
print("Exception when calling ConfigurationHubApi->delete_backup: %s\n" % e)
```
@@ -407,19 +425,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '07659d7d-2cce-47c0-9e49-185787ee565a' # str | The id of the draft to delete. # str | The id of the draft to delete.
try:
# Delete a draft
api_instance.delete_draft(id)
ConfigurationHubApi(api_client).delete_draft(id)
# Below is a request that includes all optional parameters
# api_instance.delete_draft(id)
except Exception as e:
# ConfigurationHubApi(api_client).delete_draft(id)
except Exception as e:
print("Exception when calling ConfigurationHubApi->delete_draft: %s\n" % e)
```
@@ -465,20 +486,23 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_org = 'source-org' # str | The name of the source org. # str | The name of the source org.
object_mapping_id = '3d6e0144-963f-4bd6-8d8d-d77b4e507ce4' # str | The id of the object mapping to be deleted. # str | The id of the object mapping to be deleted.
try:
# Deletes an object mapping
api_instance.delete_object_mapping(source_org, object_mapping_id)
ConfigurationHubApi(api_client).delete_object_mapping(source_org, object_mapping_id)
# Below is a request that includes all optional parameters
# api_instance.delete_object_mapping(source_org, object_mapping_id)
except Exception as e:
# ConfigurationHubApi(api_client).delete_object_mapping(source_org, object_mapping_id)
except Exception as e:
print("Exception when calling ConfigurationHubApi->delete_object_mapping: %s\n" % e)
```
@@ -524,19 +548,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b' # str | The id of the uploaded configuration. # str | The id of the uploaded configuration.
try:
# Delete an Uploaded Configuration
api_instance.delete_uploaded_configuration(id)
ConfigurationHubApi(api_client).delete_uploaded_configuration(id)
# Below is a request that includes all optional parameters
# api_instance.delete_uploaded_configuration(id)
except Exception as e:
# ConfigurationHubApi(api_client).delete_uploaded_configuration(id)
except Exception as e:
print("Exception when calling ConfigurationHubApi->delete_uploaded_configuration: %s\n" % e)
```
@@ -578,22 +605,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.deploy_response import DeployResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b' # str | The id of the deploy. # str | The id of the deploy.
try:
# Get a Deploy
api_response = api_instance.get_deploy(id)
results =ConfigurationHubApi(api_client).get_deploy(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_deploy(id)
# results = ConfigurationHubApi(api_client).get_deploy(id)
print("The response of ConfigurationHubApi->get_deploy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->get_deploy: %s\n" % e)
```
@@ -638,22 +668,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.object_mapping_response import ObjectMappingResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_org = 'source-org' # str | The name of the source org. # str | The name of the source org.
try:
# Gets list of object mappings
api_response = api_instance.get_object_mappings(source_org)
results =ConfigurationHubApi(api_client).get_object_mappings(source_org)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_object_mappings(source_org)
# results = ConfigurationHubApi(api_client).get_object_mappings(source_org)
print("The response of ConfigurationHubApi->get_object_mappings:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e)
```
@@ -695,22 +728,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.backup_response import BackupResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b' # str | The id of the uploaded configuration. # str | The id of the uploaded configuration.
try:
# Get an Uploaded Configuration
api_response = api_instance.get_uploaded_configuration(id)
results =ConfigurationHubApi(api_client).get_uploaded_configuration(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_uploaded_configuration(id)
# results = ConfigurationHubApi(api_client).get_uploaded_configuration(id)
print("The response of ConfigurationHubApi->get_uploaded_configuration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->get_uploaded_configuration: %s\n" % e)
```
@@ -751,22 +787,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.backup_response import BackupResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
filters = 'status eq \"COMPLETE\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional)
try:
# List Backups
api_response = api_instance.list_backups()
results =ConfigurationHubApi(api_client).list_backups()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_backups(filters)
# results = ConfigurationHubApi(api_client).list_backups(filters)
print("The response of ConfigurationHubApi->list_backups:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->list_backups: %s\n" % e)
```
@@ -804,21 +843,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.deploy_response import DeployResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Deploys
api_response = api_instance.list_deploys()
results =ConfigurationHubApi(api_client).list_deploys()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_deploys()
# results = ConfigurationHubApi(api_client).list_deploys()
print("The response of ConfigurationHubApi->list_deploys:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->list_deploys: %s\n" % e)
```
@@ -859,22 +901,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.draft_response import DraftResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
filters = 'status eq \"COMPLETE\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* (optional)
try:
# List Drafts
api_response = api_instance.list_drafts()
results =ConfigurationHubApi(api_client).list_drafts()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_drafts(filters)
# results = ConfigurationHubApi(api_client).list_drafts(filters)
print("The response of ConfigurationHubApi->list_drafts:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->list_drafts: %s\n" % e)
```
@@ -916,22 +961,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.backup_response import BackupResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
filters = 'status eq \"COMPLETE\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional)
try:
# List Uploaded Configurations
api_response = api_instance.list_uploaded_configurations()
results =ConfigurationHubApi(api_client).list_uploaded_configurations()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_uploaded_configurations(filters)
# results = ConfigurationHubApi(api_client).list_uploaded_configurations(filters)
print("The response of ConfigurationHubApi->list_uploaded_configurations:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e)
```
@@ -977,11 +1025,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.object_mapping_bulk_patch_request import ObjectMappingBulkPatchRequest
from sailpoint.v2024.models.object_mapping_bulk_patch_response import ObjectMappingBulkPatchResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_org = 'source-org' # str | The name of the source org. # str | The name of the source org.
object_mapping_bulk_patch_request = {
"patches" : {
@@ -1000,14 +1052,14 @@ from pprint import pprint
try:
# Bulk updates object mappings
Result = object_mapping_bulk_patch_request.from_json(object_mapping_bulk_patch_request)
api_response = api_instance.update_object_mappings(source_org, Result)
new_object_mapping_bulk_patch_request = ObjectMappingBulkPatchRequest()
new_object_mapping_bulk_patch_request.from_json(object_mapping_bulk_patch_request)
results =ConfigurationHubApi(api_client).update_object_mappings(source_org, new_object_mapping_bulk_patch_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_object_mappings(source_org, Result)
# results = ConfigurationHubApi(api_client).update_object_mappings(source_org, new_object_mapping_bulk_patch_request)
print("The response of ConfigurationHubApi->update_object_mappings:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->update_object_mappings: %s\n" % e)
```

94
docs/tools/sdk/python/Reference/V2024/Methods/ConnectorRuleManagementApi.md
View File

@@ -67,11 +67,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.connector_rule_create_request import ConnectorRuleCreateRequest
from sailpoint.v2024.models.connector_rule_response import ConnectorRuleResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
connector_rule_create_request = {
"sourceCode" : {
@@ -102,14 +106,14 @@ from pprint import pprint
try:
# Create Connector Rule
Result = connector_rule_create_request.from_json(connector_rule_create_request)
api_response = api_instance.create_connector_rule(x_sail_point_experimental, Result)
new_connector_rule_create_request = ConnectorRuleCreateRequest()
new_connector_rule_create_request.from_json(connector_rule_create_request)
results =ConnectorRuleManagementApi(api_client).create_connector_rule(x_sail_point_experimental, new_connector_rule_create_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_connector_rule(x_sail_point_experimental, Result)
# results = ConnectorRuleManagementApi(api_client).create_connector_rule(x_sail_point_experimental, new_connector_rule_create_request)
print("The response of ConnectorRuleManagementApi->create_connector_rule:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorRuleManagementApi->create_connector_rule: %s\n" % e)
```
@@ -155,20 +159,23 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to delete. # str | ID of the connector rule to delete.
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')
try:
# Delete Connector Rule
api_instance.delete_connector_rule(id, x_sail_point_experimental)
ConnectorRuleManagementApi(api_client).delete_connector_rule(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_instance.delete_connector_rule(id, x_sail_point_experimental)
except Exception as e:
# ConnectorRuleManagementApi(api_client).delete_connector_rule(id, x_sail_point_experimental)
except Exception as e:
print("Exception when calling ConnectorRuleManagementApi->delete_connector_rule: %s\n" % e)
```
@@ -214,23 +221,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.connector_rule_response import ConnectorRuleResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to get. # str | ID of the connector rule to get.
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')
try:
# Get Connector Rule
api_response = api_instance.get_connector_rule(id, x_sail_point_experimental)
results =ConnectorRuleManagementApi(api_client).get_connector_rule(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_connector_rule(id, x_sail_point_experimental)
# results = ConnectorRuleManagementApi(api_client).get_connector_rule(id, x_sail_point_experimental)
print("The response of ConnectorRuleManagementApi->get_connector_rule:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorRuleManagementApi->get_connector_rule: %s\n" % e)
```
@@ -277,10 +287,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.connector_rule_response import ConnectorRuleResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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 = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50)
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)
@@ -289,13 +303,12 @@ from pprint import pprint
try:
# List Connector Rules
api_response = api_instance.get_connector_rule_list(x_sail_point_experimental, )
results =ConnectorRuleManagementApi(api_client).get_connector_rule_list(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_connector_rule_list(x_sail_point_experimental, limit, offset, count)
# results = ConnectorRuleManagementApi(api_client).get_connector_rule_list(x_sail_point_experimental, limit, offset, count)
print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e)
```
@@ -342,11 +355,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.connector_rule_response import ConnectorRuleResponse
from sailpoint.v2024.models.connector_rule_update_request import ConnectorRuleUpdateRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to update. # str | ID of the connector rule to update.
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')
connector_rule_update_request = {
@@ -380,13 +397,12 @@ from pprint import pprint
try:
# Update Connector Rule
api_response = api_instance.put_connector_rule(id, x_sail_point_experimental, )
results =ConnectorRuleManagementApi(api_client).put_connector_rule(id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.put_connector_rule(id, x_sail_point_experimental, Result)
# results = ConnectorRuleManagementApi(api_client).put_connector_rule(id, x_sail_point_experimental, new_connector_rule_update_request)
print("The response of ConnectorRuleManagementApi->put_connector_rule:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorRuleManagementApi->put_connector_rule: %s\n" % e)
```
@@ -431,11 +447,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.connector_rule_validation_response import ConnectorRuleValidationResponse
from sailpoint.v2024.models.source_code import SourceCode
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
source_code = {
"version" : "1.0",
@@ -444,14 +464,14 @@ from pprint import pprint
try:
# Validate Connector Rule
Result = source_code.from_json(source_code)
api_response = api_instance.test_connector_rule(x_sail_point_experimental, Result)
new_source_code = SourceCode()
new_source_code.from_json(source_code)
results =ConnectorRuleManagementApi(api_client).test_connector_rule(x_sail_point_experimental, new_source_code)
# Below is a request that includes all optional parameters
# api_response = api_instance.test_connector_rule(x_sail_point_experimental, Result)
# results = ConnectorRuleManagementApi(api_client).test_connector_rule(x_sail_point_experimental, new_source_code)
print("The response of ConnectorRuleManagementApi->test_connector_rule:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorRuleManagementApi->test_connector_rule: %s\n" % e)
```

199
docs/tools/sdk/python/Reference/V2024/Methods/ConnectorsApi.md
View File

@@ -78,11 +78,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.v3_connector_dto import V3ConnectorDto
from sailpoint.v2024.models.v3_create_connector_dto import V3CreateConnectorDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
v3_create_connector_dto = {
"name" : "custom connector",
"directConnect" : true,
@@ -93,14 +97,14 @@ from pprint import pprint
try:
# Create Custom Connector
Result = v3_create_connector_dto.from_json(v3_create_connector_dto)
api_response = api_instance.create_custom_connector(Result)
new_v3_create_connector_dto = V3CreateConnectorDto()
new_v3_create_connector_dto.from_json(v3_create_connector_dto)
results =ConnectorsApi(api_client).create_custom_connector(new_v3_create_connector_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_custom_connector(Result)
# results = ConnectorsApi(api_client).create_custom_connector(new_v3_create_connector_dto)
print("The response of ConnectorsApi->create_custom_connector:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorsApi->create_custom_connector: %s\n" % e)
```
@@ -142,19 +146,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
try:
# Delete Connector by Script Name
api_instance.delete_custom_connector(script_name)
ConnectorsApi(api_client).delete_custom_connector(script_name)
# Below is a request that includes all optional parameters
# api_instance.delete_custom_connector(script_name)
except Exception as e:
# ConnectorsApi(api_client).delete_custom_connector(script_name)
except Exception as e:
print("Exception when calling ConnectorsApi->delete_custom_connector: %s\n" % e)
```
@@ -197,23 +204,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.connector_detail import ConnectorDetail
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
locale = 'de' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional)
try:
# Get Connector by Script Name
api_response = api_instance.get_connector(script_name, )
results =ConnectorsApi(api_client).get_connector(script_name, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_connector(script_name, locale)
# results = ConnectorsApi(api_client).get_connector(script_name, locale)
print("The response of ConnectorsApi->get_connector:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorsApi->get_connector: %s\n" % e)
```
@@ -255,21 +265,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
try:
# Get Connector Correlation Configuration
api_response = api_instance.get_connector_correlation_config(script_name)
results =ConnectorsApi(api_client).get_connector_correlation_config(script_name)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_connector_correlation_config(script_name)
# results = ConnectorsApi(api_client).get_connector_correlation_config(script_name)
print("The response of ConnectorsApi->get_connector_correlation_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorsApi->get_connector_correlation_config: %s\n" % e)
```
@@ -315,10 +328,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.v3_connector_dto import V3ConnectorDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
filters = 'directConnect eq \"true\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional)
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)
@@ -328,13 +345,12 @@ from pprint import pprint
try:
# Get Connector List
api_response = api_instance.get_connector_list()
results =ConnectorsApi(api_client).get_connector_list()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_connector_list(filters, limit, offset, count, locale)
# results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale)
print("The response of ConnectorsApi->get_connector_list:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e)
```
@@ -376,21 +392,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
try:
# Get Connector Source Configuration
api_response = api_instance.get_connector_source_config(script_name)
results =ConnectorsApi(api_client).get_connector_source_config(script_name)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_connector_source_config(script_name)
# results = ConnectorsApi(api_client).get_connector_source_config(script_name)
print("The response of ConnectorsApi->get_connector_source_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorsApi->get_connector_source_config: %s\n" % e)
```
@@ -432,21 +451,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
try:
# Get Connector Source Template
api_response = api_instance.get_connector_source_template(script_name)
results =ConnectorsApi(api_client).get_connector_source_template(script_name)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_connector_source_template(script_name)
# results = ConnectorsApi(api_client).get_connector_source_template(script_name)
print("The response of ConnectorsApi->get_connector_source_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorsApi->get_connector_source_template: %s\n" % e)
```
@@ -489,22 +511,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
locale = 'de' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\"
try:
# Get Connector Translations
api_response = api_instance.get_connector_translations(script_name, locale)
results =ConnectorsApi(api_client).get_connector_translations(script_name, locale)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_connector_translations(script_name, locale)
# results = ConnectorsApi(api_client).get_connector_translations(script_name, locale)
print("The response of ConnectorsApi->get_connector_translations:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorsApi->get_connector_translations: %s\n" % e)
```
@@ -547,23 +572,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.update_detail import UpdateDetail
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
file = None # bytearray | connector correlation config xml file # bytearray | connector correlation config xml file
try:
# Update Connector Correlation Configuration
api_response = api_instance.put_connector_correlation_config(script_name, file)
results =ConnectorsApi(api_client).put_connector_correlation_config(script_name, file)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_connector_correlation_config(script_name, file)
# results = ConnectorsApi(api_client).put_connector_correlation_config(script_name, file)
print("The response of ConnectorsApi->put_connector_correlation_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorsApi->put_connector_correlation_config: %s\n" % e)
```
@@ -606,23 +634,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.update_detail import UpdateDetail
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
file = None # bytearray | connector source config xml file # bytearray | connector source config xml file
try:
# Update Connector Source Configuration
api_response = api_instance.put_connector_source_config(script_name, file)
results =ConnectorsApi(api_client).put_connector_source_config(script_name, file)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_connector_source_config(script_name, file)
# results = ConnectorsApi(api_client).put_connector_source_config(script_name, file)
print("The response of ConnectorsApi->put_connector_source_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorsApi->put_connector_source_config: %s\n" % e)
```
@@ -665,23 +696,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.update_detail import UpdateDetail
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
file = None # bytearray | connector source template xml file # bytearray | connector source template xml file
try:
# Update Connector Source Template
api_response = api_instance.put_connector_source_template(script_name, file)
results =ConnectorsApi(api_client).put_connector_source_template(script_name, file)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_connector_source_template(script_name, file)
# results = ConnectorsApi(api_client).put_connector_source_template(script_name, file)
print("The response of ConnectorsApi->put_connector_source_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorsApi->put_connector_source_template: %s\n" % e)
```
@@ -724,23 +758,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.update_detail import UpdateDetail
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
locale = 'de' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\"
try:
# Update Connector Translations
api_response = api_instance.put_connector_translations(script_name, locale)
results =ConnectorsApi(api_client).put_connector_translations(script_name, locale)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_connector_translations(script_name, locale)
# results = ConnectorsApi(api_client).put_connector_translations(script_name, locale)
print("The response of ConnectorsApi->put_connector_translations:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorsApi->put_connector_translations: %s\n" % e)
```
@@ -795,11 +832,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.connector_detail import ConnectorDetail
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
[sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | A list of connector detail update operations
json_patch_operation = {
@@ -811,14 +852,14 @@ from pprint import pprint
try:
# Update Connector by Script Name
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.update_connector(script_name, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =ConnectorsApi(api_client).update_connector(script_name, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_connector(script_name, Result)
# results = ConnectorsApi(api_client).update_connector(script_name, new_json_patch_operation)
print("The response of ConnectorsApi->update_connector:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorsApi->update_connector: %s\n" % e)
```

270
docs/tools/sdk/python/Reference/V2024/Methods/CustomFormsApi.md
View File

@@ -80,11 +80,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.create_form_definition_request import CreateFormDefinitionRequest
from sailpoint.v2024.models.form_definition_response import FormDefinitionResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
body = {
"owner" : {
@@ -201,13 +205,12 @@ from pprint import pprint
try:
# Creates a form definition.
api_response = api_instance.create_form_definition(x_sail_point_experimental, )
results =CustomFormsApi(api_client).create_form_definition(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.create_form_definition(x_sail_point_experimental, Result)
# results = CustomFormsApi(api_client).create_form_definition(x_sail_point_experimental, new_body)
print("The response of CustomFormsApi->create_form_definition:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->create_form_definition: %s\n" % e)
```
@@ -253,11 +256,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.form_definition_dynamic_schema_request import FormDefinitionDynamicSchemaRequest
from sailpoint.v2024.models.form_definition_dynamic_schema_response import FormDefinitionDynamicSchemaResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
body = {
"description" : "A description",
@@ -272,13 +279,12 @@ from pprint import pprint
try:
# Generate JSON Schema dynamically.
api_response = api_instance.create_form_definition_dynamic_schema(x_sail_point_experimental, )
results =CustomFormsApi(api_client).create_form_definition_dynamic_schema(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.create_form_definition_dynamic_schema(x_sail_point_experimental, Result)
# results = CustomFormsApi(api_client).create_form_definition_dynamic_schema(x_sail_point_experimental, new_body)
print("The response of CustomFormsApi->create_form_definition_dynamic_schema:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->create_form_definition_dynamic_schema: %s\n" % e)
```
@@ -328,10 +334,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.form_definition_file_upload_response import FormDefinitionFileUploadResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | FormDefinitionID String specifying FormDefinitionID # str | FormDefinitionID String specifying FormDefinitionID
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')
file = None # bytearray | File specifying the multipart # bytearray | File specifying the multipart
@@ -339,13 +349,12 @@ from pprint import pprint
try:
# Upload new form definition file.
api_response = api_instance.create_form_definition_file_request(form_definition_id, x_sail_point_experimental, file)
results =CustomFormsApi(api_client).create_form_definition_file_request(form_definition_id, x_sail_point_experimental, file)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_form_definition_file_request(form_definition_id, x_sail_point_experimental, file)
# results = CustomFormsApi(api_client).create_form_definition_file_request(form_definition_id, x_sail_point_experimental, file)
print("The response of CustomFormsApi->create_form_definition_file_request:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->create_form_definition_file_request: %s\n" % e)
```
@@ -390,11 +399,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.create_form_instance_request import CreateFormInstanceRequest
from sailpoint.v2024.models.form_instance_response import FormInstanceResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
body = {
"formInput" : {
@@ -421,13 +434,12 @@ from pprint import pprint
try:
# Creates a form instance.
api_response = api_instance.create_form_instance(x_sail_point_experimental, )
results =CustomFormsApi(api_client).create_form_instance(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.create_form_instance(x_sail_point_experimental, Result)
# results = CustomFormsApi(api_client).create_form_instance(x_sail_point_experimental, new_body)
print("The response of CustomFormsApi->create_form_instance:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->create_form_instance: %s\n" % e)
```
@@ -473,22 +485,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition 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')
try:
# Deletes a form definition.
api_response = api_instance.delete_form_definition(form_definition_id, x_sail_point_experimental)
results =CustomFormsApi(api_client).delete_form_definition(form_definition_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_form_definition(form_definition_id, x_sail_point_experimental)
# results = CustomFormsApi(api_client).delete_form_definition(form_definition_id, x_sail_point_experimental)
print("The response of CustomFormsApi->delete_form_definition:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->delete_form_definition: %s\n" % e)
```
@@ -536,10 +551,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.export_form_definitions_by_tenant200_response_inner import ExportFormDefinitionsByTenant200ResponseInner
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
offset = 0 # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0)
limit = 250 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250)
@@ -549,13 +568,12 @@ from pprint import pprint
try:
# List form definitions by tenant.
api_response = api_instance.export_form_definitions_by_tenant(x_sail_point_experimental, )
results =CustomFormsApi(api_client).export_form_definitions_by_tenant(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.export_form_definitions_by_tenant(x_sail_point_experimental, offset, limit, filters, sorters)
# results = CustomFormsApi(api_client).export_form_definitions_by_tenant(x_sail_point_experimental, offset, limit, filters, sorters)
print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e)
```
@@ -603,9 +621,13 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | FormDefinitionID Form definition ID # str | FormDefinitionID Form definition ID
file_id = '00000031N0J7R2B57M8YG73J7M.png' # str | FileID String specifying the hashed name of the uploaded file we are retrieving. # str | FileID String specifying the hashed name of the uploaded file we are retrieving.
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')
@@ -613,13 +635,12 @@ from pprint import pprint
try:
# Download definition file by fileId.
api_response = api_instance.get_file_from_s3(form_definition_id, file_id, x_sail_point_experimental)
results =CustomFormsApi(api_client).get_file_from_s3(form_definition_id, file_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_file_from_s3(form_definition_id, file_id, x_sail_point_experimental)
# results = CustomFormsApi(api_client).get_file_from_s3(form_definition_id, file_id, x_sail_point_experimental)
print("The response of CustomFormsApi->get_file_from_s3:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->get_file_from_s3: %s\n" % e)
```
@@ -665,23 +686,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.form_definition_response import FormDefinitionResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition 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')
try:
# Return a form definition.
api_response = api_instance.get_form_definition_by_key(form_definition_id, x_sail_point_experimental)
results =CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_form_definition_by_key(form_definition_id, x_sail_point_experimental)
# results = CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id, x_sail_point_experimental)
print("The response of CustomFormsApi->get_form_definition_by_key:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->get_form_definition_by_key: %s\n" % e)
```
@@ -727,23 +751,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.form_instance_response import FormInstanceResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance 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')
try:
# Returns a form instance.
api_response = api_instance.get_form_instance_by_key(form_instance_id, x_sail_point_experimental)
results =CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_form_instance_by_key(form_instance_id, x_sail_point_experimental)
# results = CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id, x_sail_point_experimental)
print("The response of CustomFormsApi->get_form_instance_by_key:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->get_form_instance_by_key: %s\n" % e)
```
@@ -791,9 +818,13 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_instance_id = '00000000-0000-0000-0000-000000000000' # str | FormInstanceID Form instance ID # str | FormInstanceID Form instance ID
file_id = '00000031N0J7R2B57M8YG73J7M.png' # str | FileID String specifying the hashed name of the uploaded file we are retrieving. # str | FileID String specifying the hashed name of the uploaded file we are retrieving.
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')
@@ -801,13 +832,12 @@ from pprint import pprint
try:
# Download instance file by fileId.
api_response = api_instance.get_form_instance_file(form_instance_id, file_id, x_sail_point_experimental)
results =CustomFormsApi(api_client).get_form_instance_file(form_instance_id, file_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_form_instance_file(form_instance_id, file_id, x_sail_point_experimental)
# results = CustomFormsApi(api_client).get_form_instance_file(form_instance_id, file_id, x_sail_point_experimental)
print("The response of CustomFormsApi->get_form_instance_file:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->get_form_instance_file: %s\n" % e)
```
@@ -852,11 +882,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.export_form_definitions_by_tenant200_response_inner import ExportFormDefinitionsByTenant200ResponseInner
from sailpoint.v2024.models.import_form_definitions202_response import ImportFormDefinitions202Response
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}] # List[ExportFormDefinitionsByTenant200ResponseInner] | Body is the request payload to import form definitions (optional)
body = [{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}] # List[ExportFormDefinitionsByTenant200ResponseInner] | Body is the request payload to import form definitions (optional)
@@ -865,13 +899,12 @@ from pprint import pprint
try:
# Import form definitions from export.
api_response = api_instance.import_form_definitions(x_sail_point_experimental, )
results =CustomFormsApi(api_client).import_form_definitions(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.import_form_definitions(x_sail_point_experimental, Result)
# results = CustomFormsApi(api_client).import_form_definitions(x_sail_point_experimental, new_body)
print("The response of CustomFormsApi->import_form_definitions:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->import_form_definitions: %s\n" % e)
```
@@ -918,10 +951,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.form_definition_response import FormDefinitionResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition 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')
body = [{op=replace, path=/description, value=test-description}] # List[Dict[str, object]] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional)
@@ -931,13 +968,12 @@ from pprint import pprint
try:
# Patch a form definition.
api_response = api_instance.patch_form_definition(form_definition_id, x_sail_point_experimental, )
results =CustomFormsApi(api_client).patch_form_definition(form_definition_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_form_definition(form_definition_id, x_sail_point_experimental, Result)
# results = CustomFormsApi(api_client).patch_form_definition(form_definition_id, x_sail_point_experimental, new_body)
print("The response of CustomFormsApi->patch_form_definition:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->patch_form_definition: %s\n" % e)
```
@@ -985,10 +1021,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.form_instance_response import FormInstanceResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance 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')
body = [{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}] # List[Dict[str, object]] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional)
@@ -998,13 +1038,12 @@ from pprint import pprint
try:
# Patch a form instance.
api_response = api_instance.patch_form_instance(form_instance_id, x_sail_point_experimental, )
results =CustomFormsApi(api_client).patch_form_instance(form_instance_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_form_instance(form_instance_id, x_sail_point_experimental, Result)
# results = CustomFormsApi(api_client).patch_form_instance(form_instance_id, x_sail_point_experimental, new_body)
print("The response of CustomFormsApi->patch_form_instance:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->patch_form_instance: %s\n" % e)
```
@@ -1052,10 +1091,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.list_form_definitions_by_tenant_response import ListFormDefinitionsByTenantResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
offset = 0 # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0)
limit = 250 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250)
@@ -1065,13 +1108,12 @@ from pprint import pprint
try:
# Export form definitions by tenant.
api_response = api_instance.search_form_definitions_by_tenant(x_sail_point_experimental, )
results =CustomFormsApi(api_client).search_form_definitions_by_tenant(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.search_form_definitions_by_tenant(x_sail_point_experimental, offset, limit, filters, sorters)
# results = CustomFormsApi(api_client).search_form_definitions_by_tenant(x_sail_point_experimental, offset, limit, filters, sorters)
print("The response of CustomFormsApi->search_form_definitions_by_tenant:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->search_form_definitions_by_tenant: %s\n" % e)
```
@@ -1122,10 +1164,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.list_form_element_data_by_element_id_response import ListFormElementDataByElementIDResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID
form_element_id = '1' # str | Form element ID # str | Form element 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')
@@ -1136,13 +1182,12 @@ from pprint import pprint
try:
# Retrieves dynamic data by element.
api_response = api_instance.search_form_element_data_by_element_id(form_instance_id, form_element_id, x_sail_point_experimental, )
results =CustomFormsApi(api_client).search_form_element_data_by_element_id(form_instance_id, form_element_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.search_form_element_data_by_element_id(form_instance_id, form_element_id, x_sail_point_experimental, limit, filters, query)
# results = CustomFormsApi(api_client).search_form_element_data_by_element_id(form_instance_id, form_element_id, x_sail_point_experimental, limit, filters, query)
print("The response of CustomFormsApi->search_form_element_data_by_element_id:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->search_form_element_data_by_element_id: %s\n" % e)
```
@@ -1186,22 +1231,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.list_form_instances_by_tenant_response import ListFormInstancesByTenantResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
try:
# List form instances by tenant.
api_response = api_instance.search_form_instances_by_tenant(x_sail_point_experimental)
results =CustomFormsApi(api_client).search_form_instances_by_tenant(x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.search_form_instances_by_tenant(x_sail_point_experimental)
# results = CustomFormsApi(api_client).search_form_instances_by_tenant(x_sail_point_experimental)
print("The response of CustomFormsApi->search_form_instances_by_tenant:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e)
```
@@ -1245,22 +1293,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.list_predefined_select_options_response import ListPredefinedSelectOptionsResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
try:
# List predefined select options.
api_response = api_instance.search_pre_defined_select_options(x_sail_point_experimental)
results =CustomFormsApi(api_client).search_pre_defined_select_options(x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.search_pre_defined_select_options(x_sail_point_experimental)
# results = CustomFormsApi(api_client).search_pre_defined_select_options(x_sail_point_experimental)
print("The response of CustomFormsApi->search_pre_defined_select_options:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->search_pre_defined_select_options: %s\n" % e)
```
@@ -1310,11 +1361,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.form_element_preview_request import FormElementPreviewRequest
from sailpoint.v2024.models.preview_data_source_response import PreviewDataSourceResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition 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')
limit = 10 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10)
@@ -1335,13 +1390,12 @@ from pprint import pprint
try:
# Preview form definition data source.
api_response = api_instance.show_preview_data_source(form_definition_id, x_sail_point_experimental, )
results =CustomFormsApi(api_client).show_preview_data_source(form_definition_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.show_preview_data_source(form_definition_id, x_sail_point_experimental, limit, filters, query, Result)
# results = CustomFormsApi(api_client).show_preview_data_source(form_definition_id, x_sail_point_experimental, limit, filters, query, new_form_element_preview_request)
print("The response of CustomFormsApi->show_preview_data_source:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->show_preview_data_source: %s\n" % e)
```

46
docs/tools/sdk/python/Reference/V2024/Methods/CustomPasswordInstructionsApi.md
View File

@@ -66,10 +66,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.custom_password_instructions_api import CustomPasswordInstructionsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.custom_password_instruction import CustomPasswordInstruction
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
custom_password_instruction = {
"pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.",
@@ -79,14 +83,14 @@ from pprint import pprint
try:
# Create Custom Password Instructions
Result = custom_password_instruction.from_json(custom_password_instruction)
api_response = api_instance.create_custom_password_instructions(x_sail_point_experimental, Result)
new_custom_password_instruction = CustomPasswordInstruction()
new_custom_password_instruction.from_json(custom_password_instruction)
results =CustomPasswordInstructionsApi(api_client).create_custom_password_instructions(x_sail_point_experimental, new_custom_password_instruction)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_custom_password_instructions(x_sail_point_experimental, Result)
# results = CustomPasswordInstructionsApi(api_client).create_custom_password_instructions(x_sail_point_experimental, new_custom_password_instruction)
print("The response of CustomPasswordInstructionsApi->create_custom_password_instructions:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomPasswordInstructionsApi->create_custom_password_instructions: %s\n" % e)
```
@@ -131,9 +135,13 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.custom_password_instructions_api import CustomPasswordInstructionsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
page_id = 'mfa:select' # str | The page ID of custom password instructions to delete. # str | The page ID of custom password instructions to delete.
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')
locale = 'locale_example' # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional)
@@ -141,11 +149,10 @@ from pprint import pprint
try:
# Delete Custom Password Instructions by page ID
api_instance.delete_custom_password_instructions(page_id, x_sail_point_experimental, )
CustomPasswordInstructionsApi(api_client).delete_custom_password_instructions(page_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_instance.delete_custom_password_instructions(page_id, x_sail_point_experimental, locale)
except Exception as e:
# CustomPasswordInstructionsApi(api_client).delete_custom_password_instructions(page_id, x_sail_point_experimental, locale)
except Exception as e:
print("Exception when calling CustomPasswordInstructionsApi->delete_custom_password_instructions: %s\n" % e)
```
@@ -190,10 +197,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.custom_password_instructions_api import CustomPasswordInstructionsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.custom_password_instruction import CustomPasswordInstruction
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
page_id = 'mfa:select' # str | The page ID of custom password instructions to query. # str | The page ID of custom password instructions to query.
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')
locale = 'locale_example' # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional)
@@ -201,13 +212,12 @@ from pprint import pprint
try:
# Get Custom Password Instructions by Page ID
api_response = api_instance.get_custom_password_instructions(page_id, x_sail_point_experimental, )
results =CustomPasswordInstructionsApi(api_client).get_custom_password_instructions(page_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_custom_password_instructions(page_id, x_sail_point_experimental, locale)
# results = CustomPasswordInstructionsApi(api_client).get_custom_password_instructions(page_id, x_sail_point_experimental, locale)
print("The response of CustomPasswordInstructionsApi->get_custom_password_instructions:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomPasswordInstructionsApi->get_custom_password_instructions: %s\n" % e)
```

125
docs/tools/sdk/python/Reference/V2024/Methods/DataSegmentationApi.md
View File

@@ -61,22 +61,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.data_segmentation_api import DataSegmentationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.data_segment import DataSegment
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
data_segment = sailpoint.v2024.DataSegment() # DataSegment |
try:
# Create Segment
Result = data_segment.from_json(data_segment)
api_response = api_instance.create_data_segment(Result)
new_data_segment = DataSegment()
new_data_segment.from_json(data_segment)
results =DataSegmentationApi(api_client).create_data_segment(new_data_segment)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_data_segment(Result)
# results = DataSegmentationApi(api_client).create_data_segment(new_data_segment)
print("The response of DataSegmentationApi->create_data_segment:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling DataSegmentationApi->create_data_segment: %s\n" % e)
```
@@ -123,9 +127,13 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.data_segmentation_api import DataSegmentationApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete.
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')
published = False # bool | This determines which version of the segment to delete (optional) (default to False) # bool | This determines which version of the segment to delete (optional) (default to False)
@@ -133,11 +141,10 @@ from pprint import pprint
try:
# Delete Segment by ID
api_instance.delete_data_segment(id, x_sail_point_experimental, )
DataSegmentationApi(api_client).delete_data_segment(id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_instance.delete_data_segment(id, x_sail_point_experimental, published)
except Exception as e:
# DataSegmentationApi(api_client).delete_data_segment(id, x_sail_point_experimental, published)
except Exception as e:
print("Exception when calling DataSegmentationApi->delete_data_segment: %s\n" % e)
```
@@ -183,23 +190,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.data_segmentation_api import DataSegmentationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.data_segment import DataSegment
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve.
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')
try:
# Get Segment by ID
api_response = api_instance.get_data_segment(id, x_sail_point_experimental)
results =DataSegmentationApi(api_client).get_data_segment(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_data_segment(id, x_sail_point_experimental)
# results = DataSegmentationApi(api_client).get_data_segment(id, x_sail_point_experimental)
print("The response of DataSegmentationApi->get_data_segment:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling DataSegmentationApi->get_data_segment: %s\n" % e)
```
@@ -245,22 +255,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.data_segmentation_api import DataSegmentationApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve the segments they are in. # str | The identity ID to retrieve the segments they are in.
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')
try:
# Get SegmentMembership by Identity ID
api_response = api_instance.get_data_segment_identity_membership(identity_id, x_sail_point_experimental)
results =DataSegmentationApi(api_client).get_data_segment_identity_membership(identity_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_data_segment_identity_membership(identity_id, x_sail_point_experimental)
# results = DataSegmentationApi(api_client).get_data_segment_identity_membership(identity_id, x_sail_point_experimental)
print("The response of DataSegmentationApi->get_data_segment_identity_membership:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling DataSegmentationApi->get_data_segment_identity_membership: %s\n" % e)
```
@@ -306,22 +319,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.data_segmentation_api import DataSegmentationApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve if segmentation is enabled for the identity. # str | The identity ID to retrieve if segmentation is enabled for the identity.
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')
try:
# Is Segmentation enabled by Identity
api_response = api_instance.get_data_segmentation_enabled_for_user(identity_id, x_sail_point_experimental)
results =DataSegmentationApi(api_client).get_data_segmentation_enabled_for_user(identity_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_data_segmentation_enabled_for_user(identity_id, x_sail_point_experimental)
# results = DataSegmentationApi(api_client).get_data_segmentation_enabled_for_user(identity_id, x_sail_point_experimental)
print("The response of DataSegmentationApi->get_data_segmentation_enabled_for_user:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling DataSegmentationApi->get_data_segmentation_enabled_for_user: %s\n" % e)
```
@@ -373,10 +389,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.data_segmentation_api import DataSegmentationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.data_segment import DataSegment
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
enabled = True # bool | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to True) # bool | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to True)
unique = False # bool | This returns only one record if set to true and that would be the published record if exists. (optional) (default to False) # bool | This returns only one record if set to true and that would be the published record if exists. (optional) (default to False)
@@ -389,13 +409,12 @@ from pprint import pprint
try:
# Get Segments
api_response = api_instance.list_data_segments(x_sail_point_experimental, )
results =DataSegmentationApi(api_client).list_data_segments(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_data_segments(x_sail_point_experimental, enabled, unique, published, limit, offset, count, filters)
# results = DataSegmentationApi(api_client).list_data_segments(x_sail_point_experimental, enabled, unique, published, limit, offset, count, filters)
print("The response of DataSegmentationApi->list_data_segments:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling DataSegmentationApi->list_data_segments: %s\n" % e)
```
@@ -442,10 +461,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.data_segmentation_api import DataSegmentationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.data_segment import DataSegment
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify.
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 = [{op=replace, path=/memberFilter, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}] # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled
@@ -454,14 +477,14 @@ from pprint import pprint
try:
# Update Segment
Result = request_body.from_json(request_body)
api_response = api_instance.patch_data_segment(id, x_sail_point_experimental, Result)
new_request_body = RequestBody()
new_request_body.from_json(request_body)
results =DataSegmentationApi(api_client).patch_data_segment(id, x_sail_point_experimental, new_request_body)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_data_segment(id, x_sail_point_experimental, Result)
# results = DataSegmentationApi(api_client).patch_data_segment(id, x_sail_point_experimental, new_request_body)
print("The response of DataSegmentationApi->patch_data_segment:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling DataSegmentationApi->patch_data_segment: %s\n" % e)
```
@@ -508,9 +531,13 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.data_segmentation_api import DataSegmentationApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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] | A list of segment ids that you wish to publish
request_body = ['request_body_example'] # List[str] | A list of segment ids that you wish to publish
@@ -519,12 +546,12 @@ from pprint import pprint
try:
# Publish segment by ID
Result = request_body.from_json(request_body)
api_instance.publish_data_segment(x_sail_point_experimental, Result, )
new_request_body = RequestBody()
new_request_body.from_json(request_body)
DataSegmentationApi(api_client).publish_data_segment(x_sail_point_experimental, new_request_body, )
# Below is a request that includes all optional parameters
# api_instance.publish_data_segment(x_sail_point_experimental, Result, publish_all)
except Exception as e:
# DataSegmentationApi(api_client).publish_data_segment(x_sail_point_experimental, new_request_body, publish_all)
except Exception as e:
print("Exception when calling DataSegmentationApi->publish_data_segment: %s\n" % e)
```

127
docs/tools/sdk/python/Reference/V2024/Methods/DimensionsApi.md
View File

@@ -63,10 +63,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.dimensions_api import DimensionsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.dimension import Dimension
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension.
dimension = {
"owner" : {
@@ -158,14 +162,14 @@ from pprint import pprint
try:
# Create a Dimension
Result = dimension.from_json(dimension)
api_response = api_instance.create_dimension(role_id, Result)
new_dimension = Dimension()
new_dimension.from_json(dimension)
results =DimensionsApi(api_client).create_dimension(role_id, new_dimension)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_dimension(role_id, Result)
# results = DimensionsApi(api_client).create_dimension(role_id, new_dimension)
print("The response of DimensionsApi->create_dimension:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling DimensionsApi->create_dimension: %s\n" % e)
```
@@ -210,11 +214,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.dimensions_api import DimensionsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.dimension_bulk_delete_request import DimensionBulkDeleteRequest
from sailpoint.v2024.models.task_result_dto import TaskResultDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimensions. # str | Parent Role Id of the dimensions.
dimension_bulk_delete_request = {
"dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ]
@@ -222,14 +230,14 @@ from pprint import pprint
try:
# Delete Dimension(s)
Result = dimension_bulk_delete_request.from_json(dimension_bulk_delete_request)
api_response = api_instance.delete_bulk_dimensions(role_id, Result)
new_dimension_bulk_delete_request = DimensionBulkDeleteRequest()
new_dimension_bulk_delete_request.from_json(dimension_bulk_delete_request)
results =DimensionsApi(api_client).delete_bulk_dimensions(role_id, new_dimension_bulk_delete_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_bulk_dimensions(role_id, Result)
# results = DimensionsApi(api_client).delete_bulk_dimensions(role_id, new_dimension_bulk_delete_request)
print("The response of DimensionsApi->delete_bulk_dimensions:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling DimensionsApi->delete_bulk_dimensions: %s\n" % e)
```
@@ -272,20 +280,23 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.dimensions_api import DimensionsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension.
dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension
try:
# Delete a Dimension
api_instance.delete_dimension(role_id, dimension_id)
DimensionsApi(api_client).delete_dimension(role_id, dimension_id)
# Below is a request that includes all optional parameters
# api_instance.delete_dimension(role_id, dimension_id)
except Exception as e:
# DimensionsApi(api_client).delete_dimension(role_id, dimension_id)
except Exception as e:
print("Exception when calling DimensionsApi->delete_dimension: %s\n" % e)
```
@@ -329,23 +340,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.dimensions_api import DimensionsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.dimension import Dimension
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension.
dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension
try:
# Get a Dimension under Role.
api_response = api_instance.get_dimension(role_id, dimension_id)
results =DimensionsApi(api_client).get_dimension(role_id, dimension_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_dimension(role_id, dimension_id)
# results = DimensionsApi(api_client).get_dimension(role_id, dimension_id)
print("The response of DimensionsApi->get_dimension:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling DimensionsApi->get_dimension: %s\n" % e)
```
@@ -394,10 +408,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.dimensions_api import DimensionsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.entitlement1 import Entitlement1
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension.
dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension
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)
@@ -409,13 +427,12 @@ from pprint import pprint
try:
# List Dimension's Entitlements
api_response = api_instance.get_dimension_entitlements(role_id, dimension_id, )
results =DimensionsApi(api_client).get_dimension_entitlements(role_id, dimension_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_dimension_entitlements(role_id, dimension_id, limit, offset, count, filters, sorters)
# results = DimensionsApi(api_client).get_dimension_entitlements(role_id, dimension_id, limit, offset, count, filters, sorters)
print("The response of DimensionsApi->get_dimension_entitlements:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling DimensionsApi->get_dimension_entitlements: %s\n" % e)
```
@@ -465,10 +482,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.dimensions_api import DimensionsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_profile import AccessProfile
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension.
dimension_id = '2c9180835d191a86015d28455b4a2329' # str | ID of the Dimension # str | ID of the Dimension
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)
@@ -480,13 +501,12 @@ from pprint import pprint
try:
# List Dimension's Access Profiles
api_response = api_instance.list_dimension_access_profiles(role_id, dimension_id, )
results =DimensionsApi(api_client).list_dimension_access_profiles(role_id, dimension_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_dimension_access_profiles(role_id, dimension_id, limit, offset, count, filters, sorters)
# results = DimensionsApi(api_client).list_dimension_access_profiles(role_id, dimension_id, limit, offset, count, filters, sorters)
print("The response of DimensionsApi->list_dimension_access_profiles:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling DimensionsApi->list_dimension_access_profiles: %s\n" % e)
```
@@ -535,10 +555,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.dimensions_api import DimensionsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.dimension import Dimension
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension.
for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional)
limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50)
@@ -550,13 +574,12 @@ from pprint import pprint
try:
# List Dimensions
api_response = api_instance.list_dimensions(role_id, )
results =DimensionsApi(api_client).list_dimensions(role_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_dimensions(role_id, for_subadmin, limit, offset, count, filters, sorters)
# results = DimensionsApi(api_client).list_dimensions(role_id, for_subadmin, limit, offset, count, filters, sorters)
print("The response of DimensionsApi->list_dimensions:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling DimensionsApi->list_dimensions: %s\n" % e)
```
@@ -603,11 +626,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.dimensions_api import DimensionsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.dimension import Dimension
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension.
dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension
[{op=replace, path=/description, value=Test Description}, {op=replace, path=/name, value=new name}] # List[JsonPatchOperation] |
@@ -620,14 +647,14 @@ from pprint import pprint
try:
# Patch a specified Dimension
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_dimension(role_id, dimension_id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =DimensionsApi(api_client).patch_dimension(role_id, dimension_id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_dimension(role_id, dimension_id, Result)
# results = DimensionsApi(api_client).patch_dimension(role_id, dimension_id, new_json_patch_operation)
print("The response of DimensionsApi->patch_dimension:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling DimensionsApi->patch_dimension: %s\n" % e)
```

182
docs/tools/sdk/python/Reference/V2024/Methods/EntitlementsApi.md
View File

@@ -117,10 +117,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.entitlements_api import EntitlementsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.entitlement1 import Entitlement1
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id.
attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
attribute_value = 'public' # str | Technical name of the Attribute Value. # str | Technical name of the Attribute Value.
@@ -129,13 +133,12 @@ from pprint import pprint
try:
# Add metadata to an entitlement.
api_response = api_instance.create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value, x_sail_point_experimental)
results =EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value, x_sail_point_experimental)
# results = EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value, x_sail_point_experimental)
print("The response of EntitlementsApi->create_access_model_metadata_for_entitlement:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling EntitlementsApi->create_access_model_metadata_for_entitlement: %s\n" % e)
```
@@ -182,9 +185,13 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.entitlements_api import EntitlementsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id.
attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
attribute_value = 'public' # str | Technical name of the Attribute Value. # str | Technical name of the Attribute Value.
@@ -193,11 +200,10 @@ from pprint import pprint
try:
# Remove metadata from an entitlement.
api_instance.delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value, x_sail_point_experimental)
EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_instance.delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value, x_sail_point_experimental)
except Exception as e:
# EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value, x_sail_point_experimental)
except Exception as e:
print("Exception when calling EntitlementsApi->delete_access_model_metadata_from_entitlement: %s\n" % e)
```
@@ -243,23 +249,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.entitlements_api import EntitlementsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.entitlement1 import Entitlement1
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement 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')
try:
# Get an entitlement
api_response = api_instance.get_entitlement(id, x_sail_point_experimental)
results =EntitlementsApi(api_client).get_entitlement(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_entitlement(id, x_sail_point_experimental)
# results = EntitlementsApi(api_client).get_entitlement(id, x_sail_point_experimental)
print("The response of EntitlementsApi->get_entitlement:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling EntitlementsApi->get_entitlement: %s\n" % e)
```
@@ -305,23 +314,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.entitlements_api import EntitlementsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.entitlement_request_config import EntitlementRequestConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement 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')
try:
# Get Entitlement Request Config
api_response = api_instance.get_entitlement_request_config(id, x_sail_point_experimental)
results =EntitlementsApi(api_client).get_entitlement_request_config(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_entitlement_request_config(id, x_sail_point_experimental)
# results = EntitlementsApi(api_client).get_entitlement_request_config(id, x_sail_point_experimental)
print("The response of EntitlementsApi->get_entitlement_request_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling EntitlementsApi->get_entitlement_request_config: %s\n" % e)
```
@@ -374,10 +386,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.entitlements_api import EntitlementsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.load_entitlement_task import LoadEntitlementTask
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source 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')
csv_file = None # bytearray | The CSV file containing the source entitlements to aggregate. (optional) # bytearray | The CSV file containing the source entitlements to aggregate. (optional)
@@ -385,13 +401,12 @@ from pprint import pprint
try:
# Aggregate Entitlements
api_response = api_instance.import_entitlements_by_source(id, x_sail_point_experimental, )
results =EntitlementsApi(api_client).import_entitlements_by_source(id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.import_entitlements_by_source(id, x_sail_point_experimental, csv_file)
# results = EntitlementsApi(api_client).import_entitlements_by_source(id, x_sail_point_experimental, csv_file)
print("The response of EntitlementsApi->import_entitlements_by_source:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling EntitlementsApi->import_entitlements_by_source: %s\n" % e)
```
@@ -442,10 +457,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.entitlements_api import EntitlementsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.entitlement1 import Entitlement1
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement 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')
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)
@@ -457,13 +476,12 @@ from pprint import pprint
try:
# List of entitlements children
api_response = api_instance.list_entitlement_children(id, x_sail_point_experimental, )
results =EntitlementsApi(api_client).list_entitlement_children(id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_entitlement_children(id, x_sail_point_experimental, limit, offset, count, sorters, filters)
# results = EntitlementsApi(api_client).list_entitlement_children(id, x_sail_point_experimental, limit, offset, count, sorters, filters)
print("The response of EntitlementsApi->list_entitlement_children:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e)
```
@@ -514,10 +532,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.entitlements_api import EntitlementsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.entitlement1 import Entitlement1
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808c74ff913f0175097daa9d59cd' # str | Entitlement Id # str | Entitlement 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')
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)
@@ -529,13 +551,12 @@ from pprint import pprint
try:
# List of entitlements parents
api_response = api_instance.list_entitlement_parents(id, x_sail_point_experimental, )
results =EntitlementsApi(api_client).list_entitlement_parents(id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_entitlement_parents(id, x_sail_point_experimental, limit, offset, count, sorters, filters)
# results = EntitlementsApi(api_client).list_entitlement_parents(id, x_sail_point_experimental, limit, offset, count, sorters, filters)
print("The response of EntitlementsApi->list_entitlement_parents:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e)
```
@@ -592,10 +613,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.entitlements_api import EntitlementsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.entitlement1 import Entitlement1
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) # str | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional)
segmented_for_identity = 'me' # str | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) # str | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional)
@@ -610,13 +635,12 @@ from pprint import pprint
try:
# Gets a list of entitlements.
api_response = api_instance.list_entitlements(x_sail_point_experimental, )
results =EntitlementsApi(api_client).list_entitlements(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_entitlements(x_sail_point_experimental, account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters)
# results = EntitlementsApi(api_client).list_entitlements(x_sail_point_experimental, account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters)
print("The response of EntitlementsApi->list_entitlements:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e)
```
@@ -667,11 +691,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.entitlements_api import EntitlementsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.entitlement1 import Entitlement1
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the entitlement to patch # str | ID of the entitlement to patch
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')
[{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}] # List[JsonPatchOperation] | (optional)
@@ -685,13 +713,12 @@ from pprint import pprint
try:
# Patch an entitlement
api_response = api_instance.patch_entitlement(id, x_sail_point_experimental, )
results =EntitlementsApi(api_client).patch_entitlement(id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_entitlement(id, x_sail_point_experimental, Result)
# results = EntitlementsApi(api_client).patch_entitlement(id, x_sail_point_experimental, new_json_patch_operation)
print("The response of EntitlementsApi->patch_entitlement:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling EntitlementsApi->patch_entitlement: %s\n" % e)
```
@@ -738,10 +765,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.entitlements_api import EntitlementsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.entitlement_request_config import EntitlementRequestConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement 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')
entitlement_request_config = {
@@ -760,14 +791,14 @@ from pprint import pprint
try:
# Replace Entitlement Request Config
Result = entitlement_request_config.from_json(entitlement_request_config)
api_response = api_instance.put_entitlement_request_config(id, x_sail_point_experimental, Result)
new_entitlement_request_config = EntitlementRequestConfig()
new_entitlement_request_config.from_json(entitlement_request_config)
results =EntitlementsApi(api_client).put_entitlement_request_config(id, x_sail_point_experimental, new_entitlement_request_config)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_entitlement_request_config(id, x_sail_point_experimental, Result)
# results = EntitlementsApi(api_client).put_entitlement_request_config(id, x_sail_point_experimental, new_entitlement_request_config)
print("The response of EntitlementsApi->put_entitlement_request_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling EntitlementsApi->put_entitlement_request_config: %s\n" % e)
```
@@ -813,23 +844,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.entitlements_api import EntitlementsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.entitlement_source_reset_base_reference_dto import EntitlementSourceResetBaseReferenceDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset
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')
try:
# Reset Source Entitlements
api_response = api_instance.reset_source_entitlements(id, x_sail_point_experimental)
results =EntitlementsApi(api_client).reset_source_entitlements(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.reset_source_entitlements(id, x_sail_point_experimental)
# results = EntitlementsApi(api_client).reset_source_entitlements(id, x_sail_point_experimental)
print("The response of EntitlementsApi->reset_source_entitlements:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling EntitlementsApi->reset_source_entitlements: %s\n" % e)
```
@@ -880,10 +914,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.entitlements_api import EntitlementsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.entitlement_bulk_update_request import EntitlementBulkUpdateRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
entitlement_bulk_update_request = {
"entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ],
@@ -900,12 +938,12 @@ from pprint import pprint
try:
# Bulk update an entitlement list
Result = entitlement_bulk_update_request.from_json(entitlement_bulk_update_request)
api_instance.update_entitlements_in_bulk(x_sail_point_experimental, Result)
new_entitlement_bulk_update_request = EntitlementBulkUpdateRequest()
new_entitlement_bulk_update_request.from_json(entitlement_bulk_update_request)
EntitlementsApi(api_client).update_entitlements_in_bulk(x_sail_point_experimental, new_entitlement_bulk_update_request)
# Below is a request that includes all optional parameters
# api_instance.update_entitlements_in_bulk(x_sail_point_experimental, Result)
except Exception as e:
# EntitlementsApi(api_client).update_entitlements_in_bulk(x_sail_point_experimental, new_entitlement_bulk_update_request)
except Exception as e:
print("Exception when calling EntitlementsApi->update_entitlements_in_bulk: %s\n" % e)
```

51
docs/tools/sdk/python/Reference/V2024/Methods/GlobalTenantSecuritySettingsApi.md
View File

@@ -57,10 +57,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.network_configuration import NetworkConfiguration
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
network_configuration = {
"range" : [ "1.3.7.2", "255.255.255.252/30" ],
"whitelisted" : true,
@@ -69,14 +73,14 @@ from pprint import pprint
try:
# Create security network configuration.
Result = network_configuration.from_json(network_configuration)
api_response = api_instance.create_auth_org_network_config(Result)
new_network_configuration = NetworkConfiguration()
new_network_configuration.from_json(network_configuration)
results =GlobalTenantSecuritySettingsApi(api_client).create_auth_org_network_config(new_network_configuration)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_auth_org_network_config(Result)
# results = GlobalTenantSecuritySettingsApi(api_client).create_auth_org_network_config(new_network_configuration)
print("The response of GlobalTenantSecuritySettingsApi->create_auth_org_network_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GlobalTenantSecuritySettingsApi->create_auth_org_network_config: %s\n" % e)
```
@@ -115,21 +119,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.network_configuration import NetworkConfiguration
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get security network configuration.
api_response = api_instance.get_auth_org_network_config()
results =GlobalTenantSecuritySettingsApi(api_client).get_auth_org_network_config()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_auth_org_network_config()
# results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_network_config()
print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_network_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_network_config: %s\n" % e)
```
@@ -172,11 +179,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.models.network_configuration import NetworkConfiguration
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
[{op=replace, path=/whitelisted, value=false,}, {op=add, path=/geolocation, value=[AF, HN, ES]}] # List[JsonPatchOperation] | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters.
json_patch_operation = {
"op" : "replace",
@@ -187,14 +198,14 @@ from pprint import pprint
try:
# Update security network configuration.
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_auth_org_network_config(Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_network_config(new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_auth_org_network_config(Result)
# results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_network_config(new_json_patch_operation)
print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_network_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_network_config: %s\n" % e)
```

160
docs/tools/sdk/python/Reference/V2024/Methods/GovernanceGroupsApi.md
View File

@@ -69,10 +69,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.workgroup_dto import WorkgroupDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
workgroup_dto = {
"owner" : {
@@ -93,14 +97,14 @@ from pprint import pprint
try:
# Create a new Governance Group.
Result = workgroup_dto.from_json(workgroup_dto)
api_response = api_instance.create_workgroup(x_sail_point_experimental, Result)
new_workgroup_dto = WorkgroupDto()
new_workgroup_dto.from_json(workgroup_dto)
results =GovernanceGroupsApi(api_client).create_workgroup(x_sail_point_experimental, new_workgroup_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_workgroup(x_sail_point_experimental, Result)
# results = GovernanceGroupsApi(api_client).create_workgroup(x_sail_point_experimental, new_workgroup_dto)
print("The response of GovernanceGroupsApi->create_workgroup:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GovernanceGroupsApi->create_workgroup: %s\n" % e)
```
@@ -145,20 +149,23 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group
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')
try:
# Delete a Governance Group
api_instance.delete_workgroup(id, x_sail_point_experimental)
GovernanceGroupsApi(api_client).delete_workgroup(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_instance.delete_workgroup(id, x_sail_point_experimental)
except Exception as e:
# GovernanceGroupsApi(api_client).delete_workgroup(id, x_sail_point_experimental)
except Exception as e:
print("Exception when calling GovernanceGroupsApi->delete_workgroup: %s\n" % e)
```
@@ -207,11 +214,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_preview_response_identity import IdentityPreviewResponseIdentity
from sailpoint.v2024.models.workgroup_member_delete_item import WorkgroupMemberDeleteItem
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group.
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')
[sailpoint.v2024.IdentityPreviewResponseIdentity()] # List[IdentityPreviewResponseIdentity] | List of identities to be removed from a Governance Group members list.
@@ -220,14 +231,14 @@ from pprint import pprint
try:
# Remove members from Governance Group
Result = identity_preview_response_identity.from_json(identity_preview_response_identity)
api_response = api_instance.delete_workgroup_members(workgroup_id, x_sail_point_experimental, Result)
new_identity_preview_response_identity = IdentityPreviewResponseIdentity()
new_identity_preview_response_identity.from_json(identity_preview_response_identity)
results =GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_workgroup_members(workgroup_id, x_sail_point_experimental, Result)
# results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity)
print("The response of GovernanceGroupsApi->delete_workgroup_members:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e)
```
@@ -283,11 +294,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.workgroup_bulk_delete_request import WorkgroupBulkDeleteRequest
from sailpoint.v2024.models.workgroup_delete_item import WorkgroupDeleteItem
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
workgroup_bulk_delete_request = {
"ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ]
@@ -295,14 +310,14 @@ from pprint import pprint
try:
# Delete Governance Group(s)
Result = workgroup_bulk_delete_request.from_json(workgroup_bulk_delete_request)
api_response = api_instance.delete_workgroups_in_bulk(x_sail_point_experimental, Result)
new_workgroup_bulk_delete_request = WorkgroupBulkDeleteRequest()
new_workgroup_bulk_delete_request.from_json(workgroup_bulk_delete_request)
results =GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(x_sail_point_experimental, new_workgroup_bulk_delete_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_workgroups_in_bulk(x_sail_point_experimental, Result)
# results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(x_sail_point_experimental, new_workgroup_bulk_delete_request)
print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e)
```
@@ -347,23 +362,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.workgroup_dto import WorkgroupDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group
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')
try:
# Get Governance Group by Id
api_response = api_instance.get_workgroup(id, x_sail_point_experimental)
results =GovernanceGroupsApi(api_client).get_workgroup(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_workgroup(id, x_sail_point_experimental)
# results = GovernanceGroupsApi(api_client).get_workgroup(id, x_sail_point_experimental)
print("The response of GovernanceGroupsApi->get_workgroup:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GovernanceGroupsApi->get_workgroup: %s\n" % e)
```
@@ -412,10 +430,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.workgroup_connection_dto import WorkgroupConnectionDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group.
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')
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)
@@ -426,13 +448,12 @@ from pprint import pprint
try:
# List connections for Governance Group
api_response = api_instance.list_connections(workgroup_id, x_sail_point_experimental, )
results =GovernanceGroupsApi(api_client).list_connections(workgroup_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_connections(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters)
# results = GovernanceGroupsApi(api_client).list_connections(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters)
print("The response of GovernanceGroupsApi->list_connections:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e)
```
@@ -481,10 +502,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.list_workgroup_members200_response_inner import ListWorkgroupMembers200ResponseInner
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group.
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')
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)
@@ -495,13 +520,12 @@ from pprint import pprint
try:
# List Governance Group Members
api_response = api_instance.list_workgroup_members(workgroup_id, x_sail_point_experimental, )
results =GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_workgroup_members(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters)
# results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters)
print("The response of GovernanceGroupsApi->list_workgroup_members:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e)
```
@@ -550,10 +574,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.workgroup_dto import WorkgroupDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
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)
limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50)
@@ -564,13 +592,12 @@ from pprint import pprint
try:
# List Governance Groups
api_response = api_instance.list_workgroups(x_sail_point_experimental, )
results =GovernanceGroupsApi(api_client).list_workgroups(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_workgroups(x_sail_point_experimental, offset, limit, count, filters, sorters)
# results = GovernanceGroupsApi(api_client).list_workgroups(x_sail_point_experimental, offset, limit, count, filters, sorters)
print("The response of GovernanceGroupsApi->list_workgroups:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e)
```
@@ -619,11 +646,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.models.workgroup_dto import WorkgroupDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group
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')
[{op=replace, path=/description, value=Governance Group new description.}] # List[JsonPatchOperation] | (optional)
@@ -637,13 +668,12 @@ from pprint import pprint
try:
# Patch a Governance Group
api_response = api_instance.patch_workgroup(id, x_sail_point_experimental, )
results =GovernanceGroupsApi(api_client).patch_workgroup(id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_workgroup(id, x_sail_point_experimental, Result)
# results = GovernanceGroupsApi(api_client).patch_workgroup(id, x_sail_point_experimental, new_json_patch_operation)
print("The response of GovernanceGroupsApi->patch_workgroup:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GovernanceGroupsApi->patch_workgroup: %s\n" % e)
```
@@ -693,11 +723,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_preview_response_identity import IdentityPreviewResponseIdentity
from sailpoint.v2024.models.workgroup_member_add_item import WorkgroupMemberAddItem
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group.
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')
[sailpoint.v2024.IdentityPreviewResponseIdentity()] # List[IdentityPreviewResponseIdentity] | List of identities to be added to a Governance Group members list.
@@ -706,14 +740,14 @@ from pprint import pprint
try:
# Add members to Governance Group
Result = identity_preview_response_identity.from_json(identity_preview_response_identity)
api_response = api_instance.update_workgroup_members(workgroup_id, x_sail_point_experimental, Result)
new_identity_preview_response_identity = IdentityPreviewResponseIdentity()
new_identity_preview_response_identity.from_json(identity_preview_response_identity)
results =GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_workgroup_members(workgroup_id, x_sail_point_experimental, Result)
# results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity)
print("The response of GovernanceGroupsApi->update_workgroup_members:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e)
```

132
docs/tools/sdk/python/Reference/V2024/Methods/IAIAccessRequestRecommendationsApi.md
View File

@@ -62,11 +62,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto
from sailpoint.v2024.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
access_request_recommendation_action_item_dto = {
"access" : {
@@ -78,14 +82,14 @@ from pprint import pprint
try:
# Notification of Ignored Access Request Recommendations
Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto)
api_response = api_instance.add_access_request_recommendations_ignored_item(x_sail_point_experimental, Result)
new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto()
new_access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto)
results =IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_ignored_item(x_sail_point_experimental, new_access_request_recommendation_action_item_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.add_access_request_recommendations_ignored_item(x_sail_point_experimental, Result)
# results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_ignored_item(x_sail_point_experimental, new_access_request_recommendation_action_item_dto)
print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item: %s\n" % e)
```
@@ -130,11 +134,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto
from sailpoint.v2024.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
access_request_recommendation_action_item_dto = {
"access" : {
@@ -146,14 +154,14 @@ from pprint import pprint
try:
# Notification of Requested Access Request Recommendations
Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto)
api_response = api_instance.add_access_request_recommendations_requested_item(x_sail_point_experimental, Result)
new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto()
new_access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto)
results =IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_requested_item(x_sail_point_experimental, new_access_request_recommendation_action_item_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.add_access_request_recommendations_requested_item(x_sail_point_experimental, Result)
# results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_requested_item(x_sail_point_experimental, new_access_request_recommendation_action_item_dto)
print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item: %s\n" % e)
```
@@ -198,11 +206,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto
from sailpoint.v2024.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
access_request_recommendation_action_item_dto = {
"access" : {
@@ -214,14 +226,14 @@ from pprint import pprint
try:
# Notification of Viewed Access Request Recommendations
Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto)
api_response = api_instance.add_access_request_recommendations_viewed_item(x_sail_point_experimental, Result)
new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto()
new_access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto)
results =IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_item(x_sail_point_experimental, new_access_request_recommendation_action_item_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.add_access_request_recommendations_viewed_item(x_sail_point_experimental, Result)
# results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_item(x_sail_point_experimental, new_access_request_recommendation_action_item_dto)
print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item: %s\n" % e)
```
@@ -266,11 +278,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto
from sailpoint.v2024.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
[sailpoint.v2024.AccessRequestRecommendationActionItemDto()] # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity.
access_request_recommendation_action_item_dto = {
@@ -284,14 +300,14 @@ from pprint import pprint
try:
# Notification of Viewed Access Request Recommendations in Bulk
Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto)
api_response = api_instance.add_access_request_recommendations_viewed_items(x_sail_point_experimental, Result)
new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto()
new_access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto)
results =IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(x_sail_point_experimental, new_access_request_recommendation_action_item_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.add_access_request_recommendations_viewed_items(x_sail_point_experimental, Result)
# results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(x_sail_point_experimental, new_access_request_recommendation_action_item_dto)
print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e)
```
@@ -342,10 +358,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_request_recommendation_item_detail import AccessRequestRecommendationItemDetail
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
identity_id = 'me' # str | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to 'me') # str | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to 'me')
limit = 15 # int | Max number of results to return. (optional) (default to 15) # int | Max number of results to return. (optional) (default to 15)
@@ -358,13 +378,12 @@ from pprint import pprint
try:
# Identity Access Request Recommendations
api_response = api_instance.get_access_request_recommendations(x_sail_point_experimental, )
results =IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_access_request_recommendations(x_sail_point_experimental, identity_id, limit, offset, count, include_translation_messages, filters, sorters)
# results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(x_sail_point_experimental, identity_id, limit, offset, count, include_translation_messages, filters, sorters)
print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e)
```
@@ -413,10 +432,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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)
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)
@@ -427,13 +450,12 @@ from pprint import pprint
try:
# List of Ignored Access Request Recommendations
api_response = api_instance.get_access_request_recommendations_ignored_items(x_sail_point_experimental, )
results =IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_access_request_recommendations_ignored_items(x_sail_point_experimental, limit, offset, count, filters, sorters)
# results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(x_sail_point_experimental, limit, offset, count, filters, sorters)
print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e)
```
@@ -482,10 +504,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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)
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)
@@ -496,13 +522,12 @@ from pprint import pprint
try:
# List of Requested Access Request Recommendations
api_response = api_instance.get_access_request_recommendations_requested_items(x_sail_point_experimental, )
results =IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_access_request_recommendations_requested_items(x_sail_point_experimental, limit, offset, count, filters, sorters)
# results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(x_sail_point_experimental, limit, offset, count, filters, sorters)
print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e)
```
@@ -551,10 +576,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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)
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)
@@ -565,13 +594,12 @@ from pprint import pprint
try:
# List of Viewed Access Request Recommendations
api_response = api_instance.get_access_request_recommendations_viewed_items(x_sail_point_experimental, )
results =IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_access_request_recommendations_viewed_items(x_sail_point_experimental, limit, offset, count, filters, sorters)
# results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(x_sail_point_experimental, limit, offset, count, filters, sorters)
print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e)
```

51
docs/tools/sdk/python/Reference/V2024/Methods/IAICommonAccessApi.md
View File

@@ -57,11 +57,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_common_access_api import IAICommonAccessApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.common_access_item_request import CommonAccessItemRequest
from sailpoint.v2024.models.common_access_item_response import CommonAccessItemResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
common_access_item_request = {
"access" : {
@@ -77,14 +81,14 @@ from pprint import pprint
try:
# Create common access items
Result = common_access_item_request.from_json(common_access_item_request)
api_response = api_instance.create_common_access(x_sail_point_experimental, Result)
new_common_access_item_request = CommonAccessItemRequest()
new_common_access_item_request.from_json(common_access_item_request)
results =IAICommonAccessApi(api_client).create_common_access(x_sail_point_experimental, new_common_access_item_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_common_access(x_sail_point_experimental, Result)
# results = IAICommonAccessApi(api_client).create_common_access(x_sail_point_experimental, new_common_access_item_request)
print("The response of IAICommonAccessApi->create_common_access:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAICommonAccessApi->create_common_access: %s\n" % e)
```
@@ -132,10 +136,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_common_access_api import IAICommonAccessApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.common_access_response import CommonAccessResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
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)
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)
@@ -146,13 +154,12 @@ from pprint import pprint
try:
# Get a paginated list of common access
api_response = api_instance.get_common_access(x_sail_point_experimental, )
results =IAICommonAccessApi(api_client).get_common_access(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_common_access(x_sail_point_experimental, offset, limit, count, filters, sorters)
# results = IAICommonAccessApi(api_client).get_common_access(x_sail_point_experimental, offset, limit, count, filters, sorters)
print("The response of IAICommonAccessApi->get_common_access:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e)
```
@@ -197,10 +204,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_common_access_api import IAICommonAccessApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.common_access_id_status import CommonAccessIDStatus
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
[sailpoint.v2024.CommonAccessIDStatus()] # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access
common_access_id_status = {
@@ -211,14 +222,14 @@ from pprint import pprint
try:
# Bulk update common access status
Result = common_access_id_status.from_json(common_access_id_status)
api_response = api_instance.update_common_access_status_in_bulk(x_sail_point_experimental, Result)
new_common_access_id_status = CommonAccessIdStatus()
new_common_access_id_status.from_json(common_access_id_status)
results =IAICommonAccessApi(api_client).update_common_access_status_in_bulk(x_sail_point_experimental, new_common_access_id_status)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_common_access_status_in_bulk(x_sail_point_experimental, Result)
# results = IAICommonAccessApi(api_client).update_common_access_status_in_bulk(x_sail_point_experimental, new_common_access_id_status)
print("The response of IAICommonAccessApi->update_common_access_status_in_bulk:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAICommonAccessApi->update_common_access_status_in_bulk: %s\n" % e)
```

137
docs/tools/sdk/python/Reference/V2024/Methods/IAIOutliersApi.md
View File

@@ -66,22 +66,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
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()
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)
try:
# IAI Identity Outliers Export
api_response = api_instance.export_outliers_zip(x_sail_point_experimental, )
results =IAIOutliersApi(api_client).export_outliers_zip(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.export_outliers_zip(x_sail_point_experimental, type)
# results = IAIOutliersApi(api_client).export_outliers_zip(x_sail_point_experimental, type)
print("The response of IAIOutliersApi->export_outliers_zip:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIOutliersApi->export_outliers_zip: %s\n" % e)
```
@@ -131,10 +134,14 @@ Code | Description | Data Type | Response headers |
```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
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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)
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)
@@ -145,13 +152,12 @@ from pprint import pprint
try:
# IAI Identity Outliers Summary
api_response = api_instance.get_identity_outlier_snapshots(x_sail_point_experimental, )
results =IAIOutliersApi(api_client).get_identity_outlier_snapshots(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_outlier_snapshots(x_sail_point_experimental, limit, offset, type, filters, sorters)
# 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(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e)
```
@@ -201,10 +207,14 @@ Code | Description | Data Type | Response headers |
```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
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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)
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)
@@ -216,13 +226,12 @@ from pprint import pprint
try:
# IAI Get Identity Outliers
api_response = api_instance.get_identity_outliers(x_sail_point_experimental, )
results =IAIOutliersApi(api_client).get_identity_outliers(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_outliers(x_sail_point_experimental, limit, offset, count, type, filters, sorters)
# 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(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e)
```
@@ -268,23 +277,26 @@ Code | Description | Data Type | Response headers |
```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
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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)
try:
# IAI Identity Outliers Latest Summary
api_response = api_instance.get_latest_identity_outlier_snapshots(x_sail_point_experimental, )
results =IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_latest_identity_outlier_snapshots(x_sail_point_experimental, type)
# 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(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e)
```
@@ -333,23 +345,26 @@ Code | Description | Data Type | Response headers |
```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
from sailpoint.v2024.rest import ApiException
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
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')
try:
# Get identity outlier contibuting feature summary
api_response = api_instance.get_outlier_contributing_feature_summary(outlier_feature_id, x_sail_point_experimental)
results =IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_outlier_contributing_feature_summary(outlier_feature_id, x_sail_point_experimental)
# 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(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIOutliersApi->get_outlier_contributing_feature_summary: %s\n" % e)
```
@@ -403,10 +418,14 @@ Code | Description | Data Type | Response headers |
```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
from sailpoint.v2024.rest import ApiException
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
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)
@@ -418,13 +437,12 @@ from pprint import pprint
try:
# Get identity outlier's contibuting features
api_response = api_instance.get_peer_group_outliers_contributing_features(outlier_id, x_sail_point_experimental, )
results =IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_peer_group_outliers_contributing_features(outlier_id, x_sail_point_experimental, limit, offset, count, include_translation_messages, sorters)
# 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(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e)
```
@@ -469,9 +487,13 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
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()
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] |
@@ -479,12 +501,12 @@ from pprint import pprint
try:
# IAI Identity Outliers Ignore
Result = request_body.from_json(request_body)
api_instance.ignore_identity_outliers(x_sail_point_experimental, Result)
new_request_body = RequestBody()
new_request_body.from_json(request_body)
IAIOutliersApi(api_client).ignore_identity_outliers(x_sail_point_experimental, new_request_body)
# Below is a request that includes all optional parameters
# api_instance.ignore_identity_outliers(x_sail_point_experimental, Result)
except Exception as e:
# IAIOutliersApi(api_client).ignore_identity_outliers(x_sail_point_experimental, new_request_body)
except Exception as e:
print("Exception when calling IAIOutliersApi->ignore_identity_outliers: %s\n" % e)
```
@@ -539,10 +561,14 @@ Code | Description | Data Type | Response headers |
```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
from sailpoint.v2024.rest import ApiException
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
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')
@@ -555,13 +581,12 @@ from pprint import pprint
try:
# Gets a list of access items associated with each identity outlier contributing feature
api_response = api_instance.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, contributing_feature_name, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, x_sail_point_experimental, limit, offset, count, access_type, sorters)
# 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(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e)
```
@@ -606,9 +631,13 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
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()
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] |
@@ -616,12 +645,12 @@ from pprint import pprint
try:
# IAI Identity Outliers Unignore
Result = request_body.from_json(request_body)
api_instance.un_ignore_identity_outliers(x_sail_point_experimental, Result)
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)
# Below is a request that includes all optional parameters
# api_instance.un_ignore_identity_outliers(x_sail_point_experimental, Result)
except Exception as e:
# IAIOutliersApi(api_client).un_ignore_identity_outliers(x_sail_point_experimental, new_request_body)
except Exception as e:
print("Exception when calling IAIOutliersApi->un_ignore_identity_outliers: %s\n" % e)
```

15
docs/tools/sdk/python/Reference/V2024/Methods/IAIPeerGroupStrategiesApi.md
View File

@@ -61,10 +61,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_peer_group_strategies_api import IAIPeerGroupStrategiesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.peer_group_member import PeerGroupMember
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
strategy = 'entitlement' # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. # str | The strategy used to create peer groups. Currently, 'entitlement' is supported.
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)
@@ -74,13 +78,12 @@ from pprint import pprint
try:
# Identity Outliers List
api_response = api_instance.get_peer_group_outliers(strategy, x_sail_point_experimental, )
results =IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_peer_group_outliers(strategy, x_sail_point_experimental, limit, offset, count)
# results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy, x_sail_point_experimental, limit, offset, count)
print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e)
```

51
docs/tools/sdk/python/Reference/V2024/Methods/IAIRecommendationsApi.md
View File

@@ -57,11 +57,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_recommendations_api import IAIRecommendationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.recommendation_request_dto import RecommendationRequestDto
from sailpoint.v2024.models.recommendation_response_dto import RecommendationResponseDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
recommendation_request_dto = {
"prescribeMode" : false,
@@ -85,14 +89,14 @@ from pprint import pprint
try:
# Returns a Recommendation Based on Object
Result = recommendation_request_dto.from_json(recommendation_request_dto)
api_response = api_instance.get_recommendations(x_sail_point_experimental, Result)
new_recommendation_request_dto = RecommendationRequestDto()
new_recommendation_request_dto.from_json(recommendation_request_dto)
results =IAIRecommendationsApi(api_client).get_recommendations(x_sail_point_experimental, new_recommendation_request_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_recommendations(x_sail_point_experimental, Result)
# results = IAIRecommendationsApi(api_client).get_recommendations(x_sail_point_experimental, new_recommendation_request_dto)
print("The response of IAIRecommendationsApi->get_recommendations:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRecommendationsApi->get_recommendations: %s\n" % e)
```
@@ -135,22 +139,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_recommendations_api import IAIRecommendationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.recommendation_config_dto import RecommendationConfigDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
try:
# Get certification recommendation config values
api_response = api_instance.get_recommendations_config(x_sail_point_experimental)
results =IAIRecommendationsApi(api_client).get_recommendations_config(x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_recommendations_config(x_sail_point_experimental)
# results = IAIRecommendationsApi(api_client).get_recommendations_config(x_sail_point_experimental)
print("The response of IAIRecommendationsApi->get_recommendations_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRecommendationsApi->get_recommendations_config: %s\n" % e)
```
@@ -194,10 +201,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_recommendations_api import IAIRecommendationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.recommendation_config_dto import RecommendationConfigDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
recommendation_config_dto = {
"recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ],
@@ -208,14 +219,14 @@ from pprint import pprint
try:
# Update certification recommendation config values
Result = recommendation_config_dto.from_json(recommendation_config_dto)
api_response = api_instance.update_recommendations_config(x_sail_point_experimental, Result)
new_recommendation_config_dto = RecommendationConfigDto()
new_recommendation_config_dto.from_json(recommendation_config_dto)
results =IAIRecommendationsApi(api_client).update_recommendations_config(x_sail_point_experimental, new_recommendation_config_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_recommendations_config(x_sail_point_experimental, Result)
# results = IAIRecommendationsApi(api_client).update_recommendations_config(x_sail_point_experimental, new_recommendation_config_dto)
print("The response of IAIRecommendationsApi->update_recommendations_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRecommendationsApi->update_recommendations_config: %s\n" % e)
```

390
docs/tools/sdk/python/Reference/V2024/Methods/IAIRoleMiningApi.md
View File

@@ -83,11 +83,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_mining_potential_role_provision_request import RoleMiningPotentialRoleProvisionRequest
from sailpoint.v2024.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
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')
@@ -104,13 +108,12 @@ from pprint import pprint
try:
# Create request to provision a potential role into an actual role.
api_response = api_instance.create_potential_role_provision_request(session_id, potential_role_id, x_sail_point_experimental, )
results =IAIRoleMiningApi(api_client).create_potential_role_provision_request(session_id, potential_role_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.create_potential_role_provision_request(session_id, potential_role_id, x_sail_point_experimental, min_entitlement_popularity, include_common_access, Result)
# results = IAIRoleMiningApi(api_client).create_potential_role_provision_request(session_id, potential_role_id, x_sail_point_experimental, 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(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->create_potential_role_provision_request: %s\n" % e)
```
@@ -155,11 +158,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_mining_session_dto import RoleMiningSessionDto
from sailpoint.v2024.models.role_mining_session_response import RoleMiningSessionResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
role_mining_session_dto = {
"emailRecipientId" : "2c918090761a5aac0176215c46a62d58",
@@ -196,14 +203,14 @@ from pprint import pprint
try:
# Create a role mining session
Result = role_mining_session_dto.from_json(role_mining_session_dto)
api_response = api_instance.create_role_mining_sessions(x_sail_point_experimental, Result)
new_role_mining_session_dto = RoleMiningSessionDto()
new_role_mining_session_dto.from_json(role_mining_session_dto)
results =IAIRoleMiningApi(api_client).create_role_mining_sessions(x_sail_point_experimental, new_role_mining_session_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_role_mining_sessions(x_sail_point_experimental, Result)
# results = IAIRoleMiningApi(api_client).create_role_mining_sessions(x_sail_point_experimental, new_role_mining_session_dto)
print("The response of IAIRoleMiningApi->create_role_mining_sessions:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->create_role_mining_sessions: %s\n" % e)
```
@@ -249,9 +256,13 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '278359a6-04b7-4669-9468-924cf580964a' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
export_id = '4940ffd4-836f-48a3-b2b0-6d498c3fdf40' # str | The id of a previously run export job for this potential role # str | The id of a previously run export job for this potential role
@@ -260,13 +271,12 @@ from pprint import pprint
try:
# Export (download) details for a potential role in a role mining session
api_response = api_instance.download_role_mining_potential_role_zip(session_id, potential_role_id, export_id, x_sail_point_experimental)
results =IAIRoleMiningApi(api_client).download_role_mining_potential_role_zip(session_id, potential_role_id, export_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.download_role_mining_potential_role_zip(session_id, potential_role_id, export_id, x_sail_point_experimental)
# results = IAIRoleMiningApi(api_client).download_role_mining_potential_role_zip(session_id, potential_role_id, export_id, x_sail_point_experimental)
print("The response of IAIRoleMiningApi->download_role_mining_potential_role_zip:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->download_role_mining_potential_role_zip: %s\n" % e)
```
@@ -311,9 +321,13 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
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')
@@ -321,13 +335,12 @@ from pprint import pprint
try:
# Export (download) details for a potential role in a role mining session
api_response = api_instance.export_role_mining_potential_role(session_id, potential_role_id, x_sail_point_experimental)
results =IAIRoleMiningApi(api_client).export_role_mining_potential_role(session_id, potential_role_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.export_role_mining_potential_role(session_id, potential_role_id, x_sail_point_experimental)
# results = IAIRoleMiningApi(api_client).export_role_mining_potential_role(session_id, potential_role_id, x_sail_point_experimental)
print("The response of IAIRoleMiningApi->export_role_mining_potential_role:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role: %s\n" % e)
```
@@ -373,11 +386,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_mining_potential_role_export_request import RoleMiningPotentialRoleExportRequest
from sailpoint.v2024.models.role_mining_potential_role_export_response import RoleMiningPotentialRoleExportResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '278359a6-04b7-4669-9468-924cf580964a' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
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')
@@ -389,13 +406,12 @@ from pprint import pprint
try:
# Asynchronously export details for a potential role in a role mining session and upload to S3
api_response = api_instance.export_role_mining_potential_role_async(session_id, potential_role_id, x_sail_point_experimental, )
results =IAIRoleMiningApi(api_client).export_role_mining_potential_role_async(session_id, potential_role_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.export_role_mining_potential_role_async(session_id, potential_role_id, x_sail_point_experimental, Result)
# results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_async(session_id, potential_role_id, x_sail_point_experimental, new_role_mining_potential_role_export_request)
print("The response of IAIRoleMiningApi->export_role_mining_potential_role_async:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_async: %s\n" % e)
```
@@ -441,10 +457,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_mining_potential_role_export_response import RoleMiningPotentialRoleExportResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '278359a6-04b7-4669-9468-924cf580964a' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
export_id = '4940ffd4-836f-48a3-b2b0-6d498c3fdf40' # str | The id of a previously run export job for this potential role # str | The id of a previously run export job for this potential role
@@ -453,13 +473,12 @@ from pprint import pprint
try:
# Retrieve status of a potential role export job
api_response = api_instance.export_role_mining_potential_role_status(session_id, potential_role_id, export_id, x_sail_point_experimental)
results =IAIRoleMiningApi(api_client).export_role_mining_potential_role_status(session_id, potential_role_id, export_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.export_role_mining_potential_role_status(session_id, potential_role_id, export_id, x_sail_point_experimental)
# results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_status(session_id, potential_role_id, export_id, x_sail_point_experimental)
print("The response of IAIRoleMiningApi->export_role_mining_potential_role_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_status: %s\n" % e)
```
@@ -508,10 +527,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
sorters = 'createdDate' # str | 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: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) # str | 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: **createdDate, identityCount, entitlementCount, freshness, quality** (optional)
filters = '(createdByName co \"int\") and (createdById sw \"2c9180907\") and (type eq \"COMMON\") and ((name co \"entt\") or (saved eq true))' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional)
@@ -522,13 +545,12 @@ from pprint import pprint
try:
# Retrieves all potential role summaries
api_response = api_instance.get_all_potential_role_summaries(x_sail_point_experimental, )
results =IAIRoleMiningApi(api_client).get_all_potential_role_summaries(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_all_potential_role_summaries(x_sail_point_experimental, sorters, filters, offset, limit, count)
# results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(x_sail_point_experimental, sorters, filters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e)
```
@@ -574,9 +596,13 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
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')
@@ -585,13 +611,12 @@ from pprint import pprint
try:
# Retrieves entitlement popularity distribution for a potential role in a role mining session
api_response = api_instance.get_entitlement_distribution_potential_role(session_id, potential_role_id, x_sail_point_experimental, )
results =IAIRoleMiningApi(api_client).get_entitlement_distribution_potential_role(session_id, potential_role_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_entitlement_distribution_potential_role(session_id, potential_role_id, x_sail_point_experimental, include_common_access)
# results = IAIRoleMiningApi(api_client).get_entitlement_distribution_potential_role(session_id, potential_role_id, x_sail_point_experimental, include_common_access)
print("The response of IAIRoleMiningApi->get_entitlement_distribution_potential_role:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_entitlement_distribution_potential_role: %s\n" % e)
```
@@ -643,10 +668,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_mining_entitlement import RoleMiningEntitlement
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
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')
@@ -660,13 +689,12 @@ from pprint import pprint
try:
# Retrieves entitlements for a potential role in a role mining session
api_response = api_instance.get_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, )
results =IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, include_common_access, sorters, filters, offset, limit, count)
# results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, include_common_access, sorters, filters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e)
```
@@ -716,10 +744,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_mining_entitlement import RoleMiningEntitlement
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
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')
@@ -732,13 +764,12 @@ from pprint import pprint
try:
# Retrieves excluded entitlements for a potential role in a role mining session
api_response = api_instance.get_excluded_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, )
results =IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_excluded_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count)
# results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e)
```
@@ -788,10 +819,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_mining_identity import RoleMiningIdentity
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
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')
@@ -804,13 +839,12 @@ from pprint import pprint
try:
# Retrieves identities for a potential role in a role mining session
api_response = api_instance.get_identities_potential_role(session_id, potential_role_id, x_sail_point_experimental, )
results =IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identities_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count)
# results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_identities_potential_role:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e)
```
@@ -856,10 +890,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_mining_potential_role import RoleMiningPotentialRole
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
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')
@@ -867,13 +905,12 @@ from pprint import pprint
try:
# Retrieves a specific potential role
api_response = api_instance.get_potential_role(session_id, potential_role_id, x_sail_point_experimental)
results =IAIRoleMiningApi(api_client).get_potential_role(session_id, potential_role_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_potential_role(session_id, potential_role_id, x_sail_point_experimental)
# results = IAIRoleMiningApi(api_client).get_potential_role(session_id, potential_role_id, x_sail_point_experimental)
print("The response of IAIRoleMiningApi->get_potential_role:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_potential_role: %s\n" % e)
```
@@ -923,10 +960,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_mining_potential_role_application import RoleMiningPotentialRoleApplication
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '62f28d91-7d9f-4d17-be15-666d5b41d77f' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
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')
@@ -938,13 +979,12 @@ from pprint import pprint
try:
# Retrieves the applications of a potential role for a role mining session
api_response = api_instance.get_potential_role_applications(session_id, potential_role_id, x_sail_point_experimental, )
results =IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_potential_role_applications(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count)
# results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_potential_role_applications:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e)
```
@@ -994,10 +1034,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_mining_potential_role_entitlements import RoleMiningPotentialRoleEntitlements
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '62f28d91-7d9f-4d17-be15-666d5b41d77f' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
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')
@@ -1009,13 +1053,12 @@ from pprint import pprint
try:
# Retrieves the entitlements of a potential role for a role mining session
api_response = api_instance.get_potential_role_entitlements(session_id, potential_role_id, x_sail_point_experimental, )
results =IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_potential_role_entitlements(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count)
# results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e)
```
@@ -1065,10 +1108,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_mining_potential_role_source_usage import RoleMiningPotentialRoleSourceUsage
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
potential_role_id = 'e0cc5d7d-bf7f-4f81-b2af-8885b09d9923' # str | A potential role id # str | A potential role id
source_id = '2c9180877620c1460176267f336a106f' # str | A source id # str | A source 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')
@@ -1080,13 +1127,12 @@ from pprint import pprint
try:
# Retrieves potential role source usage
api_response = api_instance.get_potential_role_source_identity_usage(potential_role_id, source_id, x_sail_point_experimental, )
results =IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_potential_role_source_identity_usage(potential_role_id, source_id, x_sail_point_experimental, sorters, offset, limit, count)
# results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, x_sail_point_experimental, sorters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e)
```
@@ -1136,10 +1182,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session 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')
sorters = 'createdDate' # str | 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: **createdDate** (optional) # str | 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: **createdDate** (optional)
@@ -1151,13 +1201,12 @@ from pprint import pprint
try:
# Retrieves all potential role summaries
api_response = api_instance.get_potential_role_summaries(session_id, x_sail_point_experimental, )
results =IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_potential_role_summaries(session_id, x_sail_point_experimental, sorters, filters, offset, limit, count)
# results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, x_sail_point_experimental, sorters, filters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e)
```
@@ -1202,23 +1251,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_mining_potential_role import RoleMiningPotentialRole
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id # str | A potential role 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')
try:
# Retrieves a specific potential role
api_response = api_instance.get_role_mining_potential_role(potential_role_id, x_sail_point_experimental)
results =IAIRoleMiningApi(api_client).get_role_mining_potential_role(potential_role_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_role_mining_potential_role(potential_role_id, x_sail_point_experimental)
# results = IAIRoleMiningApi(api_client).get_role_mining_potential_role(potential_role_id, x_sail_point_experimental)
print("The response of IAIRoleMiningApi->get_role_mining_potential_role:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_role_mining_potential_role: %s\n" % e)
```
@@ -1264,23 +1316,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_mining_session_response import RoleMiningSessionResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be retrieved. # str | The role mining session id to be retrieved.
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')
try:
# Get a role mining session
api_response = api_instance.get_role_mining_session(session_id, x_sail_point_experimental)
results =IAIRoleMiningApi(api_client).get_role_mining_session(session_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_role_mining_session(session_id, x_sail_point_experimental)
# results = IAIRoleMiningApi(api_client).get_role_mining_session(session_id, x_sail_point_experimental)
print("The response of IAIRoleMiningApi->get_role_mining_session:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_role_mining_session: %s\n" % e)
```
@@ -1324,23 +1379,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_mining_session_status import RoleMiningSessionStatus
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session 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')
try:
# Get role mining session status state
api_response = api_instance.get_role_mining_session_status(session_id, x_sail_point_experimental)
results =IAIRoleMiningApi(api_client).get_role_mining_session_status(session_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_role_mining_session_status(session_id, x_sail_point_experimental)
# results = IAIRoleMiningApi(api_client).get_role_mining_session_status(session_id, x_sail_point_experimental)
print("The response of IAIRoleMiningApi->get_role_mining_session_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_role_mining_session_status: %s\n" % e)
```
@@ -1389,10 +1447,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_mining_session_dto import RoleMiningSessionDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
filters = 'saved eq \"true\" and name sw \"RM Session\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* (optional)
sorters = 'createdBy,createdDate' # str | 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: **createdBy, createdDate** (optional) # str | 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: **createdBy, createdDate** (optional)
@@ -1403,13 +1465,12 @@ from pprint import pprint
try:
# Retrieves all role mining sessions
api_response = api_instance.get_role_mining_sessions(x_sail_point_experimental, )
results =IAIRoleMiningApi(api_client).get_role_mining_sessions(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_role_mining_sessions(x_sail_point_experimental, filters, sorters, offset, limit, count)
# results = IAIRoleMiningApi(api_client).get_role_mining_sessions(x_sail_point_experimental, filters, sorters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e)
```
@@ -1457,10 +1518,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_mining_session_draft_role_dto import RoleMiningSessionDraftRoleDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
sorters = 'modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional)
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)
@@ -1470,13 +1535,12 @@ from pprint import pprint
try:
# Retrieves all saved potential roles
api_response = api_instance.get_saved_potential_roles(x_sail_point_experimental, )
results =IAIRoleMiningApi(api_client).get_saved_potential_roles(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_saved_potential_roles(x_sail_point_experimental, sorters, offset, limit, count)
# results = IAIRoleMiningApi(api_client).get_saved_potential_roles(x_sail_point_experimental, sorters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e)
```
@@ -1536,10 +1600,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.patch_potential_role_request_inner import PatchPotentialRoleRequestInner
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The potential role summary id # str | The potential role summary 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')
@@ -1549,14 +1617,14 @@ from pprint import pprint
try:
# Update a potential role
Result = patch_potential_role_request_inner.from_json(patch_potential_role_request_inner)
api_response = api_instance.patch_potential_role(session_id, potential_role_id, x_sail_point_experimental, Result)
new_patch_potential_role_request_inner = PatchPotentialRoleRequestInner()
new_patch_potential_role_request_inner.from_json(patch_potential_role_request_inner)
results =IAIRoleMiningApi(api_client).patch_potential_role(session_id, potential_role_id, x_sail_point_experimental, new_patch_potential_role_request_inner)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_potential_role(session_id, potential_role_id, x_sail_point_experimental, Result)
# results = IAIRoleMiningApi(api_client).patch_potential_role(session_id, potential_role_id, x_sail_point_experimental, new_patch_potential_role_request_inner)
print("The response of IAIRoleMiningApi->patch_potential_role:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->patch_potential_role: %s\n" % e)
```
@@ -1616,10 +1684,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.patch_potential_role_request_inner import PatchPotentialRoleRequestInner
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The potential role summary id # str | The potential role summary 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')
@@ -1629,14 +1701,14 @@ from pprint import pprint
try:
# Update a potential role
Result = patch_potential_role_request_inner.from_json(patch_potential_role_request_inner)
api_response = api_instance.patch_potential_role_0(session_id, potential_role_id, x_sail_point_experimental, Result)
new_patch_potential_role_request_inner = PatchPotentialRoleRequestInner()
new_patch_potential_role_request_inner.from_json(patch_potential_role_request_inner)
results =IAIRoleMiningApi(api_client).patch_potential_role_0(session_id, potential_role_id, x_sail_point_experimental, new_patch_potential_role_request_inner)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_potential_role_0(session_id, potential_role_id, x_sail_point_experimental, Result)
# results = IAIRoleMiningApi(api_client).patch_potential_role_0(session_id, potential_role_id, x_sail_point_experimental, new_patch_potential_role_request_inner)
print("The response of IAIRoleMiningApi->patch_potential_role_0:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->patch_potential_role_0: %s\n" % e)
```
@@ -1683,10 +1755,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be patched # str | The role mining session id to be patched
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')
[{op=replace, path=/pruneThreshold, value=83}, {op=replace, path=/minNumIdentitiesInPotentialRole, value=10}, {op=replace, path=/saved, value=false}, {op=replace, path=/name, value=RM Session - 07/10/22}, {op=add, path=/name, value=RM Session - 07/10/22}] # List[JsonPatchOperation] | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session.
@@ -1699,14 +1775,14 @@ from pprint import pprint
try:
# Patch a role mining session
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_role_mining_session(session_id, x_sail_point_experimental, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =IAIRoleMiningApi(api_client).patch_role_mining_session(session_id, x_sail_point_experimental, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_role_mining_session(session_id, x_sail_point_experimental, Result)
# results = IAIRoleMiningApi(api_client).patch_role_mining_session(session_id, x_sail_point_experimental, new_json_patch_operation)
print("The response of IAIRoleMiningApi->patch_role_mining_session:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->patch_role_mining_session: %s\n" % e)
```
@@ -1752,11 +1828,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_mining_potential_role import RoleMiningPotentialRole
from sailpoint.v2024.models.role_mining_potential_role_edit_entitlements import RoleMiningPotentialRoleEditEntitlements
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
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')
@@ -1767,14 +1847,14 @@ from pprint import pprint
try:
# Edit entitlements for a potential role to exclude some entitlements
Result = role_mining_potential_role_edit_entitlements.from_json(role_mining_potential_role_edit_entitlements)
api_response = api_instance.update_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, Result)
new_role_mining_potential_role_edit_entitlements = RoleMiningPotentialRoleEditEntitlements()
new_role_mining_potential_role_edit_entitlements.from_json(role_mining_potential_role_edit_entitlements)
results =IAIRoleMiningApi(api_client).update_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, new_role_mining_potential_role_edit_entitlements)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, Result)
# results = IAIRoleMiningApi(api_client).update_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, new_role_mining_potential_role_edit_entitlements)
print("The response of IAIRoleMiningApi->update_entitlements_potential_role:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IAIRoleMiningApi->update_entitlements_potential_role: %s\n" % e)
```

28
docs/tools/sdk/python/Reference/V2024/Methods/IconsApi.md
View File

@@ -60,9 +60,13 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.icons_api import IconsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application']
object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object 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')
@@ -70,11 +74,10 @@ from pprint import pprint
try:
# Delete an icon
api_instance.delete_icon(object_type, object_id, x_sail_point_experimental)
IconsApi(api_client).delete_icon(object_type, object_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_instance.delete_icon(object_type, object_id, x_sail_point_experimental)
except Exception as e:
# IconsApi(api_client).delete_icon(object_type, object_id, x_sail_point_experimental)
except Exception as e:
print("Exception when calling IconsApi->delete_icon: %s\n" % e)
```
@@ -122,10 +125,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.icons_api import IconsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.set_icon200_response import SetIcon200Response
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application']
object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object 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')
@@ -134,13 +141,12 @@ from pprint import pprint
try:
# Update an icon
api_response = api_instance.set_icon(object_type, object_id, x_sail_point_experimental, image)
results =IconsApi(api_client).set_icon(object_type, object_id, x_sail_point_experimental, image)
# Below is a request that includes all optional parameters
# api_response = api_instance.set_icon(object_type, object_id, x_sail_point_experimental, image)
# results = IconsApi(api_client).set_icon(object_type, object_id, x_sail_point_experimental, image)
print("The response of IconsApi->set_icon:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IconsApi->set_icon: %s\n" % e)
```

168
docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md
View File

@@ -81,20 +81,23 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.identities_api import IdentitiesApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity 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')
try:
# Delete identity
api_instance.delete_identity(id, x_sail_point_experimental)
IdentitiesApi(api_client).delete_identity(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_instance.delete_identity(id, x_sail_point_experimental)
except Exception as e:
# IdentitiesApi(api_client).delete_identity(id, x_sail_point_experimental)
except Exception as e:
print("Exception when calling IdentitiesApi->delete_identity: %s\n" % e)
```
@@ -140,23 +143,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identities_api import IdentitiesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity import Identity
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity 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')
try:
# Identity Details
api_response = api_instance.get_identity(id, x_sail_point_experimental)
results =IdentitiesApi(api_client).get_identity(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity(id, x_sail_point_experimental)
# results = IdentitiesApi(api_client).get_identity(id, x_sail_point_experimental)
print("The response of IdentitiesApi->get_identity:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentitiesApi->get_identity: %s\n" % e)
```
@@ -204,23 +210,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identities_api import IdentitiesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_ownership_association_details import IdentityOwnershipAssociationDetails
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = 'ff8081814d2a8036014d701f3fbf53fa' # str | Identity ID. # str | Identity 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')
try:
# Get ownership details
api_response = api_instance.get_identity_ownership_details(identity_id, x_sail_point_experimental)
results =IdentitiesApi(api_client).get_identity_ownership_details(identity_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_ownership_details(identity_id, x_sail_point_experimental)
# results = IdentitiesApi(api_client).get_identity_ownership_details(identity_id, x_sail_point_experimental)
print("The response of IdentitiesApi->get_identity_ownership_details:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentitiesApi->get_identity_ownership_details: %s\n" % e)
```
@@ -267,10 +276,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identities_api import IdentitiesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_assignment_dto import RoleAssignmentDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id
assignment_id = '1cbb0705b38c4226b1334eadd8874086' # str | Assignment Id # str | Assignment 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')
@@ -278,13 +291,12 @@ from pprint import pprint
try:
# Role assignment details
api_response = api_instance.get_role_assignment(identity_id, assignment_id, x_sail_point_experimental)
results =IdentitiesApi(api_client).get_role_assignment(identity_id, assignment_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_role_assignment(identity_id, assignment_id, x_sail_point_experimental)
# results = IdentitiesApi(api_client).get_role_assignment(identity_id, assignment_id, x_sail_point_experimental)
print("The response of IdentitiesApi->get_role_assignment:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentitiesApi->get_role_assignment: %s\n" % e)
```
@@ -332,10 +344,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identities_api import IdentitiesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.get_role_assignments200_response_inner import GetRoleAssignments200ResponseInner
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id to get the role assignments for # str | Identity Id to get the role assignments for
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')
role_id = 'e7697a1e96d04db1ac7b0f4544915d2c' # str | Role Id to filter the role assignments with (optional) # str | Role Id to filter the role assignments with (optional)
@@ -344,13 +360,12 @@ from pprint import pprint
try:
# List role assignments
api_response = api_instance.get_role_assignments(identity_id, x_sail_point_experimental, )
results =IdentitiesApi(api_client).get_role_assignments(identity_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_role_assignments(identity_id, x_sail_point_experimental, role_id, role_name)
# results = IdentitiesApi(api_client).get_role_assignments(identity_id, x_sail_point_experimental, role_id, role_name)
print("The response of IdentitiesApi->get_role_assignments:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e)
```
@@ -400,10 +415,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identities_api import IdentitiesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity import Identity
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
filters = 'id eq \"6c9079b270a266a60170a2779fcb0006\" or correlated eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional)
sorters = 'name,-cloudStatus' # str | 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: **name, alias, cloudStatus** (optional) # str | 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: **name, alias, cloudStatus** (optional)
@@ -415,13 +434,12 @@ from pprint import pprint
try:
# List Identities
api_response = api_instance.list_identities(x_sail_point_experimental, )
results =IdentitiesApi(api_client).list_identities(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_identities(x_sail_point_experimental, filters, sorters, default_filter, count, limit, offset)
# results = IdentitiesApi(api_client).list_identities(x_sail_point_experimental, filters, sorters, default_filter, count, limit, offset)
print("The response of IdentitiesApi->list_identities:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentitiesApi->list_identities: %s\n" % e)
```
@@ -467,20 +485,23 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.identities_api import IdentitiesApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity 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')
try:
# Reset an identity
api_instance.reset_identity(identity_id, x_sail_point_experimental)
IdentitiesApi(api_client).reset_identity(identity_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_instance.reset_identity(identity_id, x_sail_point_experimental)
except Exception as e:
# IdentitiesApi(api_client).reset_identity(identity_id, x_sail_point_experimental)
except Exception as e:
print("Exception when calling IdentitiesApi->reset_identity: %s\n" % e)
```
@@ -528,10 +549,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identities_api import IdentitiesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.send_account_verification_request import SendAccountVerificationRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID
send_account_verification_request = {
@@ -541,12 +566,12 @@ from pprint import pprint
try:
# Send password reset email
Result = send_account_verification_request.from_json(send_account_verification_request)
api_instance.send_identity_verification_account_token(x_sail_point_experimental, id, Result)
new_send_account_verification_request = SendAccountVerificationRequest()
new_send_account_verification_request.from_json(send_account_verification_request)
IdentitiesApi(api_client).send_identity_verification_account_token(x_sail_point_experimental, id, new_send_account_verification_request)
# Below is a request that includes all optional parameters
# api_instance.send_identity_verification_account_token(x_sail_point_experimental, id, Result)
except Exception as e:
# IdentitiesApi(api_client).send_identity_verification_account_token(x_sail_point_experimental, id, new_send_account_verification_request)
except Exception as e:
print("Exception when calling IdentitiesApi->send_identity_verification_account_token: %s\n" % e)
```
@@ -597,11 +622,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identities_api import IdentitiesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.invite_identities_request import InviteIdentitiesRequest
from sailpoint.v2024.models.task_status import TaskStatus
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
invite_identities_request = {
"ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ],
@@ -610,14 +639,14 @@ from pprint import pprint
try:
# Invite identities to register
Result = invite_identities_request.from_json(invite_identities_request)
api_response = api_instance.start_identities_invite(x_sail_point_experimental, Result)
new_invite_identities_request = InviteIdentitiesRequest()
new_invite_identities_request.from_json(invite_identities_request)
results =IdentitiesApi(api_client).start_identities_invite(x_sail_point_experimental, new_invite_identities_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.start_identities_invite(x_sail_point_experimental, Result)
# results = IdentitiesApi(api_client).start_identities_invite(x_sail_point_experimental, new_invite_identities_request)
print("The response of IdentitiesApi->start_identities_invite:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentitiesApi->start_identities_invite: %s\n" % e)
```
@@ -670,11 +699,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identities_api import IdentitiesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.process_identities_request import ProcessIdentitiesRequest
from sailpoint.v2024.models.task_result_response import TaskResultResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
process_identities_request = {
"identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ]
@@ -682,14 +715,14 @@ from pprint import pprint
try:
# Process a list of identityIds
Result = process_identities_request.from_json(process_identities_request)
api_response = api_instance.start_identity_processing(x_sail_point_experimental, Result)
new_process_identities_request = ProcessIdentitiesRequest()
new_process_identities_request.from_json(process_identities_request)
results =IdentitiesApi(api_client).start_identity_processing(x_sail_point_experimental, new_process_identities_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.start_identity_processing(x_sail_point_experimental, Result)
# results = IdentitiesApi(api_client).start_identity_processing(x_sail_point_experimental, new_process_identities_request)
print("The response of IdentitiesApi->start_identity_processing:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentitiesApi->start_identity_processing: %s\n" % e)
```
@@ -735,23 +768,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identities_api import IdentitiesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_sync_job import IdentitySyncJob
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = 'identity_id_example' # str | The Identity id # str | The Identity 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')
try:
# Attribute synchronization for single identity.
api_response = api_instance.synchronize_attributes_for_identity(identity_id, x_sail_point_experimental)
results =IdentitiesApi(api_client).synchronize_attributes_for_identity(identity_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.synchronize_attributes_for_identity(identity_id, x_sail_point_experimental)
# results = IdentitiesApi(api_client).synchronize_attributes_for_identity(identity_id, x_sail_point_experimental)
print("The response of IdentitiesApi->synchronize_attributes_for_identity:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentitiesApi->synchronize_attributes_for_identity: %s\n" % e)
```

95
docs/tools/sdk/python/Reference/V2024/Methods/IdentityAttributesApi.md
View File

@@ -61,10 +61,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_attributes_api import IdentityAttributesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_attribute import IdentityAttribute
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
identity_attribute = {
"standard" : false,
@@ -91,14 +95,14 @@ from pprint import pprint
try:
# Create Identity Attribute
Result = identity_attribute.from_json(identity_attribute)
api_response = api_instance.create_identity_attribute(x_sail_point_experimental, Result)
new_identity_attribute = IdentityAttribute()
new_identity_attribute.from_json(identity_attribute)
results =IdentityAttributesApi(api_client).create_identity_attribute(x_sail_point_experimental, new_identity_attribute)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_identity_attribute(x_sail_point_experimental, Result)
# results = IdentityAttributesApi(api_client).create_identity_attribute(x_sail_point_experimental, new_identity_attribute)
print("The response of IdentityAttributesApi->create_identity_attribute:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityAttributesApi->create_identity_attribute: %s\n" % e)
```
@@ -144,20 +148,23 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.identity_attributes_api import IdentityAttributesApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name.
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')
try:
# Delete Identity Attribute
api_instance.delete_identity_attribute(name, x_sail_point_experimental)
IdentityAttributesApi(api_client).delete_identity_attribute(name, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_instance.delete_identity_attribute(name, x_sail_point_experimental)
except Exception as e:
# IdentityAttributesApi(api_client).delete_identity_attribute(name, x_sail_point_experimental)
except Exception as e:
print("Exception when calling IdentityAttributesApi->delete_identity_attribute: %s\n" % e)
```
@@ -203,10 +210,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_attributes_api import IdentityAttributesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_attribute_names import IdentityAttributeNames
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
identity_attribute_names = {
"ids" : [ "name", "displayName" ]
@@ -214,12 +225,12 @@ from pprint import pprint
try:
# Bulk delete Identity Attributes
Result = identity_attribute_names.from_json(identity_attribute_names)
api_instance.delete_identity_attributes_in_bulk(x_sail_point_experimental, Result)
new_identity_attribute_names = IdentityAttributeNames()
new_identity_attribute_names.from_json(identity_attribute_names)
IdentityAttributesApi(api_client).delete_identity_attributes_in_bulk(x_sail_point_experimental, new_identity_attribute_names)
# Below is a request that includes all optional parameters
# api_instance.delete_identity_attributes_in_bulk(x_sail_point_experimental, Result)
except Exception as e:
# IdentityAttributesApi(api_client).delete_identity_attributes_in_bulk(x_sail_point_experimental, new_identity_attribute_names)
except Exception as e:
print("Exception when calling IdentityAttributesApi->delete_identity_attributes_in_bulk: %s\n" % e)
```
@@ -265,23 +276,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_attributes_api import IdentityAttributesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_attribute import IdentityAttribute
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name.
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')
try:
# Get Identity Attribute
api_response = api_instance.get_identity_attribute(name, x_sail_point_experimental)
results =IdentityAttributesApi(api_client).get_identity_attribute(name, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_attribute(name, x_sail_point_experimental)
# results = IdentityAttributesApi(api_client).get_identity_attribute(name, x_sail_point_experimental)
print("The response of IdentityAttributesApi->get_identity_attribute:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityAttributesApi->get_identity_attribute: %s\n" % e)
```
@@ -329,10 +343,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_attributes_api import IdentityAttributesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_attribute import IdentityAttribute
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
include_system = False # bool | Include 'system' attributes in the response. (optional) (default to False) # bool | Include 'system' attributes in the response. (optional) (default to False)
include_silent = False # bool | Include 'silent' attributes in the response. (optional) (default to False) # bool | Include 'silent' attributes in the response. (optional) (default to False)
@@ -342,13 +360,12 @@ from pprint import pprint
try:
# List Identity Attributes
api_response = api_instance.list_identity_attributes(x_sail_point_experimental, )
results =IdentityAttributesApi(api_client).list_identity_attributes(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_identity_attributes(x_sail_point_experimental, include_system, include_silent, searchable_only, count)
# results = IdentityAttributesApi(api_client).list_identity_attributes(x_sail_point_experimental, include_system, include_silent, searchable_only, count)
print("The response of IdentityAttributesApi->list_identity_attributes:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e)
```
@@ -395,10 +412,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_attributes_api import IdentityAttributesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_attribute import IdentityAttribute
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name.
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')
identity_attribute = {
@@ -426,14 +447,14 @@ from pprint import pprint
try:
# Update Identity Attribute
Result = identity_attribute.from_json(identity_attribute)
api_response = api_instance.put_identity_attribute(name, x_sail_point_experimental, Result)
new_identity_attribute = IdentityAttribute()
new_identity_attribute.from_json(identity_attribute)
results =IdentityAttributesApi(api_client).put_identity_attribute(name, x_sail_point_experimental, new_identity_attribute)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_identity_attribute(name, x_sail_point_experimental, Result)
# results = IdentityAttributesApi(api_client).put_identity_attribute(name, x_sail_point_experimental, new_identity_attribute)
print("The response of IdentityAttributesApi->put_identity_attribute:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityAttributesApi->put_identity_attribute: %s\n" % e)
```

165
docs/tools/sdk/python/Reference/V2024/Methods/IdentityHistoryApi.md
View File

@@ -71,10 +71,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_compare_response import IdentityCompareResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity 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')
snapshot1 = '2007-03-01T13:00:00Z' # str | The snapshot 1 of identity (optional) # str | The snapshot 1 of identity (optional)
@@ -89,13 +93,12 @@ from pprint import pprint
try:
# Gets a difference of count for each access item types for the given identity between 2 snapshots
api_response = api_instance.compare_identity_snapshots(id, x_sail_point_experimental, )
results =IdentityHistoryApi(api_client).compare_identity_snapshots(id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.compare_identity_snapshots(id, x_sail_point_experimental, snapshot1, snapshot2, access_item_types, limit, offset, count)
# results = IdentityHistoryApi(api_client).compare_identity_snapshots(id, x_sail_point_experimental, snapshot1, snapshot2, access_item_types, limit, offset, count)
print("The response of IdentityHistoryApi->compare_identity_snapshots:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e)
```
@@ -147,10 +150,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_item_diff import AccessItemDiff
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
access_type = 'role' # str | The specific type which needs to be compared # str | The specific type which needs to be compared
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')
@@ -164,13 +171,12 @@ from pprint import pprint
try:
# Gets a list of differences of specific accessType for the given identity between 2 snapshots
api_response = api_instance.compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, )
results =IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, access_associated, snapshot1, snapshot2, limit, offset, count)
# results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, access_associated, snapshot1, snapshot2, limit, offset, count)
print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e)
```
@@ -215,23 +221,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_history_response import IdentityHistoryResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity 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')
try:
# Get latest snapshot of identity
api_response = api_instance.get_historical_identity(id, x_sail_point_experimental)
results =IdentityHistoryApi(api_client).get_historical_identity(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_historical_identity(id, x_sail_point_experimental)
# results = IdentityHistoryApi(api_client).get_historical_identity(id, x_sail_point_experimental)
print("The response of IdentityHistoryApi->get_historical_identity:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityHistoryApi->get_historical_identity: %s\n" % e)
```
@@ -283,10 +292,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.get_historical_identity_events200_response_inner import GetHistoricalIdentityEvents200ResponseInner
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity 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')
var_from = '2024-03-01T13:00:00Z' # str | The optional instant until which access events are returned (optional) # str | The optional instant until which access events are returned (optional)
@@ -303,13 +316,12 @@ from pprint import pprint
try:
# Lists all events for the given identity
api_response = api_instance.get_historical_identity_events(id, x_sail_point_experimental, )
results =IdentityHistoryApi(api_client).get_historical_identity_events(id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_historical_identity_events(id, x_sail_point_experimental, var_from, event_types, access_item_types, limit, offset, count)
# results = IdentityHistoryApi(api_client).get_historical_identity_events(id, x_sail_point_experimental, var_from, event_types, access_item_types, limit, offset, count)
print("The response of IdentityHistoryApi->get_historical_identity_events:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e)
```
@@ -355,10 +367,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_history_response import IdentityHistoryResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
var_date = '2007-03-01T13:00:00Z' # str | The specified date # str | The specified date
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')
@@ -366,13 +382,12 @@ from pprint import pprint
try:
# Gets an identity snapshot at a given date
api_response = api_instance.get_identity_snapshot(id, var_date, x_sail_point_experimental)
results =IdentityHistoryApi(api_client).get_identity_snapshot(id, var_date, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_snapshot(id, var_date, x_sail_point_experimental)
# results = IdentityHistoryApi(api_client).get_identity_snapshot(id, var_date, x_sail_point_experimental)
print("The response of IdentityHistoryApi->get_identity_snapshot:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityHistoryApi->get_identity_snapshot: %s\n" % e)
```
@@ -423,10 +438,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.metric_response import MetricResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity 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')
before = '2007-03-01T13:00:00Z' # str | The date before which snapshot summary is required (optional) # str | The date before which snapshot summary is required (optional)
@@ -439,13 +458,12 @@ from pprint import pprint
try:
# Gets the summary for the event count for a specific identity
api_response = api_instance.get_identity_snapshot_summary(id, x_sail_point_experimental, )
results =IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_snapshot_summary(id, x_sail_point_experimental, before, interval, time_zone, limit, offset, count)
# results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, x_sail_point_experimental, before, interval, time_zone, limit, offset, count)
print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e)
```
@@ -490,22 +508,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity 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')
try:
# Gets the start date of the identity
api_response = api_instance.get_identity_start_date(id, x_sail_point_experimental)
results =IdentityHistoryApi(api_client).get_identity_start_date(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_start_date(id, x_sail_point_experimental)
# results = IdentityHistoryApi(api_client).get_identity_start_date(id, x_sail_point_experimental)
print("The response of IdentityHistoryApi->get_identity_start_date:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityHistoryApi->get_identity_start_date: %s\n" % e)
```
@@ -554,10 +575,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_list_item import IdentityListItem
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
starts_with_query = 'Ada' # str | This param is used for starts-with search for first, last and display name of the identity (optional) # str | This param is used for starts-with search for first, last and display name of the identity (optional)
is_deleted = true # bool | Indicates if we want to only list down deleted identities or not. (optional) # bool | Indicates if we want to only list down deleted identities or not. (optional)
@@ -568,13 +593,12 @@ from pprint import pprint
try:
# Lists all the identities
api_response = api_instance.list_historical_identities(x_sail_point_experimental, )
results =IdentityHistoryApi(api_client).list_historical_identities(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_historical_identities(x_sail_point_experimental, starts_with_query, is_deleted, is_active, limit, offset)
# results = IdentityHistoryApi(api_client).list_historical_identities(x_sail_point_experimental, starts_with_query, is_deleted, is_active, limit, offset)
print("The response of IdentityHistoryApi->list_historical_identities:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e)
```
@@ -625,10 +649,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity 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')
type = 'account' # str | The type of access item for the identity. If not provided, it defaults to account (optional) # str | The type of access item for the identity. If not provided, it defaults to account (optional)
@@ -639,13 +667,12 @@ from pprint import pprint
try:
# List Access Items by Identity
api_response = api_instance.list_identity_access_items(id, x_sail_point_experimental, )
results =IdentityHistoryApi(api_client).list_identity_access_items(id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_identity_access_items(id, x_sail_point_experimental, type, limit, count, offset)
# results = IdentityHistoryApi(api_client).list_identity_access_items(id, x_sail_point_experimental, type, limit, count, offset)
print("The response of IdentityHistoryApi->list_identity_access_items:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e)
```
@@ -692,10 +719,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
var_date = '2007-03-01T13:00:00Z' # str | The specified date # str | The specified date
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')
@@ -704,13 +735,12 @@ from pprint import pprint
try:
# Gets the list of identity access items at a given date filterd by item type
api_response = api_instance.list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, )
results =IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, type)
# results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, type)
print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e)
```
@@ -760,10 +790,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_snapshot_summary_response import IdentitySnapshotSummaryResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity 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')
start = '2007-03-01T13:00:00Z' # str | The specified start date (optional) # str | The specified start date (optional)
@@ -775,13 +809,12 @@ from pprint import pprint
try:
# Lists all the snapshots for the identity
api_response = api_instance.list_identity_snapshots(id, x_sail_point_experimental, )
results =IdentityHistoryApi(api_client).list_identity_snapshots(id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_identity_snapshots(id, x_sail_point_experimental, start, interval, limit, offset, count)
# results = IdentityHistoryApi(api_client).list_identity_snapshots(id, x_sail_point_experimental, start, interval, limit, offset, count)
print("The response of IdentityHistoryApi->list_identity_snapshots:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e)
```

180
docs/tools/sdk/python/Reference/V2024/Methods/IdentityProfilesApi.md
View File

@@ -71,10 +71,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_profile import IdentityProfile
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile = {
"owner" : {
"name" : "William Wilson",
@@ -127,14 +131,14 @@ from pprint import pprint
try:
# Create an Identity Profile
Result = identity_profile.from_json(identity_profile)
api_response = api_instance.create_identity_profile(Result)
new_identity_profile = IdentityProfile()
new_identity_profile.from_json(identity_profile)
results =IdentityProfilesApi(api_client).create_identity_profile(new_identity_profile)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_identity_profile(Result)
# results = IdentityProfilesApi(api_client).create_identity_profile(new_identity_profile)
print("The response of IdentityProfilesApi->create_identity_profile:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityProfilesApi->create_identity_profile: %s\n" % e)
```
@@ -181,22 +185,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.task_result_simplified import TaskResultSimplified
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Identity Profile ID. # str | The Identity Profile ID.
try:
# Delete an Identity Profile
api_response = api_instance.delete_identity_profile(identity_profile_id)
results =IdentityProfilesApi(api_client).delete_identity_profile(identity_profile_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_identity_profile(identity_profile_id)
# results = IdentityProfilesApi(api_client).delete_identity_profile(identity_profile_id)
print("The response of IdentityProfilesApi->delete_identity_profile:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityProfilesApi->delete_identity_profile: %s\n" % e)
```
@@ -241,24 +248,28 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.task_result_simplified import TaskResultSimplified
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body.
request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body.
try:
# Delete Identity Profiles
Result = request_body.from_json(request_body)
api_response = api_instance.delete_identity_profiles(Result)
new_request_body = RequestBody()
new_request_body.from_json(request_body)
results =IdentityProfilesApi(api_client).delete_identity_profiles(new_request_body)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_identity_profiles(Result)
# results = IdentityProfilesApi(api_client).delete_identity_profiles(new_request_body)
print("The response of IdentityProfilesApi->delete_identity_profiles:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityProfilesApi->delete_identity_profiles: %s\n" % e)
```
@@ -303,10 +314,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_profile_exported_object import IdentityProfileExportedObject
from sailpoint.v2024.rest import ApiException
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)
count = False # bool | 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=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. (optional) (default to False) # bool | 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=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. (optional) (default to False)
@@ -316,13 +331,12 @@ from pprint import pprint
try:
# Export Identity Profiles
api_response = api_instance.export_identity_profiles()
results =IdentityProfilesApi(api_client).export_identity_profiles()
# Below is a request that includes all optional parameters
# api_response = api_instance.export_identity_profiles(limit, offset, count, filters, sorters)
# results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters)
print("The response of IdentityProfilesApi->export_identity_profiles:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e)
```
@@ -364,22 +378,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_attribute_config import IdentityAttributeConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | The Identity Profile ID. # str | The Identity Profile ID.
try:
# Get default Identity Attribute Config
api_response = api_instance.get_default_identity_attribute_config(identity_profile_id)
results =IdentityProfilesApi(api_client).get_default_identity_attribute_config(identity_profile_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_default_identity_attribute_config(identity_profile_id)
# results = IdentityProfilesApi(api_client).get_default_identity_attribute_config(identity_profile_id)
print("The response of IdentityProfilesApi->get_default_identity_attribute_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityProfilesApi->get_default_identity_attribute_config: %s\n" % e)
```
@@ -421,22 +438,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_profile import IdentityProfile
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | The Identity Profile ID. # str | The Identity Profile ID.
try:
# Get single Identity Profile
api_response = api_instance.get_identity_profile(identity_profile_id)
results =IdentityProfilesApi(api_client).get_identity_profile(identity_profile_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_profile(identity_profile_id)
# results = IdentityProfilesApi(api_client).get_identity_profile(identity_profile_id)
print("The response of IdentityProfilesApi->get_identity_profile:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityProfilesApi->get_identity_profile: %s\n" % e)
```
@@ -477,11 +497,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_profile_exported_object import IdentityProfileExportedObject
from sailpoint.v2024.models.object_import_result import ObjectImportResult
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
[sailpoint.v2024.IdentityProfileExportedObject()] # List[IdentityProfileExportedObject] | Previously exported Identity Profiles.
identity_profile_exported_object = {
"self" : {
@@ -544,14 +568,14 @@ from pprint import pprint
try:
# Import Identity Profiles
Result = identity_profile_exported_object.from_json(identity_profile_exported_object)
api_response = api_instance.import_identity_profiles(Result)
new_identity_profile_exported_object = IdentityProfileExportedObject()
new_identity_profile_exported_object.from_json(identity_profile_exported_object)
results =IdentityProfilesApi(api_client).import_identity_profiles(new_identity_profile_exported_object)
# Below is a request that includes all optional parameters
# api_response = api_instance.import_identity_profiles(Result)
# results = IdentityProfilesApi(api_client).import_identity_profiles(new_identity_profile_exported_object)
print("The response of IdentityProfilesApi->import_identity_profiles:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityProfilesApi->import_identity_profiles: %s\n" % e)
```
@@ -596,10 +620,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_profile import IdentityProfile
from sailpoint.v2024.rest import ApiException
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)
count = False # bool | 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=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. (optional) (default to False) # bool | 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=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. (optional) (default to False)
@@ -609,13 +637,12 @@ from pprint import pprint
try:
# Identity Profiles List
api_response = api_instance.list_identity_profiles()
results =IdentityProfilesApi(api_client).list_identity_profiles()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_identity_profiles(limit, offset, count, filters, sorters)
# results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters)
print("The response of IdentityProfilesApi->list_identity_profiles:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e)
```
@@ -657,11 +684,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_preview_request import IdentityPreviewRequest
from sailpoint.v2024.models.identity_preview_response import IdentityPreviewResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_preview_request = {
"identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"identityAttributeConfig" : {
@@ -692,14 +723,14 @@ from pprint import pprint
try:
# Generate Identity Profile Preview
Result = identity_preview_request.from_json(identity_preview_request)
api_response = api_instance.show_identity_preview(Result)
new_identity_preview_request = IdentityPreviewRequest()
new_identity_preview_request.from_json(identity_preview_request)
results =IdentityProfilesApi(api_client).show_identity_preview(new_identity_preview_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.show_identity_preview(Result)
# results = IdentityProfilesApi(api_client).show_identity_preview(new_identity_preview_request)
print("The response of IdentityProfilesApi->show_identity_preview:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityProfilesApi->show_identity_preview: %s\n" % e)
```
@@ -745,21 +776,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Identity Profile ID to be processed # str | The Identity Profile ID to be processed
try:
# Process identities under profile
api_response = api_instance.sync_identity_profile(identity_profile_id)
results =IdentityProfilesApi(api_client).sync_identity_profile(identity_profile_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.sync_identity_profile(identity_profile_id)
# results = IdentityProfilesApi(api_client).sync_identity_profile(identity_profile_id)
print("The response of IdentityProfilesApi->sync_identity_profile:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityProfilesApi->sync_identity_profile: %s\n" % e)
```
@@ -812,11 +846,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_profile import IdentityProfile
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Identity Profile ID # str | The Identity Profile ID
[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}] # List[JsonPatchOperation] | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
json_patch_operation = {
@@ -828,14 +866,14 @@ from pprint import pprint
try:
# Update the Identity Profile
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.update_identity_profile(identity_profile_id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_identity_profile(identity_profile_id, Result)
# results = IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id, new_json_patch_operation)
print("The response of IdentityProfilesApi->update_identity_profile:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e)
```

99
docs/tools/sdk/python/Reference/V2024/Methods/LifecycleStatesApi.md
View File

@@ -95,10 +95,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.lifecycle_states_api import LifecycleStatesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.lifecycle_state import LifecycleState
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID.
lifecycle_state = {
"accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ],
@@ -128,14 +132,14 @@ from pprint import pprint
try:
# Create Lifecycle State
Result = lifecycle_state.from_json(lifecycle_state)
api_response = api_instance.create_lifecycle_state(identity_profile_id, Result)
new_lifecycle_state = LifecycleState()
new_lifecycle_state.from_json(lifecycle_state)
results =LifecycleStatesApi(api_client).create_lifecycle_state(identity_profile_id, new_lifecycle_state)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_lifecycle_state(identity_profile_id, Result)
# results = LifecycleStatesApi(api_client).create_lifecycle_state(identity_profile_id, new_lifecycle_state)
print("The response of LifecycleStatesApi->create_lifecycle_state:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling LifecycleStatesApi->create_lifecycle_state: %s\n" % e)
```
@@ -178,23 +182,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.lifecycle_states_api import LifecycleStatesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.lifecyclestate_deleted import LifecyclestateDeleted
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID.
lifecycle_state_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Lifecycle state ID. # str | Lifecycle state ID.
try:
# Delete Lifecycle State
api_response = api_instance.delete_lifecycle_state(identity_profile_id, lifecycle_state_id)
results =LifecycleStatesApi(api_client).delete_lifecycle_state(identity_profile_id, lifecycle_state_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_lifecycle_state(identity_profile_id, lifecycle_state_id)
# results = LifecycleStatesApi(api_client).delete_lifecycle_state(identity_profile_id, lifecycle_state_id)
print("The response of LifecycleStatesApi->delete_lifecycle_state:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling LifecycleStatesApi->delete_lifecycle_state: %s\n" % e)
```
@@ -237,23 +244,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.lifecycle_states_api import LifecycleStatesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.lifecycle_state import LifecycleState
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID.
lifecycle_state_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Lifecycle state ID. # str | Lifecycle state ID.
try:
# Get Lifecycle State
api_response = api_instance.get_lifecycle_state(identity_profile_id, lifecycle_state_id)
results =LifecycleStatesApi(api_client).get_lifecycle_state(identity_profile_id, lifecycle_state_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_lifecycle_state(identity_profile_id, lifecycle_state_id)
# results = LifecycleStatesApi(api_client).get_lifecycle_state(identity_profile_id, lifecycle_state_id)
print("The response of LifecycleStatesApi->get_lifecycle_state:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling LifecycleStatesApi->get_lifecycle_state: %s\n" % e)
```
@@ -298,10 +308,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.lifecycle_states_api import LifecycleStatesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.lifecycle_state import LifecycleState
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile 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)
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)
@@ -311,13 +325,12 @@ from pprint import pprint
try:
# Lists LifecycleStates
api_response = api_instance.get_lifecycle_states(identity_profile_id, )
results =LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_lifecycle_states(identity_profile_id, limit, offset, count, sorters)
# results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, limit, offset, count, sorters)
print("The response of LifecycleStatesApi->get_lifecycle_states:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e)
```
@@ -360,24 +373,28 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.lifecycle_states_api import LifecycleStatesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.set_lifecycle_state200_response import SetLifecycleState200Response
from sailpoint.v2024.models.set_lifecycle_state_request import SetLifecycleStateRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = '2c9180857893f1290178944561990364' # str | ID of the identity to update. # str | ID of the identity to update.
set_lifecycle_state_request = sailpoint.v2024.SetLifecycleStateRequest() # SetLifecycleStateRequest |
try:
# Set Lifecycle State
Result = set_lifecycle_state_request.from_json(set_lifecycle_state_request)
api_response = api_instance.set_lifecycle_state(identity_id, Result)
new_set_lifecycle_state_request = SetLifecycleStateRequest()
new_set_lifecycle_state_request.from_json(set_lifecycle_state_request)
results =LifecycleStatesApi(api_client).set_lifecycle_state(identity_id, new_set_lifecycle_state_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.set_lifecycle_state(identity_id, Result)
# results = LifecycleStatesApi(api_client).set_lifecycle_state(identity_id, new_set_lifecycle_state_request)
print("The response of LifecycleStatesApi->set_lifecycle_state:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling LifecycleStatesApi->set_lifecycle_state: %s\n" % e)
```
@@ -421,11 +438,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.lifecycle_states_api import LifecycleStatesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.models.lifecycle_state import LifecycleState
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID.
lifecycle_state_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Lifecycle state ID. # str | Lifecycle state ID.
[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/accessProfileIds, value=[2c918087742bab150174407a80f3125e, 2c918087742bab150174407a80f3124f]}, {op=replace, path=/accountActions, value=[{action=ENABLE, sourceIds=[2c9180846a2f82fb016a481c1b1560c5, 2c9180846a2f82fb016a481c1b1560cc]}, {action=DISABLE, sourceIds=[2c91808869a0c9980169a207258513fb]}]}, {op=replace, path=/emailNotificationOption, value={notifyManagers=true, notifyAllAdmins=false, notifySpecificUsers=false, emailAddressList=[]}}] # List[JsonPatchOperation] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption
@@ -438,14 +459,14 @@ from pprint import pprint
try:
# Update Lifecycle State
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =LifecycleStatesApi(api_client).update_lifecycle_states(identity_profile_id, lifecycle_state_id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result)
# results = LifecycleStatesApi(api_client).update_lifecycle_states(identity_profile_id, lifecycle_state_id, new_json_patch_operation)
print("The response of LifecycleStatesApi->update_lifecycle_states:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e)
```

114
docs/tools/sdk/python/Reference/V2024/Methods/MFAConfigurationApi.md
View File

@@ -54,21 +54,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Configuration of Duo MFA method
api_response = api_instance.get_mfa_duo_config()
results =MFAConfigurationApi(api_client).get_mfa_duo_config()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_mfa_duo_config()
# results = MFAConfigurationApi(api_client).get_mfa_duo_config()
print("The response of MFAConfigurationApi->get_mfa_duo_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e)
```
@@ -109,22 +112,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.kba_question import KbaQuestion
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional)
try:
# Configuration of KBA MFA method
api_response = api_instance.get_mfa_kba_config()
results =MFAConfigurationApi(api_client).get_mfa_kba_config()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_mfa_kba_config(all_languages)
# results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages)
print("The response of MFAConfigurationApi->get_mfa_kba_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e)
```
@@ -162,21 +168,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Configuration of Okta MFA method
api_response = api_instance.get_mfa_okta_config()
results =MFAConfigurationApi(api_client).get_mfa_okta_config()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_mfa_okta_config()
# results = MFAConfigurationApi(api_client).get_mfa_okta_config()
print("The response of MFAConfigurationApi->get_mfa_okta_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e)
```
@@ -217,10 +226,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.mfa_duo_config import MfaDuoConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
mfa_duo_config = {
"accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y",
"host" : "example.com",
@@ -235,14 +248,14 @@ from pprint import pprint
try:
# Set Duo MFA configuration
Result = mfa_duo_config.from_json(mfa_duo_config)
api_response = api_instance.set_mfa_duo_config(Result)
new_mfa_duo_config = MfaDuoConfig()
new_mfa_duo_config.from_json(mfa_duo_config)
results =MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config)
# Below is a request that includes all optional parameters
# api_response = api_instance.set_mfa_duo_config(Result)
# results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config)
print("The response of MFAConfigurationApi->set_mfa_duo_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e)
```
@@ -283,10 +296,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.mfa_okta_config import MfaOktaConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
mfa_okta_config = {
"accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y",
"host" : "example.com",
@@ -297,14 +314,14 @@ from pprint import pprint
try:
# Set Okta MFA configuration
Result = mfa_okta_config.from_json(mfa_okta_config)
api_response = api_instance.set_mfa_okta_config(Result)
new_mfa_okta_config = MfaOktaConfig()
new_mfa_okta_config.from_json(mfa_okta_config)
results =MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config)
# Below is a request that includes all optional parameters
# api_response = api_instance.set_mfa_okta_config(Result)
# results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config)
print("The response of MFAConfigurationApi->set_mfa_okta_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e)
```
@@ -345,11 +362,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.kba_answer_request_item import KbaAnswerRequestItem
from sailpoint.v2024.models.kba_answer_response_item import KbaAnswerResponseItem
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] |
kba_answer_request_item = {
"answer" : "Your answer",
@@ -359,14 +380,14 @@ from pprint import pprint
try:
# Set MFA KBA configuration
Result = kba_answer_request_item.from_json(kba_answer_request_item)
api_response = api_instance.set_mfakba_config(Result)
new_kba_answer_request_item = KbaAnswerRequestItem()
new_kba_answer_request_item.from_json(kba_answer_request_item)
results =MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item)
# Below is a request that includes all optional parameters
# api_response = api_instance.set_mfakba_config(Result)
# results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item)
print("The response of MFAConfigurationApi->set_mfakba_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e)
```
@@ -407,22 +428,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.mfa_configuration_api import MFAConfigurationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.mfa_config_test_response import MfaConfigTestResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'.
try:
# MFA method's test configuration
api_response = api_instance.test_mfa_config(method)
results =MFAConfigurationApi(api_client).test_mfa_config(method)
# Below is a request that includes all optional parameters
# api_response = api_instance.test_mfa_config(method)
# results = MFAConfigurationApi(api_client).test_mfa_config(method)
print("The response of MFAConfigurationApi->test_mfa_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e)
```

94
docs/tools/sdk/python/Reference/V2024/Methods/ManagedClientsApi.md
View File

@@ -59,11 +59,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.managed_clients_api import ManagedClientsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.managed_client import ManagedClient
from sailpoint.v2024.models.managed_client_request import ManagedClientRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
managed_client_request = {
"name" : "aName",
"description" : "A short description of the ManagedClient",
@@ -73,14 +77,14 @@ from pprint import pprint
try:
# Create Managed Client
Result = managed_client_request.from_json(managed_client_request)
api_response = api_instance.create_managed_client(Result)
new_managed_client_request = ManagedClientRequest()
new_managed_client_request.from_json(managed_client_request)
results =ManagedClientsApi(api_client).create_managed_client(new_managed_client_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_managed_client(Result)
# results = ManagedClientsApi(api_client).create_managed_client(new_managed_client_request)
print("The response of ManagedClientsApi->create_managed_client:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e)
```
@@ -121,19 +125,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.managed_clients_api import ManagedClientsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID.
try:
# Delete Managed Client
api_instance.delete_managed_client(id)
ManagedClientsApi(api_client).delete_managed_client(id)
# Below is a request that includes all optional parameters
# api_instance.delete_managed_client(id)
except Exception as e:
# ManagedClientsApi(api_client).delete_managed_client(id)
except Exception as e:
print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e)
```
@@ -175,22 +182,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.managed_clients_api import ManagedClientsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.managed_client import ManagedClient
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID.
try:
# Get Managed Client
api_response = api_instance.get_managed_client(id)
results =ManagedClientsApi(api_client).get_managed_client(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_managed_client(id)
# results = ManagedClientsApi(api_client).get_managed_client(id)
print("The response of ManagedClientsApi->get_managed_client:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e)
```
@@ -233,24 +243,27 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.managed_clients_api import ManagedClientsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.managed_client_status import ManagedClientStatus
from sailpoint.v2024.models.managed_client_type import ManagedClientType
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'aClientId' # str | Managed client ID to get status for. # str | Managed client ID to get status for.
type = sailpoint.v2024.ManagedClientType() # ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for.
try:
# Get Managed Client Status
api_response = api_instance.get_managed_client_status(id, type)
results =ManagedClientsApi(api_client).get_managed_client_status(id, type)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_managed_client_status(id, type)
# results = ManagedClientsApi(api_client).get_managed_client_status(id, type)
print("The response of ManagedClientsApi->get_managed_client_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e)
```
@@ -294,10 +307,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.managed_clients_api import ManagedClientsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.managed_client import ManagedClient
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
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)
count = False # bool | 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=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. (optional) (default to False) # bool | 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=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. (optional) (default to False)
@@ -306,13 +323,12 @@ from pprint import pprint
try:
# Get Managed Clients
api_response = api_instance.get_managed_clients()
results =ManagedClientsApi(api_client).get_managed_clients()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_managed_clients(offset, limit, count, filters)
# results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters)
print("The response of ManagedClientsApi->get_managed_clients:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e)
```
@@ -355,11 +371,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.managed_clients_api import ManagedClientsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.models.managed_client import ManagedClient
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID.
[sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | JSONPatch payload used to update the object.
json_patch_operation = {
@@ -371,14 +391,14 @@ from pprint import pprint
try:
# Update Managed Client
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.update_managed_client(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =ManagedClientsApi(api_client).update_managed_client(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_managed_client(id, Result)
# results = ManagedClientsApi(api_client).update_managed_client(id, new_json_patch_operation)
print("The response of ManagedClientsApi->update_managed_client:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e)
```

112
docs/tools/sdk/python/Reference/V2024/Methods/ManagedClustersApi.md
View File

@@ -60,11 +60,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.managed_cluster import ManagedCluster
from sailpoint.v2024.models.managed_cluster_request import ManagedClusterRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
managed_cluster_request = {
"configuration" : {
"clusterExternalId" : "externalId",
@@ -77,14 +81,14 @@ from pprint import pprint
try:
# Create Create Managed Cluster
Result = managed_cluster_request.from_json(managed_cluster_request)
api_response = api_instance.create_managed_cluster(Result)
new_managed_cluster_request = ManagedClusterRequest()
new_managed_cluster_request.from_json(managed_cluster_request)
results =ManagedClustersApi(api_client).create_managed_cluster(new_managed_cluster_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_managed_cluster(Result)
# results = ManagedClustersApi(api_client).create_managed_cluster(new_managed_cluster_request)
print("The response of ManagedClustersApi->create_managed_cluster:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e)
```
@@ -126,20 +130,23 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID.
remove_clients = False # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False)
try:
# Delete Managed Cluster
api_instance.delete_managed_cluster(id, )
ManagedClustersApi(api_client).delete_managed_cluster(id, )
# Below is a request that includes all optional parameters
# api_instance.delete_managed_cluster(id, remove_clients)
except Exception as e:
# ManagedClustersApi(api_client).delete_managed_cluster(id, remove_clients)
except Exception as e:
print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e)
```
@@ -182,22 +189,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.client_log_configuration import ClientLogConfiguration
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to get log configuration for. # str | ID of managed cluster to get log configuration for.
try:
# Get Managed Cluster Log Configuration
api_response = api_instance.get_client_log_configuration(id)
results =ManagedClustersApi(api_client).get_client_log_configuration(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_client_log_configuration(id)
# results = ManagedClustersApi(api_client).get_client_log_configuration(id)
print("The response of ManagedClustersApi->get_client_log_configuration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e)
```
@@ -239,22 +249,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.managed_cluster import ManagedCluster
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID.
try:
# Get Managed Cluster
api_response = api_instance.get_managed_cluster(id)
results =ManagedClustersApi(api_client).get_managed_cluster(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_managed_cluster(id)
# results = ManagedClustersApi(api_client).get_managed_cluster(id)
print("The response of ManagedClustersApi->get_managed_cluster:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e)
```
@@ -298,10 +311,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.managed_cluster import ManagedCluster
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
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)
count = False # bool | 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=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. (optional) (default to False) # bool | 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=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. (optional) (default to False)
@@ -310,13 +327,12 @@ from pprint import pprint
try:
# Get Managed Clusters
api_response = api_instance.get_managed_clusters()
results =ManagedClustersApi(api_client).get_managed_clusters()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_managed_clusters(offset, limit, count, filters)
# results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters)
print("The response of ManagedClustersApi->get_managed_clusters:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e)
```
@@ -359,24 +375,28 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.client_log_configuration import ClientLogConfiguration
from sailpoint.v2024.models.put_client_log_configuration_request import PutClientLogConfigurationRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of the managed cluster to update the log configuration for. # str | ID of the managed cluster to update the log configuration for.
put_client_log_configuration_request = sailpoint.v2024.PutClientLogConfigurationRequest() # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster.
try:
# Update Managed Cluster Log Configuration
Result = put_client_log_configuration_request.from_json(put_client_log_configuration_request)
api_response = api_instance.put_client_log_configuration(id, Result)
new_put_client_log_configuration_request = PutClientLogConfigurationRequest()
new_put_client_log_configuration_request.from_json(put_client_log_configuration_request)
results =ManagedClustersApi(api_client).put_client_log_configuration(id, new_put_client_log_configuration_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_client_log_configuration(id, Result)
# results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_put_client_log_configuration_request)
print("The response of ManagedClustersApi->put_client_log_configuration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e)
```
@@ -419,11 +439,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.models.managed_cluster import ManagedCluster
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID.
[sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | JSONPatch payload used to update the object.
json_patch_operation = {
@@ -435,14 +459,14 @@ from pprint import pprint
try:
# Update Managed Cluster
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.update_managed_cluster(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =ManagedClustersApi(api_client).update_managed_cluster(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_managed_cluster(id, Result)
# results = ManagedClustersApi(api_client).update_managed_cluster(id, new_json_patch_operation)
print("The response of ManagedClustersApi->update_managed_cluster:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e)
```

497
docs/tools/sdk/python/Reference/V2024/Methods/NonEmployeeLifecycleManagementApi.md
View File

File diff suppressed because it is too large Load Diff

237
docs/tools/sdk/python/Reference/V2024/Methods/NotificationsApi.md
View File

@@ -70,11 +70,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.notifications_api import NotificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.domain_address import DomainAddress
from sailpoint.v2024.models.domain_status_dto import DomainStatusDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
domain_address = {
"domain" : "sailpoint.com"
@@ -82,14 +86,14 @@ from pprint import pprint
try:
# Verify domain address via DKIM
Result = domain_address.from_json(domain_address)
api_response = api_instance.create_domain_dkim(x_sail_point_experimental, Result)
new_domain_address = DomainAddress()
new_domain_address.from_json(domain_address)
results =NotificationsApi(api_client).create_domain_dkim(x_sail_point_experimental, new_domain_address)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_domain_dkim(x_sail_point_experimental, Result)
# results = NotificationsApi(api_client).create_domain_dkim(x_sail_point_experimental, new_domain_address)
print("The response of NotificationsApi->create_domain_dkim:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->create_domain_dkim: %s\n" % e)
```
@@ -136,10 +140,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.notifications_api import NotificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.template_dto import TemplateDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
template_dto = {
"slackTemplate" : "slackTemplate",
@@ -162,14 +170,14 @@ from pprint import pprint
try:
# Create Notification Template
Result = template_dto.from_json(template_dto)
api_response = api_instance.create_notification_template(x_sail_point_experimental, Result)
new_template_dto = TemplateDto()
new_template_dto.from_json(template_dto)
results =NotificationsApi(api_client).create_notification_template(x_sail_point_experimental, new_template_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_notification_template(x_sail_point_experimental, Result)
# results = NotificationsApi(api_client).create_notification_template(x_sail_point_experimental, new_template_dto)
print("The response of NotificationsApi->create_notification_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->create_notification_template: %s\n" % e)
```
@@ -214,10 +222,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.notifications_api import NotificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.email_status_dto import EmailStatusDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
email_status_dto = {
"isVerifiedByDomain" : false,
@@ -228,14 +240,14 @@ from pprint import pprint
try:
# Create Verified From Address
Result = email_status_dto.from_json(email_status_dto)
api_response = api_instance.create_verified_from_address(x_sail_point_experimental, Result)
new_email_status_dto = EmailStatusDto()
new_email_status_dto.from_json(email_status_dto)
results =NotificationsApi(api_client).create_verified_from_address(x_sail_point_experimental, new_email_status_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_verified_from_address(x_sail_point_experimental, Result)
# results = NotificationsApi(api_client).create_verified_from_address(x_sail_point_experimental, new_email_status_dto)
print("The response of NotificationsApi->create_verified_from_address:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->create_verified_from_address: %s\n" % e)
```
@@ -280,10 +292,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.notifications_api import NotificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.template_bulk_delete_dto import TemplateBulkDeleteDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
[sailpoint.v2024.TemplateBulkDeleteDto()] # List[TemplateBulkDeleteDto] |
template_bulk_delete_dto = {
@@ -295,12 +311,12 @@ from pprint import pprint
try:
# Bulk Delete Notification Templates
Result = template_bulk_delete_dto.from_json(template_bulk_delete_dto)
api_instance.delete_notification_templates_in_bulk(x_sail_point_experimental, Result)
new_template_bulk_delete_dto = TemplateBulkDeleteDto()
new_template_bulk_delete_dto.from_json(template_bulk_delete_dto)
NotificationsApi(api_client).delete_notification_templates_in_bulk(x_sail_point_experimental, new_template_bulk_delete_dto)
# Below is a request that includes all optional parameters
# api_instance.delete_notification_templates_in_bulk(x_sail_point_experimental, Result)
except Exception as e:
# NotificationsApi(api_client).delete_notification_templates_in_bulk(x_sail_point_experimental, new_template_bulk_delete_dto)
except Exception as e:
print("Exception when calling NotificationsApi->delete_notification_templates_in_bulk: %s\n" % e)
```
@@ -346,20 +362,23 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.notifications_api import NotificationsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'id_example' # str | # str |
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')
try:
# Delete Verified From Address
api_instance.delete_verified_from_address(id, x_sail_point_experimental)
NotificationsApi(api_client).delete_verified_from_address(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_instance.delete_verified_from_address(id, x_sail_point_experimental)
except Exception as e:
# NotificationsApi(api_client).delete_verified_from_address(id, x_sail_point_experimental)
except Exception as e:
print("Exception when calling NotificationsApi->delete_verified_from_address: %s\n" % e)
```
@@ -403,22 +422,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.notifications_api import NotificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.dkim_attributes import DkimAttributes
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
try:
# Get DKIM Attributes
api_response = api_instance.get_dkim_attributes(x_sail_point_experimental)
results =NotificationsApi(api_client).get_dkim_attributes(x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_dkim_attributes(x_sail_point_experimental)
# results = NotificationsApi(api_client).get_dkim_attributes(x_sail_point_experimental)
print("The response of NotificationsApi->get_dkim_attributes:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e)
```
@@ -463,23 +485,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.notifications_api import NotificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.mail_from_attributes import MailFromAttributes
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'bobsmith@sailpoint.com' # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status
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')
try:
# Get MAIL FROM Attributes
api_response = api_instance.get_mail_from_attributes(id, x_sail_point_experimental)
results =NotificationsApi(api_client).get_mail_from_attributes(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_mail_from_attributes(id, x_sail_point_experimental)
# results = NotificationsApi(api_client).get_mail_from_attributes(id, x_sail_point_experimental)
print("The response of NotificationsApi->get_mail_from_attributes:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->get_mail_from_attributes: %s\n" % e)
```
@@ -524,23 +549,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.notifications_api import NotificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.template_dto import TemplateDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Notification Template # str | Id of the Notification Template
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')
try:
# Get Notification Template By Id
api_response = api_instance.get_notification_template(id, x_sail_point_experimental)
results =NotificationsApi(api_client).get_notification_template(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_notification_template(id, x_sail_point_experimental)
# results = NotificationsApi(api_client).get_notification_template(id, x_sail_point_experimental)
print("The response of NotificationsApi->get_notification_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e)
```
@@ -585,22 +613,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.notifications_api import NotificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.notification_template_context import NotificationTemplateContext
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
try:
# Get Notification Template Context
api_response = api_instance.get_notifications_template_context(x_sail_point_experimental)
results =NotificationsApi(api_client).get_notifications_template_context(x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_notifications_template_context(x_sail_point_experimental)
# results = NotificationsApi(api_client).get_notifications_template_context(x_sail_point_experimental)
print("The response of NotificationsApi->get_notifications_template_context:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->get_notifications_template_context: %s\n" % e)
```
@@ -648,10 +679,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.notifications_api import NotificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.email_status_dto import EmailStatusDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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)
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)
@@ -662,13 +697,12 @@ from pprint import pprint
try:
# List From Addresses
api_response = api_instance.list_from_addresses(x_sail_point_experimental, )
results =NotificationsApi(api_client).list_from_addresses(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_from_addresses(x_sail_point_experimental, limit, offset, count, filters, sorters)
# results = NotificationsApi(api_client).list_from_addresses(x_sail_point_experimental, limit, offset, count, filters, sorters)
print("The response of NotificationsApi->list_from_addresses:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e)
```
@@ -713,22 +747,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.notifications_api import NotificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.preferences_dto import PreferencesDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
try:
# List Notification Preferences for tenant.
api_response = api_instance.list_notification_preferences(x_sail_point_experimental)
results =NotificationsApi(api_client).list_notification_preferences(x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.list_notification_preferences(x_sail_point_experimental)
# results = NotificationsApi(api_client).list_notification_preferences(x_sail_point_experimental)
print("The response of NotificationsApi->list_notification_preferences:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e)
```
@@ -775,10 +812,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.notifications_api import NotificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.template_dto_default import TemplateDtoDefault
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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)
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)
@@ -787,13 +828,12 @@ from pprint import pprint
try:
# List Notification Template Defaults
api_response = api_instance.list_notification_template_defaults(x_sail_point_experimental, )
results =NotificationsApi(api_client).list_notification_template_defaults(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_notification_template_defaults(x_sail_point_experimental, limit, offset, filters)
# results = NotificationsApi(api_client).list_notification_template_defaults(x_sail_point_experimental, limit, offset, filters)
print("The response of NotificationsApi->list_notification_template_defaults:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e)
```
@@ -840,10 +880,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.notifications_api import NotificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.template_dto import TemplateDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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)
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)
@@ -852,13 +896,12 @@ from pprint import pprint
try:
# List Notification Templates
api_response = api_instance.list_notification_templates(x_sail_point_experimental, )
results =NotificationsApi(api_client).list_notification_templates(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_notification_templates(x_sail_point_experimental, limit, offset, filters)
# results = NotificationsApi(api_client).list_notification_templates(x_sail_point_experimental, limit, offset, filters)
print("The response of NotificationsApi->list_notification_templates:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e)
```
@@ -903,11 +946,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.notifications_api import NotificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.mail_from_attributes import MailFromAttributes
from sailpoint.v2024.models.mail_from_attributes_dto import MailFromAttributesDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
mail_from_attributes_dto = {
"identity" : "BobSmith@sailpoint.com",
@@ -916,14 +963,14 @@ from pprint import pprint
try:
# Change MAIL FROM domain
Result = mail_from_attributes_dto.from_json(mail_from_attributes_dto)
api_response = api_instance.put_mail_from_attributes(x_sail_point_experimental, Result)
new_mail_from_attributes_dto = MailFromAttributesDto()
new_mail_from_attributes_dto.from_json(mail_from_attributes_dto)
results =NotificationsApi(api_client).put_mail_from_attributes(x_sail_point_experimental, new_mail_from_attributes_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_mail_from_attributes(x_sail_point_experimental, Result)
# results = NotificationsApi(api_client).put_mail_from_attributes(x_sail_point_experimental, new_mail_from_attributes_dto)
print("The response of NotificationsApi->put_mail_from_attributes:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling NotificationsApi->put_mail_from_attributes: %s\n" % e)
```
@@ -969,10 +1016,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.notifications_api import NotificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.send_test_notification_request_dto import SendTestNotificationRequestDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
send_test_notification_request_dto = {
"context" : "{}",
@@ -982,12 +1033,12 @@ from pprint import pprint
try:
# Send Test Notification
Result = send_test_notification_request_dto.from_json(send_test_notification_request_dto)
api_instance.send_test_notification(x_sail_point_experimental, Result)
new_send_test_notification_request_dto = SendTestNotificationRequestDto()
new_send_test_notification_request_dto.from_json(send_test_notification_request_dto)
NotificationsApi(api_client).send_test_notification(x_sail_point_experimental, new_send_test_notification_request_dto)
# Below is a request that includes all optional parameters
# api_instance.send_test_notification(x_sail_point_experimental, Result)
except Exception as e:
# NotificationsApi(api_client).send_test_notification(x_sail_point_experimental, new_send_test_notification_request_dto)
except Exception as e:
print("Exception when calling NotificationsApi->send_test_notification: %s\n" % e)
```

79
docs/tools/sdk/python/Reference/V2024/Methods/OAuthClientsApi.md
View File

@@ -58,11 +58,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.o_auth_clients_api import OAuthClientsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.create_o_auth_client_request import CreateOAuthClientRequest
from sailpoint.v2024.models.create_o_auth_client_response import CreateOAuthClientResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
create_o_auth_client_request = {
"internal" : false,
"businessName" : "Acme-Solar",
@@ -83,14 +87,14 @@ from pprint import pprint
try:
# Create OAuth Client
Result = create_o_auth_client_request.from_json(create_o_auth_client_request)
api_response = api_instance.create_oauth_client(Result)
new_create_o_auth_client_request = CreateOAuthClientRequest()
new_create_o_auth_client_request.from_json(create_o_auth_client_request)
results =OAuthClientsApi(api_client).create_oauth_client(new_create_o_auth_client_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_oauth_client(Result)
# results = OAuthClientsApi(api_client).create_oauth_client(new_create_o_auth_client_request)
print("The response of OAuthClientsApi->create_oauth_client:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling OAuthClientsApi->create_oauth_client: %s\n" % e)
```
@@ -132,19 +136,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.o_auth_clients_api import OAuthClientsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id
try:
# Delete OAuth Client
api_instance.delete_oauth_client(id)
OAuthClientsApi(api_client).delete_oauth_client(id)
# Below is a request that includes all optional parameters
# api_instance.delete_oauth_client(id)
except Exception as e:
# OAuthClientsApi(api_client).delete_oauth_client(id)
except Exception as e:
print("Exception when calling OAuthClientsApi->delete_oauth_client: %s\n" % e)
```
@@ -186,22 +193,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.o_auth_clients_api import OAuthClientsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.get_o_auth_client_response import GetOAuthClientResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id
try:
# Get OAuth Client
api_response = api_instance.get_oauth_client(id)
results =OAuthClientsApi(api_client).get_oauth_client(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_oauth_client(id)
# results = OAuthClientsApi(api_client).get_oauth_client(id)
print("The response of OAuthClientsApi->get_oauth_client:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling OAuthClientsApi->get_oauth_client: %s\n" % e)
```
@@ -242,22 +252,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.o_auth_clients_api import OAuthClientsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.get_o_auth_client_response import GetOAuthClientResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional)
try:
# List OAuth Clients
api_response = api_instance.list_oauth_clients()
results =OAuthClientsApi(api_client).list_oauth_clients()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_oauth_clients(filters)
# results = OAuthClientsApi(api_client).list_oauth_clients(filters)
print("The response of OAuthClientsApi->list_oauth_clients:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e)
```
@@ -300,11 +313,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.o_auth_clients_api import OAuthClientsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.get_o_auth_client_response import GetOAuthClientResponse
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id
[{op=replace, path=/strongAuthSupported, value=true}, {op=replace, path=/businessName, value=acme-solar}] # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported
json_patch_operation = {
@@ -316,14 +333,14 @@ from pprint import pprint
try:
# Patch OAuth Client
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_oauth_client(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =OAuthClientsApi(api_client).patch_oauth_client(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_oauth_client(id, Result)
# results = OAuthClientsApi(api_client).patch_oauth_client(id, new_json_patch_operation)
print("The response of OAuthClientsApi->patch_oauth_client:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e)
```

48
docs/tools/sdk/python/Reference/V2024/Methods/OrgConfigApi.md
View File

@@ -59,22 +59,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.org_config_api import OrgConfigApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.org_config import OrgConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
try:
# Get Org Config Settings
api_response = api_instance.get_org_config(x_sail_point_experimental)
results =OrgConfigApi(api_client).get_org_config(x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_org_config(x_sail_point_experimental)
# results = OrgConfigApi(api_client).get_org_config(x_sail_point_experimental)
print("The response of OrgConfigApi->get_org_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling OrgConfigApi->get_org_config: %s\n" % e)
```
@@ -121,9 +124,13 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.org_config_api import OrgConfigApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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 = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50)
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)
@@ -132,13 +139,12 @@ from pprint import pprint
try:
# Get Valid Time Zones
api_response = api_instance.get_valid_time_zones(x_sail_point_experimental, )
results =OrgConfigApi(api_client).get_valid_time_zones(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_valid_time_zones(x_sail_point_experimental, limit, offset, count)
# results = OrgConfigApi(api_client).get_valid_time_zones(x_sail_point_experimental, limit, offset, count)
print("The response of OrgConfigApi->get_valid_time_zones:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e)
```
@@ -184,11 +190,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.org_config_api import OrgConfigApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.models.org_config import OrgConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
[{op=replace, path=/timeZone, value=America/Toronto}] # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
json_patch_operation = {
@@ -200,14 +210,14 @@ from pprint import pprint
try:
# Patch Org Config
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_org_config(x_sail_point_experimental, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =OrgConfigApi(api_client).patch_org_config(x_sail_point_experimental, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_org_config(x_sail_point_experimental, Result)
# results = OrgConfigApi(api_client).patch_org_config(x_sail_point_experimental, new_json_patch_operation)
print("The response of OrgConfigApi->patch_org_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling OrgConfigApi->patch_org_config: %s\n" % e)
```

51
docs/tools/sdk/python/Reference/V2024/Methods/PasswordConfigurationApi.md
View File

@@ -61,10 +61,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.password_configuration_api import PasswordConfigurationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.password_org_config import PasswordOrgConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
password_org_config = {
"digitTokenLength" : 9,
"digitTokenEnabled" : true,
@@ -74,14 +78,14 @@ from pprint import pprint
try:
# Create Password Org Config
Result = password_org_config.from_json(password_org_config)
api_response = api_instance.create_password_org_config(Result)
new_password_org_config = PasswordOrgConfig()
new_password_org_config.from_json(password_org_config)
results =PasswordConfigurationApi(api_client).create_password_org_config(new_password_org_config)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_password_org_config(Result)
# results = PasswordConfigurationApi(api_client).create_password_org_config(new_password_org_config)
print("The response of PasswordConfigurationApi->create_password_org_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordConfigurationApi->create_password_org_config: %s\n" % e)
```
@@ -119,21 +123,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.password_configuration_api import PasswordConfigurationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.password_org_config import PasswordOrgConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Password Org Config
api_response = api_instance.get_password_org_config()
results =PasswordConfigurationApi(api_client).get_password_org_config()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_password_org_config()
# results = PasswordConfigurationApi(api_client).get_password_org_config()
print("The response of PasswordConfigurationApi->get_password_org_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordConfigurationApi->get_password_org_config: %s\n" % e)
```
@@ -176,10 +183,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.password_configuration_api import PasswordConfigurationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.password_org_config import PasswordOrgConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
password_org_config = {
"digitTokenLength" : 9,
"digitTokenEnabled" : true,
@@ -189,14 +200,14 @@ from pprint import pprint
try:
# Update Password Org Config
Result = password_org_config.from_json(password_org_config)
api_response = api_instance.put_password_org_config(Result)
new_password_org_config = PasswordOrgConfig()
new_password_org_config.from_json(password_org_config)
results =PasswordConfigurationApi(api_client).put_password_org_config(new_password_org_config)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_password_org_config(Result)
# results = PasswordConfigurationApi(api_client).put_password_org_config(new_password_org_config)
print("The response of PasswordConfigurationApi->put_password_org_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordConfigurationApi->put_password_org_config: %s\n" % e)
```

28
docs/tools/sdk/python/Reference/V2024/Methods/PasswordDictionaryApi.md
View File

@@ -125,20 +125,23 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.password_dictionary_api import PasswordDictionaryApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Password Dictionary
api_response = api_instance.get_password_dictionary()
results =PasswordDictionaryApi(api_client).get_password_dictionary()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_password_dictionary()
# results = PasswordDictionaryApi(api_client).get_password_dictionary()
print("The response of PasswordDictionaryApi->get_password_dictionary:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordDictionaryApi->get_password_dictionary: %s\n" % e)
```
@@ -209,19 +212,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.password_dictionary_api import PasswordDictionaryApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
file = None # bytearray | (optional) # bytearray | (optional)
try:
# Update Password Dictionary
api_instance.put_password_dictionary()
PasswordDictionaryApi(api_client).put_password_dictionary()
# Below is a request that includes all optional parameters
# api_instance.put_password_dictionary(file)
except Exception as e:
# PasswordDictionaryApi(api_client).put_password_dictionary(file)
except Exception as e:
print("Exception when calling PasswordDictionaryApi->put_password_dictionary: %s\n" % e)
```

69
docs/tools/sdk/python/Reference/V2024/Methods/PasswordManagementApi.md
View File

@@ -82,11 +82,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.password_management_api import PasswordManagementApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.password_digit_token import PasswordDigitToken
from sailpoint.v2024.models.password_digit_token_reset import PasswordDigitTokenReset
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
password_digit_token_reset = {
"durationMinutes" : 5,
@@ -96,14 +100,14 @@ from pprint import pprint
try:
# Generate a digit token
Result = password_digit_token_reset.from_json(password_digit_token_reset)
api_response = api_instance.create_digit_token(x_sail_point_experimental, Result)
new_password_digit_token_reset = PasswordDigitTokenReset()
new_password_digit_token_reset.from_json(password_digit_token_reset)
results =PasswordManagementApi(api_client).create_digit_token(x_sail_point_experimental, new_password_digit_token_reset)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_digit_token(x_sail_point_experimental, Result)
# results = PasswordManagementApi(api_client).create_digit_token(x_sail_point_experimental, new_password_digit_token_reset)
print("The response of PasswordManagementApi->create_digit_token:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordManagementApi->create_digit_token: %s\n" % e)
```
@@ -145,22 +149,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.password_management_api import PasswordManagementApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.password_status import PasswordStatus
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '089899f13a8f4da7824996191587bab9' # str | Password change request ID # str | Password change request ID
try:
# Get Password Change Request Status
api_response = api_instance.get_password_change_status(id)
results =PasswordManagementApi(api_client).get_password_change_status(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_password_change_status(id)
# results = PasswordManagementApi(api_client).get_password_change_status(id)
print("The response of PasswordManagementApi->get_password_change_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordManagementApi->get_password_change_status: %s\n" % e)
```
@@ -202,11 +209,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.password_management_api import PasswordManagementApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.password_info import PasswordInfo
from sailpoint.v2024.models.password_info_query_dto import PasswordInfoQueryDTO
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
password_info_query_dto = {
"sourceName" : "My-AD",
"userName" : "Abby.Smith"
@@ -214,14 +225,14 @@ from pprint import pprint
try:
# Query Password Info
Result = password_info_query_dto.from_json(password_info_query_dto)
api_response = api_instance.query_password_info(Result)
new_password_info_query_dto = PasswordInfoQueryDto()
new_password_info_query_dto.from_json(password_info_query_dto)
results =PasswordManagementApi(api_client).query_password_info(new_password_info_query_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.query_password_info(Result)
# results = PasswordManagementApi(api_client).query_password_info(new_password_info_query_dto)
print("The response of PasswordManagementApi->query_password_info:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordManagementApi->query_password_info: %s\n" % e)
```
@@ -281,11 +292,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.password_management_api import PasswordManagementApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.password_change_request import PasswordChangeRequest
from sailpoint.v2024.models.password_change_response import PasswordChangeResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
password_change_request = {
"sourceId" : "8a807d4c73c545510173c545d4b60246",
"accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com",
@@ -296,14 +311,14 @@ from pprint import pprint
try:
# Set Identity's Password
Result = password_change_request.from_json(password_change_request)
api_response = api_instance.set_password(Result)
new_password_change_request = PasswordChangeRequest()
new_password_change_request.from_json(password_change_request)
results =PasswordManagementApi(api_client).set_password(new_password_change_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.set_password(Result)
# results = PasswordManagementApi(api_client).set_password(new_password_change_request)
print("The response of PasswordManagementApi->set_password:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordManagementApi->set_password: %s\n" % e)
```

79
docs/tools/sdk/python/Reference/V2024/Methods/PasswordPoliciesApi.md
View File

@@ -64,10 +64,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.password_policies_api import PasswordPoliciesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.password_policy_v3_dto import PasswordPolicyV3Dto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
password_policy_v3_dto = {
"validateAgainstAccountName" : true,
"minLength" : 8,
@@ -104,14 +108,14 @@ from pprint import pprint
try:
# Create Password Policy
Result = password_policy_v3_dto.from_json(password_policy_v3_dto)
api_response = api_instance.create_password_policy(Result)
new_password_policy_v3_dto = PasswordPolicyV3Dto()
new_password_policy_v3_dto.from_json(password_policy_v3_dto)
results =PasswordPoliciesApi(api_client).create_password_policy(new_password_policy_v3_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_password_policy(Result)
# results = PasswordPoliciesApi(api_client).create_password_policy(new_password_policy_v3_dto)
print("The response of PasswordPoliciesApi->create_password_policy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordPoliciesApi->create_password_policy: %s\n" % e)
```
@@ -153,19 +157,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.password_policies_api import PasswordPoliciesApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ff808081838d9e9d01838da6a03e0002' # str | The ID of password policy to delete. # str | The ID of password policy to delete.
try:
# Delete Password Policy by ID
api_instance.delete_password_policy(id)
PasswordPoliciesApi(api_client).delete_password_policy(id)
# Below is a request that includes all optional parameters
# api_instance.delete_password_policy(id)
except Exception as e:
# PasswordPoliciesApi(api_client).delete_password_policy(id)
except Exception as e:
print("Exception when calling PasswordPoliciesApi->delete_password_policy: %s\n" % e)
```
@@ -207,22 +214,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.password_policies_api import PasswordPoliciesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.password_policy_v3_dto import PasswordPolicyV3Dto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ff808081838d9e9d01838da6a03e0005' # str | The ID of password policy to retrieve. # str | The ID of password policy to retrieve.
try:
# Get Password Policy by ID
api_response = api_instance.get_password_policy_by_id(id)
results =PasswordPoliciesApi(api_client).get_password_policy_by_id(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_password_policy_by_id(id)
# results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id)
print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordPoliciesApi->get_password_policy_by_id: %s\n" % e)
```
@@ -266,10 +276,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.password_policies_api import PasswordPoliciesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.password_policy_v3_dto import PasswordPolicyV3Dto
from sailpoint.v2024.rest import ApiException
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)
count = False # bool | 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=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. (optional) (default to False) # bool | 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=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. (optional) (default to False)
@@ -277,13 +291,12 @@ from pprint import pprint
try:
# List Password Policies
api_response = api_instance.list_password_policies()
results =PasswordPoliciesApi(api_client).list_password_policies()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_password_policies(limit, offset, count)
# results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count)
print("The response of PasswordPoliciesApi->list_password_policies:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e)
```
@@ -326,10 +339,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.password_policies_api import PasswordPoliciesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.password_policy_v3_dto import PasswordPolicyV3Dto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ff808081838d9e9d01838da6a03e0007' # str | The ID of password policy to update. # str | The ID of password policy to update.
password_policy_v3_dto = {
"validateAgainstAccountName" : true,
@@ -367,14 +384,14 @@ from pprint import pprint
try:
# Update Password Policy by ID
Result = password_policy_v3_dto.from_json(password_policy_v3_dto)
api_response = api_instance.set_password_policy(id, Result)
new_password_policy_v3_dto = PasswordPolicyV3Dto()
new_password_policy_v3_dto.from_json(password_policy_v3_dto)
results =PasswordPoliciesApi(api_client).set_password_policy(id, new_password_policy_v3_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.set_password_policy(id, Result)
# results = PasswordPoliciesApi(api_client).set_password_policy(id, new_password_policy_v3_dto)
print("The response of PasswordPoliciesApi->set_password_policy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordPoliciesApi->set_password_policy: %s\n" % e)
```

79
docs/tools/sdk/python/Reference/V2024/Methods/PasswordSyncGroupsApi.md
View File

@@ -87,10 +87,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.password_sync_groups_api import PasswordSyncGroupsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.password_sync_group import PasswordSyncGroup
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
password_sync_group = {
"created" : "2023-03-16T04:00:00Z",
"name" : "Password Sync Group 1",
@@ -102,14 +106,14 @@ from pprint import pprint
try:
# Create Password Sync Group
Result = password_sync_group.from_json(password_sync_group)
api_response = api_instance.create_password_sync_group(Result)
new_password_sync_group = PasswordSyncGroup()
new_password_sync_group.from_json(password_sync_group)
results =PasswordSyncGroupsApi(api_client).create_password_sync_group(new_password_sync_group)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_password_sync_group(Result)
# results = PasswordSyncGroupsApi(api_client).create_password_sync_group(new_password_sync_group)
print("The response of PasswordSyncGroupsApi->create_password_sync_group:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordSyncGroupsApi->create_password_sync_group: %s\n" % e)
```
@@ -150,19 +154,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.password_sync_groups_api import PasswordSyncGroupsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '6881f631-3bd5-4213-9c75-8e05cc3e35dd' # str | The ID of password sync group to delete. # str | The ID of password sync group to delete.
try:
# Delete Password Sync Group by ID
api_instance.delete_password_sync_group(id)
PasswordSyncGroupsApi(api_client).delete_password_sync_group(id)
# Below is a request that includes all optional parameters
# api_instance.delete_password_sync_group(id)
except Exception as e:
# PasswordSyncGroupsApi(api_client).delete_password_sync_group(id)
except Exception as e:
print("Exception when calling PasswordSyncGroupsApi->delete_password_sync_group: %s\n" % e)
```
@@ -204,22 +211,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.password_sync_groups_api import PasswordSyncGroupsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.password_sync_group import PasswordSyncGroup
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '6881f631-3bd5-4213-9c75-8e05cc3e35dd' # str | The ID of password sync group to retrieve. # str | The ID of password sync group to retrieve.
try:
# Get Password Sync Group by ID
api_response = api_instance.get_password_sync_group(id)
results =PasswordSyncGroupsApi(api_client).get_password_sync_group(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_password_sync_group(id)
# results = PasswordSyncGroupsApi(api_client).get_password_sync_group(id)
print("The response of PasswordSyncGroupsApi->get_password_sync_group:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordSyncGroupsApi->get_password_sync_group: %s\n" % e)
```
@@ -262,10 +272,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.password_sync_groups_api import PasswordSyncGroupsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.password_sync_group import PasswordSyncGroup
from sailpoint.v2024.rest import ApiException
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)
count = False # bool | 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=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. (optional) (default to False) # bool | 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=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. (optional) (default to False)
@@ -273,13 +287,12 @@ from pprint import pprint
try:
# Get Password Sync Group List
api_response = api_instance.get_password_sync_groups()
results =PasswordSyncGroupsApi(api_client).get_password_sync_groups()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_password_sync_groups(limit, offset, count)
# results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count)
print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e)
```
@@ -322,10 +335,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.password_sync_groups_api import PasswordSyncGroupsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.password_sync_group import PasswordSyncGroup
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '6881f631-3bd5-4213-9c75-8e05cc3e35dd' # str | The ID of password sync group to update. # str | The ID of password sync group to update.
password_sync_group = {
"created" : "2023-03-16T04:00:00Z",
@@ -338,14 +355,14 @@ from pprint import pprint
try:
# Update Password Sync Group by ID
Result = password_sync_group.from_json(password_sync_group)
api_response = api_instance.update_password_sync_group(id, Result)
new_password_sync_group = PasswordSyncGroup()
new_password_sync_group.from_json(password_sync_group)
results =PasswordSyncGroupsApi(api_client).update_password_sync_group(id, new_password_sync_group)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_password_sync_group(id, Result)
# results = PasswordSyncGroupsApi(api_client).update_password_sync_group(id, new_password_sync_group)
print("The response of PasswordSyncGroupsApi->update_password_sync_group:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordSyncGroupsApi->update_password_sync_group: %s\n" % e)
```

64
docs/tools/sdk/python/Reference/V2024/Methods/PersonalAccessTokensApi.md
View File

@@ -65,11 +65,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.personal_access_tokens_api import PersonalAccessTokensApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.create_personal_access_token_request import CreatePersonalAccessTokenRequest
from sailpoint.v2024.models.create_personal_access_token_response import CreatePersonalAccessTokenResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
create_personal_access_token_request = {
"scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ],
"accessTokenValiditySeconds" : 36900,
@@ -78,14 +82,14 @@ from pprint import pprint
try:
# Create Personal Access Token
Result = create_personal_access_token_request.from_json(create_personal_access_token_request)
api_response = api_instance.create_personal_access_token(Result)
new_create_personal_access_token_request = CreatePersonalAccessTokenRequest()
new_create_personal_access_token_request.from_json(create_personal_access_token_request)
results =PersonalAccessTokensApi(api_client).create_personal_access_token(new_create_personal_access_token_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_personal_access_token(Result)
# results = PersonalAccessTokensApi(api_client).create_personal_access_token(new_create_personal_access_token_request)
print("The response of PersonalAccessTokensApi->create_personal_access_token:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PersonalAccessTokensApi->create_personal_access_token: %s\n" % e)
```
@@ -127,19 +131,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.personal_access_tokens_api import PersonalAccessTokensApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The personal access token id # str | The personal access token id
try:
# Delete Personal Access Token
api_instance.delete_personal_access_token(id)
PersonalAccessTokensApi(api_client).delete_personal_access_token(id)
# Below is a request that includes all optional parameters
# api_instance.delete_personal_access_token(id)
except Exception as e:
# PersonalAccessTokensApi(api_client).delete_personal_access_token(id)
except Exception as e:
print("Exception when calling PersonalAccessTokensApi->delete_personal_access_token: %s\n" % e)
```
@@ -181,23 +188,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.personal_access_tokens_api import PersonalAccessTokensApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.get_personal_access_token_response import GetPersonalAccessTokenResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = '2c9180867b50d088017b554662fb281e' # str | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) # str | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional)
filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional)
try:
# List Personal Access Tokens
api_response = api_instance.list_personal_access_tokens()
results =PersonalAccessTokensApi(api_client).list_personal_access_tokens()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_personal_access_tokens(owner_id, filters)
# results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters)
print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e)
```
@@ -241,11 +251,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.personal_access_tokens_api import PersonalAccessTokensApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.get_personal_access_token_response import GetPersonalAccessTokenResponse
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Personal Access Token id # str | The Personal Access Token id
[{op=replace, path=/name, value=New name}, {op=replace, path=/scope, value=[sp:scopes:all]}] # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope
json_patch_operation = {
@@ -257,14 +271,14 @@ from pprint import pprint
try:
# Patch Personal Access Token
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_personal_access_token(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =PersonalAccessTokensApi(api_client).patch_personal_access_token(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_personal_access_token(id, Result)
# results = PersonalAccessTokensApi(api_client).patch_personal_access_token(id, new_json_patch_operation)
print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PersonalAccessTokensApi->patch_personal_access_token: %s\n" % e)
```

15
docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesApi.md
View File

@@ -59,10 +59,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.public_identities_api import PublicIdentitiesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.public_identity import PublicIdentity
from sailpoint.v2024.rest import ApiException
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)
count = False # bool | 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=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. (optional) (default to False) # bool | 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=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. (optional) (default to False)
@@ -73,13 +77,12 @@ from pprint import pprint
try:
# Get list of public identities
api_response = api_instance.get_public_identities()
results =PublicIdentitiesApi(api_client).get_public_identities()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_public_identities(limit, offset, count, filters, add_core_filters, sorters)
# results = PublicIdentitiesApi(api_client).get_public_identities(limit, offset, count, filters, add_core_filters, sorters)
print("The response of PublicIdentitiesApi->get_public_identities:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e)
```

33
docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesConfigApi.md
View File

@@ -59,21 +59,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.public_identities_config_api import PublicIdentitiesConfigApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.public_identity_config import PublicIdentityConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get the Public Identities Configuration
api_response = api_instance.get_public_identity_config()
results =PublicIdentitiesConfigApi(api_client).get_public_identity_config()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_public_identity_config()
# results = PublicIdentitiesConfigApi(api_client).get_public_identity_config()
print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PublicIdentitiesConfigApi->get_public_identity_config: %s\n" % e)
```
@@ -114,10 +117,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.public_identities_config_api import PublicIdentitiesConfigApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.public_identity_config import PublicIdentityConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
public_identity_config = {
"modified" : "2018-06-25T20:22:28.104Z",
"attributes" : [ {
@@ -136,14 +143,14 @@ from pprint import pprint
try:
# Update the Public Identities Configuration
Result = public_identity_config.from_json(public_identity_config)
api_response = api_instance.update_public_identity_config(Result)
new_public_identity_config = PublicIdentityConfig()
new_public_identity_config.from_json(public_identity_config)
results =PublicIdentitiesConfigApi(api_client).update_public_identity_config(new_public_identity_config)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_public_identity_config(Result)
# results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(new_public_identity_config)
print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PublicIdentitiesConfigApi->update_public_identity_config: %s\n" % e)
```

61
docs/tools/sdk/python/Reference/V2024/Methods/ReportsDataExtractionApi.md
View File

@@ -57,19 +57,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.reports_data_extraction_api import ReportsDataExtractionApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'a1ed223247144cc29d23c632624b4767' # str | ID of the running Report to cancel # str | ID of the running Report to cancel
try:
# Cancel Report
api_instance.cancel_report(id)
ReportsDataExtractionApi(api_client).cancel_report(id)
# Below is a request that includes all optional parameters
# api_instance.cancel_report(id)
except Exception as e:
# ReportsDataExtractionApi(api_client).cancel_report(id)
except Exception as e:
print("Exception when calling ReportsDataExtractionApi->cancel_report: %s\n" % e)
```
@@ -114,9 +117,13 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.reports_data_extraction_api import ReportsDataExtractionApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
task_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Unique identifier of the task result which handled report # str | Unique identifier of the task result which handled report
file_format = 'csv' # str | Output format of the requested report file # str | Output format of the requested report file
name = 'Identities Details Report' # str | preferred Report file name, by default will be used report name from task result. (optional) # str | preferred Report file name, by default will be used report name from task result. (optional)
@@ -125,13 +132,12 @@ from pprint import pprint
try:
# Get Report File
api_response = api_instance.get_report(task_result_id, file_format, )
results =ReportsDataExtractionApi(api_client).get_report(task_result_id, file_format, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_report(task_result_id, file_format, name, auditable)
# results = ReportsDataExtractionApi(api_client).get_report(task_result_id, file_format, name, auditable)
print("The response of ReportsDataExtractionApi->get_report:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ReportsDataExtractionApi->get_report: %s\n" % e)
```
@@ -173,23 +179,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.reports_data_extraction_api import ReportsDataExtractionApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.report_results import ReportResults
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
task_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Unique identifier of the task result which handled report # str | Unique identifier of the task result which handled report
completed = False # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to False) # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to False)
try:
# Get Report Result
api_response = api_instance.get_report_result(task_result_id, )
results =ReportsDataExtractionApi(api_client).get_report_result(task_result_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_report_result(task_result_id, completed)
# results = ReportsDataExtractionApi(api_client).get_report_result(task_result_id, completed)
print("The response of ReportsDataExtractionApi->get_report_result:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ReportsDataExtractionApi->get_report_result: %s\n" % e)
```
@@ -230,11 +239,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.reports_data_extraction_api import ReportsDataExtractionApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.report_details import ReportDetails
from sailpoint.v2024.models.task_result_details import TaskResultDetails
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
report_details = {
"reportType" : "ACCOUNTS",
"arguments" : {
@@ -245,14 +258,14 @@ from pprint import pprint
try:
# Run Report
Result = report_details.from_json(report_details)
api_response = api_instance.start_report(Result)
new_report_details = ReportDetails()
new_report_details.from_json(report_details)
results =ReportsDataExtractionApi(api_client).start_report(new_report_details)
# Below is a request that includes all optional parameters
# api_response = api_instance.start_report(Result)
# results = ReportsDataExtractionApi(api_client).start_report(new_report_details)
print("The response of ReportsDataExtractionApi->start_report:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ReportsDataExtractionApi->start_report: %s\n" % e)
```

15
docs/tools/sdk/python/Reference/V2024/Methods/RequestableObjectsApi.md
View File

@@ -63,12 +63,16 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.requestable_objects_api import RequestableObjectsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.requestable_object import RequestableObject
from sailpoint.v2024.models.requestable_object_request_status import RequestableObjectRequestStatus
from sailpoint.v2024.models.requestable_object_type import RequestableObjectType
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = 'e7eab60924f64aa284175b9fa3309599' # str | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) # str | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional)
types = [sailpoint.v2024.RequestableObjectType()] # List[RequestableObjectType] | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. (optional)
@@ -86,13 +90,12 @@ from pprint import pprint
try:
# Requestable Objects List
api_response = api_instance.list_requestable_objects()
results =RequestableObjectsApi(api_client).list_requestable_objects()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters)
# results = RequestableObjectsApi(api_client).list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters)
print("The response of RequestableObjectsApi->list_requestable_objects:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e)
```

135
docs/tools/sdk/python/Reference/V2024/Methods/RoleInsightsApi.md
View File

@@ -65,22 +65,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.role_insights_api import RoleInsightsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_insights_response import RoleInsightsResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
try:
# Generate insights for roles
api_response = api_instance.create_role_insight_requests(x_sail_point_experimental)
results =RoleInsightsApi(api_client).create_role_insight_requests(x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_role_insight_requests(x_sail_point_experimental)
# results = RoleInsightsApi(api_client).create_role_insight_requests(x_sail_point_experimental)
print("The response of RoleInsightsApi->create_role_insight_requests:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RoleInsightsApi->create_role_insight_requests: %s\n" % e)
```
@@ -126,9 +129,13 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.role_insights_api import RoleInsightsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight 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')
sorters = 'identitiesWithAccess' # str | 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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) # str | 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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional)
@@ -137,13 +144,12 @@ from pprint import pprint
try:
# Download entitlement insights for a role
api_response = api_instance.download_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, )
results =RoleInsightsApi(api_client).download_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.download_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters)
# results = RoleInsightsApi(api_client).download_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters)
print("The response of RoleInsightsApi->download_role_insights_entitlements_changes:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RoleInsightsApi->download_role_insights_entitlements_changes: %s\n" % e)
```
@@ -194,10 +200,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.role_insights_api import RoleInsightsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_insights_identities import RoleInsightsIdentities
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id
entitlement_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The entitlement id # str | The entitlement 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')
@@ -211,13 +221,12 @@ from pprint import pprint
try:
# Get identities for a suggested entitlement (for a role)
api_response = api_instance.get_entitlement_changes_identities(insight_id, entitlement_id, x_sail_point_experimental, )
results =RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id, entitlement_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_entitlement_changes_identities(insight_id, entitlement_id, x_sail_point_experimental, has_entitlement, offset, limit, count, sorters, filters)
# results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id, entitlement_id, x_sail_point_experimental, has_entitlement, offset, limit, count, sorters, filters)
print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e)
```
@@ -261,23 +270,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.role_insights_api import RoleInsightsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_insight import RoleInsight
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight 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')
try:
# Get a single role insight
api_response = api_instance.get_role_insight(insight_id, x_sail_point_experimental)
results =RoleInsightsApi(api_client).get_role_insight(insight_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_role_insight(insight_id, x_sail_point_experimental)
# results = RoleInsightsApi(api_client).get_role_insight(insight_id, x_sail_point_experimental)
print("The response of RoleInsightsApi->get_role_insight:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RoleInsightsApi->get_role_insight: %s\n" % e)
```
@@ -325,10 +337,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.role_insights_api import RoleInsightsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_insight import RoleInsight
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
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)
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)
@@ -339,13 +355,12 @@ from pprint import pprint
try:
# Get role insights
api_response = api_instance.get_role_insights(x_sail_point_experimental, )
results =RoleInsightsApi(api_client).get_role_insights(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_role_insights(x_sail_point_experimental, offset, limit, count, sorters, filters)
# results = RoleInsightsApi(api_client).get_role_insights(x_sail_point_experimental, offset, limit, count, sorters, filters)
print("The response of RoleInsightsApi->get_role_insights:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e)
```
@@ -390,10 +405,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.role_insights_api import RoleInsightsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_insights_entitlement import RoleInsightsEntitlement
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight 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')
filters = 'name sw \"r\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional)
@@ -401,13 +420,12 @@ from pprint import pprint
try:
# Get current entitlement for a role
api_response = api_instance.get_role_insights_current_entitlements(insight_id, x_sail_point_experimental, )
results =RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_role_insights_current_entitlements(insight_id, x_sail_point_experimental, filters)
# results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, x_sail_point_experimental, filters)
print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e)
```
@@ -453,10 +471,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.role_insights_api import RoleInsightsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_insights_entitlement_changes import RoleInsightsEntitlementChanges
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight 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')
sorters = 'sorters_example' # str | 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: **identitiesWithAccess, name** (optional) # str | 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: **identitiesWithAccess, name** (optional)
@@ -465,13 +487,12 @@ from pprint import pprint
try:
# Get entitlement insights for a role
api_response = api_instance.get_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, )
results =RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters)
# results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters)
print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e)
```
@@ -519,23 +540,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.role_insights_api import RoleInsightsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_insights_response import RoleInsightsResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insights request id # str | The role insights request 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')
try:
# Returns metadata from prior request.
api_response = api_instance.get_role_insights_requests(id, x_sail_point_experimental)
results =RoleInsightsApi(api_client).get_role_insights_requests(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_role_insights_requests(id, x_sail_point_experimental)
# results = RoleInsightsApi(api_client).get_role_insights_requests(id, x_sail_point_experimental)
print("The response of RoleInsightsApi->get_role_insights_requests:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RoleInsightsApi->get_role_insights_requests: %s\n" % e)
```
@@ -578,22 +602,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.role_insights_api import RoleInsightsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_insights_summary import RoleInsightsSummary
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
try:
# Get role insights summary information
api_response = api_instance.get_role_insights_summary(x_sail_point_experimental)
results =RoleInsightsApi(api_client).get_role_insights_summary(x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_role_insights_summary(x_sail_point_experimental)
# results = RoleInsightsApi(api_client).get_role_insights_summary(x_sail_point_experimental)
print("The response of RoleInsightsApi->get_role_insights_summary:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RoleInsightsApi->get_role_insights_summary: %s\n" % e)
```

254
docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md
View File

@@ -106,10 +106,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.roles_api import RolesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role import Role
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role = {
"owner" : {
"name" : "support",
@@ -271,14 +275,14 @@ from pprint import pprint
try:
# Create a Role
Result = role.from_json(role)
api_response = api_instance.create_role(Result)
new_role = Role()
new_role.from_json(role)
results =RolesApi(api_client).create_role(new_role)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_role(Result)
# results = RolesApi(api_client).create_role(new_role)
print("The response of RolesApi->create_role:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RolesApi->create_role: %s\n" % e)
```
@@ -322,25 +326,29 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.roles_api import RolesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_bulk_delete_request import RoleBulkDeleteRequest
from sailpoint.v2024.models.task_result_dto import TaskResultDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role_bulk_delete_request = {
"roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ]
} # RoleBulkDeleteRequest |
try:
# Delete Role(s)
Result = role_bulk_delete_request.from_json(role_bulk_delete_request)
api_response = api_instance.delete_bulk_roles(Result)
new_role_bulk_delete_request = RoleBulkDeleteRequest()
new_role_bulk_delete_request.from_json(role_bulk_delete_request)
results =RolesApi(api_client).delete_bulk_roles(new_role_bulk_delete_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_bulk_roles(Result)
# results = RolesApi(api_client).delete_bulk_roles(new_role_bulk_delete_request)
print("The response of RolesApi->delete_bulk_roles:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RolesApi->delete_bulk_roles: %s\n" % e)
```
@@ -383,9 +391,13 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.roles_api import RolesApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808c74ff913f0175097daa9d59cd' # str | The role's id. # str | The role's id.
attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
attribute_value = 'public' # str | Technical name of the Attribute Value. # str | Technical name of the Attribute Value.
@@ -393,11 +405,10 @@ from pprint import pprint
try:
# Remove a Metadata From Role.
api_instance.delete_metadata_from_role_by_key_and_value(id, attribute_key, attribute_value)
RolesApi(api_client).delete_metadata_from_role_by_key_and_value(id, attribute_key, attribute_value)
# Below is a request that includes all optional parameters
# api_instance.delete_metadata_from_role_by_key_and_value(id, attribute_key, attribute_value)
except Exception as e:
# RolesApi(api_client).delete_metadata_from_role_by_key_and_value(id, attribute_key, attribute_value)
except Exception as e:
print("Exception when calling RolesApi->delete_metadata_from_role_by_key_and_value: %s\n" % e)
```
@@ -440,19 +451,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.roles_api import RolesApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role
try:
# Delete a Role
api_instance.delete_role(id)
RolesApi(api_client).delete_role(id)
# Below is a request that includes all optional parameters
# api_instance.delete_role(id)
except Exception as e:
# RolesApi(api_client).delete_role(id)
except Exception as e:
print("Exception when calling RolesApi->delete_role: %s\n" % e)
```
@@ -490,21 +504,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.roles_api import RolesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_get_all_bulk_update_response import RoleGetAllBulkUpdateResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Bulk-Update Statuses
api_response = api_instance.get_bulk_update_status()
results =RolesApi(api_client).get_bulk_update_status()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_bulk_update_status()
# results = RolesApi(api_client).get_bulk_update_status()
print("The response of RolesApi->get_bulk_update_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RolesApi->get_bulk_update_status: %s\n" % e)
```
@@ -547,22 +564,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.roles_api import RolesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_bulk_update_response import RoleBulkUpdateResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c24359c389374d0fb8585698a2189e3d' # str | The Id of the bulk update task. # str | The Id of the bulk update task.
try:
# Get Bulk-Update Status by ID
api_response = api_instance.get_bulk_update_status_by_id(id)
results =RolesApi(api_client).get_bulk_update_status_by_id(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_bulk_update_status_by_id(id)
# results = RolesApi(api_client).get_bulk_update_status_by_id(id)
print("The response of RolesApi->get_bulk_update_status_by_id:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RolesApi->get_bulk_update_status_by_id: %s\n" % e)
```
@@ -604,22 +624,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.roles_api import RolesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role import Role
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role
try:
# Get a Role
api_response = api_instance.get_role(id)
results =RolesApi(api_client).get_role(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_role(id)
# results = RolesApi(api_client).get_role(id)
print("The response of RolesApi->get_role:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RolesApi->get_role: %s\n" % e)
```
@@ -665,10 +688,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.roles_api import RolesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_identity import RoleIdentity
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the Role for which the assigned Identities are to be listed # str | ID of the Role for which the assigned Identities are to be listed
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)
@@ -679,13 +706,12 @@ from pprint import pprint
try:
# List Identities assigned a Role
api_response = api_instance.get_role_assigned_identities(id, )
results =RolesApi(api_client).get_role_assigned_identities(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_role_assigned_identities(id, limit, offset, count, filters, sorters)
# results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters)
print("The response of RolesApi->get_role_assigned_identities:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e)
```
@@ -735,10 +761,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.roles_api import RolesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.entitlement1 import Entitlement1
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121919ecca' # str | ID of the containing role # str | ID of the containing role
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)
@@ -750,13 +780,12 @@ from pprint import pprint
try:
# List role's Entitlements
api_response = api_instance.get_role_entitlements(id, x_sail_point_experimental, )
results =RolesApi(api_client).get_role_entitlements(id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_role_entitlements(id, x_sail_point_experimental, limit, offset, count, filters, sorters)
# results = RolesApi(api_client).get_role_entitlements(id, x_sail_point_experimental, limit, offset, count, filters, sorters)
print("The response of RolesApi->get_role_entitlements:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e)
```
@@ -804,10 +833,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.roles_api import RolesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role import Role
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional)
limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50)
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)
@@ -820,13 +853,12 @@ from pprint import pprint
try:
# List Roles
api_response = api_instance.list_roles()
results =RolesApi(api_client).list_roles()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented)
# results = RolesApi(api_client).list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented)
print("The response of RolesApi->list_roles:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RolesApi->list_roles: %s\n" % e)
```
@@ -887,11 +919,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.roles_api import RolesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.models.role import Role
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the Role to patch # str | ID of the Role to patch
[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}] # List[JsonPatchOperation] |
json_patch_operation = {
@@ -903,14 +939,14 @@ from pprint import pprint
try:
# Patch a specified Role
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_role(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =RolesApi(api_client).patch_role(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_role(id, Result)
# results = RolesApi(api_client).patch_role(id, new_json_patch_operation)
print("The response of RolesApi->patch_role:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RolesApi->patch_role: %s\n" % e)
```
@@ -959,11 +995,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.roles_api import RolesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role import Role
from sailpoint.v2024.models.role_list_filter_dto import RoleListFilterDTO
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional)
limit = 50 # 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 50) # 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 50)
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)
@@ -982,13 +1022,12 @@ from pprint import pprint
try:
# Filter Roles by Metadata
api_response = api_instance.search_roles_by_filter()
results =RolesApi(api_client).search_roles_by_filter()
# Below is a request that includes all optional parameters
# api_response = api_instance.search_roles_by_filter(for_subadmin, limit, offset, count, sorters, for_segment_ids, include_unsegmented, Result)
# results = RolesApi(api_client).search_roles_by_filter(for_subadmin, limit, offset, count, sorters, for_segment_ids, include_unsegmented, new_role_list_filter_dto)
print("The response of RolesApi->search_roles_by_filter:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RolesApi->search_roles_by_filter: %s\n" % e)
```
@@ -1031,10 +1070,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.roles_api import RolesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role import Role
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c24359c389374d0fb8585698a2189e3d' # str | The Id of a role # str | The Id of a role
attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
attribute_value = 'public' # str | Technical name of the Attribute Value. # str | Technical name of the Attribute Value.
@@ -1042,13 +1085,12 @@ from pprint import pprint
try:
# Add a Metadata to Role.
api_response = api_instance.update_attribute_key_and_value_to_role(id, attribute_key, attribute_value)
results =RolesApi(api_client).update_attribute_key_and_value_to_role(id, attribute_key, attribute_value)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_attribute_key_and_value_to_role(id, attribute_key, attribute_value)
# results = RolesApi(api_client).update_attribute_key_and_value_to_role(id, attribute_key, attribute_value)
print("The response of RolesApi->update_attribute_key_and_value_to_role:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RolesApi->update_attribute_key_and_value_to_role: %s\n" % e)
```
@@ -1092,11 +1134,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.roles_api import RolesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_bulk_update_response import RoleBulkUpdateResponse
from sailpoint.v2024.models.role_metadata_bulk_update_by_filter_request import RoleMetadataBulkUpdateByFilterRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role_metadata_bulk_update_by_filter_request = {
"values" : [ {
"attribute" : "iscFederalClassifications",
@@ -1109,14 +1155,14 @@ from pprint import pprint
try:
# Bulk-Update Roles' Metadata by Filters
Result = role_metadata_bulk_update_by_filter_request.from_json(role_metadata_bulk_update_by_filter_request)
api_response = api_instance.update_roles_metadata_by_filter(Result)
new_role_metadata_bulk_update_by_filter_request = RoleMetadataBulkUpdateByFilterRequest()
new_role_metadata_bulk_update_by_filter_request.from_json(role_metadata_bulk_update_by_filter_request)
results =RolesApi(api_client).update_roles_metadata_by_filter(new_role_metadata_bulk_update_by_filter_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_roles_metadata_by_filter(Result)
# results = RolesApi(api_client).update_roles_metadata_by_filter(new_role_metadata_bulk_update_by_filter_request)
print("The response of RolesApi->update_roles_metadata_by_filter:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RolesApi->update_roles_metadata_by_filter: %s\n" % e)
```
@@ -1160,11 +1206,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.roles_api import RolesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_bulk_update_response import RoleBulkUpdateResponse
from sailpoint.v2024.models.role_metadata_bulk_update_by_id_request import RoleMetadataBulkUpdateByIdRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role_metadata_bulk_update_by_id_request = {
"roles" : [ "b1db89554cfa431cb8b9921ea38d9367" ],
"values" : [ {
@@ -1177,14 +1227,14 @@ from pprint import pprint
try:
# Bulk-Update Roles' Metadata by ID
Result = role_metadata_bulk_update_by_id_request.from_json(role_metadata_bulk_update_by_id_request)
api_response = api_instance.update_roles_metadata_by_ids(Result)
new_role_metadata_bulk_update_by_id_request = RoleMetadataBulkUpdateByIdRequest()
new_role_metadata_bulk_update_by_id_request.from_json(role_metadata_bulk_update_by_id_request)
results =RolesApi(api_client).update_roles_metadata_by_ids(new_role_metadata_bulk_update_by_id_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_roles_metadata_by_ids(Result)
# results = RolesApi(api_client).update_roles_metadata_by_ids(new_role_metadata_bulk_update_by_id_request)
print("The response of RolesApi->update_roles_metadata_by_ids:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RolesApi->update_roles_metadata_by_ids: %s\n" % e)
```
@@ -1228,11 +1278,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.roles_api import RolesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.role_bulk_update_response import RoleBulkUpdateResponse
from sailpoint.v2024.models.role_metadata_bulk_update_by_query_request import RoleMetadataBulkUpdateByQueryRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role_metadata_bulk_update_by_query_request = {
"query" : {
"query\"" : {
@@ -1260,14 +1314,14 @@ from pprint import pprint
try:
# Bulk-Update Roles' Metadata by Query
Result = role_metadata_bulk_update_by_query_request.from_json(role_metadata_bulk_update_by_query_request)
api_response = api_instance.update_roles_metadata_by_query(Result)
new_role_metadata_bulk_update_by_query_request = RoleMetadataBulkUpdateByQueryRequest()
new_role_metadata_bulk_update_by_query_request.from_json(role_metadata_bulk_update_by_query_request)
results =RolesApi(api_client).update_roles_metadata_by_query(new_role_metadata_bulk_update_by_query_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_roles_metadata_by_query(Result)
# results = RolesApi(api_client).update_roles_metadata_by_query(new_role_metadata_bulk_update_by_query_request)
print("The response of RolesApi->update_roles_metadata_by_query:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RolesApi->update_roles_metadata_by_query: %s\n" % e)
```

115
docs/tools/sdk/python/Reference/V2024/Methods/SIMIntegrationsApi.md
View File

@@ -69,11 +69,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
sim_integration_details = {
"cluster" : "xyzzy999",
@@ -96,14 +100,14 @@ from pprint import pprint
try:
# Create new SIM integration
Result = sim_integration_details.from_json(sim_integration_details)
api_response = api_instance.create_sim_integration(x_sail_point_experimental, Result)
new_sim_integration_details = SimIntegrationDetails()
new_sim_integration_details.from_json(sim_integration_details)
results =SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_sim_integration(x_sail_point_experimental, Result)
# results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details)
print("The response of SIMIntegrationsApi->create_sim_integration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e)
```
@@ -149,20 +153,23 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete.
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')
try:
# Delete a SIM integration
api_instance.delete_sim_integration(id, x_sail_point_experimental)
SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_instance.delete_sim_integration(id, x_sail_point_experimental)
except Exception as e:
# SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental)
except Exception as e:
print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e)
```
@@ -208,23 +215,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '12345' # str | The id of the integration. # str | The id of the integration.
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')
try:
# Get a SIM integration details.
api_response = api_instance.get_sim_integration(id, x_sail_point_experimental)
results =SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sim_integration(id, x_sail_point_experimental)
# results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental)
print("The response of SIMIntegrationsApi->get_sim_integration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e)
```
@@ -269,22 +279,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
try:
# List the existing SIM integrations.
api_response = api_instance.get_sim_integrations(x_sail_point_experimental)
results =SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sim_integrations(x_sail_point_experimental)
# results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental)
print("The response of SIMIntegrationsApi->get_sim_integrations:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e)
```
@@ -331,25 +344,29 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch import JsonPatch
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '12345' # str | SIM integration id # str | SIM integration 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')
json_patch = "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule.
try:
# Patch a SIM beforeProvisioningRule attribute.
Result = json_patch.from_json(json_patch)
api_response = api_instance.patch_before_provisioning_rule(id, x_sail_point_experimental, Result)
new_json_patch = JsonPatch()
new_json_patch.from_json(json_patch)
results =SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_before_provisioning_rule(id, x_sail_point_experimental, Result)
# results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch)
print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e)
```
@@ -396,25 +413,29 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch import JsonPatch
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '12345' # str | SIM integration id # str | SIM integration 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')
json_patch = "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" # JsonPatch | The JsonPatch object that describes the changes of SIM
try:
# Patch a SIM attribute.
Result = json_patch.from_json(json_patch)
api_response = api_instance.patch_sim_attributes(id, x_sail_point_experimental, Result)
new_json_patch = JsonPatch()
new_json_patch.from_json(json_patch)
results =SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_sim_attributes(id, x_sail_point_experimental, Result)
# results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch)
print("The response of SIMIntegrationsApi->patch_sim_attributes:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e)
```
@@ -461,11 +482,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '12345' # str | The id of the integration. # str | The id of the integration.
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')
sim_integration_details = {
@@ -489,14 +514,14 @@ from pprint import pprint
try:
# Update an existing SIM integration
Result = sim_integration_details.from_json(sim_integration_details)
api_response = api_instance.put_sim_integration(id, x_sail_point_experimental, Result)
new_sim_integration_details = SimIntegrationDetails()
new_sim_integration_details.from_json(sim_integration_details)
results =SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_sim_integration(id, x_sail_point_experimental, Result)
# results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details)
print("The response of SIMIntegrationsApi->put_sim_integration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e)
```

263
docs/tools/sdk/python/Reference/V2024/Methods/SODPoliciesApi.md
View File

@@ -94,10 +94,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sod_policy import SodPolicy
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
sod_policy = {
"conflictingAccessCriteria" : {
"leftCriteria" : {
@@ -157,14 +161,14 @@ from pprint import pprint
try:
# Create SOD policy
Result = sod_policy.from_json(sod_policy)
api_response = api_instance.create_sod_policy(Result)
new_sod_policy = SodPolicy()
new_sod_policy.from_json(sod_policy)
results =SODPoliciesApi(api_client).create_sod_policy(new_sod_policy)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_sod_policy(Result)
# results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy)
print("The response of SODPoliciesApi->create_sod_policy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e)
```
@@ -208,20 +212,23 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete.
logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True)
try:
# Delete SOD policy by ID
api_instance.delete_sod_policy(id, )
SODPoliciesApi(api_client).delete_sod_policy(id, )
# Below is a request that includes all optional parameters
# api_instance.delete_sod_policy(id, logical)
except Exception as e:
# SODPoliciesApi(api_client).delete_sod_policy(id, logical)
except Exception as e:
print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e)
```
@@ -263,19 +270,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for.
try:
# Delete SOD policy schedule
api_instance.delete_sod_policy_schedule(id)
SODPoliciesApi(api_client).delete_sod_policy_schedule(id)
# Below is a request that includes all optional parameters
# api_instance.delete_sod_policy_schedule(id)
except Exception as e:
# SODPoliciesApi(api_client).delete_sod_policy_schedule(id)
except Exception as e:
print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e)
```
@@ -318,22 +328,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download.
file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file.
try:
# Download custom violation report
api_response = api_instance.get_custom_violation_report(report_result_id, file_name)
results =SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_custom_violation_report(report_result_id, file_name)
# results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name)
print("The response of SODPoliciesApi->get_custom_violation_report:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e)
```
@@ -375,21 +388,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download.
try:
# Download violation report
api_response = api_instance.get_default_violation_report(report_result_id)
results =SODPoliciesApi(api_client).get_default_violation_report(report_result_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_default_violation_report(report_result_id)
# results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id)
print("The response of SODPoliciesApi->get_default_violation_report:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e)
```
@@ -427,21 +443,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.report_result_reference import ReportResultReference
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get multi-report run task status
api_response = api_instance.get_sod_all_report_run_status()
results =SODPoliciesApi(api_client).get_sod_all_report_run_status()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sod_all_report_run_status()
# results = SODPoliciesApi(api_client).get_sod_all_report_run_status()
print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e)
```
@@ -484,22 +503,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sod_policy import SodPolicy
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve.
try:
# Get SOD policy by ID
api_response = api_instance.get_sod_policy(id)
results =SODPoliciesApi(api_client).get_sod_policy(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sod_policy(id)
# results = SODPoliciesApi(api_client).get_sod_policy(id)
print("The response of SODPoliciesApi->get_sod_policy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e)
```
@@ -540,22 +562,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve.
try:
# Get SOD policy schedule
api_response = api_instance.get_sod_policy_schedule(id)
results =SODPoliciesApi(api_client).get_sod_policy_schedule(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sod_policy_schedule(id)
# results = SODPoliciesApi(api_client).get_sod_policy_schedule(id)
print("The response of SODPoliciesApi->get_sod_policy_schedule:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e)
```
@@ -597,22 +622,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.report_result_reference import ReportResultReference
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve.
try:
# Get violation report run status
api_response = api_instance.get_sod_violation_report_run_status(report_result_id)
results =SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sod_violation_report_run_status(report_result_id)
# results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id)
print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e)
```
@@ -654,22 +682,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.report_result_reference import ReportResultReference
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for.
try:
# Get SOD violation report status
api_response = api_instance.get_sod_violation_report_status(id)
results =SODPoliciesApi(api_client).get_sod_violation_report_status(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sod_violation_report_status(id)
# results = SODPoliciesApi(api_client).get_sod_violation_report_status(id)
print("The response of SODPoliciesApi->get_sod_violation_report_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e)
```
@@ -715,10 +746,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sod_policy import SodPolicy
from sailpoint.v2024.rest import ApiException
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)
count = False # bool | 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=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. (optional) (default to False) # bool | 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=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. (optional) (default to False)
@@ -728,13 +763,12 @@ from pprint import pprint
try:
# List SOD policies
api_response = api_instance.list_sod_policies()
results =SODPoliciesApi(api_client).list_sod_policies()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_sod_policies(limit, offset, count, filters, sorters)
# results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters)
print("The response of SODPoliciesApi->list_sod_policies:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e)
```
@@ -779,11 +813,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.models.sod_policy import SodPolicy
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified.
[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}] # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria
json_patch_operation = {
@@ -795,14 +833,14 @@ from pprint import pprint
try:
# Patch SOD policy by ID
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_sod_policy(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_sod_policy(id, Result)
# results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation)
print("The response of SODPoliciesApi->patch_sod_policy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e)
```
@@ -844,10 +882,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule.
sod_policy_schedule = {
"schedule" : {
@@ -938,14 +980,14 @@ from pprint import pprint
try:
# Update SOD Policy schedule
Result = sod_policy_schedule.from_json(sod_policy_schedule)
api_response = api_instance.put_policy_schedule(id, Result)
new_sod_policy_schedule = SodPolicySchedule()
new_sod_policy_schedule.from_json(sod_policy_schedule)
results =SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_policy_schedule(id, Result)
# results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule)
print("The response of SODPoliciesApi->put_policy_schedule:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e)
```
@@ -989,10 +1031,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sod_policy import SodPolicy
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update.
sod_policy = {
"conflictingAccessCriteria" : {
@@ -1053,14 +1099,14 @@ from pprint import pprint
try:
# Update SOD policy by ID
Result = sod_policy.from_json(sod_policy)
api_response = api_instance.put_sod_policy(id, Result)
new_sod_policy = SodPolicy()
new_sod_policy.from_json(sod_policy)
results =SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_sod_policy(id, Result)
# results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy)
print("The response of SODPoliciesApi->put_sod_policy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e)
```
@@ -1101,22 +1147,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.report_result_reference import ReportResultReference
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run.
try:
# Evaluate one policy by ID
api_response = api_instance.start_evaluate_sod_policy(id)
results =SODPoliciesApi(api_client).start_evaluate_sod_policy(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.start_evaluate_sod_policy(id)
# results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id)
print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e)
```
@@ -1157,11 +1206,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.multi_policy_request import MultiPolicyRequest
from sailpoint.v2024.models.report_result_reference import ReportResultReference
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multi_policy_request = {
"filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ]
} # MultiPolicyRequest | (optional)
@@ -1169,13 +1222,12 @@ from pprint import pprint
try:
# Runs all policies for org
api_response = api_instance.start_sod_all_policies_for_org()
results =SODPoliciesApi(api_client).start_sod_all_policies_for_org()
# Below is a request that includes all optional parameters
# api_response = api_instance.start_sod_all_policies_for_org(Result)
# results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request)
print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e)
```
@@ -1217,22 +1269,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.report_result_reference import ReportResultReference
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run.
try:
# Runs SOD policy violation report
api_response = api_instance.start_sod_policy(id)
results =SODPoliciesApi(api_client).start_sod_policy(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.start_sod_policy(id)
# results = SODPoliciesApi(api_client).start_sod_policy(id)
print("The response of SODPoliciesApi->start_sod_policy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e)
```

36
docs/tools/sdk/python/Reference/V2024/Methods/SODViolationsApi.md
View File

@@ -71,11 +71,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sod_violations_api import SODViolationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_with_new_access import IdentityWithNewAccess
from sailpoint.v2024.models.violation_prediction import ViolationPrediction
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_with_new_access = {
"identityId" : "2c91808568c529c60168cca6f90c1313",
"accessRefs" : [ {
@@ -91,14 +95,14 @@ from pprint import pprint
try:
# Predict SOD violations for identity.
Result = identity_with_new_access.from_json(identity_with_new_access)
api_response = api_instance.start_predict_sod_violations(Result)
new_identity_with_new_access = IdentityWithNewAccess()
new_identity_with_new_access.from_json(identity_with_new_access)
results =SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access)
# Below is a request that includes all optional parameters
# api_response = api_instance.start_predict_sod_violations(Result)
# results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access)
print("The response of SODViolationsApi->start_predict_sod_violations:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e)
```
@@ -140,23 +144,27 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sod_violations_api import SODViolationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_with_new_access1 import IdentityWithNewAccess1
from sailpoint.v2024.models.sod_violation_check import SodViolationCheck
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_with_new_access1 = {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} # IdentityWithNewAccess1 |
try:
# Check SOD violations
Result = identity_with_new_access1.from_json(identity_with_new_access1)
api_response = api_instance.start_violation_check(Result)
new_identity_with_new_access1 = IdentityWithNewAccess1()
new_identity_with_new_access1.from_json(identity_with_new_access1)
results =SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1)
# Below is a request that includes all optional parameters
# api_response = api_instance.start_violation_check(Result)
# results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1)
print("The response of SODViolationsApi->start_violation_check:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e)
```

108
docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md
View File

@@ -63,11 +63,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sp_config_api import SPConfigApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.export_payload import ExportPayload
from sailpoint.v2024.models.sp_config_export_job import SpConfigExportJob
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
export_payload = {
"description" : "Export Job 1 Test"
@@ -75,14 +79,14 @@ from pprint import pprint
try:
# Initiates configuration objects export job
Result = export_payload.from_json(export_payload)
api_response = api_instance.export_sp_config(x_sail_point_experimental, Result)
new_export_payload = ExportPayload()
new_export_payload.from_json(export_payload)
results =SPConfigApi(api_client).export_sp_config(x_sail_point_experimental, new_export_payload)
# Below is a request that includes all optional parameters
# api_response = api_instance.export_sp_config(x_sail_point_experimental, Result)
# results = SPConfigApi(api_client).export_sp_config(x_sail_point_experimental, new_export_payload)
print("The response of SPConfigApi->export_sp_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e)
```
@@ -130,23 +134,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sp_config_api import SPConfigApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sp_config_export_results import SpConfigExportResults
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded.
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')
try:
# Download export job result.
api_response = api_instance.get_sp_config_export(id, x_sail_point_experimental)
results =SPConfigApi(api_client).get_sp_config_export(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sp_config_export(id, x_sail_point_experimental)
# results = SPConfigApi(api_client).get_sp_config_export(id, x_sail_point_experimental)
print("The response of SPConfigApi->get_sp_config_export:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e)
```
@@ -194,23 +201,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sp_config_api import SPConfigApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sp_config_export_job_status import SpConfigExportJobStatus
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned.
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')
try:
# Get export job status
api_response = api_instance.get_sp_config_export_status(id, x_sail_point_experimental)
results =SPConfigApi(api_client).get_sp_config_export_status(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sp_config_export_status(id, x_sail_point_experimental)
# results = SPConfigApi(api_client).get_sp_config_export_status(id, x_sail_point_experimental)
print("The response of SPConfigApi->get_sp_config_export_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e)
```
@@ -258,23 +268,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sp_config_api import SPConfigApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sp_config_import_results import SpConfigImportResults
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded.
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')
try:
# Download import job result
api_response = api_instance.get_sp_config_import(id, x_sail_point_experimental)
results =SPConfigApi(api_client).get_sp_config_import(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sp_config_import(id, x_sail_point_experimental)
# results = SPConfigApi(api_client).get_sp_config_import(id, x_sail_point_experimental)
print("The response of SPConfigApi->get_sp_config_import:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e)
```
@@ -324,23 +337,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sp_config_api import SPConfigApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sp_config_import_job_status import SpConfigImportJobStatus
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned.
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')
try:
# Get import job status
api_response = api_instance.get_sp_config_import_status(id, x_sail_point_experimental)
results =SPConfigApi(api_client).get_sp_config_import_status(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sp_config_import_status(id, x_sail_point_experimental)
# results = SPConfigApi(api_client).get_sp_config_import_status(id, x_sail_point_experimental)
print("The response of SPConfigApi->get_sp_config_import_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e)
```
@@ -400,11 +416,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sp_config_api import SPConfigApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.import_options import ImportOptions
from sailpoint.v2024.models.sp_config_job import SpConfigJob
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported.
preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False)
@@ -413,13 +433,12 @@ from pprint import pprint
try:
# Initiates configuration objects import job
api_response = api_instance.import_sp_config(x_sail_point_experimental, data, )
results =SPConfigApi(api_client).import_sp_config(x_sail_point_experimental, data, )
# Below is a request that includes all optional parameters
# api_response = api_instance.import_sp_config(x_sail_point_experimental, data, preview, options)
# results = SPConfigApi(api_client).import_sp_config(x_sail_point_experimental, data, preview, options)
print("The response of SPConfigApi->import_sp_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e)
```
@@ -464,22 +483,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sp_config_api import SPConfigApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sp_config_object import SpConfigObject
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
try:
# Get config object details
api_response = api_instance.list_sp_config_objects(x_sail_point_experimental)
results =SPConfigApi(api_client).list_sp_config_objects(x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.list_sp_config_objects(x_sail_point_experimental)
# results = SPConfigApi(api_client).list_sp_config_objects(x_sail_point_experimental)
print("The response of SPConfigApi->list_sp_config_objects:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e)
```

95
docs/tools/sdk/python/Reference/V2024/Methods/SavedSearchApi.md
View File

@@ -67,23 +67,27 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.saved_search_api import SavedSearchApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.create_saved_search_request import CreateSavedSearchRequest
from sailpoint.v2024.models.saved_search import SavedSearch
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
create_saved_search_request = sailpoint.v2024.CreateSavedSearchRequest() # CreateSavedSearchRequest | The saved search to persist.
try:
# Create a saved search
Result = create_saved_search_request.from_json(create_saved_search_request)
api_response = api_instance.create_saved_search(Result)
new_create_saved_search_request = CreateSavedSearchRequest()
new_create_saved_search_request.from_json(create_saved_search_request)
results =SavedSearchApi(api_client).create_saved_search(new_create_saved_search_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_saved_search(Result)
# results = SavedSearchApi(api_client).create_saved_search(new_create_saved_search_request)
print("The response of SavedSearchApi->create_saved_search:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SavedSearchApi->create_saved_search: %s\n" % e)
```
@@ -126,19 +130,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.saved_search_api import SavedSearchApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
try:
# Delete document by ID
api_instance.delete_saved_search(id)
SavedSearchApi(api_client).delete_saved_search(id)
# Below is a request that includes all optional parameters
# api_instance.delete_saved_search(id)
except Exception as e:
# SavedSearchApi(api_client).delete_saved_search(id)
except Exception as e:
print("Exception when calling SavedSearchApi->delete_saved_search: %s\n" % e)
```
@@ -182,10 +189,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.saved_search_api import SavedSearchApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.search_arguments import SearchArguments
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
search_arguments = {
"owner" : "",
@@ -201,12 +212,12 @@ from pprint import pprint
try:
# Execute a saved search by ID
Result = search_arguments.from_json(search_arguments)
api_instance.execute_saved_search(id, Result)
new_search_arguments = SearchArguments()
new_search_arguments.from_json(search_arguments)
SavedSearchApi(api_client).execute_saved_search(id, new_search_arguments)
# Below is a request that includes all optional parameters
# api_instance.execute_saved_search(id, Result)
except Exception as e:
# SavedSearchApi(api_client).execute_saved_search(id, new_search_arguments)
except Exception as e:
print("Exception when calling SavedSearchApi->execute_saved_search: %s\n" % e)
```
@@ -249,22 +260,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.saved_search_api import SavedSearchApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.saved_search import SavedSearch
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
try:
# Return saved search by ID
api_response = api_instance.get_saved_search(id)
results =SavedSearchApi(api_client).get_saved_search(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_saved_search(id)
# results = SavedSearchApi(api_client).get_saved_search(id)
print("The response of SavedSearchApi->get_saved_search:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SavedSearchApi->get_saved_search: %s\n" % e)
```
@@ -309,10 +323,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.saved_search_api import SavedSearchApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.saved_search import SavedSearch
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
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)
count = False # bool | 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=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. (optional) (default to False) # bool | 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=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. (optional) (default to False)
@@ -321,13 +339,12 @@ from pprint import pprint
try:
# A list of Saved Searches
api_response = api_instance.list_saved_searches()
results =SavedSearchApi(api_client).list_saved_searches()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_saved_searches(offset, limit, count, filters)
# results = SavedSearchApi(api_client).list_saved_searches(offset, limit, count, filters)
print("The response of SavedSearchApi->list_saved_searches:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e)
```
@@ -372,10 +389,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.saved_search_api import SavedSearchApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.saved_search import SavedSearch
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
saved_search = {
"owner" : {
@@ -425,14 +446,14 @@ from pprint import pprint
try:
# Updates an existing saved search
Result = saved_search.from_json(saved_search)
api_response = api_instance.put_saved_search(id, Result)
new_saved_search = SavedSearch()
new_saved_search.from_json(saved_search)
results =SavedSearchApi(api_client).put_saved_search(id, new_saved_search)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_saved_search(id, Result)
# results = SavedSearchApi(api_client).put_saved_search(id, new_saved_search)
print("The response of SavedSearchApi->put_saved_search:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SavedSearchApi->put_saved_search: %s\n" % e)
```

95
docs/tools/sdk/python/Reference/V2024/Methods/ScheduledSearchApi.md
View File

@@ -84,23 +84,27 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.scheduled_search_api import ScheduledSearchApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.create_scheduled_search_request import CreateScheduledSearchRequest
from sailpoint.v2024.models.scheduled_search import ScheduledSearch
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
create_scheduled_search_request = {savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]} # CreateScheduledSearchRequest | The scheduled search to persist.
try:
# Create a new scheduled search
Result = create_scheduled_search_request.from_json(create_scheduled_search_request)
api_response = api_instance.create_scheduled_search(Result)
new_create_scheduled_search_request = CreateScheduledSearchRequest()
new_create_scheduled_search_request.from_json(create_scheduled_search_request)
results =ScheduledSearchApi(api_client).create_scheduled_search(new_create_scheduled_search_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_scheduled_search(Result)
# results = ScheduledSearchApi(api_client).create_scheduled_search(new_create_scheduled_search_request)
print("The response of ScheduledSearchApi->create_scheduled_search:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ScheduledSearchApi->create_scheduled_search: %s\n" % e)
```
@@ -143,19 +147,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.scheduled_search_api import ScheduledSearchApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
try:
# Delete a Scheduled Search
api_instance.delete_scheduled_search(id)
ScheduledSearchApi(api_client).delete_scheduled_search(id)
# Below is a request that includes all optional parameters
# api_instance.delete_scheduled_search(id)
except Exception as e:
# ScheduledSearchApi(api_client).delete_scheduled_search(id)
except Exception as e:
print("Exception when calling ScheduledSearchApi->delete_scheduled_search: %s\n" % e)
```
@@ -197,22 +204,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.scheduled_search_api import ScheduledSearchApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.scheduled_search import ScheduledSearch
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
try:
# Get a Scheduled Search
api_response = api_instance.get_scheduled_search(id)
results =ScheduledSearchApi(api_client).get_scheduled_search(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_scheduled_search(id)
# results = ScheduledSearchApi(api_client).get_scheduled_search(id)
print("The response of ScheduledSearchApi->get_scheduled_search:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ScheduledSearchApi->get_scheduled_search: %s\n" % e)
```
@@ -258,10 +268,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.scheduled_search_api import ScheduledSearchApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.scheduled_search import ScheduledSearch
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
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)
count = False # bool | 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=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. (optional) (default to False) # bool | 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=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. (optional) (default to False)
@@ -270,13 +284,12 @@ from pprint import pprint
try:
# List scheduled searches
api_response = api_instance.list_scheduled_search()
results =ScheduledSearchApi(api_client).list_scheduled_search()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_scheduled_search(offset, limit, count, filters)
# results = ScheduledSearchApi(api_client).list_scheduled_search(offset, limit, count, filters)
print("The response of ScheduledSearchApi->list_scheduled_search:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e)
```
@@ -317,10 +330,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.scheduled_search_api import ScheduledSearchApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.typed_reference import TypedReference
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
typed_reference = {
"id" : "2c91808568c529c60168cca6f90c1313",
@@ -329,12 +346,12 @@ from pprint import pprint
try:
# Unsubscribe a recipient from Scheduled Search
Result = typed_reference.from_json(typed_reference)
api_instance.unsubscribe_scheduled_search(id, Result)
new_typed_reference = TypedReference()
new_typed_reference.from_json(typed_reference)
ScheduledSearchApi(api_client).unsubscribe_scheduled_search(id, new_typed_reference)
# Below is a request that includes all optional parameters
# api_instance.unsubscribe_scheduled_search(id, Result)
except Exception as e:
# ScheduledSearchApi(api_client).unsubscribe_scheduled_search(id, new_typed_reference)
except Exception as e:
print("Exception when calling ScheduledSearchApi->unsubscribe_scheduled_search: %s\n" % e)
```
@@ -378,10 +395,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.scheduled_search_api import ScheduledSearchApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.scheduled_search import ScheduledSearch
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
scheduled_search = {
"owner" : {
@@ -477,14 +498,14 @@ from pprint import pprint
try:
# Update an existing Scheduled Search
Result = scheduled_search.from_json(scheduled_search)
api_response = api_instance.update_scheduled_search(id, Result)
new_scheduled_search = ScheduledSearch()
new_scheduled_search.from_json(scheduled_search)
results =ScheduledSearchApi(api_client).update_scheduled_search(id, new_scheduled_search)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_scheduled_search(id, Result)
# results = ScheduledSearchApi(api_client).update_scheduled_search(id, new_scheduled_search)
print("The response of ScheduledSearchApi->update_scheduled_search:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ScheduledSearchApi->update_scheduled_search: %s\n" % e)
```

67
docs/tools/sdk/python/Reference/V2024/Methods/SearchApi.md
View File

@@ -80,11 +80,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.search_api import SearchApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.aggregation_result import AggregationResult
from sailpoint.v2024.models.search import Search
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
search = {
"queryDsl" : {
"match" : {
@@ -208,14 +212,14 @@ from pprint import pprint
try:
# Perform a Search Query Aggregation
Result = search.from_json(search)
api_response = api_instance.search_aggregate(Result, )
new_search = Search()
new_search.from_json(search)
results =SearchApi(api_client).search_aggregate(new_search, )
# Below is a request that includes all optional parameters
# api_response = api_instance.search_aggregate(Result, offset, limit, count)
# results = SearchApi(api_client).search_aggregate(new_search, offset, limit, count)
print("The response of SearchApi->search_aggregate:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SearchApi->search_aggregate: %s\n" % e)
```
@@ -256,10 +260,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.search_api import SearchApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.search import Search
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
search = {
"queryDsl" : {
"match" : {
@@ -380,12 +388,12 @@ from pprint import pprint
try:
# Count Documents Satisfying a Query
Result = search.from_json(search)
api_instance.search_count(Result)
new_search = Search()
new_search.from_json(search)
SearchApi(api_client).search_count(new_search)
# Below is a request that includes all optional parameters
# api_instance.search_count(Result)
except Exception as e:
# SearchApi(api_client).search_count(new_search)
except Exception as e:
print("Exception when calling SearchApi->search_count: %s\n" % e)
```
@@ -428,22 +436,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.search_api import SearchApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
index = 'accounts' # str | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. # str | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*.
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
try:
# Get a Document by ID
api_response = api_instance.search_get(index, id)
results =SearchApi(api_client).search_get(index, id)
# Below is a request that includes all optional parameters
# api_response = api_instance.search_get(index, id)
# results = SearchApi(api_client).search_get(index, id)
print("The response of SearchApi->search_get:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SearchApi->search_get: %s\n" % e)
```
@@ -487,10 +498,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.search_api import SearchApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.search import Search
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
search = {
"queryDsl" : {
"match" : {
@@ -614,14 +629,14 @@ from pprint import pprint
try:
# Perform Search
Result = search.from_json(search)
api_response = api_instance.search_post(Result, )
new_search = Search()
new_search.from_json(search)
results =SearchApi(api_client).search_post(new_search, )
# Below is a request that includes all optional parameters
# api_response = api_instance.search_post(Result, offset, limit, count)
# results = SearchApi(api_client).search_post(new_search, offset, limit, count)
print("The response of SearchApi->search_post:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SearchApi->search_post: %s\n" % e)
```

79
docs/tools/sdk/python/Reference/V2024/Methods/SearchAttributeConfigurationApi.md
View File

@@ -74,10 +74,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.search_attribute_configuration_api import SearchAttributeConfigurationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.search_attribute_config import SearchAttributeConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
search_attribute_config = {
"displayName" : "New Mail Attribute",
"name" : "newMailAttribute",
@@ -89,14 +93,14 @@ from pprint import pprint
try:
# Create Extended Search Attributes
Result = search_attribute_config.from_json(search_attribute_config)
api_response = api_instance.create_search_attribute_config(Result)
new_search_attribute_config = SearchAttributeConfig()
new_search_attribute_config.from_json(search_attribute_config)
results =SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_search_attribute_config(Result)
# results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config)
print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e)
```
@@ -138,19 +142,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.search_attribute_configuration_api import SearchAttributeConfigurationApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete.
try:
# Delete Extended Search Attribute
api_instance.delete_search_attribute_config(name)
SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name)
# Below is a request that includes all optional parameters
# api_instance.delete_search_attribute_config(name)
except Exception as e:
# SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name)
except Exception as e:
print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e)
```
@@ -188,21 +195,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.search_attribute_configuration_api import SearchAttributeConfigurationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.search_attribute_config import SearchAttributeConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Extended Search Attributes
api_response = api_instance.get_search_attribute_config()
results =SearchAttributeConfigurationApi(api_client).get_search_attribute_config()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_search_attribute_config()
# results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config()
print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e)
```
@@ -245,22 +255,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.search_attribute_configuration_api import SearchAttributeConfigurationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.search_attribute_config import SearchAttributeConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
name = 'newMailAttribute' # str | Name of the extended search attribute configuration to retrieve. # str | Name of the extended search attribute configuration to retrieve.
try:
# Get Extended Search Attribute
api_response = api_instance.get_single_search_attribute_config(name)
results =SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_single_search_attribute_config(name)
# results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name)
print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e)
```
@@ -305,11 +318,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.search_attribute_configuration_api import SearchAttributeConfigurationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.models.search_attribute_config import SearchAttributeConfig
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
name = 'promotedMailAttribute' # str | Name of the search attribute configuration to patch. # str | Name of the search attribute configuration to patch.
[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}] # List[JsonPatchOperation] |
json_patch_operation = {
@@ -321,14 +338,14 @@ from pprint import pprint
try:
# Update Extended Search Attribute
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_search_attribute_config(name, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_search_attribute_config(name, Result)
# results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation)
print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e)
```

79
docs/tools/sdk/python/Reference/V2024/Methods/SegmentsApi.md
View File

@@ -73,10 +73,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.segments_api import SegmentsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.segment import Segment
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
segment = {
"owner" : {
"name" : "support",
@@ -104,14 +108,14 @@ from pprint import pprint
try:
# Create Segment
Result = segment.from_json(segment)
api_response = api_instance.create_segment(Result)
new_segment = Segment()
new_segment.from_json(segment)
results =SegmentsApi(api_client).create_segment(new_segment)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_segment(Result)
# results = SegmentsApi(api_client).create_segment(new_segment)
print("The response of SegmentsApi->create_segment:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SegmentsApi->create_segment: %s\n" % e)
```
@@ -154,19 +158,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.segments_api import SegmentsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete.
try:
# Delete Segment by ID
api_instance.delete_segment(id)
SegmentsApi(api_client).delete_segment(id)
# Below is a request that includes all optional parameters
# api_instance.delete_segment(id)
except Exception as e:
# SegmentsApi(api_client).delete_segment(id)
except Exception as e:
print("Exception when calling SegmentsApi->delete_segment: %s\n" % e)
```
@@ -208,22 +215,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.segments_api import SegmentsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.segment import Segment
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve.
try:
# Get Segment by ID
api_response = api_instance.get_segment(id)
results =SegmentsApi(api_client).get_segment(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_segment(id)
# results = SegmentsApi(api_client).get_segment(id)
print("The response of SegmentsApi->get_segment:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SegmentsApi->get_segment: %s\n" % e)
```
@@ -266,10 +276,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.segments_api import SegmentsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.segment import Segment
from sailpoint.v2024.rest import ApiException
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)
count = False # bool | 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=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. (optional) (default to False) # bool | 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=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. (optional) (default to False)
@@ -277,13 +291,12 @@ from pprint import pprint
try:
# List Segments
api_response = api_instance.list_segments()
results =SegmentsApi(api_client).list_segments()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_segments(limit, offset, count)
# results = SegmentsApi(api_client).list_segments(limit, offset, count)
print("The response of SegmentsApi->list_segments:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SegmentsApi->list_segments: %s\n" % e)
```
@@ -327,10 +340,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.segments_api import SegmentsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.segment import Segment
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify.
request_body = [{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}] # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active
request_body = [{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}] # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active
@@ -338,14 +355,14 @@ from pprint import pprint
try:
# Update Segment
Result = request_body.from_json(request_body)
api_response = api_instance.patch_segment(id, Result)
new_request_body = RequestBody()
new_request_body.from_json(request_body)
results =SegmentsApi(api_client).patch_segment(id, new_request_body)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_segment(id, Result)
# results = SegmentsApi(api_client).patch_segment(id, new_request_body)
print("The response of SegmentsApi->patch_segment:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SegmentsApi->patch_segment: %s\n" % e)
```

160
docs/tools/sdk/python/Reference/V2024/Methods/ServiceDeskIntegrationApi.md
View File

@@ -85,10 +85,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
service_desk_integration_dto = {
"ownerRef" : "",
"cluster" : "xyzzy999",
@@ -126,14 +130,14 @@ from pprint import pprint
try:
# Create new Service Desk integration
Result = service_desk_integration_dto.from_json(service_desk_integration_dto)
api_response = api_instance.create_service_desk_integration(Result)
new_service_desk_integration_dto = ServiceDeskIntegrationDto()
new_service_desk_integration_dto.from_json(service_desk_integration_dto)
results =ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_service_desk_integration(Result)
# results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto)
print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e)
```
@@ -175,19 +179,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete
try:
# Delete a Service Desk integration
api_instance.delete_service_desk_integration(id)
ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id)
# Below is a request that includes all optional parameters
# api_instance.delete_service_desk_integration(id)
except Exception as e:
# ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id)
except Exception as e:
print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e)
```
@@ -229,22 +236,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get
try:
# Get a Service Desk integration
api_response = api_instance.get_service_desk_integration(id)
results =ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_service_desk_integration(id)
# results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id)
print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e)
```
@@ -286,22 +296,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get
try:
# Service Desk integration template by scriptName
api_response = api_instance.get_service_desk_integration_template(script_name)
results =ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_service_desk_integration_template(script_name)
# results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name)
print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e)
```
@@ -340,21 +353,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Service Desk integration types
api_response = api_instance.get_service_desk_integration_types()
results =ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_service_desk_integration_types()
# results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types()
print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e)
```
@@ -400,10 +416,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
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)
sorters = 'name' # str | 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: **name** (optional) # str | 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: **name** (optional)
@@ -413,13 +433,12 @@ from pprint import pprint
try:
# List existing Service Desk integrations
api_response = api_instance.get_service_desk_integrations()
results =ServiceDeskIntegrationApi(api_client).get_service_desk_integrations()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_service_desk_integrations(offset, limit, sorters, filters, count)
# results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations(offset, limit, sorters, filters, count)
print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e)
```
@@ -458,21 +477,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.queued_check_config_details import QueuedCheckConfigDetails
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get the time check configuration
api_response = api_instance.get_status_check_details()
results =ServiceDeskIntegrationApi(api_client).get_status_check_details()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_status_check_details()
# results = ServiceDeskIntegrationApi(api_client).get_status_check_details()
print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e)
```
@@ -515,24 +537,28 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest
from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update
patch_service_desk_integration_request = sailpoint.v2024.PatchServiceDeskIntegrationRequest() # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed.
try:
# Patch a Service Desk Integration
Result = patch_service_desk_integration_request.from_json(patch_service_desk_integration_request)
api_response = api_instance.patch_service_desk_integration(id, Result)
new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest()
new_patch_service_desk_integration_request.from_json(patch_service_desk_integration_request)
results =ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_service_desk_integration(id, Result)
# results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request)
print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e)
```
@@ -575,10 +601,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update
service_desk_integration_dto = {
"ownerRef" : "",
@@ -617,14 +647,14 @@ from pprint import pprint
try:
# Update a Service Desk integration
Result = service_desk_integration_dto.from_json(service_desk_integration_dto)
api_response = api_instance.put_service_desk_integration(id, Result)
new_service_desk_integration_dto = ServiceDeskIntegrationDto()
new_service_desk_integration_dto.from_json(service_desk_integration_dto)
results =ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_service_desk_integration(id, Result)
# results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto)
print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e)
```
@@ -666,10 +696,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.queued_check_config_details import QueuedCheckConfigDetails
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
queued_check_config_details = {
"provisioningStatusCheckIntervalMinutes" : "30",
"provisioningMaxStatusCheckDays" : "2"
@@ -677,14 +711,14 @@ from pprint import pprint
try:
# Update the time check configuration
Result = queued_check_config_details.from_json(queued_check_config_details)
api_response = api_instance.update_status_check_details(Result)
new_queued_check_config_details = QueuedCheckConfigDetails()
new_queued_check_config_details.from_json(queued_check_config_details)
results =ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_status_check_details(Result)
# results = ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details)
print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e)
```

30
docs/tools/sdk/python/Reference/V2024/Methods/SourceUsagesApi.md
View File

@@ -55,22 +55,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.source_usages_api import SourceUsagesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.source_usage_status import SourceUsageStatus
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source
try:
# Finds status of source usage
api_response = api_instance.get_status_by_source_id(source_id)
results =SourceUsagesApi(api_client).get_status_by_source_id(source_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_status_by_source_id(source_id)
# results = SourceUsagesApi(api_client).get_status_by_source_id(source_id)
print("The response of SourceUsagesApi->get_status_by_source_id:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e)
```
@@ -115,10 +118,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.source_usages_api import SourceUsagesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.source_usage import SourceUsage
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source
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)
@@ -128,13 +135,12 @@ from pprint import pprint
try:
# Returns source usage insights
api_response = api_instance.get_usages_by_source_id(source_id, )
results =SourceUsagesApi(api_client).get_usages_by_source_id(source_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_usages_by_source_id(source_id, limit, offset, count, sorters)
# results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters)
print("The response of SourceUsagesApi->get_usages_by_source_id:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e)
```

777
docs/tools/sdk/python/Reference/V2024/Methods/SourcesApi.md
View File

File diff suppressed because it is too large Load Diff

114
docs/tools/sdk/python/Reference/V2024/Methods/SuggestedEntitlementDescriptionApi.md
View File

@@ -69,23 +69,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sed_batch_stats import SedBatchStats
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
batch_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | Batch Id # str | Batch 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')
try:
# Submit Sed Batch Stats Request
api_response = api_instance.get_sed_batch_stats(batch_id, x_sail_point_experimental)
results =SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sed_batch_stats(batch_id, x_sail_point_experimental)
# results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id, x_sail_point_experimental)
print("The response of SuggestedEntitlementDescriptionApi->get_sed_batch_stats:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batch_stats: %s\n" % e)
```
@@ -131,22 +134,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sed_batch_status import SedBatchStatus
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
try:
# List Sed Batch Request
api_response = api_instance.get_sed_batches(x_sail_point_experimental)
results =SuggestedEntitlementDescriptionApi(api_client).get_sed_batches(x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sed_batches(x_sail_point_experimental)
# results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches(x_sail_point_experimental)
print("The response of SuggestedEntitlementDescriptionApi->get_sed_batches:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batches: %s\n" % e)
```
@@ -212,10 +218,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sed import Sed
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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 = limit=25 # int | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) # int | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional)
filters = 'displayName co \"Read and Write\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional)
@@ -228,13 +238,12 @@ from pprint import pprint
try:
# List Suggested Entitlement Descriptions
api_response = api_instance.list_seds(x_sail_point_experimental, )
results =SuggestedEntitlementDescriptionApi(api_client).list_seds(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_seds(x_sail_point_experimental, limit, filters, sorters, count, count_only, requested_by_anyone, show_pending_status_only)
# results = SuggestedEntitlementDescriptionApi(api_client).list_seds(x_sail_point_experimental, limit, filters, sorters, count, count_only, requested_by_anyone, show_pending_status_only)
print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e)
```
@@ -281,11 +290,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sed import Sed
from sailpoint.v2024.models.sed_patch import SedPatch
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ebab396f-0af1-4050-89b7-dafc63ec70e7' # str | id is sed id # str | id is sed 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')
[sailpoint.v2024.SedPatch()] # List[SedPatch] | Sed Patch Request
@@ -298,14 +311,14 @@ from pprint import pprint
try:
# Patch Suggested Entitlement Description
Result = sed_patch.from_json(sed_patch)
api_response = api_instance.patch_sed(id, x_sail_point_experimental, Result)
new_sed_patch = SedPatch()
new_sed_patch.from_json(sed_patch)
results =SuggestedEntitlementDescriptionApi(api_client).patch_sed(id, x_sail_point_experimental, new_sed_patch)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_sed(id, x_sail_point_experimental, Result)
# results = SuggestedEntitlementDescriptionApi(api_client).patch_sed(id, x_sail_point_experimental, new_sed_patch)
print("The response of SuggestedEntitlementDescriptionApi->patch_sed:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SuggestedEntitlementDescriptionApi->patch_sed: %s\n" % e)
```
@@ -352,11 +365,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sed_approval import SedApproval
from sailpoint.v2024.models.sed_approval_status import SedApprovalStatus
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
[sailpoint.v2024.SedApproval()] # List[SedApproval] | Sed Approval
sed_approval = {
@@ -366,14 +383,14 @@ from pprint import pprint
try:
# Submit Bulk Approval Request
Result = sed_approval.from_json(sed_approval)
api_response = api_instance.submit_sed_approval(x_sail_point_experimental, Result)
new_sed_approval = SedApproval()
new_sed_approval.from_json(sed_approval)
results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(x_sail_point_experimental, new_sed_approval)
# Below is a request that includes all optional parameters
# api_response = api_instance.submit_sed_approval(x_sail_point_experimental, Result)
# results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(x_sail_point_experimental, new_sed_approval)
print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e)
```
@@ -420,11 +437,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sed_assignment import SedAssignment
from sailpoint.v2024.models.sed_assignment_response import SedAssignmentResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
sed_assignment = {
"assignee" : {
@@ -436,14 +457,14 @@ from pprint import pprint
try:
# Submit Sed Assignment Request
Result = sed_assignment.from_json(sed_assignment)
api_response = api_instance.submit_sed_assignment(x_sail_point_experimental, Result)
new_sed_assignment = SedAssignment()
new_sed_assignment.from_json(sed_assignment)
results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(x_sail_point_experimental, new_sed_assignment)
# Below is a request that includes all optional parameters
# api_response = api_instance.submit_sed_assignment(x_sail_point_experimental, Result)
# results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(x_sail_point_experimental, new_sed_assignment)
print("The response of SuggestedEntitlementDescriptionApi->submit_sed_assignment:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_assignment: %s\n" % e)
```
@@ -490,11 +511,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sed_batch_request import SedBatchRequest
from sailpoint.v2024.models.sed_batch_response import SedBatchResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
sed_batch_request = {
"entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ],
@@ -504,13 +529,12 @@ from pprint import pprint
try:
# Submit Sed Batch Request
api_response = api_instance.submit_sed_batch_request(x_sail_point_experimental, )
results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.submit_sed_batch_request(x_sail_point_experimental, Result)
# results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request(x_sail_point_experimental, new_sed_batch_request)
print("The response of SuggestedEntitlementDescriptionApi->submit_sed_batch_request:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_batch_request: %s\n" % e)
```

126
docs/tools/sdk/python/Reference/V2024/Methods/TaggedObjectsApi.md
View File

@@ -112,20 +112,23 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
type = 'ROLE' # str | The type of object to delete tags from. # str | The type of object to delete tags from.
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object to delete tags from. # str | The ID of the object to delete tags from.
try:
# Delete Object Tags
api_instance.delete_tagged_object(type, id)
TaggedObjectsApi(api_client).delete_tagged_object(type, id)
# Below is a request that includes all optional parameters
# api_instance.delete_tagged_object(type, id)
except Exception as e:
# TaggedObjectsApi(api_client).delete_tagged_object(type, id)
except Exception as e:
print("Exception when calling TaggedObjectsApi->delete_tagged_object: %s\n" % e)
```
@@ -166,10 +169,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.bulk_remove_tagged_object import BulkRemoveTaggedObject
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
bulk_remove_tagged_object = {
"objectRefs" : [ {
"name" : "William Wilson",
@@ -185,12 +192,12 @@ from pprint import pprint
try:
# Remove Tags from Multiple Objects
Result = bulk_remove_tagged_object.from_json(bulk_remove_tagged_object)
api_instance.delete_tags_to_many_object(Result)
new_bulk_remove_tagged_object = BulkRemoveTaggedObject()
new_bulk_remove_tagged_object.from_json(bulk_remove_tagged_object)
TaggedObjectsApi(api_client).delete_tags_to_many_object(new_bulk_remove_tagged_object)
# Below is a request that includes all optional parameters
# api_instance.delete_tags_to_many_object(Result)
except Exception as e:
# TaggedObjectsApi(api_client).delete_tags_to_many_object(new_bulk_remove_tagged_object)
except Exception as e:
print("Exception when calling TaggedObjectsApi->delete_tags_to_many_object: %s\n" % e)
```
@@ -232,23 +239,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.tagged_object import TaggedObject
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
type = 'ROLE' # str | The type of tagged object to retrieve. # str | The type of tagged object to retrieve.
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve.
try:
# Get Tagged Object
api_response = api_instance.get_tagged_object(type, id)
results =TaggedObjectsApi(api_client).get_tagged_object(type, id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_tagged_object(type, id)
# results = TaggedObjectsApi(api_client).get_tagged_object(type, id)
print("The response of TaggedObjectsApi->get_tagged_object:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e)
```
@@ -294,10 +304,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.tagged_object import TaggedObject
from sailpoint.v2024.rest import ApiException
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)
count = False # bool | 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=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. (optional) (default to False) # bool | 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=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. (optional) (default to False)
@@ -306,13 +320,12 @@ from pprint import pprint
try:
# List Tagged Objects
api_response = api_instance.list_tagged_objects()
results =TaggedObjectsApi(api_client).list_tagged_objects()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_tagged_objects(limit, offset, count, filters)
# results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters)
print("The response of TaggedObjectsApi->list_tagged_objects:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e)
```
@@ -359,10 +372,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.tagged_object import TaggedObject
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
type = 'ROLE' # str | The type of tagged object to retrieve. # str | The type of tagged object to retrieve.
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)
@@ -372,13 +389,12 @@ from pprint import pprint
try:
# List Tagged Objects by Type
api_response = api_instance.list_tagged_objects_by_type(type, )
results =TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_tagged_objects_by_type(type, limit, offset, count, filters)
# results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, limit, offset, count, filters)
print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e)
```
@@ -421,10 +437,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.tagged_object import TaggedObject
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
type = 'ROLE' # str | The type of tagged object to update. # str | The type of tagged object to update.
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to update. # str | The ID of the object reference to update.
tagged_object = {
@@ -438,14 +458,14 @@ from pprint import pprint
try:
# Update Tagged Object
Result = tagged_object.from_json(tagged_object)
api_response = api_instance.put_tagged_object(type, id, Result)
new_tagged_object = TaggedObject()
new_tagged_object.from_json(tagged_object)
results =TaggedObjectsApi(api_client).put_tagged_object(type, id, new_tagged_object)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_tagged_object(type, id, Result)
# results = TaggedObjectsApi(api_client).put_tagged_object(type, id, new_tagged_object)
print("The response of TaggedObjectsApi->put_tagged_object:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TaggedObjectsApi->put_tagged_object: %s\n" % e)
```
@@ -488,10 +508,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.tagged_object import TaggedObject
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
tagged_object = {
"objectRef" : {
"name" : "William Wilson",
@@ -503,12 +527,12 @@ from pprint import pprint
try:
# Add Tag to Object
Result = tagged_object.from_json(tagged_object)
api_instance.set_tag_to_object(Result)
new_tagged_object = TaggedObject()
new_tagged_object.from_json(tagged_object)
TaggedObjectsApi(api_client).set_tag_to_object(new_tagged_object)
# Below is a request that includes all optional parameters
# api_instance.set_tag_to_object(Result)
except Exception as e:
# TaggedObjectsApi(api_client).set_tag_to_object(new_tagged_object)
except Exception as e:
print("Exception when calling TaggedObjectsApi->set_tag_to_object: %s\n" % e)
```
@@ -549,11 +573,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.bulk_add_tagged_object import BulkAddTaggedObject
from sailpoint.v2024.models.bulk_tagged_object_response import BulkTaggedObjectResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
bulk_add_tagged_object = {
"objectRefs" : [ {
"name" : "William Wilson",
@@ -570,14 +598,14 @@ from pprint import pprint
try:
# Tag Multiple Objects
Result = bulk_add_tagged_object.from_json(bulk_add_tagged_object)
api_response = api_instance.set_tags_to_many_objects(Result)
new_bulk_add_tagged_object = BulkAddTaggedObject()
new_bulk_add_tagged_object.from_json(bulk_add_tagged_object)
results =TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_add_tagged_object)
# Below is a request that includes all optional parameters
# api_response = api_instance.set_tags_to_many_objects(Result)
# results = TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_add_tagged_object)
print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e)
```

76
docs/tools/sdk/python/Reference/V2024/Methods/TaskManagementApi.md
View File

@@ -62,9 +62,13 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.task_management_api import TaskManagementApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
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)
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)
@@ -73,11 +77,10 @@ from pprint import pprint
try:
# Retrieve Pending Task List Headers
api_instance.get_pending_task_headers(x_sail_point_experimental, )
TaskManagementApi(api_client).get_pending_task_headers(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_instance.get_pending_task_headers(x_sail_point_experimental, offset, limit, count)
except Exception as e:
# TaskManagementApi(api_client).get_pending_task_headers(x_sail_point_experimental, offset, limit, count)
except Exception as e:
print("Exception when calling TaskManagementApi->get_pending_task_headers: %s\n" % e)
```
@@ -125,10 +128,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.task_management_api import TaskManagementApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.task_status import TaskStatus
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
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)
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)
@@ -137,13 +144,12 @@ from pprint import pprint
try:
# Retrieve Pending Task Status List
api_response = api_instance.get_pending_tasks(x_sail_point_experimental, )
results =TaskManagementApi(api_client).get_pending_tasks(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_pending_tasks(x_sail_point_experimental, offset, limit, count)
# results = TaskManagementApi(api_client).get_pending_tasks(x_sail_point_experimental, offset, limit, count)
print("The response of TaskManagementApi->get_pending_tasks:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e)
```
@@ -189,23 +195,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.task_management_api import TaskManagementApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.task_status import TaskStatus
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task 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')
try:
# Get Task Status by ID
api_response = api_instance.get_task_status(id, x_sail_point_experimental)
results =TaskManagementApi(api_client).get_task_status(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_task_status(id, x_sail_point_experimental)
# results = TaskManagementApi(api_client).get_task_status(id, x_sail_point_experimental)
print("The response of TaskManagementApi->get_task_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TaskManagementApi->get_task_status: %s\n" % e)
```
@@ -256,10 +265,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.task_management_api import TaskManagementApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.task_status import TaskStatus
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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)
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)
@@ -270,13 +283,12 @@ from pprint import pprint
try:
# Retrieve Task Status List
api_response = api_instance.get_task_status_list(x_sail_point_experimental, )
results =TaskManagementApi(api_client).get_task_status_list(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_task_status_list(x_sail_point_experimental, limit, offset, count, filters, sorters)
# results = TaskManagementApi(api_client).get_task_status_list(x_sail_point_experimental, limit, offset, count, filters, sorters)
print("The response of TaskManagementApi->get_task_status_list:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e)
```
@@ -323,11 +335,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.task_management_api import TaskManagementApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.models.task_status import TaskStatus
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task 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')
[sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | The JSONPatch payload used to update the object.
@@ -340,14 +356,14 @@ from pprint import pprint
try:
# Update Task Status by ID
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.update_task_status(id, x_sail_point_experimental, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =TaskManagementApi(api_client).update_task_status(id, x_sail_point_experimental, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_task_status(id, x_sail_point_experimental, Result)
# results = TaskManagementApi(api_client).update_task_status(id, x_sail_point_experimental, new_json_patch_operation)
print("The response of TaskManagementApi->update_task_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TaskManagementApi->update_task_status: %s\n" % e)
```

15
docs/tools/sdk/python/Reference/V2024/Methods/TenantApi.md
View File

@@ -55,22 +55,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.tenant_api import TenantApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.tenant import Tenant
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
try:
# Get Tenant Information.
api_response = api_instance.get_tenant(x_sail_point_experimental)
results =TenantApi(api_client).get_tenant(x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_tenant(x_sail_point_experimental)
# results = TenantApi(api_client).get_tenant(x_sail_point_experimental)
print("The response of TenantApi->get_tenant:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TenantApi->get_tenant: %s\n" % e)
```

76
docs/tools/sdk/python/Reference/V2024/Methods/TransformsApi.md
View File

@@ -62,11 +62,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.transforms_api import TransformsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.transform import Transform
from sailpoint.v2024.models.transform_read import TransformRead
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
transform = {
"name" : "Timestamp To Date",
"attributes" : "{}",
@@ -75,14 +79,14 @@ from pprint import pprint
try:
# Create transform
Result = transform.from_json(transform)
api_response = api_instance.create_transform(Result)
new_transform = Transform()
new_transform.from_json(transform)
results =TransformsApi(api_client).create_transform(new_transform)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_transform(Result)
# results = TransformsApi(api_client).create_transform(new_transform)
print("The response of TransformsApi->create_transform:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TransformsApi->create_transform: %s\n" % e)
```
@@ -124,19 +128,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.transforms_api import TransformsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to delete # str | ID of the transform to delete
try:
# Delete a transform
api_instance.delete_transform(id)
TransformsApi(api_client).delete_transform(id)
# Below is a request that includes all optional parameters
# api_instance.delete_transform(id)
except Exception as e:
# TransformsApi(api_client).delete_transform(id)
except Exception as e:
print("Exception when calling TransformsApi->delete_transform: %s\n" % e)
```
@@ -178,22 +185,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.transforms_api import TransformsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.transform_read import TransformRead
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to retrieve # str | ID of the transform to retrieve
try:
# Transform by ID
api_response = api_instance.get_transform(id)
results =TransformsApi(api_client).get_transform(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_transform(id)
# results = TransformsApi(api_client).get_transform(id)
print("The response of TransformsApi->get_transform:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TransformsApi->get_transform: %s\n" % e)
```
@@ -239,10 +249,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.transforms_api import TransformsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.transform_read import TransformRead
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
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)
count = False # bool | 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=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. (optional) (default to False) # bool | 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=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. (optional) (default to False)
@@ -252,13 +266,12 @@ from pprint import pprint
try:
# List transforms
api_response = api_instance.list_transforms()
results =TransformsApi(api_client).list_transforms()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_transforms(offset, limit, count, name, filters)
# results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters)
print("The response of TransformsApi->list_transforms:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TransformsApi->list_transforms: %s\n" % e)
```
@@ -301,11 +314,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.transforms_api import TransformsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.transform import Transform
from sailpoint.v2024.models.transform_read import TransformRead
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to update # str | ID of the transform to update
transform = {
"name" : "Timestamp To Date",
@@ -316,13 +333,12 @@ from pprint import pprint
try:
# Update a transform
api_response = api_instance.update_transform(id, )
results =TransformsApi(api_client).update_transform(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.update_transform(id, Result)
# results = TransformsApi(api_client).update_transform(id, new_transform)
print("The response of TransformsApi->update_transform:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TransformsApi->update_transform: %s\n" % e)
```

164
docs/tools/sdk/python/Reference/V2024/Methods/TriggersApi.md
View File

@@ -106,10 +106,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.triggers_api import TriggersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.complete_invocation import CompleteInvocation
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the invocation to complete. # str | The ID of the invocation to complete.
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')
complete_invocation = {
@@ -122,12 +126,12 @@ from pprint import pprint
try:
# Complete Trigger Invocation
Result = complete_invocation.from_json(complete_invocation)
api_instance.complete_trigger_invocation(id, x_sail_point_experimental, Result)
new_complete_invocation = CompleteInvocation()
new_complete_invocation.from_json(complete_invocation)
TriggersApi(api_client).complete_trigger_invocation(id, x_sail_point_experimental, new_complete_invocation)
# Below is a request that includes all optional parameters
# api_instance.complete_trigger_invocation(id, x_sail_point_experimental, Result)
except Exception as e:
# TriggersApi(api_client).complete_trigger_invocation(id, x_sail_point_experimental, new_complete_invocation)
except Exception as e:
print("Exception when calling TriggersApi->complete_trigger_invocation: %s\n" % e)
```
@@ -174,11 +178,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.triggers_api import TriggersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.subscription import Subscription
from sailpoint.v2024.models.subscription_post_request import SubscriptionPostRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
subscription_post_request = {
"filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]",
@@ -208,14 +216,14 @@ from pprint import pprint
try:
# Create a Subscription
Result = subscription_post_request.from_json(subscription_post_request)
api_response = api_instance.create_subscription(x_sail_point_experimental, Result)
new_subscription_post_request = SubscriptionPostRequest()
new_subscription_post_request.from_json(subscription_post_request)
results =TriggersApi(api_client).create_subscription(x_sail_point_experimental, new_subscription_post_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_subscription(x_sail_point_experimental, Result)
# results = TriggersApi(api_client).create_subscription(x_sail_point_experimental, new_subscription_post_request)
print("The response of TriggersApi->create_subscription:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TriggersApi->create_subscription: %s\n" % e)
```
@@ -261,20 +269,23 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.triggers_api import TriggersApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription 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')
try:
# Delete a Subscription
api_instance.delete_subscription(id, x_sail_point_experimental)
TriggersApi(api_client).delete_subscription(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_instance.delete_subscription(id, x_sail_point_experimental)
except Exception as e:
# TriggersApi(api_client).delete_subscription(id, x_sail_point_experimental)
except Exception as e:
print("Exception when calling TriggersApi->delete_subscription: %s\n" % e)
```
@@ -323,10 +334,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.triggers_api import TriggersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.subscription import Subscription
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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)
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)
@@ -337,13 +352,12 @@ from pprint import pprint
try:
# List Subscriptions
api_response = api_instance.list_subscriptions(x_sail_point_experimental, )
results =TriggersApi(api_client).list_subscriptions(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_subscriptions(x_sail_point_experimental, limit, offset, count, filters, sorters)
# results = TriggersApi(api_client).list_subscriptions(x_sail_point_experimental, limit, offset, count, filters, sorters)
print("The response of TriggersApi->list_subscriptions:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e)
```
@@ -394,10 +408,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.triggers_api import TriggersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.invocation_status import InvocationStatus
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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)
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)
@@ -408,13 +426,12 @@ from pprint import pprint
try:
# List Latest Invocation Statuses
api_response = api_instance.list_trigger_invocation_status(x_sail_point_experimental, )
results =TriggersApi(api_client).list_trigger_invocation_status(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_trigger_invocation_status(x_sail_point_experimental, limit, offset, count, filters, sorters)
# results = TriggersApi(api_client).list_trigger_invocation_status(x_sail_point_experimental, limit, offset, count, filters, sorters)
print("The response of TriggersApi->list_trigger_invocation_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e)
```
@@ -463,10 +480,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.triggers_api import TriggersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.trigger import Trigger
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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)
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)
@@ -477,13 +498,12 @@ from pprint import pprint
try:
# List Triggers
api_response = api_instance.list_triggers(x_sail_point_experimental, )
results =TriggersApi(api_client).list_triggers(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_triggers(x_sail_point_experimental, limit, offset, count, filters, sorters)
# results = TriggersApi(api_client).list_triggers(x_sail_point_experimental, limit, offset, count, filters, sorters)
print("The response of TriggersApi->list_triggers:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TriggersApi->list_triggers: %s\n" % e)
```
@@ -532,11 +552,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.triggers_api import TriggersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.subscription import Subscription
from sailpoint.v2024.models.subscription_patch_request_inner import SubscriptionPatchRequestInner
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | ID of the Subscription to patch # str | ID of the Subscription to patch
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')
[sailpoint.v2024.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] |
@@ -545,14 +569,14 @@ from pprint import pprint
try:
# Patch a Subscription
Result = subscription_patch_request_inner.from_json(subscription_patch_request_inner)
api_response = api_instance.patch_subscription(id, x_sail_point_experimental, Result)
new_subscription_patch_request_inner = SubscriptionPatchRequestInner()
new_subscription_patch_request_inner.from_json(subscription_patch_request_inner)
results =TriggersApi(api_client).patch_subscription(id, x_sail_point_experimental, new_subscription_patch_request_inner)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_subscription(id, x_sail_point_experimental, Result)
# results = TriggersApi(api_client).patch_subscription(id, x_sail_point_experimental, new_subscription_patch_request_inner)
print("The response of TriggersApi->patch_subscription:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TriggersApi->patch_subscription: %s\n" % e)
```
@@ -598,11 +622,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.triggers_api import TriggersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.invocation import Invocation
from sailpoint.v2024.models.test_invocation import TestInvocation
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
test_invocation = {
"input" : {
@@ -617,14 +645,14 @@ from pprint import pprint
try:
# Start a Test Invocation
Result = test_invocation.from_json(test_invocation)
api_response = api_instance.start_test_trigger_invocation(x_sail_point_experimental, Result)
new_test_invocation = TestInvocation()
new_test_invocation.from_json(test_invocation)
results =TriggersApi(api_client).start_test_trigger_invocation(x_sail_point_experimental, new_test_invocation)
# Below is a request that includes all optional parameters
# api_response = api_instance.start_test_trigger_invocation(x_sail_point_experimental, Result)
# results = TriggersApi(api_client).start_test_trigger_invocation(x_sail_point_experimental, new_test_invocation)
print("The response of TriggersApi->start_test_trigger_invocation:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e)
```
@@ -670,11 +698,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.triggers_api import TriggersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.validate_filter_input_dto import ValidateFilterInputDto
from sailpoint.v2024.models.validate_filter_output_dto import ValidateFilterOutputDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
validate_filter_input_dto = {
"filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]",
@@ -685,14 +717,14 @@ from pprint import pprint
try:
# Validate a Subscription Filter
Result = validate_filter_input_dto.from_json(validate_filter_input_dto)
api_response = api_instance.test_subscription_filter(x_sail_point_experimental, Result)
new_validate_filter_input_dto = ValidateFilterInputDto()
new_validate_filter_input_dto.from_json(validate_filter_input_dto)
results =TriggersApi(api_client).test_subscription_filter(x_sail_point_experimental, new_validate_filter_input_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.test_subscription_filter(x_sail_point_experimental, Result)
# results = TriggersApi(api_client).test_subscription_filter(x_sail_point_experimental, new_validate_filter_input_dto)
print("The response of TriggersApi->test_subscription_filter:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TriggersApi->test_subscription_filter: %s\n" % e)
```
@@ -748,11 +780,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.triggers_api import TriggersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.subscription import Subscription
from sailpoint.v2024.models.subscription_put_request import SubscriptionPutRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription 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')
subscription_put_request = {
@@ -782,14 +818,14 @@ from pprint import pprint
try:
# Update a Subscription
Result = subscription_put_request.from_json(subscription_put_request)
api_response = api_instance.update_subscription(id, x_sail_point_experimental, Result)
new_subscription_put_request = SubscriptionPutRequest()
new_subscription_put_request.from_json(subscription_put_request)
results =TriggersApi(api_client).update_subscription(id, x_sail_point_experimental, new_subscription_put_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_subscription(id, x_sail_point_experimental, Result)
# results = TriggersApi(api_client).update_subscription(id, x_sail_point_experimental, new_subscription_put_request)
print("The response of TriggersApi->update_subscription:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TriggersApi->update_subscription: %s\n" % e)
```

33
docs/tools/sdk/python/Reference/V2024/Methods/UIMetadataApi.md
View File

@@ -57,22 +57,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.ui_metadata_api import UIMetadataApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.tenant_ui_metadata_item_response import TenantUiMetadataItemResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
try:
# Get a tenant UI metadata
api_response = api_instance.get_tenant_ui_metadata(x_sail_point_experimental)
results =UIMetadataApi(api_client).get_tenant_ui_metadata(x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_tenant_ui_metadata(x_sail_point_experimental)
# results = UIMetadataApi(api_client).get_tenant_ui_metadata(x_sail_point_experimental)
print("The response of UIMetadataApi->get_tenant_ui_metadata:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling UIMetadataApi->get_tenant_ui_metadata: %s\n" % e)
```
@@ -118,11 +121,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.ui_metadata_api import UIMetadataApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.tenant_ui_metadata_item_response import TenantUiMetadataItemResponse
from sailpoint.v2024.models.tenant_ui_metadata_item_update_request import TenantUiMetadataItemUpdateRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
tenant_ui_metadata_item_update_request = {
"usernameEmptyText" : "Please provide your work email address...",
@@ -132,14 +139,14 @@ from pprint import pprint
try:
# Update tenant UI metadata
Result = tenant_ui_metadata_item_update_request.from_json(tenant_ui_metadata_item_update_request)
api_response = api_instance.set_tenant_ui_metadata(x_sail_point_experimental, Result)
new_tenant_ui_metadata_item_update_request = TenantUiMetadataItemUpdateRequest()
new_tenant_ui_metadata_item_update_request.from_json(tenant_ui_metadata_item_update_request)
results =UIMetadataApi(api_client).set_tenant_ui_metadata(x_sail_point_experimental, new_tenant_ui_metadata_item_update_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.set_tenant_ui_metadata(x_sail_point_experimental, Result)
# results = UIMetadataApi(api_client).set_tenant_ui_metadata(x_sail_point_experimental, new_tenant_ui_metadata_item_update_request)
print("The response of UIMetadataApi->set_tenant_ui_metadata:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling UIMetadataApi->set_tenant_ui_metadata: %s\n" % e)
```

51
docs/tools/sdk/python/Reference/V2024/Methods/VendorConnectorMappingsApi.md
View File

@@ -59,10 +59,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.vendor_connector_mappings_api import VendorConnectorMappingsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.vendor_connector_mapping import VendorConnectorMapping
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
vendor_connector_mapping = {
"createdAt" : "2024-03-13T12:56:19.391294Z",
"deletedAt" : {
@@ -89,14 +93,14 @@ from pprint import pprint
try:
# Create Vendor Connector Mapping
Result = vendor_connector_mapping.from_json(vendor_connector_mapping)
api_response = api_instance.create_vendor_connector_mapping(Result)
new_vendor_connector_mapping = VendorConnectorMapping()
new_vendor_connector_mapping.from_json(vendor_connector_mapping)
results =VendorConnectorMappingsApi(api_client).create_vendor_connector_mapping(new_vendor_connector_mapping)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_vendor_connector_mapping(Result)
# results = VendorConnectorMappingsApi(api_client).create_vendor_connector_mapping(new_vendor_connector_mapping)
print("The response of VendorConnectorMappingsApi->create_vendor_connector_mapping:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e)
```
@@ -139,11 +143,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.vendor_connector_mappings_api import VendorConnectorMappingsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.delete_vendor_connector_mapping200_response import DeleteVendorConnectorMapping200Response
from sailpoint.v2024.models.vendor_connector_mapping import VendorConnectorMapping
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
vendor_connector_mapping = {
"createdAt" : "2024-03-13T12:56:19.391294Z",
"deletedAt" : {
@@ -170,14 +178,14 @@ from pprint import pprint
try:
# Delete Vendor Connector Mapping
Result = vendor_connector_mapping.from_json(vendor_connector_mapping)
api_response = api_instance.delete_vendor_connector_mapping(Result)
new_vendor_connector_mapping = VendorConnectorMapping()
new_vendor_connector_mapping.from_json(vendor_connector_mapping)
results =VendorConnectorMappingsApi(api_client).delete_vendor_connector_mapping(new_vendor_connector_mapping)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_vendor_connector_mapping(Result)
# results = VendorConnectorMappingsApi(api_client).delete_vendor_connector_mapping(new_vendor_connector_mapping)
print("The response of VendorConnectorMappingsApi->delete_vendor_connector_mapping:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e)
```
@@ -217,21 +225,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.vendor_connector_mappings_api import VendorConnectorMappingsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.vendor_connector_mapping import VendorConnectorMapping
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Vendor Connector Mappings
api_response = api_instance.get_vendor_connector_mappings()
results =VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_vendor_connector_mappings()
# results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings()
print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e)
```

199
docs/tools/sdk/python/Reference/V2024/Methods/WorkItemsApi.md
View File

@@ -79,23 +79,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.work_items_api import WorkItemsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.work_items import WorkItems
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item.
try:
# Approve an Approval Item
api_response = api_instance.approve_approval_item(id, approval_item_id)
results =WorkItemsApi(api_client).approve_approval_item(id, approval_item_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.approve_approval_item(id, approval_item_id)
# results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id)
print("The response of WorkItemsApi->approve_approval_item:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e)
```
@@ -137,22 +140,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.work_items_api import WorkItemsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.work_items import WorkItems
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
try:
# Bulk approve Approval Items
api_response = api_instance.approve_approval_items_in_bulk(id)
results =WorkItemsApi(api_client).approve_approval_items_in_bulk(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.approve_approval_items_in_bulk(id)
# results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id)
print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e)
```
@@ -194,22 +200,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.work_items_api import WorkItemsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.work_items import WorkItems
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
try:
# Complete a Work Item
api_response = api_instance.complete_work_item(id)
results =WorkItemsApi(api_client).complete_work_item(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.complete_work_item(id)
# results = WorkItemsApi(api_client).complete_work_item(id)
print("The response of WorkItemsApi->complete_work_item:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e)
```
@@ -253,10 +262,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.work_items_api import WorkItemsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.work_items import WorkItems
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional)
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)
@@ -265,13 +278,12 @@ from pprint import pprint
try:
# Completed Work Items
api_response = api_instance.get_completed_work_items()
results =WorkItemsApi(api_client).get_completed_work_items()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_completed_work_items(owner_id, limit, offset, count)
# results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count)
print("The response of WorkItemsApi->get_completed_work_items:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e)
```
@@ -312,22 +324,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.work_items_api import WorkItemsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.work_items_count import WorkItemsCount
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
try:
# Count Completed Work Items
api_response = api_instance.get_count_completed_work_items()
results =WorkItemsApi(api_client).get_count_completed_work_items()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_count_completed_work_items(owner_id)
# results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id)
print("The response of WorkItemsApi->get_count_completed_work_items:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e)
```
@@ -368,22 +383,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.work_items_api import WorkItemsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.work_items_count import WorkItemsCount
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
try:
# Count Work Items
api_response = api_instance.get_count_work_items()
results =WorkItemsApi(api_client).get_count_work_items()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_count_work_items(owner_id)
# results = WorkItemsApi(api_client).get_count_work_items(owner_id)
print("The response of WorkItemsApi->get_count_work_items:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e)
```
@@ -424,22 +442,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.work_items_api import WorkItemsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.work_items import WorkItems
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item.
try:
# Get a Work Item
api_response = api_instance.get_work_item(id)
results =WorkItemsApi(api_client).get_work_item(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_work_item(id)
# results = WorkItemsApi(api_client).get_work_item(id)
print("The response of WorkItemsApi->get_work_item:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e)
```
@@ -480,22 +501,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.work_items_api import WorkItemsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.work_items_summary import WorkItemsSummary
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
try:
# Work Items Summary
api_response = api_instance.get_work_items_summary()
results =WorkItemsApi(api_client).get_work_items_summary()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_work_items_summary(owner_id)
# results = WorkItemsApi(api_client).get_work_items_summary(owner_id)
print("The response of WorkItemsApi->get_work_items_summary:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e)
```
@@ -539,10 +563,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.work_items_api import WorkItemsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.work_items import WorkItems
from sailpoint.v2024.rest import ApiException
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)
count = False # bool | 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=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. (optional) (default to False) # bool | 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=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. (optional) (default to False)
@@ -551,13 +579,12 @@ from pprint import pprint
try:
# List Work Items
api_response = api_instance.list_work_items()
results =WorkItemsApi(api_client).list_work_items()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_work_items(limit, offset, count, owner_id)
# results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id)
print("The response of WorkItemsApi->list_work_items:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e)
```
@@ -600,23 +627,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.work_items_api import WorkItemsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.work_items import WorkItems
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item.
try:
# Reject an Approval Item
api_response = api_instance.reject_approval_item(id, approval_item_id)
results =WorkItemsApi(api_client).reject_approval_item(id, approval_item_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.reject_approval_item(id, approval_item_id)
# results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id)
print("The response of WorkItemsApi->reject_approval_item:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e)
```
@@ -658,22 +688,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.work_items_api import WorkItemsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.work_items import WorkItems
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
try:
# Bulk reject Approval Items
api_response = api_instance.reject_approval_items_in_bulk(id)
results =WorkItemsApi(api_client).reject_approval_items_in_bulk(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.reject_approval_items_in_bulk(id)
# results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id)
print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e)
```
@@ -715,10 +748,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.work_items_api import WorkItemsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.work_item_forward import WorkItemForward
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
work_item_forward = {
"targetOwnerId" : "2c9180835d2e5168015d32f890ca1581",
@@ -728,12 +765,12 @@ from pprint import pprint
try:
# Forward a Work Item
Result = work_item_forward.from_json(work_item_forward)
api_instance.send_work_item_forward(id, Result)
new_work_item_forward = WorkItemForward()
new_work_item_forward.from_json(work_item_forward)
WorkItemsApi(api_client).send_work_item_forward(id, new_work_item_forward)
# Below is a request that includes all optional parameters
# api_instance.send_work_item_forward(id, Result)
except Exception as e:
# WorkItemsApi(api_client).send_work_item_forward(id, new_work_item_forward)
except Exception as e:
print("Exception when calling WorkItemsApi->send_work_item_forward: %s\n" % e)
```
@@ -776,23 +813,27 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.work_items_api import WorkItemsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.work_items import WorkItems
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
request_body = {fieldName=fieldValue} # Dict[str, object] | Account Selection Data map, keyed on fieldName # Dict[str, object] | Account Selection Data map, keyed on fieldName
try:
# Submit Account Selections
Result = request_body.from_json(request_body)
api_response = api_instance.submit_account_selection(id, Result)
new_request_body = RequestBody()
new_request_body.from_json(request_body)
results =WorkItemsApi(api_client).submit_account_selection(id, new_request_body)
# Below is a request that includes all optional parameters
# api_response = api_instance.submit_account_selection(id, Result)
# results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body)
print("The response of WorkItemsApi->submit_account_selection:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e)
```

142
docs/tools/sdk/python/Reference/V2024/Methods/WorkReassignmentApi.md
View File

@@ -73,11 +73,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.configuration_item_request import ConfigurationItemRequest
from sailpoint.v2024.models.configuration_item_response import ConfigurationItemResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
configuration_item_request = {
"endDate" : "2022-07-30T17:00:00Z",
@@ -89,14 +93,14 @@ from pprint import pprint
try:
# Create a Reassignment Configuration
Result = configuration_item_request.from_json(configuration_item_request)
api_response = api_instance.create_reassignment_configuration(x_sail_point_experimental, Result)
new_configuration_item_request = ConfigurationItemRequest()
new_configuration_item_request.from_json(configuration_item_request)
results =WorkReassignmentApi(api_client).create_reassignment_configuration(x_sail_point_experimental, new_configuration_item_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_reassignment_configuration(x_sail_point_experimental, Result)
# results = WorkReassignmentApi(api_client).create_reassignment_configuration(x_sail_point_experimental, new_configuration_item_request)
print("The response of WorkReassignmentApi->create_reassignment_configuration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkReassignmentApi->create_reassignment_configuration: %s\n" % e)
```
@@ -142,10 +146,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.config_type_enum import ConfigTypeEnum
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id
config_type = sailpoint.v2024.ConfigTypeEnum() # ConfigTypeEnum | # ConfigTypeEnum |
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')
@@ -153,11 +161,10 @@ from pprint import pprint
try:
# Delete Reassignment Configuration
api_instance.delete_reassignment_configuration(identity_id, config_type, x_sail_point_experimental)
WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id, config_type, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_instance.delete_reassignment_configuration(identity_id, config_type, x_sail_point_experimental)
except Exception as e:
# WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id, config_type, x_sail_point_experimental)
except Exception as e:
print("Exception when calling WorkReassignmentApi->delete_reassignment_configuration: %s\n" % e)
```
@@ -204,11 +211,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.config_type_enum import ConfigTypeEnum
from sailpoint.v2024.models.evaluate_response import EvaluateResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id
config_type = sailpoint.v2024.ConfigTypeEnum() # ConfigTypeEnum | Reassignment work type # ConfigTypeEnum | Reassignment work type
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')
@@ -219,13 +230,12 @@ from pprint import pprint
try:
# Evaluate Reassignment Configuration
api_response = api_instance.get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, )
results =WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, exclusion_filters)
# results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, exclusion_filters)
print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e)
```
@@ -269,22 +279,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.config_type import ConfigType
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
try:
# List Reassignment Config Types
api_response = api_instance.get_reassignment_config_types(x_sail_point_experimental)
results =WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_reassignment_config_types(x_sail_point_experimental)
# results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental)
print("The response of WorkReassignmentApi->get_reassignment_config_types:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e)
```
@@ -330,23 +343,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.configuration_response import ConfigurationResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = '2c91808781a71ddb0181b9090b5c504f' # str | unique identity id # str | unique identity 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')
try:
# Get Reassignment Configuration
api_response = api_instance.get_reassignment_configuration(identity_id, x_sail_point_experimental)
results =WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_reassignment_configuration(identity_id, x_sail_point_experimental)
# results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id, x_sail_point_experimental)
print("The response of WorkReassignmentApi->get_reassignment_configuration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkReassignmentApi->get_reassignment_configuration: %s\n" % e)
```
@@ -391,22 +407,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.tenant_configuration_response import TenantConfigurationResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
try:
# Get Tenant-wide Reassignment Configuration settings
api_response = api_instance.get_tenant_config_configuration(x_sail_point_experimental)
results =WorkReassignmentApi(api_client).get_tenant_config_configuration(x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_tenant_config_configuration(x_sail_point_experimental)
# results = WorkReassignmentApi(api_client).get_tenant_config_configuration(x_sail_point_experimental)
print("The response of WorkReassignmentApi->get_tenant_config_configuration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkReassignmentApi->get_tenant_config_configuration: %s\n" % e)
```
@@ -451,22 +470,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.configuration_response import ConfigurationResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
try:
# List Reassignment Configurations
api_response = api_instance.list_reassignment_configurations(x_sail_point_experimental)
results =WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.list_reassignment_configurations(x_sail_point_experimental)
# results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental)
print("The response of WorkReassignmentApi->list_reassignment_configurations:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e)
```
@@ -512,11 +534,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.configuration_item_request import ConfigurationItemRequest
from sailpoint.v2024.models.configuration_item_response import ConfigurationItemResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity 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')
configuration_item_request = {
@@ -529,14 +555,14 @@ from pprint import pprint
try:
# Update Reassignment Configuration
Result = configuration_item_request.from_json(configuration_item_request)
api_response = api_instance.put_reassignment_config(identity_id, x_sail_point_experimental, Result)
new_configuration_item_request = ConfigurationItemRequest()
new_configuration_item_request.from_json(configuration_item_request)
results =WorkReassignmentApi(api_client).put_reassignment_config(identity_id, x_sail_point_experimental, new_configuration_item_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_reassignment_config(identity_id, x_sail_point_experimental, Result)
# results = WorkReassignmentApi(api_client).put_reassignment_config(identity_id, x_sail_point_experimental, new_configuration_item_request)
print("The response of WorkReassignmentApi->put_reassignment_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkReassignmentApi->put_reassignment_config: %s\n" % e)
```
@@ -581,11 +607,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.work_reassignment_api import WorkReassignmentApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.tenant_configuration_request import TenantConfigurationRequest
from sailpoint.v2024.models.tenant_configuration_response import TenantConfigurationResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
tenant_configuration_request = {
"configDetails" : {
@@ -595,14 +625,14 @@ from pprint import pprint
try:
# Update Tenant-wide Reassignment Configuration settings
Result = tenant_configuration_request.from_json(tenant_configuration_request)
api_response = api_instance.put_tenant_configuration(x_sail_point_experimental, Result)
new_tenant_configuration_request = TenantConfigurationRequest()
new_tenant_configuration_request.from_json(tenant_configuration_request)
results =WorkReassignmentApi(api_client).put_tenant_configuration(x_sail_point_experimental, new_tenant_configuration_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_tenant_configuration(x_sail_point_experimental, Result)
# results = WorkReassignmentApi(api_client).put_tenant_configuration(x_sail_point_experimental, new_tenant_configuration_request)
print("The response of WorkReassignmentApi->put_tenant_configuration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e)
```

278
docs/tools/sdk/python/Reference/V2024/Methods/WorkflowsApi.md
View File

@@ -70,19 +70,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.workflows_api import WorkflowsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID
try:
# Cancel Workflow Execution by ID
api_instance.cancel_workflow_execution(id)
WorkflowsApi(api_client).cancel_workflow_execution(id)
# Below is a request that includes all optional parameters
# api_instance.cancel_workflow_execution(id)
except Exception as e:
# WorkflowsApi(api_client).cancel_workflow_execution(id)
except Exception as e:
print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e)
```
@@ -124,24 +127,27 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.workflows_api import WorkflowsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response
from sailpoint.v2024.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow
create_external_execute_workflow_request = sailpoint.v2024.CreateExternalExecuteWorkflowRequest() # CreateExternalExecuteWorkflowRequest | (optional)
try:
# Execute Workflow via External Trigger
api_response = api_instance.create_external_execute_workflow(id, )
results =WorkflowsApi(api_client).create_external_execute_workflow(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.create_external_execute_workflow(id, Result)
# results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request)
print("The response of WorkflowsApi->create_external_execute_workflow:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e)
```
@@ -182,23 +188,27 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.workflows_api import WorkflowsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.create_workflow_request import CreateWorkflowRequest
from sailpoint.v2024.models.workflow import Workflow
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
create_workflow_request = {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} # CreateWorkflowRequest |
try:
# Create Workflow
Result = create_workflow_request.from_json(create_workflow_request)
api_response = api_instance.create_workflow(Result)
new_create_workflow_request = CreateWorkflowRequest()
new_create_workflow_request.from_json(create_workflow_request)
results =WorkflowsApi(api_client).create_workflow(new_create_workflow_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_workflow(Result)
# results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request)
print("The response of WorkflowsApi->create_workflow:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e)
```
@@ -239,22 +249,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.workflows_api import WorkflowsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.workflow_o_auth_client import WorkflowOAuthClient
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow
try:
# Generate External Trigger OAuth Client
api_response = api_instance.create_workflow_external_trigger(id)
results =WorkflowsApi(api_client).create_workflow_external_trigger(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_workflow_external_trigger(id)
# results = WorkflowsApi(api_client).create_workflow_external_trigger(id)
print("The response of WorkflowsApi->create_workflow_external_trigger:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e)
```
@@ -295,19 +308,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.workflows_api import WorkflowsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow
try:
# Delete Workflow By Id
api_instance.delete_workflow(id)
WorkflowsApi(api_client).delete_workflow(id)
# Below is a request that includes all optional parameters
# api_instance.delete_workflow(id)
except Exception as e:
# WorkflowsApi(api_client).delete_workflow(id)
except Exception as e:
print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e)
```
@@ -348,22 +364,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.workflows_api import WorkflowsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.workflow import Workflow
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow
try:
# Get Workflow By Id
api_response = api_instance.get_workflow(id)
results =WorkflowsApi(api_client).get_workflow(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_workflow(id)
# results = WorkflowsApi(api_client).get_workflow(id)
print("The response of WorkflowsApi->get_workflow:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e)
```
@@ -405,21 +424,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.workflows_api import WorkflowsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID.
try:
# Get Workflow Execution
api_response = api_instance.get_workflow_execution(id)
results =WorkflowsApi(api_client).get_workflow_execution(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_workflow_execution(id)
# results = WorkflowsApi(api_client).get_workflow_execution(id)
print("The response of WorkflowsApi->get_workflow_execution:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e)
```
@@ -461,22 +483,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.workflows_api import WorkflowsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.workflow_execution_event import WorkflowExecutionEvent
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution
try:
# Get Workflow Execution History
api_response = api_instance.get_workflow_execution_history(id)
results =WorkflowsApi(api_client).get_workflow_execution_history(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_workflow_execution_history(id)
# results = WorkflowsApi(api_client).get_workflow_execution_history(id)
print("The response of WorkflowsApi->get_workflow_execution_history:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e)
```
@@ -532,10 +557,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.workflows_api import WorkflowsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.workflow_execution import WorkflowExecution
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow 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)
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)
@@ -545,13 +574,12 @@ from pprint import pprint
try:
# List Workflow Executions
api_response = api_instance.get_workflow_executions(id, )
results =WorkflowsApi(api_client).get_workflow_executions(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_workflow_executions(id, limit, offset, count, filters)
# results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters)
print("The response of WorkflowsApi->get_workflow_executions:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e)
```
@@ -593,23 +621,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.workflows_api import WorkflowsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner
from sailpoint.v2024.rest import ApiException
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)
try:
# List Complete Workflow Library
api_response = api_instance.list_complete_workflow_library()
results =WorkflowsApi(api_client).list_complete_workflow_library()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_complete_workflow_library(limit, offset)
# results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset)
print("The response of WorkflowsApi->list_complete_workflow_library:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e)
```
@@ -652,10 +683,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.workflows_api import WorkflowsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.workflow_library_action import WorkflowLibraryAction
from sailpoint.v2024.rest import ApiException
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)
filters = 'id eq \"sp:create-campaign\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional)
@@ -663,13 +698,12 @@ from pprint import pprint
try:
# List Workflow Library Actions
api_response = api_instance.list_workflow_library_actions()
results =WorkflowsApi(api_client).list_workflow_library_actions()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_workflow_library_actions(limit, offset, filters)
# results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters)
print("The response of WorkflowsApi->list_workflow_library_actions:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e)
```
@@ -707,21 +741,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.workflows_api import WorkflowsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.workflow_library_operator import WorkflowLibraryOperator
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Workflow Library Operators
api_response = api_instance.list_workflow_library_operators()
results =WorkflowsApi(api_client).list_workflow_library_operators()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_workflow_library_operators()
# results = WorkflowsApi(api_client).list_workflow_library_operators()
print("The response of WorkflowsApi->list_workflow_library_operators:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e)
```
@@ -764,10 +801,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.workflows_api import WorkflowsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.workflow_library_trigger import WorkflowLibraryTrigger
from sailpoint.v2024.rest import ApiException
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)
filters = 'id eq \"idn:identity-attributes-changed\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional)
@@ -775,13 +816,12 @@ from pprint import pprint
try:
# List Workflow Library Triggers
api_response = api_instance.list_workflow_library_triggers()
results =WorkflowsApi(api_client).list_workflow_library_triggers()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_workflow_library_triggers(limit, offset, filters)
# results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters)
print("The response of WorkflowsApi->list_workflow_library_triggers:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e)
```
@@ -819,21 +859,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.workflows_api import WorkflowsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.workflow import Workflow
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Workflows
api_response = api_instance.list_workflows()
results =WorkflowsApi(api_client).list_workflows()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_workflows()
# results = WorkflowsApi(api_client).list_workflows()
print("The response of WorkflowsApi->list_workflows:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e)
```
@@ -875,11 +918,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.workflows_api import WorkflowsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2024.models.workflow import Workflow
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow
[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}] # List[JsonPatchOperation] |
json_patch_operation = {
@@ -891,14 +938,14 @@ from pprint import pprint
try:
# Patch Workflow
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_workflow(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_workflow(id, Result)
# results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation)
print("The response of WorkflowsApi->patch_workflow:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e)
```
@@ -940,11 +987,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.workflows_api import WorkflowsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.workflow import Workflow
from sailpoint.v2024.models.workflow_body import WorkflowBody
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow
workflow_body = {
"owner" : {
@@ -988,14 +1039,14 @@ from pprint import pprint
try:
# Update Workflow
Result = workflow_body.from_json(workflow_body)
api_response = api_instance.put_workflow(id, Result)
new_workflow_body = WorkflowBody()
new_workflow_body.from_json(workflow_body)
results =WorkflowsApi(api_client).put_workflow(id, new_workflow_body)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_workflow(id, Result)
# results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body)
print("The response of WorkflowsApi->put_workflow:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e)
```
@@ -1037,24 +1088,27 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.workflows_api import WorkflowsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response
from sailpoint.v2024.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow
test_external_execute_workflow_request = sailpoint.v2024.TestExternalExecuteWorkflowRequest() # TestExternalExecuteWorkflowRequest | (optional)
try:
# Test Workflow via External Trigger
api_response = api_instance.test_external_execute_workflow(id, )
results =WorkflowsApi(api_client).test_external_execute_workflow(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.test_external_execute_workflow(id, Result)
# results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request)
print("The response of WorkflowsApi->test_external_execute_workflow:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e)
```
@@ -1098,24 +1152,28 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.workflows_api import WorkflowsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.test_workflow200_response import TestWorkflow200Response
from sailpoint.v2024.models.test_workflow_request import TestWorkflowRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow
test_workflow_request = {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} # TestWorkflowRequest |
try:
# Test Workflow By Id
Result = test_workflow_request.from_json(test_workflow_request)
api_response = api_instance.test_workflow(id, Result)
new_test_workflow_request = TestWorkflowRequest()
new_test_workflow_request.from_json(test_workflow_request)
results =WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.test_workflow(id, Result)
# results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request)
print("The response of WorkflowsApi->test_workflow:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e)
```