diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccessModelMetadataApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccessModelMetadataApi.md index e8950c29e..b4c286426 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccessModelMetadataApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccessModelMetadataApi.md @@ -64,22 +64,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.access_model_metadata_api import AccessModelMetadataApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.attribute_dto import AttributeDTO -from sailpoint.beta.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. try: # Get Access Model Metadata Attribute - api_response = api_instance.get_access_model_metadata_attribute(key) - + results =AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key) # Below is a request that includes all optional parameters - # api_response = api_instance.get_access_model_metadata_attribute(key) + # results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key) 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) ``` @@ -121,23 +124,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.access_model_metadata_api import AccessModelMetadataApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.attribute_value_dto import AttributeValueDTO -from sailpoint.beta.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. try: # Get Access Model Metadata Value - api_response = api_instance.get_access_model_metadata_attribute_value(key, value) - + results =AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key, value) # Below is a request that includes all optional parameters - # api_response = api_instance.get_access_model_metadata_attribute_value(key, value) + # results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key, value) 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) ``` @@ -178,22 +184,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.access_model_metadata_api import AccessModelMetadataApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.attribute_dto import AttributeDTO -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: 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() - + results =AccessModelMetadataApi(api_client).list_access_model_metadata_attribute() # Below is a request that includes all optional parameters - # api_response = api_instance.list_access_model_metadata_attribute(filters) + # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(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) ``` @@ -234,22 +243,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.access_model_metadata_api import AccessModelMetadataApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.attribute_value_dto import AttributeValueDTO -from sailpoint.beta.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. try: # List Access Model Metadata Values - api_response = api_instance.list_access_model_metadata_attribute_value(key) - + results =AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key) # Below is a request that includes all optional parameters - # api_response = api_instance.list_access_model_metadata_attribute_value(key) + # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key) 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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md index 28602c948..6a8377e7c 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md @@ -94,10 +94,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.access_profiles_api import AccessProfilesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.access_profile import AccessProfile -from sailpoint.beta.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.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.access_profiles_api import AccessProfilesApi +from sailpoint.beta.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) ``` @@ -295,11 +302,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.access_profiles_api import AccessProfilesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.access_profile_bulk_delete_request import AccessProfileBulkDeleteRequest from sailpoint.beta.models.access_profile_bulk_delete_response import AccessProfileBulkDeleteResponse -from sailpoint.beta.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 @@ -307,14 +318,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) ``` @@ -355,22 +366,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.access_profiles_api import AccessProfilesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.access_profile import AccessProfile -from sailpoint.beta.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) ``` @@ -417,10 +431,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.access_profiles_api import AccessProfilesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.entitlement import Entitlement -from sailpoint.beta.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) @@ -431,13 +449,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) ``` @@ -486,10 +503,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.access_profiles_api import AccessProfilesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.access_profile import AccessProfile -from sailpoint.beta.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) @@ -502,13 +523,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) ``` @@ -555,11 +575,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.access_profiles_api import AccessProfilesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.access_profile import AccessProfile from sailpoint.beta.models.json_patch_operation import JsonPatchOperation -from sailpoint.beta.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 = { @@ -571,14 +595,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) ``` @@ -626,25 +650,29 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.access_profiles_api import AccessProfilesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.access_profile_bulk_update_request_inner import AccessProfileBulkUpdateRequestInner from sailpoint.beta.models.access_profile_update_item import AccessProfileUpdateItem -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: [{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] | 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(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(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(Result) + # results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestApprovalsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestApprovalsApi.md index 647f131a2..8fe344ea9 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestApprovalsApi.md @@ -75,10 +75,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.comment_dto import CommentDto -from sailpoint.beta.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 = { "author" : { @@ -92,14 +96,14 @@ from pprint import pprint try: # Approve Access Request Approval - Result = comment_dto.from_json(comment_dto) - api_response = api_instance.approve_access_request(approval_id, Result) - + new_comment_dto = CommentDto() + new_comment_dto.from_json(comment_dto) + results =AccessRequestApprovalsApi(api_client).approve_access_request(approval_id, new_comment_dto) # 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) ``` @@ -142,10 +146,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.forward_approval_dto import ForwardApprovalDto -from sailpoint.beta.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" : "newOwnerId", @@ -154,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) ``` @@ -203,23 +211,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.approval_summary import ApprovalSummary -from sailpoint.beta.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) ``` @@ -264,10 +275,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.completed_approval import CompletedApproval -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: owner_id = 'owner_id_example' # 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) @@ -278,13 +293,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) ``` @@ -329,10 +343,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.pending_approval import PendingApproval -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: owner_id = 'owner_id_example' # 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) @@ -343,13 +361,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) ``` @@ -392,10 +409,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.comment_dto import CommentDto -from sailpoint.beta.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 = { "author" : { @@ -409,14 +430,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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestIdentityMetricsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestIdentityMetricsApi.md index 300667fc2..a625edb57 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestIdentityMetricsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestIdentityMetricsApi.md @@ -57,9 +57,13 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.access_request_identity_metrics_api import AccessRequestIdentityMetricsApi +from sailpoint.beta.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. @@ -67,13 +71,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) - + results =AccessRequestIdentityMetricsApi(api_client).get_access_request_identity_metrics(identity_id, requested_object_id, type) # Below is a request that includes all optional parameters - # api_response = api_instance.get_access_request_identity_metrics(identity_id, requested_object_id, type) + # results = AccessRequestIdentityMetricsApi(api_client).get_access_request_identity_metrics(identity_id, requested_object_id, type) 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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md index 009777257..94a75512a 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md @@ -73,10 +73,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.access_requests_api import AccessRequestsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.cancel_access_request import CancelAccessRequest -from sailpoint.beta.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." @@ -84,14 +88,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) ``` @@ -143,10 +147,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.access_requests_api import AccessRequestsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.close_access_request import CloseAccessRequest -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: close_access_request = { "executionStatus" : "Terminated", "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], @@ -156,14 +164,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(Result) - + new_close_access_request = CloseAccessRequest() + new_close_access_request.from_json(close_access_request) + results =AccessRequestsApi(api_client).close_access_request(new_close_access_request) # Below is a request that includes all optional parameters - # api_response = api_instance.close_access_request(Result) + # results = AccessRequestsApi(api_client).close_access_request(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) ``` @@ -234,11 +242,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.access_requests_api import AccessRequestsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.access_request import AccessRequest from sailpoint.beta.models.access_request_response import AccessRequestResponse -from sailpoint.beta.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" : { @@ -296,14 +308,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) ``` @@ -341,21 +353,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.access_requests_api import AccessRequestsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.access_request_config import AccessRequestConfig -from sailpoint.beta.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) ``` @@ -407,10 +422,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.access_requests_api import AccessRequestsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.requested_item_status import RequestedItemStatus -from sailpoint.beta.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) @@ -425,13 +444,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) ``` @@ -472,10 +490,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.access_requests_api import AccessRequestsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.access_request_config import AccessRequestConfig -from sailpoint.beta.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, @@ -505,14 +527,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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccountActivitiesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccountActivitiesApi.md index 83afa920e..f776b7697 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccountActivitiesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccountActivitiesApi.md @@ -86,22 +86,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.account_activities_api import AccountActivitiesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.cancelable_account_activity import CancelableAccountActivity -from sailpoint.beta.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 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) ``` @@ -150,10 +153,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.account_activities_api import AccountActivitiesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.cancelable_account_activity import CancelableAccountActivity -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: requested_for = 'requested_for_example' # 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 = 'requested_by_example' # 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 = 'regarding_identity_example' # 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) @@ -167,13 +174,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, type, limit, offset, count, filters, sorters) + # results = AccountActivitiesApi(api_client).list_account_activities(requested_for, requested_by, regarding_identity, type, 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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccountAggregationsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccountAggregationsApi.md index b4eaf5759..084e470ee 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccountAggregationsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccountAggregationsApi.md @@ -69,22 +69,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.account_aggregations_api import AccountAggregationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.account_aggregation_status import AccountAggregationStatus -from sailpoint.beta.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 try: # In-progress Account Aggregation status - api_response = api_instance.get_account_aggregation_status(id) - + results =AccountAggregationsApi(api_client).get_account_aggregation_status(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_account_aggregation_status(id) + # results = AccountAggregationsApi(api_client).get_account_aggregation_status(id) 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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccountUsagesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccountUsagesApi.md index f69a3f402..3b0c9b97b 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccountUsagesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccountUsagesApi.md @@ -58,10 +58,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.account_usages_api import AccountUsagesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.account_usage import AccountUsage -from sailpoint.beta.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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccountsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccountsApi.md index 373785afb..839aad28f 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccountsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccountsApi.md @@ -104,11 +104,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.account_attributes_create import AccountAttributesCreate from sailpoint.beta.models.accounts_async_result import AccountsAsyncResult -from sailpoint.beta.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) ``` @@ -175,22 +179,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.accounts_async_result import AccountsAsyncResult -from sailpoint.beta.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) ``` @@ -237,22 +244,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.task_result_dto import TaskResultDto -from sailpoint.beta.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 try: # Remove Account - api_response = api_instance.delete_account_async(id) - + results =AccountsApi(api_client).delete_account_async(id) # Below is a request that includes all optional parameters - # api_response = api_instance.delete_account_async(id) + # results = AccountsApi(api_client).delete_account_async(id) 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) ``` @@ -296,11 +306,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.account_toggle_request import AccountToggleRequest from sailpoint.beta.models.accounts_async_result import AccountsAsyncResult -from sailpoint.beta.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, @@ -309,14 +323,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) ``` @@ -358,21 +372,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.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. try: # Disable IDN Account for Identity - api_response = api_instance.disable_account_for_identity(id) - + results =AccountsApi(api_client).disable_account_for_identity(id) # Below is a request that includes all optional parameters - # api_response = api_instance.disable_account_for_identity(id) + # results = AccountsApi(api_client).disable_account_for_identity(id) 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) ``` @@ -413,25 +430,29 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.bulk_identities_accounts_response import BulkIdentitiesAccountsResponse from sailpoint.beta.models.identities_accounts_bulk_request import IdentitiesAccountsBulkRequest -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: identities_accounts_bulk_request = { "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] } # IdentitiesAccountsBulkRequest | 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(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(new_identities_accounts_bulk_request) # Below is a request that includes all optional parameters - # api_response = api_instance.disable_accounts_for_identities(Result) + # results = AccountsApi(api_client).disable_accounts_for_identities(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) ``` @@ -475,11 +496,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.account_toggle_request import AccountToggleRequest from sailpoint.beta.models.accounts_async_result import AccountsAsyncResult -from sailpoint.beta.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, @@ -488,14 +513,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) ``` @@ -537,21 +562,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.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. try: # Enable IDN Account for Identity - api_response = api_instance.enable_account_for_identity(id) - + results =AccountsApi(api_client).enable_account_for_identity(id) # Below is a request that includes all optional parameters - # api_response = api_instance.enable_account_for_identity(id) + # results = AccountsApi(api_client).enable_account_for_identity(id) 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) ``` @@ -592,25 +620,29 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.bulk_identities_accounts_response import BulkIdentitiesAccountsResponse from sailpoint.beta.models.identities_accounts_bulk_request import IdentitiesAccountsBulkRequest -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: identities_accounts_bulk_request = { "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] } # IdentitiesAccountsBulkRequest | 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(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(new_identities_accounts_bulk_request) # Below is a request that includes all optional parameters - # api_response = api_instance.enable_accounts_for_identities(Result) + # results = AccountsApi(api_client).enable_accounts_for_identities(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) ``` @@ -653,22 +685,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.account import Account -from sailpoint.beta.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) ``` @@ -714,10 +749,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.entitlement import Entitlement -from sailpoint.beta.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 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) @@ -726,13 +765,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, offset, limit, count) + # results = AccountsApi(api_client).get_account_entitlements(id, offset, limit, 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) ``` @@ -778,10 +816,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.account import Account -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: detail_level = 'FULL' # str | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) # str | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` 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) @@ -792,13 +834,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(detail_level, limit, offset, count, filters, sorters) + # results = AccountsApi(api_client).list_accounts(detail_level, limit, offset, count, 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) ``` @@ -848,11 +889,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.account_attributes import AccountAttributes from sailpoint.beta.models.accounts_async_result import AccountsAsyncResult -from sailpoint.beta.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" : { @@ -866,14 +911,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) ``` @@ -916,22 +961,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.accounts_async_result import AccountsAsyncResult -from sailpoint.beta.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) ``` @@ -976,11 +1024,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.account_unlock_request import AccountUnlockRequest from sailpoint.beta.models.accounts_async_result import AccountsAsyncResult -from sailpoint.beta.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, @@ -990,14 +1042,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) ``` @@ -1051,9 +1103,13 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.accounts_api import AccountsApi +from sailpoint.beta.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 = {Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}} # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. request_body = {Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}} # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. @@ -1061,14 +1117,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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ApplicationDiscoveryApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ApplicationDiscoveryApi.md index 17507558d..9672088e8 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/ApplicationDiscoveryApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ApplicationDiscoveryApi.md @@ -58,19 +58,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.application_discovery_api import ApplicationDiscoveryApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '123e4567-e89b-12d3-a456-426655440000' # str | Discovered application's ID. # str | Discovered application's ID. try: # Get Discovered Application by ID - api_instance.get_discovered_application_by_id(id) - + ApplicationDiscoveryApi(api_client).get_discovered_application_by_id(id) # Below is a request that includes all optional parameters - # api_instance.get_discovered_application_by_id(id) - except Exception as e: + # ApplicationDiscoveryApi(api_client).get_discovered_application_by_id(id) + except Exception as e: print("Exception when calling ApplicationDiscoveryApi->get_discovered_application_by_id: %s\n" % e) ``` @@ -116,10 +119,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.application_discovery_api import ApplicationDiscoveryApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.get_discovered_applications200_response_inner import GetDiscoveredApplications200ResponseInner -from sailpoint.beta.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) @@ -129,13 +136,12 @@ from pprint import pprint try: # Retrieve 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) ``` @@ -176,21 +182,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.application_discovery_api import ApplicationDiscoveryApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.manual_discover_applications_template import ManualDiscoverApplicationsTemplate -from sailpoint.beta.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) ``` @@ -233,10 +242,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.application_discovery_api import ApplicationDiscoveryApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.json_patch_operations import JsonPatchOperations -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '123e4567-e89b-12d3-a456-426655440000' # str | Discovered application's ID. # str | Discovered application's ID. [{op=replace, path=/dismissed, value=true}] # List[JsonPatchOperations] | (optional) json_patch_operations = { @@ -249,11 +262,10 @@ from pprint import pprint try: # Patch Discovered Application by ID - api_instance.patch_discovered_application_by_id(id, ) - + ApplicationDiscoveryApi(api_client).patch_discovered_application_by_id(id, ) # Below is a request that includes all optional parameters - # api_instance.patch_discovered_application_by_id(id, Result) - except Exception as e: + # ApplicationDiscoveryApi(api_client).patch_discovered_application_by_id(id, new_json_patch_operations) + except Exception as e: print("Exception when calling ApplicationDiscoveryApi->patch_discovered_application_by_id: %s\n" % e) ``` @@ -295,19 +307,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.application_discovery_api import ApplicationDiscoveryApi +from sailpoint.beta.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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ApprovalsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ApprovalsApi.md index e4d39c57e..fab87f4ab 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/ApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ApprovalsApi.md @@ -55,22 +55,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.approvals_api import ApprovalsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.approval import Approval -from sailpoint.beta.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 to be returned. # str | ID of the approval that to be returned. try: # Get Approval - api_response = api_instance.get_approval(id) - + results =ApprovalsApi(api_client).get_approval(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_approval(id) + # results = ApprovalsApi(api_client).get_approval(id) 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) ``` @@ -114,10 +117,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.approvals_api import ApprovalsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.approval import Approval -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: 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) filters = 'filters=status eq PENDING' # 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* **referenceType**: *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* **referenceType**: *eq* (optional) @@ -125,13 +132,12 @@ from pprint import pprint try: # Get Approvals - api_response = api_instance.get_approvals() - + results =ApprovalsApi(api_client).get_approvals() # Below is a request that includes all optional parameters - # api_response = api_instance.get_approvals(mine, requester_id, filters) + # results = ApprovalsApi(api_client).get_approvals(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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AppsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AppsApi.md index af8ada4fc..2854d8945 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AppsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AppsApi.md @@ -66,11 +66,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.source_app import SourceApp from sailpoint.beta.models.source_app_create_dto import SourceAppCreateDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_app_create_dto = { "name" : "my app", "description" : "the source app for engineers", @@ -84,14 +88,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(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(new_source_app_create_dto) # Below is a request that includes all optional parameters - # api_response = api_instance.create_source_app(Result) + # results = AppsApi(api_client).create_source_app(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) ``` @@ -134,10 +138,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.access_profile_details import AccessProfileDetails -from sailpoint.beta.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 request_body = ['request_body_example'] # List[str] | request_body = ['request_body_example'] # List[str] | @@ -146,14 +154,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, 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, 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, Result, limit) + # results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, 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) ``` @@ -194,22 +202,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.source_app import SourceApp -from sailpoint.beta.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. try: # Delete source app by ID - api_response = api_instance.delete_source_app(id) - + results =AppsApi(api_client).delete_source_app(id) # Below is a request that includes all optional parameters - # api_response = api_instance.delete_source_app(id) + # results = AppsApi(api_client).delete_source_app(id) 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) ``` @@ -251,22 +262,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.source_app import SourceApp -from sailpoint.beta.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 try: # Get source app by ID - api_response = api_instance.get_source_app(id) - + results =AppsApi(api_client).get_source_app(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_app(id) + # results = AppsApi(api_client).get_source_app(id) 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) ``` @@ -310,10 +324,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.access_profile_details import AccessProfileDetails -from sailpoint.beta.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 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) @@ -322,13 +340,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, ) - + results =AppsApi(api_client).list_access_profiles_for_source_app(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.list_access_profiles_for_source_app(id, limit, offset, filters) + # results = AppsApi(api_client).list_access_profiles_for_source_app(id, 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) ``` @@ -375,10 +392,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.source_app import SourceApp -from sailpoint.beta.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) 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) 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) @@ -388,13 +409,12 @@ from pprint import pprint try: # List all source apps - api_response = api_instance.list_all_source_app() - + results =AppsApi(api_client).list_all_source_app() # Below is a request that includes all optional parameters - # api_response = api_instance.list_all_source_app(limit, count, offset, sorters, filters) + # results = AppsApi(api_client).list_all_source_app(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) ``` @@ -439,10 +459,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.user_app import UserApp -from sailpoint.beta.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* 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) @@ -451,13 +475,12 @@ from pprint import pprint try: # List all user apps - api_response = api_instance.list_all_user_apps(filters, ) - + results =AppsApi(api_client).list_all_user_apps(filters, ) # Below is a request that includes all optional parameters - # api_response = api_instance.list_all_user_apps(filters, limit, count, offset) + # results = AppsApi(api_client).list_all_user_apps(filters, 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) ``` @@ -502,10 +525,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.source_app import SourceApp -from sailpoint.beta.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) 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) 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) @@ -515,13 +542,12 @@ from pprint import pprint try: # List assigned source apps - api_response = api_instance.list_assigned_source_app() - + results =AppsApi(api_client).list_assigned_source_app() # Below is a request that includes all optional parameters - # api_response = api_instance.list_assigned_source_app(limit, count, offset, sorters, filters) + # results = AppsApi(api_client).list_assigned_source_app(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) ``` @@ -565,10 +591,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.app_account_details import AppAccountDetails -from sailpoint.beta.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 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) @@ -577,13 +607,12 @@ from pprint import pprint try: # List available accounts for user app - api_response = api_instance.list_available_accounts_for_user_app(id, ) - + results =AppsApi(api_client).list_available_accounts_for_user_app(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.list_available_accounts_for_user_app(id, limit, count, offset) + # results = AppsApi(api_client).list_available_accounts_for_user_app(id, limit, count, offset) 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) ``` @@ -628,10 +657,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.source_app import SourceApp -from sailpoint.beta.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) 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) 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) @@ -641,13 +674,12 @@ from pprint import pprint try: # List available source apps - api_response = api_instance.list_available_source_apps() - + results =AppsApi(api_client).list_available_source_apps() # Below is a request that includes all optional parameters - # api_response = api_instance.list_available_source_apps(limit, count, offset, sorters, filters) + # results = AppsApi(api_client).list_available_source_apps(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) ``` @@ -691,10 +723,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.user_app import UserApp -from sailpoint.beta.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) 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) 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) @@ -703,13 +739,12 @@ from pprint import pprint try: # List owned user apps - api_response = api_instance.list_owned_user_apps() - + results =AppsApi(api_client).list_owned_user_apps() # Below is a request that includes all optional parameters - # api_response = api_instance.list_owned_user_apps(limit, count, offset, filters) + # results = AppsApi(api_client).list_owned_user_apps(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) ``` @@ -754,11 +789,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.json_patch_operation import JsonPatchOperation from sailpoint.beta.models.source_app_patch_dto import SourceAppPatchDto -from sailpoint.beta.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 [{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}] # List[JsonPatchOperation] | (optional) json_patch_operation = { @@ -771,13 +810,12 @@ from pprint import pprint try: # Patch source app by ID - api_response = api_instance.patch_source_app(id, ) - + results =AppsApi(api_client).patch_source_app(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_source_app(id, Result) + # results = AppsApi(api_client).patch_source_app(id, 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) ``` @@ -821,11 +859,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.json_patch_operation import JsonPatchOperation from sailpoint.beta.models.user_app import UserApp -from sailpoint.beta.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 [sailpoint.beta.JsonPatchOperation()] # List[JsonPatchOperation] | (optional) json_patch_operation = { @@ -838,13 +880,12 @@ from pprint import pprint try: # Patch user app by ID - api_response = api_instance.patch_user_app(id, ) - + results =AppsApi(api_client).patch_user_app(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_user_app(id, Result) + # results = AppsApi(api_client).patch_user_app(id, 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) ``` @@ -888,10 +929,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.apps_api import AppsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.source_app_bulk_update_request import SourceAppBulkUpdateRequest -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_app_bulk_update_request = { "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], "jsonPatch" : [ { @@ -908,11 +953,10 @@ from pprint import pprint try: # Bulk update source apps - api_instance.update_source_apps_in_bulk() - + AppsApi(api_client).update_source_apps_in_bulk() # Below is a request that includes all optional parameters - # api_instance.update_source_apps_in_bulk(Result) - except Exception as e: + # AppsApi(api_client).update_source_apps_in_bulk(new_source_app_bulk_update_request) + except Exception as e: print("Exception when calling AppsApi->update_source_apps_in_bulk: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AuthProfileApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AuthProfileApi.md index a868f1507..f25b5e3d0 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AuthProfileApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AuthProfileApi.md @@ -60,22 +60,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.auth_profile_api import AuthProfileApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.auth_profile import AuthProfile -from sailpoint.beta.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 get. # str | ID of the Auth Profile to get. try: # Get Auth Profile. - api_response = api_instance.get_profile_config(id) - + results =AuthProfileApi(api_client).get_profile_config(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_profile_config(id) + # results = AuthProfileApi(api_client).get_profile_config(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) ``` @@ -113,21 +116,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.auth_profile_api import AuthProfileApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.auth_profile_summary import AuthProfileSummary -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # Get list of Auth Profiles. - api_response = api_instance.get_profile_config_list() - + results =AuthProfileApi(api_client).get_profile_config_list() # Below is a request that includes all optional parameters - # api_response = api_instance.get_profile_config_list() + # results = AuthProfileApi(api_client).get_profile_config_list() 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) ``` @@ -170,11 +176,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.auth_profile_api import AuthProfileApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.auth_profile import AuthProfile from sailpoint.beta.models.json_patch_operation import JsonPatchOperation -from sailpoint.beta.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. [sailpoint.beta.JsonPatchOperation()] # List[JsonPatchOperation] | json_patch_operation = { @@ -186,14 +196,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, Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =AuthProfileApi(api_client).patch_profile_config(id, new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_profile_config(id, Result) + # results = AuthProfileApi(api_client).patch_profile_config(id, 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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/CertificationCampaignsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/CertificationCampaignsApi.md index 7d4d74b48..2627a70d2 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/CertificationCampaignsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/CertificationCampaignsApi.md @@ -154,10 +154,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.complete_campaign_options import CompleteCampaignOptions -from sailpoint.beta.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. complete_campaign_options = { "autoCompleteAction" : "REVOKE" @@ -166,13 +170,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_complete_campaign_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) ``` @@ -219,10 +222,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.campaign import Campaign -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: campaign = { "totalCertifications" : 100, "sourcesWithOrphanEntitlements" : [ { @@ -335,14 +342,14 @@ from pprint import pprint try: # Create 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) ``` @@ -389,10 +396,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.campaign_template import CampaignTemplate -from sailpoint.beta.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", @@ -520,14 +531,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) ``` @@ -575,19 +586,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.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) ``` @@ -635,19 +649,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.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) ``` @@ -695,24 +712,28 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.delete_campaigns_request import DeleteCampaignsRequest -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: delete_campaigns_request = { "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] } # DeleteCampaignsRequest | IDs of the campaigns to delete. try: # Delete Campaigns - Result = delete_campaigns_request.from_json(delete_campaigns_request) - api_response = api_instance.delete_campaigns(Result) - + new_delete_campaigns_request = DeleteCampaignsRequest() + new_delete_campaigns_request.from_json(delete_campaigns_request) + results =CertificationCampaignsApi(api_client).delete_campaigns(new_delete_campaigns_request) # Below is a request that includes all optional parameters - # api_response = api_instance.delete_campaigns(Result) + # results = CertificationCampaignsApi(api_client).delete_campaigns(new_delete_campaigns_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) ``` @@ -764,10 +785,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner -from sailpoint.beta.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) @@ -778,13 +803,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) ``` @@ -832,22 +856,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.slimcampaign import Slimcampaign -from sailpoint.beta.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. 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) + # results = CertificationCampaignsApi(api_client).get_campaign(id) 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) ``` @@ -895,22 +922,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.campaign_report import CampaignReport -from sailpoint.beta.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) ``` @@ -954,21 +984,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.campaign_reports_config import CampaignReportsConfig -from sailpoint.beta.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) ``` @@ -1016,22 +1049,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.campaign_template import CampaignTemplate -from sailpoint.beta.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) ``` @@ -1079,22 +1115,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.schedule import Schedule -from sailpoint.beta.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) ``` @@ -1147,10 +1186,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.campaign_template import CampaignTemplate -from sailpoint.beta.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) @@ -1160,13 +1203,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) ``` @@ -1215,11 +1257,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.admin_review_reassign import AdminReviewReassign from sailpoint.beta.models.certification_task import CertificationTask -from sailpoint.beta.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" ], @@ -1232,14 +1278,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) ``` @@ -1288,11 +1334,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.campaign_template import CampaignTemplate from sailpoint.beta.models.json_patch_operation import JsonPatchOperation -from sailpoint.beta.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 = { @@ -1304,14 +1354,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) ``` @@ -1358,24 +1408,28 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.campaign_reports_config import CampaignReportsConfig -from sailpoint.beta.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) ``` @@ -1425,10 +1479,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.schedule import Schedule -from sailpoint.beta.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" : { @@ -1454,11 +1512,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) ``` @@ -1507,10 +1564,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.activate_campaign_options import ActivateCampaignOptions -from sailpoint.beta.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" @@ -1519,13 +1580,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) ``` @@ -1573,21 +1633,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.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) ``` @@ -1636,23 +1699,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.report_type import ReportType -from sailpoint.beta.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.beta.ReportType() # ReportType | Type of report to run. # ReportType | Type of 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) ``` @@ -1711,22 +1777,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.campaign_reference import CampaignReference -from sailpoint.beta.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) ``` @@ -1775,10 +1844,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.slimcampaign import Slimcampaign -from sailpoint.beta.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 being modified. # str | ID of the campaign being modified. request_body = [{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}] # List[object] | 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 request_body = [{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}] # List[object] | 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 @@ -1786,14 +1859,14 @@ from pprint import pprint try: # Update a Campaign - Result = request_body.from_json(request_body) - api_response = api_instance.update_campaign(id, Result) - + new_request_body = RequestBody() + new_request_body.from_json(request_body) + results =CertificationCampaignsApi(api_client).update_campaign(id, new_request_body) # 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_request_body) 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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/CertificationsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/CertificationsApi.md index c0f9885ad..fbd49c7c6 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/CertificationsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/CertificationsApi.md @@ -79,10 +79,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certifications_api import CertificationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.permission_dto import PermissionDto -from sailpoint.beta.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* 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: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (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* 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: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (optional) @@ -93,13 +97,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) ``` @@ -141,22 +144,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certifications_api import CertificationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_certification_task import IdentityCertificationTask -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'id_example' # str | The identity campaign certification ID # str | The identity campaign certification ID try: # Pending Certification Tasks - api_response = api_instance.get_identity_certification_pending_tasks(id) - + results =CertificationsApi(api_client).get_identity_certification_pending_tasks(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_certification_pending_tasks(id) + # results = CertificationsApi(api_client).get_identity_certification_pending_tasks(id) print("The response of CertificationsApi->get_identity_certification_pending_tasks:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_pending_tasks: %s\n" % e) ``` @@ -199,23 +205,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certifications_api import CertificationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_certification_task import IdentityCertificationTask -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'id_example' # str | The identity campaign certification ID # str | The identity campaign certification ID task_id = 'task_id_example' # str | The certification task ID # str | The certification task ID try: # Certification Task Status - api_response = api_instance.get_identity_certification_task_status(id, task_id) - + results =CertificationsApi(api_client).get_identity_certification_task_status(id, task_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_certification_task_status(id, task_id) + # results = CertificationsApi(api_client).get_identity_certification_task_status(id, task_id) print("The response of CertificationsApi->get_identity_certification_task_status:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_task_status: %s\n" % e) ``` @@ -265,10 +274,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certifications_api import CertificationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_reference_with_name_and_email import IdentityReferenceWithNameAndEmail -from sailpoint.beta.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) @@ -279,13 +292,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) ``` @@ -331,11 +343,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.certifications_api import CertificationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_certification_task import IdentityCertificationTask from sailpoint.beta.models.review_reassign import ReviewReassign -from sailpoint.beta.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", @@ -351,14 +367,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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorRuleManagementApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorRuleManagementApi.md index f50771a80..0e4e0c611 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorRuleManagementApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorRuleManagementApi.md @@ -63,11 +63,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.connector_rule_management_api import ConnectorRuleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.connector_rule_create_request import ConnectorRuleCreateRequest from sailpoint.beta.models.connector_rule_response import ConnectorRuleResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: connector_rule_create_request = { "sourceCode" : { "version" : "1.0", @@ -97,14 +101,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(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(new_connector_rule_create_request) # Below is a request that includes all optional parameters - # api_response = api_instance.create_connector_rule(Result) + # results = ConnectorRuleManagementApi(api_client).create_connector_rule(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) ``` @@ -147,19 +151,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.connector_rule_management_api import ConnectorRuleManagementApi +from sailpoint.beta.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 try: # Delete a Connector-Rule - api_instance.delete_connector_rule(id) - + ConnectorRuleManagementApi(api_client).delete_connector_rule(id) # Below is a request that includes all optional parameters - # api_instance.delete_connector_rule(id) - except Exception as e: + # ConnectorRuleManagementApi(api_client).delete_connector_rule(id) + except Exception as e: print("Exception when calling ConnectorRuleManagementApi->delete_connector_rule: %s\n" % e) ``` @@ -202,22 +209,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.connector_rule_management_api import ConnectorRuleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.connector_rule_response import ConnectorRuleResponse -from sailpoint.beta.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 retrieve # str | ID of the connector rule to retrieve try: # Connector-Rule by ID - api_response = api_instance.get_connector_rule(id) - + results =ConnectorRuleManagementApi(api_client).get_connector_rule(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_connector_rule(id) + # results = ConnectorRuleManagementApi(api_client).get_connector_rule(id) 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) ``` @@ -256,21 +266,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.connector_rule_management_api import ConnectorRuleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.connector_rule_response import ConnectorRuleResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # List Connector Rules - api_response = api_instance.get_connector_rule_list() - + results =ConnectorRuleManagementApi(api_client).get_connector_rule_list() # Below is a request that includes all optional parameters - # api_response = api_instance.get_connector_rule_list() + # results = ConnectorRuleManagementApi(api_client).get_connector_rule_list() 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) ``` @@ -314,11 +327,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.connector_rule_management_api import ConnectorRuleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.connector_rule_response import ConnectorRuleResponse from sailpoint.beta.models.connector_rule_update_request import ConnectorRuleUpdateRequest -from sailpoint.beta.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 connector_rule_update_request = { "sourceCode" : { @@ -351,13 +368,12 @@ from pprint import pprint try: # Update a Connector Rule - api_response = api_instance.update_connector_rule(id, ) - + results =ConnectorRuleManagementApi(api_client).update_connector_rule(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.update_connector_rule(id, Result) + # results = ConnectorRuleManagementApi(api_client).update_connector_rule(id, new_connector_rule_update_request) print("The response of ConnectorRuleManagementApi->update_connector_rule:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling ConnectorRuleManagementApi->update_connector_rule: %s\n" % e) ``` @@ -399,11 +415,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.connector_rule_management_api import ConnectorRuleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.connector_rule_validation_response import ConnectorRuleValidationResponse from sailpoint.beta.models.source_code import SourceCode -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_code = { "version" : "1.0", "script" : "return \"Mr. \" + firstName;" @@ -411,14 +431,14 @@ from pprint import pprint try: # Validate Connector Rule - Result = source_code.from_json(source_code) - api_response = api_instance.validate_connector_rule(Result) - + new_source_code = SourceCode() + new_source_code.from_json(source_code) + results =ConnectorRuleManagementApi(api_client).validate_connector_rule(new_source_code) # Below is a request that includes all optional parameters - # api_response = api_instance.validate_connector_rule(Result) + # results = ConnectorRuleManagementApi(api_client).validate_connector_rule(new_source_code) print("The response of ConnectorRuleManagementApi->validate_connector_rule:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling ConnectorRuleManagementApi->validate_connector_rule: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorsApi.md index 4189a75a4..c956ff5be 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorsApi.md @@ -70,10 +70,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.connectors_api import ConnectorsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.v3_connector_dto import V3ConnectorDto -from sailpoint.beta.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* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *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* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *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) @@ -83,13 +87,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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/CustomFormsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/CustomFormsApi.md index 38fef22f1..a929cb77d 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/CustomFormsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/CustomFormsApi.md @@ -77,11 +77,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.create_form_definition_request import CreateFormDefinitionRequest from sailpoint.beta.models.form_definition_response import FormDefinitionResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: create_form_definition_request = { "owner" : { "name" : "Grant Smith", @@ -197,13 +201,12 @@ from pprint import pprint try: # Creates a form definition. - api_response = api_instance.create_form_definition() - + results =CustomFormsApi(api_client).create_form_definition() # Below is a request that includes all optional parameters - # api_response = api_instance.create_form_definition(Result) + # results = CustomFormsApi(api_client).create_form_definition(new_create_form_definition_request) 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) ``` @@ -244,11 +247,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.create_form_definition_request import CreateFormDefinitionRequest from sailpoint.beta.models.form_definition_response import FormDefinitionResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: create_form_definition_request = { "owner" : { "name" : "Grant Smith", @@ -364,13 +371,12 @@ from pprint import pprint try: # Create a form definition by template. - api_response = api_instance.create_form_definition_by_template() - + results =CustomFormsApi(api_client).create_form_definition_by_template() # Below is a request that includes all optional parameters - # api_response = api_instance.create_form_definition_by_template(Result) + # results = CustomFormsApi(api_client).create_form_definition_by_template(new_create_form_definition_request) print("The response of CustomFormsApi->create_form_definition_by_template:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling CustomFormsApi->create_form_definition_by_template: %s\n" % e) ``` @@ -412,11 +418,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.form_definition_dynamic_schema_request import FormDefinitionDynamicSchemaRequest from sailpoint.beta.models.form_definition_dynamic_schema_response import FormDefinitionDynamicSchemaResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: body = { "description" : "A description", "attributes" : { @@ -430,13 +440,12 @@ from pprint import pprint try: # Generate JSON Schema dynamically. - api_response = api_instance.create_form_definition_dynamic_schema() - + results =CustomFormsApi(api_client).create_form_definition_dynamic_schema() # Below is a request that includes all optional parameters - # api_response = api_instance.create_form_definition_dynamic_schema(Result) + # results = CustomFormsApi(api_client).create_form_definition_dynamic_schema(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) ``` @@ -482,23 +491,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.form_definition_file_upload_response import FormDefinitionFileUploadResponse -from sailpoint.beta.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 file = None # bytearray | File specifying the multipart # bytearray | File specifying the multipart try: # Upload new form definition file. - api_response = api_instance.create_form_definition_file_request(form_definition_id, file) - + results =CustomFormsApi(api_client).create_form_definition_file_request(form_definition_id, file) # Below is a request that includes all optional parameters - # api_response = api_instance.create_form_definition_file_request(form_definition_id, file) + # results = CustomFormsApi(api_client).create_form_definition_file_request(form_definition_id, 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) ``` @@ -539,11 +551,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.create_form_instance_request import CreateFormInstanceRequest from sailpoint.beta.models.form_instance_response import FormInstanceResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: body = { "formInput" : { "input1" : "Sales" @@ -569,13 +585,12 @@ from pprint import pprint try: # Creates a form instance. - api_response = api_instance.create_form_instance() - + results =CustomFormsApi(api_client).create_form_instance() # Below is a request that includes all optional parameters - # api_response = api_instance.create_form_instance(Result) + # results = CustomFormsApi(api_client).create_form_instance(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) ``` @@ -617,21 +632,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.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 try: # Deletes a form definition. - api_response = api_instance.delete_form_definition(form_definition_id) - + results =CustomFormsApi(api_client).delete_form_definition(form_definition_id) # Below is a request that includes all optional parameters - # api_response = api_instance.delete_form_definition(form_definition_id) + # results = CustomFormsApi(api_client).delete_form_definition(form_definition_id) 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) ``` @@ -675,10 +693,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.export_form_definitions_by_tenant200_response_inner import ExportFormDefinitionsByTenant200ResponseInner -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: 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) filters = 'name sw \"my form\"' # 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, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) @@ -687,13 +709,12 @@ from pprint import pprint try: # List form definitions by tenant. - api_response = api_instance.export_form_definitions_by_tenant() - + results =CustomFormsApi(api_client).export_form_definitions_by_tenant() # Below is a request that includes all optional parameters - # api_response = api_instance.export_form_definitions_by_tenant(offset, limit, filters, sorters) + # results = CustomFormsApi(api_client).export_form_definitions_by_tenant(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) ``` @@ -737,22 +758,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.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. try: # Download definition file by fileId. - api_response = api_instance.get_file_from_s3(form_definition_id, file_id) - + results =CustomFormsApi(api_client).get_file_from_s3(form_definition_id, file_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_file_from_s3(form_definition_id, file_id) + # results = CustomFormsApi(api_client).get_file_from_s3(form_definition_id, file_id) 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) ``` @@ -794,22 +818,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.form_definition_response import FormDefinitionResponse -from sailpoint.beta.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 try: # Return a form definition. - api_response = api_instance.get_form_definition_by_key(form_definition_id) - + results =CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_form_definition_by_key(form_definition_id) + # results = CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id) 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) ``` @@ -851,22 +878,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.form_instance_response import FormInstanceResponse -from sailpoint.beta.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 try: # Returns a form instance. - api_response = api_instance.get_form_instance_by_key(form_instance_id) - + results =CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_form_instance_by_key(form_instance_id) + # results = CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id) 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) ``` @@ -910,22 +940,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.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. try: # Download instance file by fileId. - api_response = api_instance.get_form_instance_file(form_instance_id, file_id) - + results =CustomFormsApi(api_client).get_form_instance_file(form_instance_id, file_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_form_instance_file(form_instance_id, file_id) + # results = CustomFormsApi(api_client).get_form_instance_file(form_instance_id, file_id) 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) ``` @@ -966,11 +999,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.import_form_definitions202_response import ImportFormDefinitions202Response from sailpoint.beta.models.import_form_definitions_request_inner import ImportFormDefinitionsRequestInner -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: [{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[ImportFormDefinitionsRequestInner] | 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[ImportFormDefinitionsRequestInner] | Body is the request payload to import form definitions (optional) @@ -978,13 +1015,12 @@ from pprint import pprint try: # Import form definitions from export. - api_response = api_instance.import_form_definitions() - + results =CustomFormsApi(api_client).import_form_definitions() # Below is a request that includes all optional parameters - # api_response = api_instance.import_form_definitions(Result) + # results = CustomFormsApi(api_client).import_form_definitions(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) ``` @@ -1027,10 +1063,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.form_definition_response import FormDefinitionResponse -from sailpoint.beta.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 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) 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) @@ -1039,13 +1079,12 @@ from pprint import pprint try: # Patch a form definition. - api_response = api_instance.patch_form_definition(form_definition_id, ) - + results =CustomFormsApi(api_client).patch_form_definition(form_definition_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_form_definition(form_definition_id, Result) + # results = CustomFormsApi(api_client).patch_form_definition(form_definition_id, 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) ``` @@ -1089,10 +1128,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.form_instance_response import FormInstanceResponse -from sailpoint.beta.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 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) 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) @@ -1101,13 +1144,12 @@ from pprint import pprint try: # Patch a form instance. - api_response = api_instance.patch_form_instance(form_instance_id, ) - + results =CustomFormsApi(api_client).patch_form_instance(form_instance_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_form_instance(form_instance_id, Result) + # results = CustomFormsApi(api_client).patch_form_instance(form_instance_id, 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) ``` @@ -1151,10 +1193,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.list_form_definitions_by_tenant_response import ListFormDefinitionsByTenantResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: 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) filters = 'name sw \"my form\"' # 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, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) @@ -1163,13 +1209,12 @@ from pprint import pprint try: # Export form definitions by tenant. - api_response = api_instance.search_form_definitions_by_tenant() - + results =CustomFormsApi(api_client).search_form_definitions_by_tenant() # Below is a request that includes all optional parameters - # api_response = api_instance.search_form_definitions_by_tenant(offset, limit, filters, sorters) + # results = CustomFormsApi(api_client).search_form_definitions_by_tenant(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) ``` @@ -1216,10 +1261,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.list_form_element_data_by_element_id_response import ListFormElementDataByElementIDResponse -from sailpoint.beta.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 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) @@ -1229,13 +1278,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, ) - + results =CustomFormsApi(api_client).search_form_element_data_by_element_id(form_instance_id, form_element_id, ) # 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, limit, filters, query) + # results = CustomFormsApi(api_client).search_form_element_data_by_element_id(form_instance_id, form_element_id, 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) ``` @@ -1273,21 +1321,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.form_instance_response import FormInstanceResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # List form instances by tenant. - api_response = api_instance.search_form_instances_by_tenant() - + results =CustomFormsApi(api_client).search_form_instances_by_tenant() # Below is a request that includes all optional parameters - # api_response = api_instance.search_form_instances_by_tenant() + # results = CustomFormsApi(api_client).search_form_instances_by_tenant() 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) ``` @@ -1325,21 +1376,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.list_predefined_select_options_response import ListPredefinedSelectOptionsResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # List predefined select options. - api_response = api_instance.search_pre_defined_select_options() - + results =CustomFormsApi(api_client).search_pre_defined_select_options() # Below is a request that includes all optional parameters - # api_response = api_instance.search_pre_defined_select_options() + # results = CustomFormsApi(api_client).search_pre_defined_select_options() 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) ``` @@ -1385,11 +1439,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.custom_forms_api import CustomFormsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.form_element_preview_request import FormElementPreviewRequest from sailpoint.beta.models.preview_data_source_response import PreviewDataSourceResponse -from sailpoint.beta.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 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) filters = 'value eq \"ID01\"' # 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) @@ -1409,13 +1467,12 @@ from pprint import pprint try: # Preview form definition data source. - api_response = api_instance.show_preview_data_source(form_definition_id, ) - + results =CustomFormsApi(api_client).show_preview_data_source(form_definition_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.show_preview_data_source(form_definition_id, limit, filters, query, Result) + # results = CustomFormsApi(api_client).show_preview_data_source(form_definition_id, 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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/CustomPasswordInstructionsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/CustomPasswordInstructionsApi.md index 58aede7cb..ccde84d58 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/CustomPasswordInstructionsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/CustomPasswordInstructionsApi.md @@ -62,10 +62,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.custom_password_instructions_api import CustomPasswordInstructionsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.custom_password_instruction import CustomPasswordInstruction -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: 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.", "pageId" : "change-password:enter-password", @@ -74,14 +78,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(Result) - + new_custom_password_instruction = CustomPasswordInstruction() + new_custom_password_instruction.from_json(custom_password_instruction) + results =CustomPasswordInstructionsApi(api_client).create_custom_password_instructions(new_custom_password_instruction) # Below is a request that includes all optional parameters - # api_response = api_instance.create_custom_password_instructions(Result) + # results = CustomPasswordInstructionsApi(api_client).create_custom_password_instructions(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) ``` @@ -122,20 +126,23 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.custom_password_instructions_api import CustomPasswordInstructionsApi +from sailpoint.beta.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. 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) try: # Delete Custom Password Instructions by page ID - api_instance.delete_custom_password_instructions(page_id, ) - + CustomPasswordInstructionsApi(api_client).delete_custom_password_instructions(page_id, ) # Below is a request that includes all optional parameters - # api_instance.delete_custom_password_instructions(page_id, locale) - except Exception as e: + # CustomPasswordInstructionsApi(api_client).delete_custom_password_instructions(page_id, locale) + except Exception as e: print("Exception when calling CustomPasswordInstructionsApi->delete_custom_password_instructions: %s\n" % e) ``` @@ -176,23 +183,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.custom_password_instructions_api import CustomPasswordInstructionsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.custom_password_instruction import CustomPasswordInstruction -from sailpoint.beta.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. 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) try: # Get Custom Password Instructions by Page ID - api_response = api_instance.get_custom_password_instructions(page_id, ) - + results =CustomPasswordInstructionsApi(api_client).get_custom_password_instructions(page_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_custom_password_instructions(page_id, locale) + # results = CustomPasswordInstructionsApi(api_client).get_custom_password_instructions(page_id, 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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/EntitlementsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/EntitlementsApi.md index 0c90ea7be..bdbac91ec 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/EntitlementsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/EntitlementsApi.md @@ -113,10 +113,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.entitlement import Entitlement -from sailpoint.beta.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. @@ -124,13 +128,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) - + results =EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value) # Below is a request that includes all optional parameters - # api_response = api_instance.create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value) + # results = EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value) 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) ``` @@ -173,9 +176,13 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.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. @@ -183,11 +190,10 @@ from pprint import pprint try: # Remove metadata from an entitlement. - api_instance.delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value) - + EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value) # Below is a request that includes all optional parameters - # api_instance.delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value) - except Exception as e: + # EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value) + except Exception as e: print("Exception when calling EntitlementsApi->delete_access_model_metadata_from_entitlement: %s\n" % e) ``` @@ -229,22 +235,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.entitlement import Entitlement -from sailpoint.beta.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 try: # Get an entitlement - api_response = api_instance.get_entitlement(id) - + results =EntitlementsApi(api_client).get_entitlement(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_entitlement(id) + # results = EntitlementsApi(api_client).get_entitlement(id) 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) ``` @@ -286,22 +295,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.entitlement_request_config import EntitlementRequestConfig -from sailpoint.beta.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 try: # Get Entitlement Request Config - api_response = api_instance.get_entitlement_request_config(id) - + results =EntitlementsApi(api_client).get_entitlement_request_config(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_entitlement_request_config(id) + # results = EntitlementsApi(api_client).get_entitlement_request_config(id) 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) ``` @@ -350,23 +362,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.load_entitlement_task import LoadEntitlementTask -from sailpoint.beta.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 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) try: # Aggregate Entitlements - api_response = api_instance.import_entitlements_by_source(id, ) - + results =EntitlementsApi(api_client).import_entitlements_by_source(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.import_entitlements_by_source(id, csv_file) + # results = EntitlementsApi(api_client).import_entitlements_by_source(id, 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) ``` @@ -413,10 +428,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.entitlement import Entitlement -from sailpoint.beta.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 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 +446,12 @@ from pprint import pprint try: # List of entitlements children - api_response = api_instance.list_entitlement_children(id, ) - + results =EntitlementsApi(api_client).list_entitlement_children(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.list_entitlement_children(id, limit, offset, count, sorters, filters) + # results = EntitlementsApi(api_client).list_entitlement_children(id, 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) ``` @@ -480,10 +498,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.entitlement import Entitlement -from sailpoint.beta.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 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) @@ -494,13 +516,12 @@ from pprint import pprint try: # List of entitlements parents - api_response = api_instance.list_entitlement_parents(id, ) - + results =EntitlementsApi(api_client).list_entitlement_parents(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.list_entitlement_parents(id, limit, offset, count, sorters, filters) + # results = EntitlementsApi(api_client).list_entitlement_parents(id, 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) ``` @@ -553,10 +574,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.entitlement import Entitlement -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: 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). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (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). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (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) for_segment_ids = '041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649' # str | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) # str | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) @@ -570,13 +595,12 @@ from pprint import pprint try: # Gets a list of entitlements. - api_response = api_instance.list_entitlements() - + results =EntitlementsApi(api_client).list_entitlements() # Below is a request that includes all optional parameters - # api_response = api_instance.list_entitlements(account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters) + # results = EntitlementsApi(api_client).list_entitlements(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) ``` @@ -625,11 +649,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.entitlement import Entitlement from sailpoint.beta.models.json_patch_operation import JsonPatchOperation -from sailpoint.beta.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 [{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}] # List[JsonPatchOperation] | (optional) json_patch_operation = { @@ -642,13 +670,12 @@ from pprint import pprint try: # Patch an entitlement - api_response = api_instance.patch_entitlement(id, ) - + results =EntitlementsApi(api_client).patch_entitlement(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_entitlement(id, Result) + # results = EntitlementsApi(api_client).patch_entitlement(id, 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) ``` @@ -691,10 +718,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.entitlement_request_config import EntitlementRequestConfig -from sailpoint.beta.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 entitlement_request_config = { "accessRequestConfig" : { @@ -712,14 +743,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, Result) - + new_entitlement_request_config = EntitlementRequestConfig() + new_entitlement_request_config.from_json(entitlement_request_config) + results =EntitlementsApi(api_client).put_entitlement_request_config(id, new_entitlement_request_config) # Below is a request that includes all optional parameters - # api_response = api_instance.put_entitlement_request_config(id, Result) + # results = EntitlementsApi(api_client).put_entitlement_request_config(id, 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) ``` @@ -761,22 +792,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.entitlement_source_reset_base_reference_dto import EntitlementSourceResetBaseReferenceDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset try: # Reset Source Entitlements - api_response = api_instance.reset_source_entitlements(source_id) - + results =EntitlementsApi(api_client).reset_source_entitlements(source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.reset_source_entitlements(source_id) + # results = EntitlementsApi(api_client).reset_source_entitlements(source_id) 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) ``` @@ -830,10 +864,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.entitlements_api import EntitlementsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.entitlement_bulk_update_request import EntitlementBulkUpdateRequest -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: entitlement_bulk_update_request = { "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], "jsonPatch" : [ { @@ -849,12 +887,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(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(new_entitlement_bulk_update_request) # Below is a request that includes all optional parameters - # api_instance.update_entitlements_in_bulk(Result) - except Exception as e: + # EntitlementsApi(api_client).update_entitlements_in_bulk(new_entitlement_bulk_update_request) + except Exception as e: print("Exception when calling EntitlementsApi->update_entitlements_in_bulk: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/GovernanceGroupsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/GovernanceGroupsApi.md index 1e9ec1f23..b1746fff8 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/GovernanceGroupsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/GovernanceGroupsApi.md @@ -65,10 +65,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.workgroup_dto import WorkgroupDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: workgroup_dto = { "owner" : { "emailAddress" : "support@sailpoint.com", @@ -88,14 +92,14 @@ from pprint import pprint try: # Create a new Governance Group. - Result = workgroup_dto.from_json(workgroup_dto) - api_response = api_instance.create_workgroup(Result) - + new_workgroup_dto = WorkgroupDto() + new_workgroup_dto.from_json(workgroup_dto) + results =GovernanceGroupsApi(api_client).create_workgroup(new_workgroup_dto) # Below is a request that includes all optional parameters - # api_response = api_instance.create_workgroup(Result) + # results = GovernanceGroupsApi(api_client).create_workgroup(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) ``` @@ -136,19 +140,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.beta.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 try: # Delete a Governance Group - api_instance.delete_workgroup(id) - + GovernanceGroupsApi(api_client).delete_workgroup(id) # Below is a request that includes all optional parameters - # api_instance.delete_workgroup(id) - except Exception as e: + # GovernanceGroupsApi(api_client).delete_workgroup(id) + except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroup: %s\n" % e) ``` @@ -194,11 +201,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.bulk_workgroup_members_request_inner import BulkWorkgroupMembersRequestInner from sailpoint.beta.models.workgroup_member_delete_item import WorkgroupMemberDeleteItem -from sailpoint.beta.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. [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be removed from a Governance Group members list. bulk_workgroup_members_request_inner = [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be removed from a Governance Group members list. @@ -206,14 +217,14 @@ from pprint import pprint try: # Remove members from Governance Group - Result = bulk_workgroup_members_request_inner.from_json(bulk_workgroup_members_request_inner) - api_response = api_instance.delete_workgroup_members(workgroup_id, Result) - + new_bulk_workgroup_members_request_inner = BulkWorkgroupMembersRequestInner() + new_bulk_workgroup_members_request_inner.from_json(bulk_workgroup_members_request_inner) + results =GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner) # Below is a request that includes all optional parameters - # api_response = api_instance.delete_workgroup_members(workgroup_id, Result) + # results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner) 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) ``` @@ -265,25 +276,29 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.workgroup_bulk_delete_request import WorkgroupBulkDeleteRequest from sailpoint.beta.models.workgroup_delete_item import WorkgroupDeleteItem -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: workgroup_bulk_delete_request = { "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] } # WorkgroupBulkDeleteRequest | try: # Delete Governance Group(s) - Result = workgroup_bulk_delete_request.from_json(workgroup_bulk_delete_request) - api_response = api_instance.delete_workgroups_in_bulk(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(new_workgroup_bulk_delete_request) # Below is a request that includes all optional parameters - # api_response = api_instance.delete_workgroups_in_bulk(Result) + # results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(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) ``` @@ -324,22 +339,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.workgroup_dto import WorkgroupDto -from sailpoint.beta.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 try: # Get Governance Group by Id - api_response = api_instance.get_workgroup(id) - + results =GovernanceGroupsApi(api_client).get_workgroup(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_workgroup(id) + # results = GovernanceGroupsApi(api_client).get_workgroup(id) 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) ``` @@ -384,10 +402,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.workgroup_connection_dto import WorkgroupConnectionDto -from sailpoint.beta.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. 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) @@ -397,13 +419,12 @@ from pprint import pprint try: # List connections for Governance Group - api_response = api_instance.list_connections(workgroup_id, ) - + results =GovernanceGroupsApi(api_client).list_connections(workgroup_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.list_connections(workgroup_id, offset, limit, count, sorters) + # results = GovernanceGroupsApi(api_client).list_connections(workgroup_id, 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) ``` @@ -448,10 +469,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.list_workgroup_members200_response_inner import ListWorkgroupMembers200ResponseInner -from sailpoint.beta.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. 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) @@ -461,13 +486,12 @@ from pprint import pprint try: # List Governance Group Members - api_response = api_instance.list_workgroup_members(workgroup_id, ) - + results =GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.list_workgroup_members(workgroup_id, offset, limit, count, sorters) + # results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, 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) ``` @@ -512,10 +536,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.workgroup_dto import WorkgroupDto -from sailpoint.beta.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 = 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) 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) @@ -525,13 +553,12 @@ from pprint import pprint try: # List Governance Groups - api_response = api_instance.list_workgroups() - + results =GovernanceGroupsApi(api_client).list_workgroups() # Below is a request that includes all optional parameters - # api_response = api_instance.list_workgroups(offset, limit, count, filters, sorters) + # results = GovernanceGroupsApi(api_client).list_workgroups(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) ``` @@ -579,11 +606,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.json_patch_operation import JsonPatchOperation from sailpoint.beta.models.workgroup_dto import WorkgroupDto -from sailpoint.beta.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 [{op=replace, path=/description, value=Governance Group new description.}] # List[JsonPatchOperation] | (optional) json_patch_operation = { @@ -596,13 +627,12 @@ from pprint import pprint try: # Patch a Governance Group - api_response = api_instance.patch_workgroup(id, ) - + results =GovernanceGroupsApi(api_client).patch_workgroup(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_workgroup(id, Result) + # results = GovernanceGroupsApi(api_client).patch_workgroup(id, 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) ``` @@ -648,11 +678,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.bulk_workgroup_members_request_inner import BulkWorkgroupMembersRequestInner from sailpoint.beta.models.workgroup_member_add_item import WorkgroupMemberAddItem -from sailpoint.beta.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. [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be added to a Governance Group members list. bulk_workgroup_members_request_inner = [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be added to a Governance Group members list. @@ -660,14 +694,14 @@ from pprint import pprint try: # Add members to Governance Group - Result = bulk_workgroup_members_request_inner.from_json(bulk_workgroup_members_request_inner) - api_response = api_instance.update_workgroup_members(workgroup_id, Result) - + new_bulk_workgroup_members_request_inner = BulkWorkgroupMembersRequestInner() + new_bulk_workgroup_members_request_inner.from_json(bulk_workgroup_members_request_inner) + results =GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner) # Below is a request that includes all optional parameters - # api_response = api_instance.update_workgroup_members(workgroup_id, Result) + # results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner) 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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAIAccessRequestRecommendationsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAIAccessRequestRecommendationsApi.md index e2de35749..ef368689f 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IAIAccessRequestRecommendationsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAIAccessRequestRecommendationsApi.md @@ -58,11 +58,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto from sailpoint.beta.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: access_request_recommendation_action_item_dto = { "access" : { "id" : "2c9180835d2e5168015d32f890ca1581", @@ -73,14 +77,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(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(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(Result) + # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_ignored_item(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) ``` @@ -121,11 +125,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto from sailpoint.beta.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: access_request_recommendation_action_item_dto = { "access" : { "id" : "2c9180835d2e5168015d32f890ca1581", @@ -136,14 +144,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(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(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(Result) + # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_requested_item(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) ``` @@ -184,11 +192,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto from sailpoint.beta.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: access_request_recommendation_action_item_dto = { "access" : { "id" : "2c9180835d2e5168015d32f890ca1581", @@ -199,14 +211,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(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(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(Result) + # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_item(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) ``` @@ -247,11 +259,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto from sailpoint.beta.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: [sailpoint.beta.AccessRequestRecommendationActionItemDto()] # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. access_request_recommendation_action_item_dto = { "access" : { @@ -264,14 +280,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(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(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(Result) + # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(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) ``` @@ -318,10 +334,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.access_request_recommendation_item_detail import AccessRequestRecommendationItemDetail -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: 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) 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) @@ -333,13 +353,12 @@ from pprint import pprint try: # Identity Access Request Recommendations - api_response = api_instance.get_access_request_recommendations() - + results =IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations() # Below is a request that includes all optional parameters - # api_response = api_instance.get_access_request_recommendations(identity_id, limit, offset, count, include_translation_messages, filters, sorters) + # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(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) ``` @@ -384,10 +403,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto -from sailpoint.beta.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) @@ -397,13 +420,12 @@ from pprint import pprint try: # List of Ignored Access Request Recommendations - api_response = api_instance.get_access_request_recommendations_ignored_items() - + results =IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items() # Below is a request that includes all optional parameters - # api_response = api_instance.get_access_request_recommendations_ignored_items(limit, offset, count, filters, sorters) + # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(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) ``` @@ -448,10 +470,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto -from sailpoint.beta.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) @@ -461,13 +487,12 @@ from pprint import pprint try: # List of Requested Access Request Recommendations - api_response = api_instance.get_access_request_recommendations_requested_items() - + results =IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items() # Below is a request that includes all optional parameters - # api_response = api_instance.get_access_request_recommendations_requested_items(limit, offset, count, filters, sorters) + # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(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) ``` @@ -512,10 +537,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto -from sailpoint.beta.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) @@ -525,13 +554,12 @@ from pprint import pprint try: # List of Viewed Access Request Recommendations - api_response = api_instance.get_access_request_recommendations_viewed_items() - + results =IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items() # Below is a request that includes all optional parameters - # api_response = api_instance.get_access_request_recommendations_viewed_items(limit, offset, count, filters, sorters) + # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAICommonAccessApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAICommonAccessApi.md index 6d76bfc30..7528e03ff 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IAICommonAccessApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAICommonAccessApi.md @@ -53,11 +53,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_common_access_api import IAICommonAccessApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.common_access_item_request import CommonAccessItemRequest from sailpoint.beta.models.common_access_item_response import CommonAccessItemResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: common_access_item_request = { "access" : { "ownerName" : "ownerName", @@ -72,14 +76,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(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(new_common_access_item_request) # Below is a request that includes all optional parameters - # api_response = api_instance.create_common_access(Result) + # results = IAICommonAccessApi(api_client).create_common_access(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) ``` @@ -123,10 +127,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_common_access_api import IAICommonAccessApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.common_access_response import CommonAccessResponse -from sailpoint.beta.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) @@ -136,13 +144,12 @@ from pprint import pprint try: # Get a paginated list of common access - api_response = api_instance.get_common_access() - + results =IAICommonAccessApi(api_client).get_common_access() # Below is a request that includes all optional parameters - # api_response = api_instance.get_common_access(offset, limit, count, filters, sorters) + # results = IAICommonAccessApi(api_client).get_common_access(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) ``` @@ -183,10 +190,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_common_access_api import IAICommonAccessApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.common_access_id_status import CommonAccessIDStatus -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: [sailpoint.beta.CommonAccessIDStatus()] # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access common_access_id_status = { "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], @@ -196,14 +207,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(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(new_common_access_id_status) # Below is a request that includes all optional parameters - # api_response = api_instance.update_common_access_status_in_bulk(Result) + # results = IAICommonAccessApi(api_client).update_common_access_status_in_bulk(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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAIMessageCatalogsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAIMessageCatalogsApi.md index fd02f6868..2cf8da573 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IAIMessageCatalogsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAIMessageCatalogsApi.md @@ -51,22 +51,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_message_catalogs_api import IAIMessageCatalogsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.message_catalog_dto import MessageCatalogDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: catalog_id = 'recommender' # str | The ID of the message catalog. # str | The ID of the message catalog. try: # Get Message catalogs - api_response = api_instance.get_message_catalogs(catalog_id) - + results =IAIMessageCatalogsApi(api_client).get_message_catalogs(catalog_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_message_catalogs(catalog_id) + # results = IAIMessageCatalogsApi(api_client).get_message_catalogs(catalog_id) print("The response of IAIMessageCatalogsApi->get_message_catalogs:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling IAIMessageCatalogsApi->get_message_catalogs: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAIOutliersApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAIOutliersApi.md index f22fc3350..1c4b61dbb 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IAIOutliersApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAIOutliersApi.md @@ -62,21 +62,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: type = 'LOW_SIMILARITY' # str | Type of the identity outliers snapshot to filter on (optional) # str | Type of the identity outliers snapshot to filter on (optional) try: # IAI Identity Outliers Export - api_response = api_instance.export_outliers_zip() - + results =IAIOutliersApi(api_client).export_outliers_zip() # Below is a request that includes all optional parameters - # api_response = api_instance.export_outliers_zip(type) + # results = IAIOutliersApi(api_client).export_outliers_zip(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) ``` @@ -122,10 +125,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.outlier_summary import OutlierSummary -from sailpoint.beta.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) 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) @@ -135,13 +142,12 @@ from pprint import pprint try: # IAI Identity Outliers Summary - api_response = api_instance.get_identity_outlier_snapshots() - + results =IAIOutliersApi(api_client).get_identity_outlier_snapshots() # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_outlier_snapshots(limit, offset, type, filters, sorters) + # results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(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) ``` @@ -187,10 +193,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.outlier import Outlier -from sailpoint.beta.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) @@ -201,13 +211,12 @@ from pprint import pprint try: # IAI Get Identity Outliers - api_response = api_instance.get_identity_outliers() - + results =IAIOutliersApi(api_client).get_identity_outliers() # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_outliers(limit, offset, count, type, filters, sorters) + # results = IAIOutliersApi(api_client).get_identity_outliers(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) ``` @@ -249,22 +258,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.latest_outlier_summary import LatestOutlierSummary -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: type = 'LOW_SIMILARITY' # str | Type of the identity outliers snapshot to filter on (optional) # str | Type of the identity outliers snapshot to filter on (optional) try: # IAI Identity Outliers Latest Summary - api_response = api_instance.get_latest_identity_outlier_snapshots() - + results =IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots() # Below is a request that includes all optional parameters - # api_response = api_instance.get_latest_identity_outlier_snapshots(type) + # results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(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) ``` @@ -309,22 +321,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.outlier_feature_summary import OutlierFeatureSummary -from sailpoint.beta.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 try: # Get identity outlier contibuting feature summary - api_response = api_instance.get_outlier_contributing_feature_summary(outlier_feature_id) - + results =IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_outlier_contributing_feature_summary(outlier_feature_id) + # results = IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id) 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) ``` @@ -374,10 +389,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.outlier_contributing_feature import OutlierContributingFeature -from sailpoint.beta.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 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) @@ -388,13 +407,12 @@ from pprint import pprint try: # Get identity outlier's contibuting features - api_response = api_instance.get_peer_group_outliers_contributing_features(outlier_id, ) - + results =IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_peer_group_outliers_contributing_features(outlier_id, limit, offset, count, include_translation_messages, sorters) + # results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, limit, offset, count, include_translation_messages, sorters) print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") - pprint(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) ``` @@ -435,21 +453,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: request_body = ['request_body_example'] # List[str] | request_body = ['request_body_example'] # List[str] | try: # IAI Identity Outliers Ignore - Result = request_body.from_json(request_body) - api_instance.ignore_identity_outliers(Result) - + new_request_body = RequestBody() + new_request_body.from_json(request_body) + IAIOutliersApi(api_client).ignore_identity_outliers(new_request_body) # Below is a request that includes all optional parameters - # api_instance.ignore_identity_outliers(Result) - except Exception as e: + # IAIOutliersApi(api_client).ignore_identity_outliers(new_request_body) + except Exception as e: print("Exception when calling IAIOutliersApi->ignore_identity_outliers: %s\n" % e) ``` @@ -500,10 +522,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.outliers_contributing_feature_access_items import OutliersContributingFeatureAccessItems -from sailpoint.beta.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 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) @@ -515,13 +541,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, ) - + results =IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, ) # Below is a request that includes all optional parameters - # api_response = api_instance.list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, limit, offset, count, access_type, sorters) + # results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, limit, offset, count, access_type, sorters) print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") - pprint(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) ``` @@ -562,21 +587,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: request_body = ['request_body_example'] # List[str] | request_body = ['request_body_example'] # List[str] | try: # IAI Identity Outliers Unignore - Result = request_body.from_json(request_body) - api_instance.un_ignore_identity_outliers(Result) - + new_request_body = RequestBody() + new_request_body.from_json(request_body) + IAIOutliersApi(api_client).un_ignore_identity_outliers(new_request_body) # Below is a request that includes all optional parameters - # api_instance.un_ignore_identity_outliers(Result) - except Exception as e: + # IAIOutliersApi(api_client).un_ignore_identity_outliers(new_request_body) + except Exception as e: print("Exception when calling IAIOutliersApi->un_ignore_identity_outliers: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAIPeerGroupStrategiesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAIPeerGroupStrategiesApi.md index 2af2bc289..6dffe14c4 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IAIPeerGroupStrategiesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAIPeerGroupStrategiesApi.md @@ -57,10 +57,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_peer_group_strategies_api import IAIPeerGroupStrategiesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.peer_group_member import PeerGroupMember -from sailpoint.beta.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. 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) @@ -69,13 +73,12 @@ from pprint import pprint try: # Identity Outliers List - api_response = api_instance.get_peer_group_outliers(strategy, ) - + results =IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_peer_group_outliers(strategy, limit, offset, count) + # results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy, 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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAIRecommendationsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAIRecommendationsApi.md index 91c42fc77..03073d64d 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IAIRecommendationsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAIRecommendationsApi.md @@ -53,11 +53,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_recommendations_api import IAIRecommendationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.recommendation_request_dto import RecommendationRequestDto from sailpoint.beta.models.recommendation_response_dto import RecommendationResponseDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: recommendation_request_dto = { "prescribeMode" : false, "excludeInterpretations" : false, @@ -80,14 +84,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(Result) - + new_recommendation_request_dto = RecommendationRequestDto() + new_recommendation_request_dto.from_json(recommendation_request_dto) + results =IAIRecommendationsApi(api_client).get_recommendations(new_recommendation_request_dto) # Below is a request that includes all optional parameters - # api_response = api_instance.get_recommendations(Result) + # results = IAIRecommendationsApi(api_client).get_recommendations(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) ``` @@ -124,21 +128,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_recommendations_api import IAIRecommendationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.recommendation_config_dto import RecommendationConfigDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # Get certification recommendation config values - api_response = api_instance.get_recommendations_config() - + results =IAIRecommendationsApi(api_client).get_recommendations_config() # Below is a request that includes all optional parameters - # api_response = api_instance.get_recommendations_config() + # results = IAIRecommendationsApi(api_client).get_recommendations_config() 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) ``` @@ -178,10 +185,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_recommendations_api import IAIRecommendationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.recommendation_config_dto import RecommendationConfigDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: recommendation_config_dto = { "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], "peerGroupPercentageThreshold" : 0.5, @@ -191,14 +202,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(Result) - + new_recommendation_config_dto = RecommendationConfigDto() + new_recommendation_config_dto.from_json(recommendation_config_dto) + results =IAIRecommendationsApi(api_client).update_recommendations_config(new_recommendation_config_dto) # Below is a request that includes all optional parameters - # api_response = api_instance.update_recommendations_config(Result) + # results = IAIRecommendationsApi(api_client).update_recommendations_config(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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAIRoleMiningApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAIRoleMiningApi.md index e578155ea..0ca2fe9a9 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IAIRoleMiningApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAIRoleMiningApi.md @@ -79,11 +79,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_mining_potential_role_provision_request import RoleMiningPotentialRoleProvisionRequest from sailpoint.beta.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary -from sailpoint.beta.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 min_entitlement_popularity = 0 # int | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) # int | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) @@ -99,13 +103,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, ) - + results =IAIRoleMiningApi(api_client).create_potential_role_provision_request(session_id, potential_role_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.create_potential_role_provision_request(session_id, potential_role_id, min_entitlement_popularity, include_common_access, Result) + # results = IAIRoleMiningApi(api_client).create_potential_role_provision_request(session_id, potential_role_id, min_entitlement_popularity, include_common_access, new_role_mining_potential_role_provision_request) print("The response of IAIRoleMiningApi->create_potential_role_provision_request:\n") - pprint(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) ``` @@ -146,11 +149,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_mining_session_dto import RoleMiningSessionDto from sailpoint.beta.models.role_mining_session_response import RoleMiningSessionResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: role_mining_session_dto = { "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", "prescribedPruneThreshold" : 10, @@ -186,14 +193,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(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(new_role_mining_session_dto) # Below is a request that includes all optional parameters - # api_response = api_instance.create_role_mining_sessions(Result) + # results = IAIRoleMiningApi(api_client).create_role_mining_sessions(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) ``` @@ -235,9 +242,13 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +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 @@ -245,13 +256,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) - + results =IAIRoleMiningApi(api_client).download_role_mining_potential_role_zip(session_id, potential_role_id, export_id) # 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) + # results = IAIRoleMiningApi(api_client).download_role_mining_potential_role_zip(session_id, potential_role_id, export_id) print("The response of IAIRoleMiningApi->download_role_mining_potential_role_zip:\n") - pprint(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) ``` @@ -292,22 +302,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +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 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) - + results =IAIRoleMiningApi(api_client).export_role_mining_potential_role(session_id, potential_role_id) # Below is a request that includes all optional parameters - # api_response = api_instance.export_role_mining_potential_role(session_id, potential_role_id) + # results = IAIRoleMiningApi(api_client).export_role_mining_potential_role(session_id, potential_role_id) print("The response of IAIRoleMiningApi->export_role_mining_potential_role:\n") - pprint(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) ``` @@ -349,11 +362,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_mining_potential_role_export_request import RoleMiningPotentialRoleExportRequest from sailpoint.beta.models.role_mining_potential_role_export_response import RoleMiningPotentialRoleExportResponse -from sailpoint.beta.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 role_mining_potential_role_export_request = { @@ -364,13 +381,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, ) - + results =IAIRoleMiningApi(api_client).export_role_mining_potential_role_async(session_id, potential_role_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.export_role_mining_potential_role_async(session_id, potential_role_id, Result) + # results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_async(session_id, potential_role_id, new_role_mining_potential_role_export_request) print("The response of IAIRoleMiningApi->export_role_mining_potential_role_async:\n") - pprint(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) ``` @@ -412,10 +428,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_mining_potential_role_export_response import RoleMiningPotentialRoleExportResponse -from sailpoint.beta.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 @@ -423,13 +443,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) - + results =IAIRoleMiningApi(api_client).export_role_mining_potential_role_status(session_id, potential_role_id, export_id) # 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) + # results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_status(session_id, potential_role_id, export_id) print("The response of IAIRoleMiningApi->export_role_mining_potential_role_status:\n") - pprint(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) ``` @@ -474,10 +493,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: 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) 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) @@ -487,13 +510,12 @@ from pprint import pprint try: # Retrieves all potential role summaries - api_response = api_instance.get_all_potential_role_summaries() - + results =IAIRoleMiningApi(api_client).get_all_potential_role_summaries() # Below is a request that includes all optional parameters - # api_response = api_instance.get_all_potential_role_summaries(sorters, filters, offset, limit, count) + # results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") - pprint(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) ``` @@ -535,9 +557,13 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +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 include_common_access = True # bool | Boolean determining whether common access entitlements will be included or not (optional) # bool | Boolean determining whether common access entitlements will be included or not (optional) @@ -545,13 +571,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, ) - + results =IAIRoleMiningApi(api_client).get_entitlement_distribution_potential_role(session_id, potential_role_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_entitlement_distribution_potential_role(session_id, potential_role_id, include_common_access) + # results = IAIRoleMiningApi(api_client).get_entitlement_distribution_potential_role(session_id, potential_role_id, include_common_access) print("The response of IAIRoleMiningApi->get_entitlement_distribution_potential_role:\n") - pprint(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) ``` @@ -599,10 +624,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_mining_entitlement import RoleMiningEntitlement -from sailpoint.beta.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 include_common_access = True # bool | Boolean determining whether common access entitlements will be included or not (optional) (default to True) # bool | Boolean determining whether common access entitlements will be included or not (optional) (default to True) @@ -615,13 +644,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, ) - + results =IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_entitlements_potential_role(session_id, potential_role_id, include_common_access, sorters, filters, offset, limit, count) + # results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, include_common_access, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) ``` @@ -667,10 +695,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_mining_entitlement import RoleMiningEntitlement -from sailpoint.beta.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 sorters = 'populariity' # 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: **popularity** (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: **popularity** (optional) @@ -682,13 +714,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, ) - + results =IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_excluded_entitlements_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) + # results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") - pprint(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) ``` @@ -734,10 +765,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_mining_identity import RoleMiningIdentity -from sailpoint.beta.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 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) @@ -749,13 +784,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, ) - + results =IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_identities_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) + # results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) ``` @@ -797,23 +831,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_mining_potential_role import RoleMiningPotentialRole -from sailpoint.beta.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 try: # Retrieve potential role in session - api_response = api_instance.get_potential_role(session_id, potential_role_id) - + results =IAIRoleMiningApi(api_client).get_potential_role(session_id, potential_role_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_potential_role(session_id, potential_role_id) + # results = IAIRoleMiningApi(api_client).get_potential_role(session_id, potential_role_id) 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) ``` @@ -859,10 +896,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_mining_potential_role_application import RoleMiningPotentialRoleApplication -from sailpoint.beta.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 filters = 'applicationName sw \"test\"' # 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: **applicationName**: *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: **applicationName**: *sw* (optional) @@ -873,13 +914,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, ) - + results =IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_potential_role_applications(session_id, potential_role_id, filters, offset, limit, count) + # results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) ``` @@ -925,10 +965,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_mining_potential_role_entitlements import RoleMiningPotentialRoleEntitlements -from sailpoint.beta.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 filters = 'entitlementRef.name sw \"test\"' # 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: **entitlementRef.name**: *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: **entitlementRef.name**: *sw* (optional) @@ -939,13 +983,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, ) - + results =IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_potential_role_entitlements(session_id, potential_role_id, filters, offset, limit, count) + # results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) ``` @@ -991,10 +1034,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_mining_potential_role_source_usage import RoleMiningPotentialRoleSourceUsage -from sailpoint.beta.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 sorters = '-usageCount' # 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: **displayName, email, usageCount** (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: **displayName, email, usageCount** (optional) @@ -1005,13 +1052,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, ) - + results =IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_potential_role_source_identity_usage(potential_role_id, source_id, sorters, offset, limit, count) + # results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") - pprint(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) ``` @@ -1057,10 +1103,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary -from sailpoint.beta.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 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) 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* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) @@ -1071,13 +1121,12 @@ from pprint import pprint try: # Retrieve session's potential role summaries - api_response = api_instance.get_potential_role_summaries(session_id, ) - + results =IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_potential_role_summaries(session_id, sorters, filters, offset, limit, count) + # results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) ``` @@ -1118,22 +1167,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_mining_potential_role import RoleMiningPotentialRole -from sailpoint.beta.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 try: # Retrieves a specific potential role - api_response = api_instance.get_role_mining_potential_role(potential_role_id) - + results =IAIRoleMiningApi(api_client).get_role_mining_potential_role(potential_role_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_mining_potential_role(potential_role_id) + # results = IAIRoleMiningApi(api_client).get_role_mining_potential_role(potential_role_id) 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) ``` @@ -1175,22 +1227,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_mining_session_response import RoleMiningSessionResponse -from sailpoint.beta.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. try: # Get a role mining session - api_response = api_instance.get_role_mining_session(session_id) - + results =IAIRoleMiningApi(api_client).get_role_mining_session(session_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_mining_session(session_id) + # results = IAIRoleMiningApi(api_client).get_role_mining_session(session_id) 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) ``` @@ -1230,22 +1285,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_mining_session_status import RoleMiningSessionStatus -from sailpoint.beta.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 try: # Get role mining session status state - api_response = api_instance.get_role_mining_session_status(session_id) - + results =IAIRoleMiningApi(api_client).get_role_mining_session_status(session_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_mining_session_status(session_id) + # results = IAIRoleMiningApi(api_client).get_role_mining_session_status(session_id) 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) ``` @@ -1290,10 +1348,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_mining_session_response import RoleMiningSessionResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: 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) 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) @@ -1303,13 +1365,12 @@ from pprint import pprint try: # Retrieves all role mining sessions - api_response = api_instance.get_role_mining_sessions() - + results =IAIRoleMiningApi(api_client).get_role_mining_sessions() # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_mining_sessions(filters, sorters, offset, limit, count) + # results = IAIRoleMiningApi(api_client).get_role_mining_sessions(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) ``` @@ -1353,10 +1414,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_mining_session_draft_role_dto import RoleMiningSessionDraftRoleDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: 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) 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) @@ -1365,13 +1430,12 @@ from pprint import pprint try: # Retrieves all saved potential roles - api_response = api_instance.get_saved_potential_roles() - + results =IAIRoleMiningApi(api_client).get_saved_potential_roles() # Below is a request that includes all optional parameters - # api_response = api_instance.get_saved_potential_roles(sorters, offset, limit, count) + # results = IAIRoleMiningApi(api_client).get_saved_potential_roles(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) ``` @@ -1427,10 +1491,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.patch_potential_role_request_inner import PatchPotentialRoleRequestInner -from sailpoint.beta.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 [{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}] # List[PatchPotentialRoleRequestInner] | @@ -1439,14 +1507,14 @@ from pprint import pprint try: # Update a potential role in session - 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, 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, 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, Result) + # results = IAIRoleMiningApi(api_client).patch_potential_role(session_id, potential_role_id, new_patch_potential_role_request_inner) print("The response of IAIRoleMiningApi->patch_potential_role:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling IAIRoleMiningApi->patch_potential_role: %s\n" % e) ``` @@ -1501,10 +1569,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.patch_potential_role_request_inner import PatchPotentialRoleRequestInner -from sailpoint.beta.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 | The potential role summary id # str | The potential role summary id [{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}] # List[PatchPotentialRoleRequestInner] | patch_potential_role_request_inner = [{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}] # List[PatchPotentialRoleRequestInner] | @@ -1512,14 +1584,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_role_mining_potential_role(potential_role_id, 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_role_mining_potential_role(potential_role_id, new_patch_potential_role_request_inner) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_role_mining_potential_role(potential_role_id, Result) + # results = IAIRoleMiningApi(api_client).patch_role_mining_potential_role(potential_role_id, new_patch_potential_role_request_inner) print("The response of IAIRoleMiningApi->patch_role_mining_potential_role:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling IAIRoleMiningApi->patch_role_mining_potential_role: %s\n" % e) ``` @@ -1562,10 +1634,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.json_patch_operation import JsonPatchOperation -from sailpoint.beta.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 [{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. json_patch_operation = { @@ -1577,14 +1653,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, 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, new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_role_mining_session(session_id, Result) + # results = IAIRoleMiningApi(api_client).patch_role_mining_session(session_id, new_json_patch_operation) print("The response of IAIRoleMiningApi->patch_role_mining_session:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling IAIRoleMiningApi->patch_role_mining_session: %s\n" % e) ``` @@ -1626,11 +1702,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_mining_potential_role import RoleMiningPotentialRole from sailpoint.beta.models.role_mining_potential_role_edit_entitlements import RoleMiningPotentialRoleEditEntitlements -from sailpoint.beta.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 role_mining_potential_role_edit_entitlements = { @@ -1640,14 +1720,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, 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, 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, Result) + # results = IAIRoleMiningApi(api_client).update_entitlements_potential_role(session_id, potential_role_id, new_role_mining_potential_role_edit_entitlements) print("The response of IAIRoleMiningApi->update_entitlements_potential_role:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling IAIRoleMiningApi->update_entitlements_potential_role: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IconsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IconsApi.md index d01307d96..b546bba96 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IconsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IconsApi.md @@ -56,20 +56,23 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.icons_api import IconsApi +from sailpoint.beta.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 # str | Object type object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object id. try: # Delete an icon - api_instance.delete_icon(object_type, object_id) - + IconsApi(api_client).delete_icon(object_type, object_id) # Below is a request that includes all optional parameters - # api_instance.delete_icon(object_type, object_id) - except Exception as e: + # IconsApi(api_client).delete_icon(object_type, object_id) + except Exception as e: print("Exception when calling IconsApi->delete_icon: %s\n" % e) ``` @@ -113,10 +116,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.icons_api import IconsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.set_icon200_response import SetIcon200Response -from sailpoint.beta.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 # str | Object type object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object id. image = None # bytearray | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] # bytearray | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] @@ -124,13 +131,12 @@ from pprint import pprint try: # Update an icon - api_response = api_instance.set_icon(object_type, object_id, image) - + results =IconsApi(api_client).set_icon(object_type, object_id, image) # Below is a request that includes all optional parameters - # api_response = api_instance.set_icon(object_type, object_id, image) + # results = IconsApi(api_client).set_icon(object_type, object_id, 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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IdentitiesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IdentitiesApi.md index a6b279436..85dae1839 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IdentitiesApi.md @@ -77,19 +77,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.identities_api import IdentitiesApi +from sailpoint.beta.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 try: # Delete identity - api_instance.delete_identity(id) - + IdentitiesApi(api_client).delete_identity(id) # Below is a request that includes all optional parameters - # api_instance.delete_identity(id) - except Exception as e: + # IdentitiesApi(api_client).delete_identity(id) + except Exception as e: print("Exception when calling IdentitiesApi->delete_identity: %s\n" % e) ``` @@ -131,22 +134,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identities_api import IdentitiesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity import Identity -from sailpoint.beta.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: # Identity Details - api_response = api_instance.get_identity(id) - + results =IdentitiesApi(api_client).get_identity(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity(id) + # results = IdentitiesApi(api_client).get_identity(id) 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) ``` @@ -190,22 +196,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identities_api import IdentitiesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_ownership_association_details import IdentityOwnershipAssociationDetails -from sailpoint.beta.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. try: # Get ownership details - api_response = api_instance.get_identity_ownership_details(identity_id) - + results =IdentitiesApi(api_client).get_identity_ownership_details(identity_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_ownership_details(identity_id) + # results = IdentitiesApi(api_client).get_identity_ownership_details(identity_id) 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) ``` @@ -248,23 +257,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identities_api import IdentitiesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_assignment_dto import RoleAssignmentDto -from sailpoint.beta.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 try: # Role assignment details - api_response = api_instance.get_role_assignment(identity_id, assignment_id) - + results =IdentitiesApi(api_client).get_role_assignment(identity_id, assignment_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_assignment(identity_id, assignment_id) + # results = IdentitiesApi(api_client).get_role_assignment(identity_id, assignment_id) 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) ``` @@ -308,10 +320,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identities_api import IdentitiesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.get_role_assignments200_response_inner import GetRoleAssignments200ResponseInner -from sailpoint.beta.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 role_id = 'e7697a1e96d04db1ac7b0f4544915d2c' # str | Role Id to filter the role assignments with (optional) # str | Role Id to filter the role assignments with (optional) role_name = 'Engineer' # str | Role name to filter the role assignments with (optional) # str | Role name to filter the role assignments with (optional) @@ -319,13 +335,12 @@ from pprint import pprint try: # List role assignments - api_response = api_instance.get_role_assignments(identity_id, ) - + results =IdentitiesApi(api_client).get_role_assignments(identity_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_assignments(identity_id, role_id, role_name) + # results = IdentitiesApi(api_client).get_role_assignments(identity_id, 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) ``` @@ -371,10 +386,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identities_api import IdentitiesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity import Identity -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: 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) default_filter = CORRELATED_ONLY # str | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to CORRELATED_ONLY) # str | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to CORRELATED_ONLY) @@ -385,13 +404,12 @@ from pprint import pprint try: # List Identities - api_response = api_instance.list_identities() - + results =IdentitiesApi(api_client).list_identities() # Below is a request that includes all optional parameters - # api_response = api_instance.list_identities(filters, sorters, default_filter, count, limit, offset) + # results = IdentitiesApi(api_client).list_identities(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) ``` @@ -433,19 +451,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.identities_api import IdentitiesApi +from sailpoint.beta.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 try: # Reset an identity - api_instance.reset_identity(identity_id) - + IdentitiesApi(api_client).reset_identity(identity_id) # Below is a request that includes all optional parameters - # api_instance.reset_identity(identity_id) - except Exception as e: + # IdentitiesApi(api_client).reset_identity(identity_id) + except Exception as e: print("Exception when calling IdentitiesApi->reset_identity: %s\n" % e) ``` @@ -489,10 +510,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identities_api import IdentitiesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.send_account_verification_request import SendAccountVerificationRequest -from sailpoint.beta.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 send_account_verification_request = { "sourceName" : "Active Directory Source", @@ -501,12 +526,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(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(id, new_send_account_verification_request) # Below is a request that includes all optional parameters - # api_instance.send_identity_verification_account_token(id, Result) - except Exception as e: + # IdentitiesApi(api_client).send_identity_verification_account_token(id, new_send_account_verification_request) + except Exception as e: print("Exception when calling IdentitiesApi->send_identity_verification_account_token: %s\n" % e) ``` @@ -553,11 +578,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identities_api import IdentitiesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.invite_identities_request import InviteIdentitiesRequest from sailpoint.beta.models.task_status import TaskStatus -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: invite_identities_request = { "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], "uninvited" : false @@ -565,14 +594,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(Result) - + new_invite_identities_request = InviteIdentitiesRequest() + new_invite_identities_request.from_json(invite_identities_request) + results =IdentitiesApi(api_client).start_identities_invite(new_invite_identities_request) # Below is a request that includes all optional parameters - # api_response = api_instance.start_identities_invite(Result) + # results = IdentitiesApi(api_client).start_identities_invite(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) ``` @@ -624,25 +653,29 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identities_api import IdentitiesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.process_identities_request import ProcessIdentitiesRequest from sailpoint.beta.models.task_result_response import TaskResultResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: process_identities_request = { "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] } # ProcessIdentitiesRequest | try: # Process a list of identityIds - Result = process_identities_request.from_json(process_identities_request) - api_response = api_instance.start_identity_processing(Result) - + new_process_identities_request = ProcessIdentitiesRequest() + new_process_identities_request.from_json(process_identities_request) + results =IdentitiesApi(api_client).start_identity_processing(new_process_identities_request) # Below is a request that includes all optional parameters - # api_response = api_instance.start_identity_processing(Result) + # results = IdentitiesApi(api_client).start_identity_processing(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) ``` @@ -684,22 +717,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identities_api import IdentitiesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_sync_job import IdentitySyncJob -from sailpoint.beta.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 try: # Attribute synchronization for single identity. - api_response = api_instance.synchronize_attributes_for_identity(identity_id) - + results =IdentitiesApi(api_client).synchronize_attributes_for_identity(identity_id) # Below is a request that includes all optional parameters - # api_response = api_instance.synchronize_attributes_for_identity(identity_id) + # results = IdentitiesApi(api_client).synchronize_attributes_for_identity(identity_id) 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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IdentityAttributesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityAttributesApi.md index 34d17ef5e..637affcfb 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IdentityAttributesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityAttributesApi.md @@ -57,10 +57,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_attributes_api import IdentityAttributesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_attribute import IdentityAttribute -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: identity_attribute = { "standard" : false, "system" : false, @@ -86,14 +90,14 @@ from pprint import pprint try: # Create Identity Attribute - Result = identity_attribute.from_json(identity_attribute) - api_response = api_instance.create_identity_attribute(Result) - + new_identity_attribute = IdentityAttribute() + new_identity_attribute.from_json(identity_attribute) + results =IdentityAttributesApi(api_client).create_identity_attribute(new_identity_attribute) # Below is a request that includes all optional parameters - # api_response = api_instance.create_identity_attribute(Result) + # results = IdentityAttributesApi(api_client).create_identity_attribute(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) ``` @@ -135,19 +139,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.identity_attributes_api import IdentityAttributesApi +from sailpoint.beta.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. try: # Delete Identity Attribute - api_instance.delete_identity_attribute(name) - + IdentityAttributesApi(api_client).delete_identity_attribute(name) # Below is a request that includes all optional parameters - # api_instance.delete_identity_attribute(name) - except Exception as e: + # IdentityAttributesApi(api_client).delete_identity_attribute(name) + except Exception as e: print("Exception when calling IdentityAttributesApi->delete_identity_attribute: %s\n" % e) ``` @@ -189,22 +196,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_attributes_api import IdentityAttributesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_attribute_names import IdentityAttributeNames -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: identity_attribute_names = { "ids" : [ "name", "displayName" ] } # IdentityAttributeNames | try: # Bulk delete Identity Attributes - Result = identity_attribute_names.from_json(identity_attribute_names) - api_instance.delete_identity_attributes_in_bulk(Result) - + new_identity_attribute_names = IdentityAttributeNames() + new_identity_attribute_names.from_json(identity_attribute_names) + IdentityAttributesApi(api_client).delete_identity_attributes_in_bulk(new_identity_attribute_names) # Below is a request that includes all optional parameters - # api_instance.delete_identity_attributes_in_bulk(Result) - except Exception as e: + # IdentityAttributesApi(api_client).delete_identity_attributes_in_bulk(new_identity_attribute_names) + except Exception as e: print("Exception when calling IdentityAttributesApi->delete_identity_attributes_in_bulk: %s\n" % e) ``` @@ -246,22 +257,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_attributes_api import IdentityAttributesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_attribute import IdentityAttribute -from sailpoint.beta.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. try: # Get Identity Attribute - api_response = api_instance.get_identity_attribute(name) - + results =IdentityAttributesApi(api_client).get_identity_attribute(name) # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_attribute(name) + # results = IdentityAttributesApi(api_client).get_identity_attribute(name) 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) ``` @@ -305,10 +319,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_attributes_api import IdentityAttributesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_attribute import IdentityAttribute -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: 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) searchable_only = False # bool | Include only 'searchable' attributes in the response. (optional) (default to False) # bool | Include only 'searchable' attributes in the response. (optional) (default to False) @@ -317,13 +335,12 @@ from pprint import pprint try: # List Identity Attributes - api_response = api_instance.list_identity_attributes() - + results =IdentityAttributesApi(api_client).list_identity_attributes() # Below is a request that includes all optional parameters - # api_response = api_instance.list_identity_attributes(include_system, include_silent, searchable_only, count) + # results = IdentityAttributesApi(api_client).list_identity_attributes(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) ``` @@ -366,10 +383,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_attributes_api import IdentityAttributesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_attribute import IdentityAttribute -from sailpoint.beta.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. identity_attribute = { "standard" : false, @@ -396,14 +417,14 @@ from pprint import pprint try: # Update Identity Attribute - Result = identity_attribute.from_json(identity_attribute) - api_response = api_instance.put_identity_attribute(name, Result) - + new_identity_attribute = IdentityAttribute() + new_identity_attribute.from_json(identity_attribute) + results =IdentityAttributesApi(api_client).put_identity_attribute(name, new_identity_attribute) # Below is a request that includes all optional parameters - # api_response = api_instance.put_identity_attribute(name, Result) + # results = IdentityAttributesApi(api_client).put_identity_attribute(name, 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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IdentityHistoryApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityHistoryApi.md index f95355a24..6d32a5cc5 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IdentityHistoryApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityHistoryApi.md @@ -67,10 +67,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_history_api import IdentityHistoryApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_compare_response import IdentityCompareResponse -from sailpoint.beta.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 snapshot1 = '2007-03-01T13:00:00Z' # str | The snapshot 1 of identity (optional) # str | The snapshot 1 of identity (optional) snapshot2 = '2008-03-01T13:00:00Z' # str | The snapshot 2 of identity (optional) # str | The snapshot 2 of identity (optional) @@ -84,13 +88,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, ) - + results =IdentityHistoryApi(api_client).compare_identity_snapshots(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.compare_identity_snapshots(id, snapshot1, snapshot2, access_item_types, limit, offset, count) + # results = IdentityHistoryApi(api_client).compare_identity_snapshots(id, 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) ``` @@ -138,10 +141,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_history_api import IdentityHistoryApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.access_item_diff import AccessItemDiff -from sailpoint.beta.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 access_associated = 2007-03-01T13:00:00Z # bool | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) # bool | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) @@ -154,13 +161,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, ) - + results =IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, ) # Below is a request that includes all optional parameters - # api_response = api_instance.compare_identity_snapshots_access_type(id, access_type, access_associated, snapshot1, snapshot2, limit, offset, count) + # results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, 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) ``` @@ -201,22 +207,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_history_api import IdentityHistoryApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_history_response import IdentityHistoryResponse -from sailpoint.beta.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 try: # Get latest snapshot of identity - api_response = api_instance.get_historical_identity(id) - + results =IdentityHistoryApi(api_client).get_historical_identity(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_historical_identity(id) + # results = IdentityHistoryApi(api_client).get_historical_identity(id) 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) ``` @@ -264,10 +273,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_history_api import IdentityHistoryApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.get_historical_identity_events200_response_inner import GetHistoricalIdentityEvents200ResponseInner -from sailpoint.beta.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_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) event_types = ['[AccessAddedEvent, AccessRemovedEvent]'] # List[str] | An optional list of event types to return. If null or empty, all events are returned (optional) @@ -283,13 +296,12 @@ from pprint import pprint try: # Lists all events for the given identity - api_response = api_instance.get_historical_identity_events(id, ) - + results =IdentityHistoryApi(api_client).get_historical_identity_events(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_historical_identity_events(id, var_from, event_types, access_item_types, limit, offset, count) + # results = IdentityHistoryApi(api_client).get_historical_identity_events(id, 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) ``` @@ -331,23 +343,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_history_api import IdentityHistoryApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_history_response import IdentityHistoryResponse -from sailpoint.beta.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 try: # Gets an identity snapshot at a given date - api_response = api_instance.get_identity_snapshot(id, var_date) - + results =IdentityHistoryApi(api_client).get_identity_snapshot(id, var_date) # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_snapshot(id, var_date) + # results = IdentityHistoryApi(api_client).get_identity_snapshot(id, var_date) 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) ``` @@ -394,10 +409,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_history_api import IdentityHistoryApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.metric_response import MetricResponse -from sailpoint.beta.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 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) interval = 'interval_example' # str | The interval indicating day or month. Defaults to month if not specified (optional) # str | The interval indicating day or month. Defaults to month if not specified (optional) @@ -409,13 +428,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, ) - + results =IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_snapshot_summary(id, before, interval, time_zone, limit, offset, count) + # results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, 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) ``` @@ -456,21 +474,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.identity_history_api import IdentityHistoryApi +from sailpoint.beta.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 try: # Gets the start date of the identity - api_response = api_instance.get_identity_start_date(id) - + results =IdentityHistoryApi(api_client).get_identity_start_date(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_start_date(id) + # results = IdentityHistoryApi(api_client).get_identity_start_date(id) 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) ``` @@ -515,10 +536,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_history_api import IdentityHistoryApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_list_item import IdentityListItem -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: 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) is_active = true # bool | Indicates if we want to only list active or inactive identities. (optional) # bool | Indicates if we want to only list active or inactive identities. (optional) @@ -528,13 +553,12 @@ from pprint import pprint try: # Lists all the identities - api_response = api_instance.list_historical_identities() - + results =IdentityHistoryApi(api_client).list_historical_identities() # Below is a request that includes all optional parameters - # api_response = api_instance.list_historical_identities(starts_with_query, is_deleted, is_active, limit, offset) + # results = IdentityHistoryApi(api_client).list_historical_identities(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) ``` @@ -583,10 +607,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_history_api import IdentityHistoryApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner -from sailpoint.beta.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 type = 'account' # str | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) # str | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) filters = 'source eq \"DataScienceDataset\"' # 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: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *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: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq* (optional) @@ -599,13 +627,12 @@ from pprint import pprint try: # List Access Items by Identity - api_response = api_instance.list_identity_access_items(id, ) - + results =IdentityHistoryApi(api_client).list_identity_access_items(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.list_identity_access_items(id, type, filters, sorters, query, limit, count, offset) + # results = IdentityHistoryApi(api_client).list_identity_access_items(id, type, filters, sorters, query, 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) ``` @@ -649,10 +676,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_history_api import IdentityHistoryApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | Identity ID. # str | Identity ID. var_date = '2007-03-01T13:00:00Z' # str | Specified date. # str | Specified date. type = 'account' # str | Access item type. (optional) # str | Access item type. (optional) @@ -660,13 +691,12 @@ from pprint import pprint try: # Get Identity Access Items Snapshot - api_response = api_instance.list_identity_snapshot_access_items(id, var_date, ) - + results =IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, ) # Below is a request that includes all optional parameters - # api_response = api_instance.list_identity_snapshot_access_items(id, var_date, type) + # results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, 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) ``` @@ -712,10 +742,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_history_api import IdentityHistoryApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_snapshot_summary_response import IdentitySnapshotSummaryResponse -from sailpoint.beta.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 start = '2007-03-01T13:00:00Z' # str | The specified start date (optional) # str | The specified start date (optional) interval = 'interval_example' # str | The interval indicating the range in day or month for the specified interval-name (optional) # str | The interval indicating the range in day or month for the specified interval-name (optional) @@ -726,13 +760,12 @@ from pprint import pprint try: # Lists all the snapshots for the identity - api_response = api_instance.list_identity_snapshots(id, ) - + results =IdentityHistoryApi(api_client).list_identity_snapshots(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.list_identity_snapshots(id, start, interval, limit, offset, count) + # results = IdentityHistoryApi(api_client).list_identity_snapshots(id, 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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IdentityProfilesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityProfilesApi.md index 283ce2c3e..229b6b6d0 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IdentityProfilesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityProfilesApi.md @@ -74,10 +74,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_profile import IdentityProfile -from sailpoint.beta.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", @@ -130,14 +134,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) ``` @@ -185,22 +189,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.task_result_simplified import TaskResultSimplified -from sailpoint.beta.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) ``` @@ -247,24 +254,28 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.task_result_simplified import TaskResultSimplified -from sailpoint.beta.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) ``` @@ -310,10 +321,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_profile_exported_object import IdentityProfileExportedObject -from sailpoint.beta.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) @@ -323,13 +338,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) ``` @@ -372,22 +386,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_attribute_config import IdentityAttributeConfig -from sailpoint.beta.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: # 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) ``` @@ -431,22 +448,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_profile import IdentityProfile -from sailpoint.beta.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: # Gets a 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) ``` @@ -487,11 +507,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_profile_exported_object import IdentityProfileExportedObject from sailpoint.beta.models.object_import_result import ObjectImportResult -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: [sailpoint.beta.IdentityProfileExportedObject()] # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. identity_profile_exported_object = { "self" : { @@ -554,14 +578,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) ``` @@ -607,10 +631,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_profile import IdentityProfile -from sailpoint.beta.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) @@ -620,13 +648,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) ``` @@ -669,11 +696,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_preview_request import IdentityPreviewRequest from sailpoint.beta.models.identity_preview_response import IdentityPreviewResponse -from sailpoint.beta.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" : { @@ -704,14 +735,14 @@ from pprint import pprint try: # Generate Identity Profile Preview - Result = identity_preview_request.from_json(identity_preview_request) - api_response = api_instance.show_generate_identity_preview(Result) - + new_identity_preview_request = IdentityPreviewRequest() + new_identity_preview_request.from_json(identity_preview_request) + results =IdentityProfilesApi(api_client).show_generate_identity_preview(new_identity_preview_request) # Below is a request that includes all optional parameters - # api_response = api_instance.show_generate_identity_preview(Result) + # results = IdentityProfilesApi(api_client).show_generate_identity_preview(new_identity_preview_request) print("The response of IdentityProfilesApi->show_generate_identity_preview:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling IdentityProfilesApi->show_generate_identity_preview: %s\n" % e) ``` @@ -758,21 +789,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.beta.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) ``` @@ -826,11 +860,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_profile import IdentityProfile from sailpoint.beta.models.json_patch_operation import JsonPatchOperation -from sailpoint.beta.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 = { @@ -842,14 +880,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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/LaunchersApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/LaunchersApi.md index dd988533c..0052c2eef 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/LaunchersApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/LaunchersApi.md @@ -60,11 +60,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.launchers_api import LaunchersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.launcher import Launcher from sailpoint.beta.models.launcher_request import LauncherRequest -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: launcher_request = { "reference" : { "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", @@ -79,14 +83,14 @@ from pprint import pprint try: # Create launcher - Result = launcher_request.from_json(launcher_request) - api_response = api_instance.create_launcher(Result) - + new_launcher_request = LauncherRequest() + new_launcher_request.from_json(launcher_request) + results =LaunchersApi(api_client).create_launcher(new_launcher_request) # Below is a request that includes all optional parameters - # api_response = api_instance.create_launcher(Result) + # results = LaunchersApi(api_client).create_launcher(new_launcher_request) print("The response of LaunchersApi->create_launcher:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling LaunchersApi->create_launcher: %s\n" % e) ``` @@ -128,19 +132,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.launchers_api import LaunchersApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be deleted # str | ID of the Launcher to be deleted try: # Delete Launcher - api_instance.delete_launcher(launcher_id) - + LaunchersApi(api_client).delete_launcher(launcher_id) # Below is a request that includes all optional parameters - # api_instance.delete_launcher(launcher_id) - except Exception as e: + # LaunchersApi(api_client).delete_launcher(launcher_id) + except Exception as e: print("Exception when calling LaunchersApi->delete_launcher: %s\n" % e) ``` @@ -182,22 +189,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.launchers_api import LaunchersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.launcher import Launcher -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be retrieved # str | ID of the Launcher to be retrieved try: # Get Launcher by ID - api_response = api_instance.get_launcher(launcher_id) - + results =LaunchersApi(api_client).get_launcher(launcher_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_launcher(launcher_id) + # results = LaunchersApi(api_client).get_launcher(launcher_id) print("The response of LaunchersApi->get_launcher:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling LaunchersApi->get_launcher: %s\n" % e) ``` @@ -241,10 +251,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.launchers_api import LaunchersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.get_launchers200_response import GetLaunchers200Response -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: filters = 'disabled 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: **description**: *sw* **disabled**: *eq* **name**: *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: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional) next = 'eyJuZXh0IjoxMjN9Cg==' # str | Pagination marker (optional) # str | Pagination marker (optional) limit = 10 # int | Number of Launchers to return (optional) (default to 10) # int | Number of Launchers to return (optional) (default to 10) @@ -252,13 +266,12 @@ from pprint import pprint try: # List all Launchers for tenant - api_response = api_instance.get_launchers() - + results =LaunchersApi(api_client).get_launchers() # Below is a request that includes all optional parameters - # api_response = api_instance.get_launchers(filters, next, limit) + # results = LaunchersApi(api_client).get_launchers(filters, next, limit) print("The response of LaunchersApi->get_launchers:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling LaunchersApi->get_launchers: %s\n" % e) ``` @@ -301,11 +314,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.launchers_api import LaunchersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.launcher import Launcher from sailpoint.beta.models.launcher_request import LauncherRequest -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be replaced # str | ID of the Launcher to be replaced launcher_request = { "reference" : { @@ -321,14 +338,14 @@ from pprint import pprint try: # Replace Launcher - Result = launcher_request.from_json(launcher_request) - api_response = api_instance.put_launcher(launcher_id, Result) - + new_launcher_request = LauncherRequest() + new_launcher_request.from_json(launcher_request) + results =LaunchersApi(api_client).put_launcher(launcher_id, new_launcher_request) # Below is a request that includes all optional parameters - # api_response = api_instance.put_launcher(launcher_id, Result) + # results = LaunchersApi(api_client).put_launcher(launcher_id, new_launcher_request) print("The response of LaunchersApi->put_launcher:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling LaunchersApi->put_launcher: %s\n" % e) ``` @@ -370,22 +387,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.launchers_api import LaunchersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.start_launcher200_response import StartLauncher200Response -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be launched # str | ID of the Launcher to be launched try: # Launch a Launcher - api_response = api_instance.start_launcher(launcher_id) - + results =LaunchersApi(api_client).start_launcher(launcher_id) # Below is a request that includes all optional parameters - # api_response = api_instance.start_launcher(launcher_id) + # results = LaunchersApi(api_client).start_launcher(launcher_id) print("The response of LaunchersApi->start_launcher:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling LaunchersApi->start_launcher: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/LifecycleStatesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/LifecycleStatesApi.md index a76739067..621491205 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/LifecycleStatesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/LifecycleStatesApi.md @@ -92,23 +92,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.lifecycle_states_api import LifecycleStatesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.lifecycle_state import LifecycleState -from sailpoint.beta.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_states(identity_profile_id, lifecycle_state_id) - + results =LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, lifecycle_state_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_lifecycle_states(identity_profile_id, lifecycle_state_id) + # results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, lifecycle_state_id) 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) ``` @@ -154,11 +157,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.lifecycle_states_api import LifecycleStatesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.json_patch_operation import JsonPatchOperation from sailpoint.beta.models.lifecycle_state import LifecycleState -from sailpoint.beta.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 @@ -171,14 +178,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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/MFAConfigurationApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/MFAConfigurationApi.md index 42cca765f..e05cc91eb 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/MFAConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/MFAConfigurationApi.md @@ -58,22 +58,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.mfa_okta_config import MfaOktaConfig -from sailpoint.beta.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: # Delete MFA method configuration - api_response = api_instance.delete_mfa_config(method) - + results =MFAConfigurationApi(api_client).delete_mfa_config(method) # Below is a request that includes all optional parameters - # api_response = api_instance.delete_mfa_config(method) + # results = MFAConfigurationApi(api_client).delete_mfa_config(method) print("The response of MFAConfigurationApi->delete_mfa_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling MFAConfigurationApi->delete_mfa_config: %s\n" % e) ``` @@ -111,21 +114,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.mfa_duo_config import MfaDuoConfig -from sailpoint.beta.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) ``` @@ -166,22 +172,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.kba_question import KbaQuestion -from sailpoint.beta.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) ``` @@ -219,21 +228,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.mfa_okta_config import MfaOktaConfig -from sailpoint.beta.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) ``` @@ -274,10 +286,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.mfa_duo_config import MfaDuoConfig -from sailpoint.beta.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", @@ -292,14 +308,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) ``` @@ -340,10 +356,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.mfa_okta_config import MfaOktaConfig -from sailpoint.beta.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", @@ -354,14 +374,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) ``` @@ -402,11 +422,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.kba_answer_request_item import KbaAnswerRequestItem from sailpoint.beta.models.kba_answer_response_item import KbaAnswerResponseItem -from sailpoint.beta.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", @@ -416,14 +440,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) ``` @@ -464,22 +488,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.mfa_config_test_response import MfaConfigTestResponse -from sailpoint.beta.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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/MFAControllerApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/MFAControllerApi.md index 3adfd99c9..14ae77db6 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/MFAControllerApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/MFAControllerApi.md @@ -56,11 +56,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.mfa_controller_api import MFAControllerApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.send_token_request import SendTokenRequest from sailpoint.beta.models.send_token_response import SendTokenResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: send_token_request = { "userAlias" : "will.albin", "deliveryType" : "EMAIL_WORK" @@ -68,14 +72,14 @@ from pprint import pprint try: # Create and send user token - Result = send_token_request.from_json(send_token_request) - api_response = api_instance.create_send_token(Result) - + new_send_token_request = SendTokenRequest() + new_send_token_request.from_json(send_token_request) + results =MFAControllerApi(api_client).create_send_token(new_send_token_request) # Below is a request that includes all optional parameters - # api_response = api_instance.create_send_token(Result) + # results = MFAControllerApi(api_client).create_send_token(new_send_token_request) print("The response of MFAControllerApi->create_send_token:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling MFAControllerApi->create_send_token: %s\n" % e) ``` @@ -117,11 +121,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.mfa_controller_api import MFAControllerApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.verification_poll_request import VerificationPollRequest from sailpoint.beta.models.verification_response import VerificationResponse -from sailpoint.beta.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', 'duo-web', 'kba','token', 'rsa' # str | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' verification_poll_request = { "requestId" : "089899f13a8f4da7824996191587bab9" @@ -129,14 +137,14 @@ from pprint import pprint try: # Polling MFA method by VerificationPollRequest - Result = verification_poll_request.from_json(verification_poll_request) - api_response = api_instance.ping_verification_status(method, Result) - + new_verification_poll_request = VerificationPollRequest() + new_verification_poll_request.from_json(verification_poll_request) + results =MFAControllerApi(api_client).ping_verification_status(method, new_verification_poll_request) # Below is a request that includes all optional parameters - # api_response = api_instance.ping_verification_status(method, Result) + # results = MFAControllerApi(api_client).ping_verification_status(method, new_verification_poll_request) print("The response of MFAControllerApi->ping_verification_status:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling MFAControllerApi->ping_verification_status: %s\n" % e) ``` @@ -177,11 +185,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.mfa_controller_api import MFAControllerApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.duo_verification_request import DuoVerificationRequest from sailpoint.beta.models.verification_response import VerificationResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: duo_verification_request = { "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", "userId" : "2c9180947f0ef465017f215cbcfd004b" @@ -189,14 +201,14 @@ from pprint import pprint try: # Verifying authentication via Duo method - Result = duo_verification_request.from_json(duo_verification_request) - api_response = api_instance.send_duo_verify_request(Result) - + new_duo_verification_request = DuoVerificationRequest() + new_duo_verification_request.from_json(duo_verification_request) + results =MFAControllerApi(api_client).send_duo_verify_request(new_duo_verification_request) # Below is a request that includes all optional parameters - # api_response = api_instance.send_duo_verify_request(Result) + # results = MFAControllerApi(api_client).send_duo_verify_request(new_duo_verification_request) print("The response of MFAControllerApi->send_duo_verify_request:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling MFAControllerApi->send_duo_verify_request: %s\n" % e) ``` @@ -237,11 +249,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.mfa_controller_api import MFAControllerApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.kba_answer_request_item import KbaAnswerRequestItem from sailpoint.beta.models.kba_auth_response import KbaAuthResponse -from sailpoint.beta.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", @@ -251,14 +267,14 @@ from pprint import pprint try: # Authenticate KBA provided MFA method - Result = kba_answer_request_item.from_json(kba_answer_request_item) - api_response = api_instance.send_kba_answers(Result) - + new_kba_answer_request_item = KbaAnswerRequestItem() + new_kba_answer_request_item.from_json(kba_answer_request_item) + results =MFAControllerApi(api_client).send_kba_answers(new_kba_answer_request_item) # Below is a request that includes all optional parameters - # api_response = api_instance.send_kba_answers(Result) + # results = MFAControllerApi(api_client).send_kba_answers(new_kba_answer_request_item) print("The response of MFAControllerApi->send_kba_answers:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling MFAControllerApi->send_kba_answers: %s\n" % e) ``` @@ -299,25 +315,29 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.mfa_controller_api import MFAControllerApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.okta_verification_request import OktaVerificationRequest from sailpoint.beta.models.verification_response import VerificationResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: okta_verification_request = { "userId" : "example@mail.com" } # OktaVerificationRequest | try: # Verifying authentication via Okta method - Result = okta_verification_request.from_json(okta_verification_request) - api_response = api_instance.send_okta_verify_request(Result) - + new_okta_verification_request = OktaVerificationRequest() + new_okta_verification_request.from_json(okta_verification_request) + results =MFAControllerApi(api_client).send_okta_verify_request(new_okta_verification_request) # Below is a request that includes all optional parameters - # api_response = api_instance.send_okta_verify_request(Result) + # results = MFAControllerApi(api_client).send_okta_verify_request(new_okta_verification_request) print("The response of MFAControllerApi->send_okta_verify_request:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling MFAControllerApi->send_okta_verify_request: %s\n" % e) ``` @@ -358,11 +378,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.mfa_controller_api import MFAControllerApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.token_auth_request import TokenAuthRequest from sailpoint.beta.models.token_auth_response import TokenAuthResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: token_auth_request = { "userAlias" : "will.albin", "deliveryType" : "EMAIL_WORK", @@ -371,14 +395,14 @@ from pprint import pprint try: # Authenticate Token provided MFA method - Result = token_auth_request.from_json(token_auth_request) - api_response = api_instance.send_token_auth_request(Result) - + new_token_auth_request = TokenAuthRequest() + new_token_auth_request.from_json(token_auth_request) + results =MFAControllerApi(api_client).send_token_auth_request(new_token_auth_request) # Below is a request that includes all optional parameters - # api_response = api_instance.send_token_auth_request(Result) + # results = MFAControllerApi(api_client).send_token_auth_request(new_token_auth_request) print("The response of MFAControllerApi->send_token_auth_request:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ManagedClientsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ManagedClientsApi.md index d865ed3e3..4ddf202b7 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/ManagedClientsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ManagedClientsApi.md @@ -59,24 +59,27 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.managed_clients_api import ManagedClientsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.managed_client_status import ManagedClientStatus from sailpoint.beta.models.managed_client_type import ManagedClientType -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'aClientId' # str | ID of the Managed Client Status to get # str | ID of the Managed Client Status to get type = sailpoint.beta.ManagedClientType() # ManagedClientType | Type of the Managed Client Status to get # ManagedClientType | Type of the Managed Client Status to get try: # Specified 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) ``` @@ -122,11 +125,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.managed_clients_api import ManagedClientsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.managed_client_status import ManagedClientStatus from sailpoint.beta.models.managed_client_status_agg_response import ManagedClientStatusAggResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'aClientId' # str | ID of the Managed Client Status to update # str | ID of the Managed Client Status to update managed_client_status = { "body" : { @@ -157,14 +164,14 @@ from pprint import pprint try: # Handle status request from client - Result = managed_client_status.from_json(managed_client_status) - api_response = api_instance.update_managed_client_status(id, Result) - + new_managed_client_status = ManagedClientStatus() + new_managed_client_status.from_json(managed_client_status) + results =ManagedClientsApi(api_client).update_managed_client_status(id, new_managed_client_status) # Below is a request that includes all optional parameters - # api_response = api_instance.update_managed_client_status(id, Result) + # results = ManagedClientsApi(api_client).update_managed_client_status(id, new_managed_client_status) print("The response of ManagedClientsApi->update_managed_client_status:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling ManagedClientsApi->update_managed_client_status: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ManagedClustersApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ManagedClustersApi.md index 0d40a0b9a..1654106f7 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/ManagedClustersApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ManagedClustersApi.md @@ -60,22 +60,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'aClusterId' # str | ID of ManagedCluster to get log configuration for # str | ID of ManagedCluster to get log configuration for try: # Get managed cluster's 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) ``` @@ -120,22 +123,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.managed_cluster import ManagedCluster -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'aClusterId' # str | ID of the ManagedCluster to get # str | ID of the ManagedCluster to get try: # Get a specified ManagedCluster. - 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) ``` @@ -182,10 +188,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.managed_cluster import ManagedCluster -from sailpoint.beta.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) @@ -194,13 +204,12 @@ from pprint import pprint try: # Retrieve all 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) ``` @@ -246,10 +255,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'aClusterId' # str | ID of ManagedCluster to update log configuration for # str | ID of ManagedCluster to update log configuration for client_log_configuration = { "durationMinutes" : 120, @@ -262,13 +275,12 @@ from pprint import pprint try: # Update managed cluster's log configuration - api_response = api_instance.put_client_log_configuration(id, Result) - + results =ManagedClustersApi(api_client).put_client_log_configuration(id, new_client_log_configuration) # 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_client_log_configuration) 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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/MultiHostIntegrationApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/MultiHostIntegrationApi.md index 56a6de869..2064bbf1c 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/MultiHostIntegrationApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/MultiHostIntegrationApi.md @@ -69,11 +69,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.multi_host_integrations import MultiHostIntegrations from sailpoint.beta.models.multi_host_integrations_create import MultiHostIntegrationsCreate -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: multi_host_integrations_create = { "owner" : { "name" : "MyName", @@ -103,14 +107,14 @@ from pprint import pprint try: # Create Multi-Host Integration - Result = multi_host_integrations_create.from_json(multi_host_integrations_create) - api_response = api_instance.create_multi_host_integration(Result) - + new_multi_host_integrations_create = MultiHostIntegrationsCreate() + new_multi_host_integrations_create.from_json(multi_host_integrations_create) + results =MultiHostIntegrationApi(api_client).create_multi_host_integration(new_multi_host_integrations_create) # Below is a request that includes all optional parameters - # api_response = api_instance.create_multi_host_integration(Result) + # results = MultiHostIntegrationApi(api_client).create_multi_host_integration(new_multi_host_integrations_create) print("The response of MultiHostIntegrationApi->create_multi_host_integration:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling MultiHostIntegrationApi->create_multi_host_integration: %s\n" % e) ``` @@ -155,10 +159,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.multi_host_integrations_create_sources import MultiHostIntegrationsCreateSources -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration. # str | ID of the Multi-Host Integration. [sailpoint.beta.MultiHostIntegrationsCreateSources()] # List[MultiHostIntegrationsCreateSources] | The specifics of the sources to create within Multi-Host Integration. multi_host_integrations_create_sources = { @@ -177,12 +185,12 @@ from pprint import pprint try: # Create Sources Within Multi-Host Integration - Result = multi_host_integrations_create_sources.from_json(multi_host_integrations_create_sources) - api_instance.create_sources_within_multi_host(multihost_id, Result) - + new_multi_host_integrations_create_sources = MultiHostIntegrationsCreateSources() + new_multi_host_integrations_create_sources.from_json(multi_host_integrations_create_sources) + MultiHostIntegrationApi(api_client).create_sources_within_multi_host(multihost_id, new_multi_host_integrations_create_sources) # Below is a request that includes all optional parameters - # api_instance.create_sources_within_multi_host(multihost_id, Result) - except Exception as e: + # MultiHostIntegrationApi(api_client).create_sources_within_multi_host(multihost_id, new_multi_host_integrations_create_sources) + except Exception as e: print("Exception when calling MultiHostIntegrationApi->create_sources_within_multi_host: %s\n" % e) ``` @@ -226,19 +234,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of Multi-Host Integration to delete. # str | ID of Multi-Host Integration to delete. try: # Delete Multi-Host Integration - api_instance.delete_multi_host(multihost_id) - + MultiHostIntegrationApi(api_client).delete_multi_host(multihost_id) # Below is a request that includes all optional parameters - # api_instance.delete_multi_host(multihost_id) - except Exception as e: + # MultiHostIntegrationApi(api_client).delete_multi_host(multihost_id) + except Exception as e: print("Exception when calling MultiHostIntegrationApi->delete_multi_host: %s\n" % e) ``` @@ -282,22 +293,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.multi_host_integrations_agg_schedule_update import MultiHostIntegrationsAggScheduleUpdate -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: multihost_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update try: # Get Account Aggregation Groups Within Multi-Host Integration ID - api_response = api_instance.get_acct_aggregation_groups(multihost_id) - + results =MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_acct_aggregation_groups(multihost_id) + # results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id) print("The response of MultiHostIntegrationApi->get_acct_aggregation_groups:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_acct_aggregation_groups: %s\n" % e) ``` @@ -341,22 +355,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.multi_host_integrations_agg_schedule_update import MultiHostIntegrationsAggScheduleUpdate -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: multi_host_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update try: # Get Entitlement Aggregation Groups Within Multi-Host Integration ID - api_response = api_instance.get_entitlement_aggregation_groups(multi_host_id) - + results =MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_entitlement_aggregation_groups(multi_host_id) + # results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id) print("The response of MultiHostIntegrationApi->get_entitlement_aggregation_groups:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_entitlement_aggregation_groups: %s\n" % e) ``` @@ -400,22 +417,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.multi_host_integrations import MultiHostIntegrations -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration. # str | ID of the Multi-Host Integration. try: # Get Multi-Host Integration By ID - api_response = api_instance.get_multi_host_integrations(multihost_id) - + results =MultiHostIntegrationApi(api_client).get_multi_host_integrations(multihost_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_multi_host_integrations(multihost_id) + # results = MultiHostIntegrationApi(api_client).get_multi_host_integrations(multihost_id) print("The response of MultiHostIntegrationApi->get_multi_host_integrations:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations: %s\n" % e) ``` @@ -464,10 +484,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.multi_host_integrations import MultiHostIntegrations -from sailpoint.beta.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) @@ -478,13 +502,12 @@ from pprint import pprint try: # List All Existing Multi-Host Integrations - api_response = api_instance.get_multi_host_integrations_list() - + results =MultiHostIntegrationApi(api_client).get_multi_host_integrations_list() # Below is a request that includes all optional parameters - # api_response = api_instance.get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin) + # results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin) print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e) ``` @@ -528,22 +551,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.source_creation_errors import SourceCreationErrors -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: multi_host_id = '004091cb79b04636b88662afa50a4440' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration try: # List Multi-Host Source Creation Errors - api_response = api_instance.get_multi_host_source_creation_errors(multi_host_id) - + results =MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_multi_host_source_creation_errors(multi_host_id) + # results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id) print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e) ``` @@ -584,21 +610,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.multi_host_integration_template_type import MultiHostIntegrationTemplateType -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # List Multi-Host Integration Types - api_response = api_instance.get_multihost_integration_types() - + results =MultiHostIntegrationApi(api_client).get_multihost_integration_types() # Below is a request that includes all optional parameters - # api_response = api_instance.get_multihost_integration_types() + # results = MultiHostIntegrationApi(api_client).get_multihost_integration_types() print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e) ``` @@ -647,10 +676,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.multi_host_sources import MultiHostSources -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: multihost_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update 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) @@ -661,13 +694,12 @@ from pprint import pprint try: # List Sources Within Multi-Host Integration - api_response = api_instance.get_sources_within_multi_host(multihost_id, ) - + results =MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count) + # results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count) print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e) ``` @@ -711,19 +743,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: multihost_id = '2c91808568c529c60168cca6f90c1324' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration try: # Test Configuration For Multi-Host Integration - api_instance.test_connection_multi_host_sources(multihost_id) - + MultiHostIntegrationApi(api_client).test_connection_multi_host_sources(multihost_id) # Below is a request that includes all optional parameters - # api_instance.test_connection_multi_host_sources(multihost_id) - except Exception as e: + # MultiHostIntegrationApi(api_client).test_connection_multi_host_sources(multihost_id) + except Exception as e: print("Exception when calling MultiHostIntegrationApi->test_connection_multi_host_sources: %s\n" % e) ``` @@ -768,23 +803,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.test_source_connection_multihost200_response import TestSourceConnectionMultihost200Response -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration source_id = '2c91808568c529f60168cca6f90c1324' # str | ID of the source within the Multi-Host Integration # str | ID of the source within the Multi-Host Integration try: # Test Configuration For Multi-Host Integration's Single Source - api_response = api_instance.test_source_connection_multihost(multihost_id, source_id) - + results =MultiHostIntegrationApi(api_client).test_source_connection_multihost(multihost_id, source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.test_source_connection_multihost(multihost_id, source_id) + # results = MultiHostIntegrationApi(api_client).test_source_connection_multihost(multihost_id, source_id) print("The response of MultiHostIntegrationApi->test_source_connection_multihost:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling MultiHostIntegrationApi->test_source_connection_multihost: %s\n" % e) ``` @@ -829,10 +867,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.update_multi_host_sources_request_inner import UpdateMultiHostSourcesRequestInner -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: multihost_id = 'anId' # str | ID of the Multi-Host Integration to update. # str | ID of the Multi-Host Integration to update. [{op=add, path=/description, value=MDK Multi-Host Integration 222 description}] # List[UpdateMultiHostSourcesRequestInner] | This endpoint allows you to update a Multi-Host Integration. update_multi_host_sources_request_inner = [{op=add, path=/description, value=MDK Multi-Host Integration 222 description}] # List[UpdateMultiHostSourcesRequestInner] | This endpoint allows you to update a Multi-Host Integration. @@ -840,12 +882,12 @@ from pprint import pprint try: # Update Multi-Host Integration - Result = update_multi_host_sources_request_inner.from_json(update_multi_host_sources_request_inner) - api_instance.update_multi_host_sources(multihost_id, Result) - + new_update_multi_host_sources_request_inner = UpdateMultiHostSourcesRequestInner() + new_update_multi_host_sources_request_inner.from_json(update_multi_host_sources_request_inner) + MultiHostIntegrationApi(api_client).update_multi_host_sources(multihost_id, new_update_multi_host_sources_request_inner) # Below is a request that includes all optional parameters - # api_instance.update_multi_host_sources(multihost_id, Result) - except Exception as e: + # MultiHostIntegrationApi(api_client).update_multi_host_sources(multihost_id, new_update_multi_host_sources_request_inner) + except Exception as e: print("Exception when calling MultiHostIntegrationApi->update_multi_host_sources: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/NonEmployeeLifecycleManagementApi.md index 87c6cb568..1e497142b 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/NonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/NonEmployeeLifecycleManagementApi.md @@ -114,11 +114,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.non_employee_approval_decision import NonEmployeeApprovalDecision from sailpoint.beta.models.non_employee_approval_item import NonEmployeeApprovalItem -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'id_example' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) non_employee_approval_decision = { "comment" : "comment" @@ -126,14 +130,14 @@ from pprint import pprint try: # Approve a Non-Employee Request - Result = non_employee_approval_decision.from_json(non_employee_approval_decision) - api_response = api_instance.approve_non_employee_request(id, Result) - + new_non_employee_approval_decision = NonEmployeeApprovalDecision() + new_non_employee_approval_decision.from_json(non_employee_approval_decision) + results =NonEmployeeLifecycleManagementApi(api_client).approve_non_employee_request(id, new_non_employee_approval_decision) # Below is a request that includes all optional parameters - # api_response = api_instance.approve_non_employee_request(id, Result) + # results = NonEmployeeLifecycleManagementApi(api_client).approve_non_employee_request(id, new_non_employee_approval_decision) print("The response of NonEmployeeLifecycleManagementApi->approve_non_employee_request:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->approve_non_employee_request: %s\n" % e) ``` @@ -176,11 +180,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.non_employee_record import NonEmployeeRecord from sailpoint.beta.models.non_employee_request_body import NonEmployeeRequestBody -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: non_employee_request_body = { "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", @@ -198,14 +206,14 @@ from pprint import pprint try: # Create Non-Employee Record - Result = non_employee_request_body.from_json(non_employee_request_body) - api_response = api_instance.create_non_employee_record(Result) - + new_non_employee_request_body = NonEmployeeRequestBody() + new_non_employee_request_body.from_json(non_employee_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(new_non_employee_request_body) # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_record(Result) + # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(new_non_employee_request_body) print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_record:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_record: %s\n" % e) ``` @@ -246,11 +254,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.non_employee_request import NonEmployeeRequest from sailpoint.beta.models.non_employee_request_body import NonEmployeeRequestBody -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: non_employee_request_body = { "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", @@ -268,14 +280,14 @@ from pprint import pprint try: # Create Non-Employee Request - Result = non_employee_request_body.from_json(non_employee_request_body) - api_response = api_instance.create_non_employee_request(Result) - + new_non_employee_request_body = NonEmployeeRequestBody() + new_non_employee_request_body.from_json(non_employee_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(new_non_employee_request_body) # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_request(Result) + # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(new_non_employee_request_body) print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_request:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_request: %s\n" % e) ``` @@ -318,11 +330,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.non_employee_source_request_body import NonEmployeeSourceRequestBody from sailpoint.beta.models.non_employee_source_with_cloud_external_id import NonEmployeeSourceWithCloudExternalId -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: non_employee_source_request_body = { "owner" : { "id" : "2c91808570313110017040b06f344ec9" @@ -352,14 +368,14 @@ from pprint import pprint try: # Create Non-Employee Source - Result = non_employee_source_request_body.from_json(non_employee_source_request_body) - api_response = api_instance.create_non_employee_source(Result) - + new_non_employee_source_request_body = NonEmployeeSourceRequestBody() + new_non_employee_source_request_body.from_json(non_employee_source_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source(new_non_employee_source_request_body) # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_source(Result) + # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source(new_non_employee_source_request_body) print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source: %s\n" % e) ``` @@ -401,11 +417,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute from sailpoint.beta.models.non_employee_schema_attribute_body import NonEmployeeSchemaAttributeBody -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id non_employee_schema_attribute_body = { "helpText" : "The unique identifier for the account", @@ -418,14 +438,14 @@ from pprint import pprint try: # Create Non-Employee Source Schema Attribute - Result = non_employee_schema_attribute_body.from_json(non_employee_schema_attribute_body) - api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) - + new_non_employee_schema_attribute_body = NonEmployeeSchemaAttributeBody() + new_non_employee_schema_attribute_body.from_json(non_employee_schema_attribute_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source_schema_attributes(source_id, new_non_employee_schema_attribute_body) # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) + # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source_schema_attributes(source_id, new_non_employee_schema_attribute_body) print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes: %s\n" % e) ``` @@ -466,19 +486,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) try: # Delete Non-Employee Record - api_instance.delete_non_employee_record(id) - + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id) # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_record(id) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_record: %s\n" % e) ``` @@ -521,20 +544,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.delete_non_employee_record_in_bulk_request import DeleteNonEmployeeRecordInBulkRequest -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: delete_non_employee_record_in_bulk_request = sailpoint.beta.DeleteNonEmployeeRecordInBulkRequest() # DeleteNonEmployeeRecordInBulkRequest | Non-Employee bulk delete request body. try: # Delete Multiple Non-Employee Records - Result = delete_non_employee_record_in_bulk_request.from_json(delete_non_employee_record_in_bulk_request) - api_instance.delete_non_employee_record_in_bulk(Result) - + new_delete_non_employee_record_in_bulk_request = DeleteNonEmployeeRecordInBulkRequest() + new_delete_non_employee_record_in_bulk_request.from_json(delete_non_employee_record_in_bulk_request) + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record_in_bulk(new_delete_non_employee_record_in_bulk_request) # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_record_in_bulk(Result) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record_in_bulk(new_delete_non_employee_record_in_bulk_request) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_record_in_bulk: %s\n" % e) ``` @@ -576,19 +603,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee request id in the UUID format # str | Non-Employee request id in the UUID format try: # Delete Non-Employee Request - api_instance.delete_non_employee_request(id) - + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_request(id) # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_request(id) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_request(id) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_request: %s\n" % e) ``` @@ -631,20 +661,23 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: attribute_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id try: # Delete Non-Employee Source's Schema Attribute - api_instance.delete_non_employee_schema_attribute(attribute_id, source_id) - + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_schema_attribute(attribute_id, source_id) # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_schema_attribute(attribute_id, source_id) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_schema_attribute(attribute_id, source_id) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_schema_attribute: %s\n" % e) ``` @@ -685,19 +718,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c91808b6ef1d43e016efba0ce470904' # str | Source Id # str | Source Id try: # Delete Non-Employee Source - api_instance.delete_non_employee_source(source_id) - + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source(source_id) # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_source(source_id) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source(source_id) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source: %s\n" % e) ``` @@ -738,19 +774,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id try: # Delete all custom schema attributes - api_instance.delete_non_employee_source_schema_attributes(source_id) - + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source_schema_attributes(source_id) # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_source_schema_attributes(source_id) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source_schema_attributes(source_id) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source_schema_attributes: %s\n" % e) ``` @@ -792,19 +831,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '2c918085842e69ae018432d22ccb212f' # str | Source Id (UUID) # str | Source Id (UUID) try: # Exports Non-Employee Records to CSV - api_instance.export_non_employee_records(id) - + NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(id) # Below is a request that includes all optional parameters - # api_instance.export_non_employee_records(id) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(id) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_records: %s\n" % e) ``` @@ -848,19 +890,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '2c918085842e69ae018432d22ccb212f' # str | Source Id (UUID) # str | Source Id (UUID) try: # Exports Source Schema Template - api_instance.export_non_employee_source_schema_template(id) - + NonEmployeeLifecycleManagementApi(api_client).export_non_employee_source_schema_template(id) # Below is a request that includes all optional parameters - # api_instance.export_non_employee_source_schema_template(id) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).export_non_employee_source_schema_template(id) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_source_schema_template: %s\n" % e) ``` @@ -902,23 +947,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.non_employee_approval_item_detail import NonEmployeeApprovalItemDetail -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) include_detail = 'include-detail=false' # str | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) # str | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) try: # Get a non-employee approval item detail - api_response = api_instance.get_non_employee_approval(id, ) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_approval(id, include_detail) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval(id, include_detail) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval: %s\n" % e) ``` @@ -959,22 +1007,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.non_employee_approval_summary import NonEmployeeApprovalSummary -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: requested_for = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # str | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # str | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. try: # Get Summary of Non-Employee Approval Requests - api_response = api_instance.get_non_employee_approval_summary(requested_for) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval_summary(requested_for) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_approval_summary(requested_for) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval_summary(requested_for) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary: %s\n" % e) ``` @@ -1016,22 +1067,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.non_employee_bulk_upload_status import NonEmployeeBulkUploadStatus -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '2c918085842e69ae018432d22ccb212f' # str | Source ID (UUID) # str | Source ID (UUID) try: # Bulk upload status on source - api_response = api_instance.get_non_employee_bulk_upload_status(id) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_bulk_upload_status(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_bulk_upload_status(id) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_bulk_upload_status(id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status: %s\n" % e) ``` @@ -1072,22 +1126,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.non_employee_record import NonEmployeeRecord -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) try: # Get a Non-Employee Record - api_response = api_instance.get_non_employee_record(id) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_record(id) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_record:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_record: %s\n" % e) ``` @@ -1129,22 +1186,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.non_employee_request import NonEmployeeRequest -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee request id (UUID) # str | Non-Employee request id (UUID) try: # Get a Non-Employee Request - api_response = api_instance.get_non_employee_request(id) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_request(id) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request: %s\n" % e) ``` @@ -1185,22 +1245,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.non_employee_request_summary import NonEmployeeRequestSummary -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: requested_for = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # str | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # str | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. try: # Get Summary of Non-Employee Requests - api_response = api_instance.get_non_employee_request_summary(requested_for) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request_summary(requested_for) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_request_summary(requested_for) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request_summary(requested_for) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request_summary:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request_summary: %s\n" % e) ``` @@ -1242,23 +1305,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: attribute_id = '2c918085842e69ae018432d22ccb212f' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) source_id = '2c918085842e69ae018432d22ccb212f' # str | The Source id # str | The Source id try: # Get Schema Attribute Non-Employee Source - api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_schema_attribute(attribute_id, source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_schema_attribute(attribute_id, source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute: %s\n" % e) ``` @@ -1299,22 +1365,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.non_employee_source import NonEmployeeSource -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c91808b7c28b350017c2a2ec5790aa1' # str | Source Id # str | Source Id try: # Get a Non-Employee Source - api_response = api_instance.get_non_employee_source(source_id) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source(source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_source(source_id) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source(source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source: %s\n" % e) ``` @@ -1356,22 +1425,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c918085842e69ae018432d22ccb212f' # str | The Source id # str | The Source id try: # List Schema Attributes Non-Employee Source - api_response = api_instance.get_non_employee_source_schema_attributes(source_id) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_source_schema_attributes(source_id) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) ``` @@ -1416,23 +1488,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.non_employee_bulk_upload_job import NonEmployeeBulkUploadJob -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) data = None # bytearray | # bytearray | try: # Imports, or Updates, Non-Employee Records - api_response = api_instance.import_non_employee_records_in_bulk(id, data) - + results =NonEmployeeLifecycleManagementApi(api_client).import_non_employee_records_in_bulk(id, data) # Below is a request that includes all optional parameters - # api_response = api_instance.import_non_employee_records_in_bulk(id, data) + # results = NonEmployeeLifecycleManagementApi(api_client).import_non_employee_records_in_bulk(id, data) print("The response of NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk: %s\n" % e) ``` @@ -1478,10 +1553,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.non_employee_approval_item import NonEmployeeApprovalItem -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: requested_for = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # str | The identity for whom the request was made. *me* indicates the current user. (optional) # str | The identity for whom the request was made. *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) @@ -1492,13 +1571,12 @@ from pprint import pprint try: # Get List of Non-Employee Approval Requests - api_response = api_instance.list_non_employee_approval() - + results =NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approval() # Below is a request that includes all optional parameters - # api_response = api_instance.list_non_employee_approval(requested_for, limit, offset, count, filters, sorters) + # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approval(requested_for, limit, offset, count, filters, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approval:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approval: %s\n" % e) ``` @@ -1543,10 +1621,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.non_employee_record import NonEmployeeRecord -from sailpoint.beta.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) @@ -1556,13 +1638,12 @@ from pprint import pprint try: # List Non-Employee Records - api_response = api_instance.list_non_employee_records() - + results =NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records() # Below is a request that includes all optional parameters - # api_response = api_instance.list_non_employee_records(limit, offset, count, sorters, filters) + # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) ``` @@ -1608,10 +1689,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.non_employee_request import NonEmployeeRequest -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: requested_for = 'me' # str | The identity for whom the request was made. *me* indicates the current user. # str | The identity for whom the request was made. *me* indicates the current user. 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) @@ -1622,13 +1707,12 @@ from pprint import pprint try: # List Non-Employee Requests - api_response = api_instance.list_non_employee_requests(requested_for, ) - + results =NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, ) # Below is a request that includes all optional parameters - # api_response = api_instance.list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) + # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) ``` @@ -1674,10 +1758,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.non_employee_source_with_ne_count import NonEmployeeSourceWithNECount -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: requested_for = 'me' # str | The identity for whom the request was made. *me* indicates the current user. # str | The identity for whom the request was made. *me* indicates the current user. non_employee_count = false # bool | The flag to determine whether return a non-employee count associate with source. # bool | The flag to determine whether return a non-employee count associate with 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) @@ -1688,13 +1776,12 @@ from pprint import pprint try: # List Non-Employee Sources - api_response = api_instance.list_non_employee_sources(requested_for, non_employee_count, ) - + results =NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(requested_for, non_employee_count, ) # Below is a request that includes all optional parameters - # api_response = api_instance.list_non_employee_sources(requested_for, non_employee_count, limit, offset, count, sorters) + # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(requested_for, non_employee_count, limit, offset, count, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) ``` @@ -1737,11 +1824,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.json_patch_operation import JsonPatchOperation from sailpoint.beta.models.non_employee_record import NonEmployeeRecord -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) [{op=replace, path=/endDate, value={2019-08-23T18:40:35.772Z=null}}] # List[JsonPatchOperation] | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. json_patch_operation = { @@ -1753,14 +1844,14 @@ from pprint import pprint try: # Patch Non-Employee Record - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_non_employee_record(id, Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id, new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_non_employee_record(id, Result) + # results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id, new_json_patch_operation) print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_record:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_record: %s\n" % e) ``` @@ -1805,11 +1896,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.json_patch_operation import JsonPatchOperation from sailpoint.beta.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: attribute_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id [{op=replace, path=/label, value={new attribute label=null}}] # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. @@ -1822,14 +1917,14 @@ from pprint import pprint try: # Patch Non-Employee Source's Schema Attribute - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_schema_attribute(attribute_id, source_id, new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) + # results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_schema_attribute(attribute_id, source_id, new_json_patch_operation) print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute: %s\n" % e) ``` @@ -1871,11 +1966,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.json_patch_operation import JsonPatchOperation from sailpoint.beta.models.non_employee_source import NonEmployeeSource -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c91808b6ef1d43e016efba0ce470904' # str | Source Id # str | Source Id [{op=replace, path=/name, value={new name=null}}, {op=replace, path=/approvers, value=[2c91809f703bb37a017040a2fe8748c7, 48b1f463c9e8427db5a5071bd81914b8]}] # List[JsonPatchOperation] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. json_patch_operation = { @@ -1887,14 +1986,14 @@ from pprint import pprint try: # Patch a Non-Employee Source - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_non_employee_source(source_id, Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id, new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_non_employee_source(source_id, Result) + # results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id, new_json_patch_operation) print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_source: %s\n" % e) ``` @@ -1936,11 +2035,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.non_employee_approval_item import NonEmployeeApprovalItem from sailpoint.beta.models.non_employee_reject_approval_decision import NonEmployeeRejectApprovalDecision -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'id_example' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) non_employee_reject_approval_decision = { "comment" : "comment" @@ -1948,14 +2051,14 @@ from pprint import pprint try: # Reject a Non-Employee Request - Result = non_employee_reject_approval_decision.from_json(non_employee_reject_approval_decision) - api_response = api_instance.reject_non_employee_request(id, Result) - + new_non_employee_reject_approval_decision = NonEmployeeRejectApprovalDecision() + new_non_employee_reject_approval_decision.from_json(non_employee_reject_approval_decision) + results =NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id, new_non_employee_reject_approval_decision) # Below is a request that includes all optional parameters - # api_response = api_instance.reject_non_employee_request(id, Result) + # results = NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id, new_non_employee_reject_approval_decision) print("The response of NonEmployeeLifecycleManagementApi->reject_non_employee_request:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->reject_non_employee_request: %s\n" % e) ``` @@ -1998,11 +2101,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.non_employee_record import NonEmployeeRecord from sailpoint.beta.models.non_employee_request_body import NonEmployeeRequestBody -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) non_employee_request_body = { "sourceId" : "2c91808568c529c60168cca6f90c1313", @@ -2021,14 +2128,14 @@ from pprint import pprint try: # Update Non-Employee Record - Result = non_employee_request_body.from_json(non_employee_request_body) - api_response = api_instance.update_non_employee_record(id, Result) - + new_non_employee_request_body = NonEmployeeRequestBody() + new_non_employee_request_body.from_json(non_employee_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id, new_non_employee_request_body) # Below is a request that includes all optional parameters - # api_response = api_instance.update_non_employee_record(id, Result) + # results = NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id, new_non_employee_request_body) print("The response of NonEmployeeLifecycleManagementApi->update_non_employee_record:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->update_non_employee_record: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/NotificationsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/NotificationsApi.md index 21c69fd8b..c19b46d87 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/NotificationsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/NotificationsApi.md @@ -66,25 +66,29 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.domain_address import DomainAddress from sailpoint.beta.models.domain_status_dto import DomainStatusDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: domain_address = { "domain" : "sailpoint.com" } # DomainAddress | try: # Verify domain address via DKIM - Result = domain_address.from_json(domain_address) - api_response = api_instance.create_domain_dkim(Result) - + new_domain_address = DomainAddress() + new_domain_address.from_json(domain_address) + results =NotificationsApi(api_client).create_domain_dkim(new_domain_address) # Below is a request that includes all optional parameters - # api_response = api_instance.create_domain_dkim(Result) + # results = NotificationsApi(api_client).create_domain_dkim(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) ``` @@ -127,10 +131,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.template_dto import TemplateDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: template_dto = { "slackTemplate" : "slackTemplate", "footer" : "footer", @@ -152,14 +160,14 @@ from pprint import pprint try: # Create Notification Template - Result = template_dto.from_json(template_dto) - api_response = api_instance.create_notification_template(Result) - + new_template_dto = TemplateDto() + new_template_dto.from_json(template_dto) + results =NotificationsApi(api_client).create_notification_template(new_template_dto) # Below is a request that includes all optional parameters - # api_response = api_instance.create_notification_template(Result) + # results = NotificationsApi(api_client).create_notification_template(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) ``` @@ -200,10 +208,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.email_status_dto import EmailStatusDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: email_status_dto = { "isVerifiedByDomain" : false, "verificationStatus" : "PENDING", @@ -213,14 +225,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(Result) - + new_email_status_dto = EmailStatusDto() + new_email_status_dto.from_json(email_status_dto) + results =NotificationsApi(api_client).create_verified_from_address(new_email_status_dto) # Below is a request that includes all optional parameters - # api_response = api_instance.create_verified_from_address(Result) + # results = NotificationsApi(api_client).create_verified_from_address(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) ``` @@ -261,10 +273,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.template_bulk_delete_dto import TemplateBulkDeleteDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: [sailpoint.beta.TemplateBulkDeleteDto()] # List[TemplateBulkDeleteDto] | template_bulk_delete_dto = { "medium" : "EMAIL", @@ -275,12 +291,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(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(new_template_bulk_delete_dto) # Below is a request that includes all optional parameters - # api_instance.delete_notification_templates_in_bulk(Result) - except Exception as e: + # NotificationsApi(api_client).delete_notification_templates_in_bulk(new_template_bulk_delete_dto) + except Exception as e: print("Exception when calling NotificationsApi->delete_notification_templates_in_bulk: %s\n" % e) ``` @@ -322,19 +338,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.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 | try: # Delete Verified From Address - api_instance.delete_verified_from_address(id) - + NotificationsApi(api_client).delete_verified_from_address(id) # Below is a request that includes all optional parameters - # api_instance.delete_verified_from_address(id) - except Exception as e: + # NotificationsApi(api_client).delete_verified_from_address(id) + except Exception as e: print("Exception when calling NotificationsApi->delete_verified_from_address: %s\n" % e) ``` @@ -372,21 +391,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.dkim_attributes import DkimAttributes -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # Get DKIM Attributes - api_response = api_instance.get_dkim_attributes() - + results =NotificationsApi(api_client).get_dkim_attributes() # Below is a request that includes all optional parameters - # api_response = api_instance.get_dkim_attributes() + # results = NotificationsApi(api_client).get_dkim_attributes() 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) ``` @@ -427,22 +449,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.mail_from_attributes import MailFromAttributes -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: identity_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 try: # Get MAIL FROM Attributes - api_response = api_instance.get_mail_from_attributes(identity_id) - + results =NotificationsApi(api_client).get_mail_from_attributes(identity_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_mail_from_attributes(identity_id) + # results = NotificationsApi(api_client).get_mail_from_attributes(identity_id) 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) ``` @@ -483,22 +508,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.template_dto import TemplateDto -from sailpoint.beta.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 try: # Get Notification Template By Id - api_response = api_instance.get_notification_template(id) - + results =NotificationsApi(api_client).get_notification_template(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_notification_template(id) + # results = NotificationsApi(api_client).get_notification_template(id) 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) ``` @@ -537,21 +565,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.notification_template_context import NotificationTemplateContext -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # Get Notification Template Context - api_response = api_instance.get_notifications_template_context() - + results =NotificationsApi(api_client).get_notifications_template_context() # Below is a request that includes all optional parameters - # api_response = api_instance.get_notifications_template_context() + # results = NotificationsApi(api_client).get_notifications_template_context() 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) ``` @@ -595,10 +626,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.email_status_dto import EmailStatusDto -from sailpoint.beta.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) @@ -608,13 +643,12 @@ from pprint import pprint try: # List From Addresses - api_response = api_instance.list_from_addresses() - + results =NotificationsApi(api_client).list_from_addresses() # Below is a request that includes all optional parameters - # api_response = api_instance.list_from_addresses(limit, offset, count, filters, sorters) + # results = NotificationsApi(api_client).list_from_addresses(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) ``` @@ -656,22 +690,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.preferences_dto import PreferencesDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: key = 'cloud_manual_work_item_summary' # str | The notification key. # str | The notification key. try: # List Notification Preferences for tenant. - api_response = api_instance.list_notification_preferences(key) - + results =NotificationsApi(api_client).list_notification_preferences(key) # Below is a request that includes all optional parameters - # api_response = api_instance.list_notification_preferences(key) + # results = NotificationsApi(api_client).list_notification_preferences(key) 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) ``` @@ -714,10 +751,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.template_dto_default import TemplateDtoDefault -from sailpoint.beta.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 = 'key eq \"cloud_manual_work_item_summary\"' # 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) @@ -725,13 +766,12 @@ from pprint import pprint try: # List Notification Template Defaults - api_response = api_instance.list_notification_template_defaults() - + results =NotificationsApi(api_client).list_notification_template_defaults() # Below is a request that includes all optional parameters - # api_response = api_instance.list_notification_template_defaults(limit, offset, filters) + # results = NotificationsApi(api_client).list_notification_template_defaults(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) ``` @@ -774,10 +814,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.template_dto import TemplateDto -from sailpoint.beta.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 = 'medium eq \"EMAIL\"' # 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) @@ -785,13 +829,12 @@ from pprint import pprint try: # List Notification Templates - api_response = api_instance.list_notification_templates() - + results =NotificationsApi(api_client).list_notification_templates() # Below is a request that includes all optional parameters - # api_response = api_instance.list_notification_templates(limit, offset, filters) + # results = NotificationsApi(api_client).list_notification_templates(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) ``` @@ -832,11 +875,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.mail_from_attributes import MailFromAttributes from sailpoint.beta.models.mail_from_attributes_dto import MailFromAttributesDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: mail_from_attributes_dto = { "identity" : "BobSmith@sailpoint.com", "mailFromDomain" : "example.sailpoint.com" @@ -844,14 +891,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(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(new_mail_from_attributes_dto) # Below is a request that includes all optional parameters - # api_response = api_instance.put_mail_from_attributes(Result) + # results = NotificationsApi(api_client).put_mail_from_attributes(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) ``` @@ -893,10 +940,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.notifications_api import NotificationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.send_test_notification_request_dto import SendTestNotificationRequestDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: send_test_notification_request_dto = { "context" : "{}", "medium" : "EMAIL", @@ -905,12 +956,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(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(new_send_test_notification_request_dto) # Below is a request that includes all optional parameters - # api_instance.send_test_notification(Result) - except Exception as e: + # NotificationsApi(api_client).send_test_notification(new_send_test_notification_request_dto) + except Exception as e: print("Exception when calling NotificationsApi->send_test_notification: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/OAuthClientsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/OAuthClientsApi.md index 356bdaa38..f8425ace1 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/OAuthClientsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/OAuthClientsApi.md @@ -58,11 +58,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.create_o_auth_client_request import CreateOAuthClientRequest from sailpoint.beta.models.create_o_auth_client_response import CreateOAuthClientResponse -from sailpoint.beta.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.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.beta.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.beta +from sailpoint.beta.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.get_o_auth_client_response import GetOAuthClientResponse -from sailpoint.beta.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.beta +from sailpoint.beta.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.get_o_auth_client_response import GetOAuthClientResponse -from sailpoint.beta.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) ``` @@ -302,11 +315,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.get_o_auth_client_response import GetOAuthClientResponse from sailpoint.beta.models.json_patch_operation import JsonPatchOperation -from sailpoint.beta.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 = { @@ -318,14 +335,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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/OrgConfigApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/OrgConfigApi.md index a82af812c..44af467e9 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/OrgConfigApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/OrgConfigApi.md @@ -53,21 +53,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.org_config_api import OrgConfigApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.org_config import OrgConfig -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # Get Org configuration settings - api_response = api_instance.get_org_config() - + results =OrgConfigApi(api_client).get_org_config() # Below is a request that includes all optional parameters - # api_response = api_instance.get_org_config() + # results = OrgConfigApi(api_client).get_org_config() 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) ``` @@ -105,20 +108,23 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.org_config_api import OrgConfigApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # Get list of time zones - api_response = api_instance.get_valid_time_zones() - + results =OrgConfigApi(api_client).get_valid_time_zones() # Below is a request that includes all optional parameters - # api_response = api_instance.get_valid_time_zones() + # results = OrgConfigApi(api_client).get_valid_time_zones() 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) ``` @@ -160,11 +166,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.org_config_api import OrgConfigApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.json_patch_operation import JsonPatchOperation from sailpoint.beta.models.org_config import OrgConfig -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: [{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 = { "op" : "replace", @@ -175,14 +185,14 @@ from pprint import pprint try: # Patch an Org configuration property - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_org_config(Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =OrgConfigApi(api_client).patch_org_config(new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_org_config(Result) + # results = OrgConfigApi(api_client).patch_org_config(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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/PasswordConfigurationApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordConfigurationApi.md index 3f509df8f..6e0778f6b 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/PasswordConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordConfigurationApi.md @@ -61,10 +61,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.password_configuration_api import PasswordConfigurationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.password_org_config import PasswordOrgConfig -from sailpoint.beta.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.beta +from sailpoint.beta.api.password_configuration_api import PasswordConfigurationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.password_org_config import PasswordOrgConfig -from sailpoint.beta.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.beta +from sailpoint.beta.api.password_configuration_api import PasswordConfigurationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.password_org_config import PasswordOrgConfig -from sailpoint.beta.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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/PasswordDictionaryApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordDictionaryApi.md index 9d1b8d812..6d7c99f70 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/PasswordDictionaryApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordDictionaryApi.md @@ -125,20 +125,23 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.password_dictionary_api import PasswordDictionaryApi +from sailpoint.beta.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.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.password_dictionary_api import PasswordDictionaryApi +from sailpoint.beta.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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/PasswordManagementApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordManagementApi.md index 69d9b5c3e..2826d01ae 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/PasswordManagementApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordManagementApi.md @@ -78,11 +78,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.password_management_api import PasswordManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.password_digit_token import PasswordDigitToken from sailpoint.beta.models.password_digit_token_reset import PasswordDigitTokenReset -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: password_digit_token_reset = { "durationMinutes" : 5, "length" : 8, @@ -91,14 +95,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(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(new_password_digit_token_reset) # Below is a request that includes all optional parameters - # api_response = api_instance.create_digit_token(Result) + # results = PasswordManagementApi(api_client).create_digit_token(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) ``` @@ -139,22 +143,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.password_management_api import PasswordManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.password_status import PasswordStatus -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'id_example' # str | # str | try: # Get Password Change Request Status - api_response = api_instance.get_identity_password_change_status(id) - + results =PasswordManagementApi(api_client).get_identity_password_change_status(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_password_change_status(id) + # results = PasswordManagementApi(api_client).get_identity_password_change_status(id) print("The response of PasswordManagementApi->get_identity_password_change_status:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling PasswordManagementApi->get_identity_password_change_status: %s\n" % e) ``` @@ -203,11 +210,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.password_management_api import PasswordManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.password_info import PasswordInfo from sailpoint.beta.models.password_info_query_dto import PasswordInfoQueryDTO -from sailpoint.beta.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" @@ -215,14 +226,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) ``` @@ -306,11 +317,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.password_management_api import PasswordManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.password_change_request import PasswordChangeRequest from sailpoint.beta.models.password_change_response import PasswordChangeResponse -from sailpoint.beta.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", @@ -321,14 +336,14 @@ from pprint import pprint try: # Set Identity's Password - Result = password_change_request.from_json(password_change_request) - api_response = api_instance.set_identity_password(Result) - + new_password_change_request = PasswordChangeRequest() + new_password_change_request.from_json(password_change_request) + results =PasswordManagementApi(api_client).set_identity_password(new_password_change_request) # Below is a request that includes all optional parameters - # api_response = api_instance.set_identity_password(Result) + # results = PasswordManagementApi(api_client).set_identity_password(new_password_change_request) print("The response of PasswordManagementApi->set_identity_password:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling PasswordManagementApi->set_identity_password: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/PasswordPoliciesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordPoliciesApi.md index 1e1d2f472..641c02e3c 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/PasswordPoliciesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordPoliciesApi.md @@ -65,10 +65,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.password_policies_api import PasswordPoliciesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.password_policy_v3_dto import PasswordPolicyV3Dto -from sailpoint.beta.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, @@ -105,14 +109,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) ``` @@ -154,19 +158,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.password_policies_api import PasswordPoliciesApi +from sailpoint.beta.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) ``` @@ -208,22 +215,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.password_policies_api import PasswordPoliciesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.password_policy_v3_dto import PasswordPolicyV3Dto -from sailpoint.beta.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) ``` @@ -267,10 +277,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.password_policies_api import PasswordPoliciesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.password_policy_v3_dto import PasswordPolicyV3Dto -from sailpoint.beta.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) @@ -278,13 +292,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) ``` @@ -327,10 +340,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.password_policies_api import PasswordPoliciesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.password_policy_v3_dto import PasswordPolicyV3Dto -from sailpoint.beta.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, @@ -368,14 +385,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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/PasswordSyncGroupsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordSyncGroupsApi.md index c63be9a36..0e3ade205 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/PasswordSyncGroupsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordSyncGroupsApi.md @@ -87,10 +87,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.password_sync_group import PasswordSyncGroup -from sailpoint.beta.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.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.beta.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.beta +from sailpoint.beta.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.password_sync_group import PasswordSyncGroup -from sailpoint.beta.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.beta +from sailpoint.beta.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.password_sync_group import PasswordSyncGroup -from sailpoint.beta.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.beta +from sailpoint.beta.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.password_sync_group import PasswordSyncGroup -from sailpoint.beta.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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/PersonalAccessTokensApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/PersonalAccessTokensApi.md index 4d18eb777..0acadcd76 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/PersonalAccessTokensApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/PersonalAccessTokensApi.md @@ -65,11 +65,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.personal_access_tokens_api import PersonalAccessTokensApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.create_personal_access_token_request import CreatePersonalAccessTokenRequest from sailpoint.beta.models.create_personal_access_token_response import CreatePersonalAccessTokenResponse -from sailpoint.beta.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.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.personal_access_tokens_api import PersonalAccessTokensApi +from sailpoint.beta.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.beta +from sailpoint.beta.api.personal_access_tokens_api import PersonalAccessTokensApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.get_personal_access_token_response import GetPersonalAccessTokenResponse -from sailpoint.beta.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) ``` @@ -240,11 +250,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.personal_access_tokens_api import PersonalAccessTokensApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.get_personal_access_token_response import GetPersonalAccessTokenResponse from sailpoint.beta.models.json_patch_operation import JsonPatchOperation -from sailpoint.beta.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 = { @@ -256,14 +270,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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/PublicIdentitiesConfigApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/PublicIdentitiesConfigApi.md index 6cd00b70a..77d30a615 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/PublicIdentitiesConfigApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/PublicIdentitiesConfigApi.md @@ -59,21 +59,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.public_identities_config_api import PublicIdentitiesConfigApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.public_identity_config import PublicIdentityConfig -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # Get Public Identity Config - 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.beta +from sailpoint.beta.api.public_identities_config_api import PublicIdentitiesConfigApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.public_identity_config import PublicIdentityConfig -from sailpoint.beta.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 Public Identity Config - 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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/RequestableObjectsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/RequestableObjectsApi.md index 31d95dbc7..bbffb3687 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/RequestableObjectsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/RequestableObjectsApi.md @@ -63,12 +63,16 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.requestable_objects_api import RequestableObjectsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.requestable_object import RequestableObject from sailpoint.beta.models.requestable_object_request_status import RequestableObjectRequestStatus from sailpoint.beta.models.requestable_object_type import RequestableObjectType -from sailpoint.beta.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.beta.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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/RoleInsightsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/RoleInsightsApi.md index 59bdea213..1157c7dd8 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/RoleInsightsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/RoleInsightsApi.md @@ -59,21 +59,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.role_insights_api import RoleInsightsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_insights_response import RoleInsightsResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # Generate insights for roles - api_response = api_instance.create_role_insight_requests() - + results =RoleInsightsApi(api_client).create_role_insight_requests() # Below is a request that includes all optional parameters - # api_response = api_instance.create_role_insight_requests() + # results = RoleInsightsApi(api_client).create_role_insight_requests() 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) ``` @@ -115,9 +118,13 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.role_insights_api import RoleInsightsApi +from sailpoint.beta.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 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) 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) @@ -125,13 +132,12 @@ from pprint import pprint try: # Download entitlement insights for a role - api_response = api_instance.download_role_insights_entitlements_changes(insight_id, ) - + results =RoleInsightsApi(api_client).download_role_insights_entitlements_changes(insight_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.download_role_insights_entitlements_changes(insight_id, sorters, filters) + # results = RoleInsightsApi(api_client).download_role_insights_entitlements_changes(insight_id, 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) ``` @@ -178,10 +184,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.role_insights_api import RoleInsightsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_insights_identities import RoleInsightsIdentities -from sailpoint.beta.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 has_entitlement = False # bool | Identity has this entitlement or not (optional) (default to False) # bool | Identity has this entitlement or not (optional) (default to False) @@ -194,13 +204,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, ) - + results =RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id, entitlement_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_entitlement_changes_identities(insight_id, entitlement_id, has_entitlement, offset, limit, count, sorters, filters) + # results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id, entitlement_id, 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) ``` @@ -240,22 +249,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.role_insights_api import RoleInsightsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_insight import RoleInsight -from sailpoint.beta.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 try: # Get a single role insight - api_response = api_instance.get_role_insight(insight_id) - + results =RoleInsightsApi(api_client).get_role_insight(insight_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_insight(insight_id) + # results = RoleInsightsApi(api_client).get_role_insight(insight_id) 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) ``` @@ -299,10 +311,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.role_insights_api import RoleInsightsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_insight import RoleInsight -from sailpoint.beta.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) @@ -312,13 +328,12 @@ from pprint import pprint try: # Get role insights - api_response = api_instance.get_role_insights() - + results =RoleInsightsApi(api_client).get_role_insights() # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_insights(offset, limit, count, sorters, filters) + # results = RoleInsightsApi(api_client).get_role_insights(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) ``` @@ -359,23 +374,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.role_insights_api import RoleInsightsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_insights_entitlement import RoleInsightsEntitlement -from sailpoint.beta.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 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) try: # Get current entitlement for a role - api_response = api_instance.get_role_insights_current_entitlements(insight_id, ) - + results =RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_insights_current_entitlements(insight_id, filters) + # results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, 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) ``` @@ -417,10 +435,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.role_insights_api import RoleInsightsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_insights_entitlement_changes import RoleInsightsEntitlementChanges -from sailpoint.beta.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 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) filters = 'name sw \"Admin\"' # 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) @@ -428,13 +450,12 @@ from pprint import pprint try: # Get entitlement insights for a role - api_response = api_instance.get_role_insights_entitlements_changes(insight_id, ) - + results =RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_insights_entitlements_changes(insight_id, sorters, filters) + # results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id, 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) ``` @@ -478,22 +499,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.role_insights_api import RoleInsightsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_insights_response import RoleInsightsResponse -from sailpoint.beta.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 try: # Returns metadata from prior request. - api_response = api_instance.get_role_insights_requests(id) - + results =RoleInsightsApi(api_client).get_role_insights_requests(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_insights_requests(id) + # results = RoleInsightsApi(api_client).get_role_insights_requests(id) 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) ``` @@ -530,21 +554,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.role_insights_api import RoleInsightsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_insights_summary import RoleInsightsSummary -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # Get role insights summary information - api_response = api_instance.get_role_insights_summary() - + results =RoleInsightsApi(api_client).get_role_insights_summary() # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_insights_summary() + # results = RoleInsightsApi(api_client).get_role_insights_summary() 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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md index 6b086491c..d6c2f11ed 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md @@ -101,10 +101,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.roles_api import RolesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role import Role -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: role = { "owner" : { "name" : "support", @@ -266,14 +270,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) ``` @@ -317,25 +321,29 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.roles_api import RolesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_bulk_delete_request import RoleBulkDeleteRequest from sailpoint.beta.models.task_result_dto import TaskResultDto -from sailpoint.beta.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) ``` @@ -378,19 +386,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.roles_api import RolesApi +from sailpoint.beta.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) ``` @@ -432,22 +443,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.roles_api import RolesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role import Role -from sailpoint.beta.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) ``` @@ -493,10 +507,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.roles_api import RolesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role_identity import RoleIdentity -from sailpoint.beta.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) @@ -507,13 +525,12 @@ from pprint import pprint try: # 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) ``` @@ -561,10 +578,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.roles_api import RolesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.entitlement import Entitlement -from sailpoint.beta.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 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) @@ -575,13 +596,12 @@ from pprint import pprint try: # List role's Entitlements - api_response = api_instance.get_role_entitlements(id, ) - + results =RolesApi(api_client).get_role_entitlements(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_entitlements(id, limit, offset, count, filters, sorters) + # results = RolesApi(api_client).get_role_entitlements(id, 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) ``` @@ -631,10 +651,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.roles_api import RolesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.role import Role -from sailpoint.beta.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) @@ -647,13 +671,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) ``` @@ -715,11 +738,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.roles_api import RolesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.json_patch_operation import JsonPatchOperation from sailpoint.beta.models.role import Role -from sailpoint.beta.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 = { @@ -731,14 +758,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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SIMIntegrationsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SIMIntegrationsApi.md index 2afa6381d..c86f3c479 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SIMIntegrationsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SIMIntegrationsApi.md @@ -65,11 +65,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sim_integrations_api import SIMIntegrationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto from sailpoint.beta.models.sim_integration_details import SimIntegrationDetails -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: sim_integration_details = { "cluster" : "xyzzy999", "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", @@ -91,14 +95,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(Result) - + new_sim_integration_details = SimIntegrationDetails() + new_sim_integration_details.from_json(sim_integration_details) + results =SIMIntegrationsApi(api_client).create_sim_integration(new_sim_integration_details) # Below is a request that includes all optional parameters - # api_response = api_instance.create_sim_integration(Result) + # results = SIMIntegrationsApi(api_client).create_sim_integration(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) ``` @@ -140,19 +144,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.sim_integrations_api import SIMIntegrationsApi +from sailpoint.beta.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. try: # Delete a SIM integration - api_instance.delete_sim_integration(id) - + SIMIntegrationsApi(api_client).delete_sim_integration(id) # Below is a request that includes all optional parameters - # api_instance.delete_sim_integration(id) - except Exception as e: + # SIMIntegrationsApi(api_client).delete_sim_integration(id) + except Exception as e: print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) ``` @@ -194,22 +201,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sim_integrations_api import SIMIntegrationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto -from sailpoint.beta.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. try: # Get a SIM integration details. - api_response = api_instance.get_sim_integration(id) - + results =SIMIntegrationsApi(api_client).get_sim_integration(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_sim_integration(id) + # results = SIMIntegrationsApi(api_client).get_sim_integration(id) 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) ``` @@ -248,21 +258,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sim_integrations_api import SIMIntegrationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # List the existing SIM integrations. - api_response = api_instance.get_sim_integrations() - + results =SIMIntegrationsApi(api_client).get_sim_integrations() # Below is a request that includes all optional parameters - # api_response = api_instance.get_sim_integrations() + # results = SIMIntegrationsApi(api_client).get_sim_integrations() 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) ``` @@ -305,24 +318,28 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sim_integrations_api import SIMIntegrationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.json_patch import JsonPatch from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto -from sailpoint.beta.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 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, Result) - + new_json_patch = JsonPatch() + new_json_patch.from_json(json_patch) + results =SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, new_json_patch) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_before_provisioning_rule(id, Result) + # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, 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) ``` @@ -365,24 +382,28 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sim_integrations_api import SIMIntegrationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.json_patch import JsonPatch from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto -from sailpoint.beta.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 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, Result) - + new_json_patch = JsonPatch() + new_json_patch.from_json(json_patch) + results =SIMIntegrationsApi(api_client).patch_sim_attributes(id, new_json_patch) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_sim_attributes(id, Result) + # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, 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) ``` @@ -425,11 +446,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sim_integrations_api import SIMIntegrationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto from sailpoint.beta.models.sim_integration_details import SimIntegrationDetails -from sailpoint.beta.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. sim_integration_details = { "cluster" : "xyzzy999", @@ -452,14 +477,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, Result) - + new_sim_integration_details = SimIntegrationDetails() + new_sim_integration_details.from_json(sim_integration_details) + results =SIMIntegrationsApi(api_client).put_sim_integration(id, new_sim_integration_details) # Below is a request that includes all optional parameters - # api_response = api_instance.put_sim_integration(id, Result) + # results = SIMIntegrationsApi(api_client).put_sim_integration(id, 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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SODPoliciesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SODPoliciesApi.md index 518547314..22ccd4f26 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SODPoliciesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SODPoliciesApi.md @@ -96,10 +96,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.sod_policy import SodPolicy -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: sod_policy = { "conflictingAccessCriteria" : { "leftCriteria" : { @@ -159,14 +163,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) ``` @@ -213,20 +217,23 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.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 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. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. (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) ``` @@ -272,19 +279,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.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 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) ``` @@ -331,22 +341,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.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) ``` @@ -392,21 +405,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.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) ``` @@ -448,21 +464,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.report_result_reference import ReportResultReference -from sailpoint.beta.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) ``` @@ -508,22 +527,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.sod_policy import SodPolicy -from sailpoint.beta.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 object reference to retrieve. # str | The ID of the object reference 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) ``` @@ -568,22 +590,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.sod_policy_schedule import SodPolicySchedule -from sailpoint.beta.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 object reference to retrieve. # str | The ID of the object reference 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) ``` @@ -629,22 +654,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.report_result_reference import ReportResultReference -from sailpoint.beta.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) ``` @@ -690,22 +718,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.report_result_reference import ReportResultReference -from sailpoint.beta.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 object reference to retrieve. # str | The ID of the object reference to retrieve. 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) ``` @@ -754,10 +785,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.sod_policy import SodPolicy -from sailpoint.beta.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) @@ -767,13 +802,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) ``` @@ -821,10 +855,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.sod_policy import SodPolicy -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. request_body = [{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[object] | 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 request_body = [{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[object] | 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 @@ -832,14 +870,14 @@ from pprint import pprint try: # Patch a SOD policy - Result = request_body.from_json(request_body) - api_response = api_instance.patch_sod_policy(id, Result) - + new_request_body = RequestBody() + new_request_body.from_json(request_body) + results =SODPoliciesApi(api_client).patch_sod_policy(id, new_request_body) # 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_request_body) 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) ``` @@ -885,10 +923,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.sod_policy_schedule import SodPolicySchedule -from sailpoint.beta.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 SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. sod_policy_schedule = { "schedule" : { @@ -979,14 +1021,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) ``` @@ -1033,10 +1075,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.sod_policy import SodPolicy -from sailpoint.beta.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 SOD policy to update. # str | The ID of the SOD policy to update. sod_policy = { "conflictingAccessCriteria" : { @@ -1097,14 +1143,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) ``` @@ -1149,11 +1195,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.multi_policy_request import MultiPolicyRequest from sailpoint.beta.models.report_result_reference import ReportResultReference -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: multi_policy_request = { "filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ] } # MultiPolicyRequest | (optional) @@ -1161,13 +1211,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) ``` @@ -1213,22 +1262,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sod_policies_api import SODPoliciesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.report_result_reference import ReportResultReference -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # 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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SODViolationsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SODViolationsApi.md index 79c4ce0e0..a7e47898a 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SODViolationsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SODViolationsApi.md @@ -75,11 +75,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sod_violations_api import SODViolationsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.identity_with_new_access import IdentityWithNewAccess from sailpoint.beta.models.violation_prediction import ViolationPrediction -from sailpoint.beta.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" : [ { @@ -95,14 +99,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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SPConfigApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SPConfigApi.md index 3595585ae..9a103f4b9 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SPConfigApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SPConfigApi.md @@ -59,25 +59,29 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sp_config_api import SPConfigApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.export_payload import ExportPayload from sailpoint.beta.models.sp_config_export_job import SpConfigExportJob -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: export_payload = { "description" : "Export Job 1 Test" } # ExportPayload | Export options control what will be included in the export. try: # Initiates configuration objects export job - Result = export_payload.from_json(export_payload) - api_response = api_instance.export_sp_config(Result) - + new_export_payload = ExportPayload() + new_export_payload.from_json(export_payload) + results =SPConfigApi(api_client).export_sp_config(new_export_payload) # Below is a request that includes all optional parameters - # api_response = api_instance.export_sp_config(Result) + # results = SPConfigApi(api_client).export_sp_config(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) ``` @@ -121,22 +125,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sp_config_api import SPConfigApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.sp_config_export_results import SpConfigExportResults -from sailpoint.beta.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. try: # Download export job result. - api_response = api_instance.get_sp_config_export(id) - + results =SPConfigApi(api_client).get_sp_config_export(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_sp_config_export(id) + # results = SPConfigApi(api_client).get_sp_config_export(id) 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) ``` @@ -180,22 +187,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sp_config_api import SPConfigApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.sp_config_export_job_status import SpConfigExportJobStatus -from sailpoint.beta.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. try: # Get export job status - api_response = api_instance.get_sp_config_export_status(id) - + results =SPConfigApi(api_client).get_sp_config_export_status(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_sp_config_export_status(id) + # results = SPConfigApi(api_client).get_sp_config_export_status(id) 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) ``` @@ -239,22 +249,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sp_config_api import SPConfigApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.sp_config_import_results import SpConfigImportResults -from sailpoint.beta.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. try: # Download import job result - api_response = api_instance.get_sp_config_import(id) - + results =SPConfigApi(api_client).get_sp_config_import(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_sp_config_import(id) + # results = SPConfigApi(api_client).get_sp_config_import(id) 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) ``` @@ -297,22 +310,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sp_config_api import SPConfigApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.sp_config_import_job_status import SpConfigImportJobStatus -from sailpoint.beta.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. try: # Get import job status - api_response = api_instance.get_sp_config_import_status(id) - + results =SPConfigApi(api_client).get_sp_config_import_status(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_sp_config_import_status(id) + # results = SPConfigApi(api_client).get_sp_config_import_status(id) 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) ``` @@ -366,11 +382,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sp_config_api import SPConfigApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.import_options import ImportOptions from sailpoint.beta.models.sp_config_job import SpConfigJob -from sailpoint.beta.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. 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) options = sailpoint.beta.ImportOptions() # ImportOptions | (optional) @@ -378,13 +398,12 @@ from pprint import pprint try: # Initiates configuration objects import job - api_response = api_instance.import_sp_config(data, ) - + results =SPConfigApi(api_client).import_sp_config(data, ) # Below is a request that includes all optional parameters - # api_response = api_instance.import_sp_config(data, preview, options) + # results = SPConfigApi(api_client).import_sp_config(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) ``` @@ -423,21 +442,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sp_config_api import SPConfigApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.sp_config_object import SpConfigObject -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # Get config object details - api_response = api_instance.list_sp_config_objects() - + results =SPConfigApi(api_client).list_sp_config_objects() # Below is a request that includes all optional parameters - # api_response = api_instance.list_sp_config_objects() + # results = SPConfigApi(api_client).list_sp_config_objects() 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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SearchAttributeConfigurationApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SearchAttributeConfigurationApi.md index 41803a08f..46b0789cb 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SearchAttributeConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SearchAttributeConfigurationApi.md @@ -75,10 +75,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig -from sailpoint.beta.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", @@ -90,14 +94,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.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.beta.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.beta +from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig -from sailpoint.beta.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) ``` @@ -244,22 +254,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig -from sailpoint.beta.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 get. # str | Name of the extended search attribute configuration to get. 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) ``` @@ -304,11 +317,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.json_patch_operation import JsonPatchOperation from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig -from sailpoint.beta.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 extended search attribute configuration to patch. # str | Name of the extended 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 = { @@ -320,14 +337,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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SegmentsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SegmentsApi.md index 27745417a..f489d6c2a 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SegmentsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SegmentsApi.md @@ -74,10 +74,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.segments_api import SegmentsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.segment import Segment -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: segment = { "owner" : { "name" : "support", @@ -105,14 +109,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) ``` @@ -156,19 +160,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.segments_api import SegmentsApi +from sailpoint.beta.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) ``` @@ -211,22 +218,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.segments_api import SegmentsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.segment import Segment -from sailpoint.beta.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) ``` @@ -270,10 +280,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.segments_api import SegmentsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.segment import Segment -from sailpoint.beta.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) @@ -281,13 +295,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) ``` @@ -332,10 +345,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.segments_api import SegmentsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.segment import Segment -from sailpoint.beta.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 @@ -343,14 +360,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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ServiceDeskIntegrationApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ServiceDeskIntegrationApi.md index 7867b24c0..bd20e921a 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ServiceDeskIntegrationApi.md @@ -85,10 +85,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto -from sailpoint.beta.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", @@ -123,14 +127,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) ``` @@ -172,19 +176,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.beta.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) ``` @@ -226,22 +233,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto -from sailpoint.beta.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) ``` @@ -287,10 +297,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto -from sailpoint.beta.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) @@ -300,13 +314,12 @@ from pprint import pprint try: # List existing Service Desk integrations - api_response = api_instance.get_service_desk_integration_list() - + results =ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list() # Below is a request that includes all optional parameters - # api_response = api_instance.get_service_desk_integration_list(offset, limit, sorters, filters, count) + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list(offset, limit, sorters, filters, count) print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) ``` @@ -348,22 +361,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto -from sailpoint.beta.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) ``` @@ -402,21 +418,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType -from sailpoint.beta.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) ``` @@ -455,21 +474,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails -from sailpoint.beta.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) ``` @@ -512,24 +534,28 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto -from sailpoint.beta.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.beta.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) ``` @@ -572,10 +598,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto -from sailpoint.beta.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" : "", @@ -611,14 +641,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) ``` @@ -660,10 +690,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails -from sailpoint.beta.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" @@ -671,14 +705,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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SourceUsagesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SourceUsagesApi.md index 799697a65..bc70c9f55 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SourceUsagesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SourceUsagesApi.md @@ -55,22 +55,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.source_usages_api import SourceUsagesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.source_usage_status import SourceUsageStatus -from sailpoint.beta.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.beta +from sailpoint.beta.api.source_usages_api import SourceUsagesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.source_usage import SourceUsage -from sailpoint.beta.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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SourcesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SourcesApi.md index cc6837354..fa0e45044 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SourcesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SourcesApi.md @@ -154,10 +154,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.provisioning_policy_dto import ProvisioningPolicyDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id provisioning_policy_dto = { "name" : "example provisioning policy for inactive identities", @@ -202,14 +206,14 @@ from pprint import pprint try: # Create Provisioning Policy - Result = provisioning_policy_dto.from_json(provisioning_policy_dto) - api_response = api_instance.create_provisioning_policy(source_id, Result) - + new_provisioning_policy_dto = ProvisioningPolicyDto() + new_provisioning_policy_dto.from_json(provisioning_policy_dto) + results =SourcesApi(api_client).create_provisioning_policy(source_id, new_provisioning_policy_dto) # Below is a request that includes all optional parameters - # api_response = api_instance.create_provisioning_policy(source_id, Result) + # results = SourcesApi(api_client).create_provisioning_policy(source_id, new_provisioning_policy_dto) print("The response of SourcesApi->create_provisioning_policy:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) ``` @@ -252,10 +256,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.source import Source -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source = { "cluster" : { "name" : "Corporate Cluster", @@ -343,14 +351,14 @@ from pprint import pprint try: # Creates a source in IdentityNow. - Result = source.from_json(source) - api_response = api_instance.create_source(Result, ) - + new_source = Source() + new_source.from_json(source) + results =SourcesApi(api_client).create_source(new_source, ) # Below is a request that includes all optional parameters - # api_response = api_instance.create_source(Result, provision_as_csv) + # results = SourcesApi(api_client).create_source(new_source, provision_as_csv) print("The response of SourcesApi->create_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->create_source: %s\n" % e) ``` @@ -392,23 +400,27 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.model_schema import ModelSchema -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. model_schema = sailpoint.beta.ModelSchema() # ModelSchema | try: # Create Schema on Source - Result = model_schema.from_json(model_schema) - api_response = api_instance.create_source_schema(source_id, Result) - + new_model_schema = ModelSchema() + new_model_schema.from_json(model_schema) + results =SourcesApi(api_client).create_source_schema(source_id, new_model_schema) # Below is a request that includes all optional parameters - # api_response = api_instance.create_source_schema(source_id, Result) + # results = SourcesApi(api_client).create_source_schema(source_id, new_model_schema) print("The response of SourcesApi->create_source_schema:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) ``` @@ -452,22 +464,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.delete202_response import Delete202Response -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. try: # Delete Source by ID - api_response = api_instance.delete(id) - + results =SourcesApi(api_client).delete(id) # Below is a request that includes all optional parameters - # api_response = api_instance.delete(id) + # results = SourcesApi(api_client).delete(id) print("The response of SourcesApi->delete:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->delete: %s\n" % e) ``` @@ -514,22 +529,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.task_result_dto import TaskResultDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = 'ebbf35756e1140699ce52b233121384a' # str | The source id # str | The source id try: # Remove All Accounts in a Source - api_response = api_instance.delete_accounts_async(source_id) - + results =SourcesApi(api_client).delete_accounts_async(source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.delete_accounts_async(source_id) + # results = SourcesApi(api_client).delete_accounts_async(source_id) print("The response of SourcesApi->delete_accounts_async:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->delete_accounts_async: %s\n" % e) ``` @@ -572,19 +590,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id try: # Delete Native Change Detection Configuration - api_instance.delete_native_change_detection_config(source_id) - + SourcesApi(api_client).delete_native_change_detection_config(source_id) # Below is a request that includes all optional parameters - # api_instance.delete_native_change_detection_config(source_id) - except Exception as e: + # SourcesApi(api_client).delete_native_change_detection_config(source_id) + except Exception as e: print("Exception when calling SourcesApi->delete_native_change_detection_config: %s\n" % e) ``` @@ -627,21 +648,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.usage_type import UsageType -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. usage_type = sailpoint.beta.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. try: # Delete Provisioning Policy by UsageType - api_instance.delete_provisioning_policy(source_id, usage_type) - + SourcesApi(api_client).delete_provisioning_policy(source_id, usage_type) # Below is a request that includes all optional parameters - # api_instance.delete_provisioning_policy(source_id, usage_type) - except Exception as e: + # SourcesApi(api_client).delete_provisioning_policy(source_id, usage_type) + except Exception as e: print("Exception when calling SourcesApi->delete_provisioning_policy: %s\n" % e) ``` @@ -684,20 +708,23 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema ID. # str | The Schema ID. try: # Delete Source Schema by ID - api_instance.delete_source_schema(source_id, schema_id) - + SourcesApi(api_client).delete_source_schema(source_id, schema_id) # Below is a request that includes all optional parameters - # api_instance.delete_source_schema(source_id, schema_id) - except Exception as e: + # SourcesApi(api_client).delete_source_schema(source_id, schema_id) + except Exception as e: print("Exception when calling SourcesApi->delete_source_schema: %s\n" % e) ``` @@ -739,22 +766,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.correlation_config import CorrelationConfig -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id try: # Get Source Correlation Configuration - api_response = api_instance.get_correlation_config(source_id) - + results =SourcesApi(api_client).get_correlation_config(source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_correlation_config(source_id) + # results = SourcesApi(api_client).get_correlation_config(source_id) print("The response of SourcesApi->get_correlation_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_correlation_config: %s\n" % e) ``` @@ -797,22 +827,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.native_change_detection_config import NativeChangeDetectionConfig -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id try: # Native Change Detection Configuration - api_response = api_instance.get_native_change_detection_config(source_id) - + results =SourcesApi(api_client).get_native_change_detection_config(source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_native_change_detection_config(source_id) + # results = SourcesApi(api_client).get_native_change_detection_config(source_id) print("The response of SourcesApi->get_native_change_detection_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_native_change_detection_config: %s\n" % e) ``` @@ -855,24 +888,27 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.provisioning_policy_dto import ProvisioningPolicyDto from sailpoint.beta.models.usage_type import UsageType -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. usage_type = sailpoint.beta.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. try: # Get Provisioning Policy by UsageType - api_response = api_instance.get_provisioning_policy(source_id, usage_type) - + results =SourcesApi(api_client).get_provisioning_policy(source_id, usage_type) # Below is a request that includes all optional parameters - # api_response = api_instance.get_provisioning_policy(source_id, usage_type) + # results = SourcesApi(api_client).get_provisioning_policy(source_id, usage_type) print("The response of SourcesApi->get_provisioning_policy:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) ``` @@ -915,22 +951,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.source import Source -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. try: # Get Source by ID - api_response = api_instance.get_source(id) - + results =SourcesApi(api_client).get_source(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_source(id) + # results = SourcesApi(api_client).get_source(id) print("The response of SourcesApi->get_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_source: %s\n" % e) ``` @@ -972,19 +1011,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id try: # Downloads source accounts schema template - api_instance.get_source_accounts_schema(source_id) - + SourcesApi(api_client).get_source_accounts_schema(source_id) # Below is a request that includes all optional parameters - # api_instance.get_source_accounts_schema(source_id) - except Exception as e: + # SourcesApi(api_client).get_source_accounts_schema(source_id) + except Exception as e: print("Exception when calling SourcesApi->get_source_accounts_schema: %s\n" % e) ``` @@ -1027,22 +1069,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.attr_sync_source_config import AttrSyncSourceConfig -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id try: # Attribute Sync Config - api_response = api_instance.get_source_attr_sync_config(id) - + results =SourcesApi(api_client).get_source_attr_sync_config(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_attr_sync_config(id) + # results = SourcesApi(api_client).get_source_attr_sync_config(id) print("The response of SourcesApi->get_source_attr_sync_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_source_attr_sync_config: %s\n" % e) ``` @@ -1085,23 +1130,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.connector_detail import ConnectorDetail -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'id_example' # str | The Source id # str | The Source id locale = 'locale_example' # 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: # Gets source config with language translations - api_response = api_instance.get_source_config(id, ) - + results =SourcesApi(api_client).get_source_config(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_config(id, locale) + # results = SourcesApi(api_client).get_source_config(id, locale) print("The response of SourcesApi->get_source_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_source_config: %s\n" % e) ``` @@ -1148,22 +1196,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.source_entitlement_request_config import SourceEntitlementRequestConfig -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id try: # Get Source Entitlement Request Configuration - api_response = api_instance.get_source_entitlement_request_config(source_id) - + results =SourcesApi(api_client).get_source_entitlement_request_config(source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_entitlement_request_config(source_id) + # results = SourcesApi(api_client).get_source_entitlement_request_config(source_id) print("The response of SourcesApi->get_source_entitlement_request_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_source_entitlement_request_config: %s\n" % e) ``` @@ -1206,20 +1257,23 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id schema_name = '?schemaName=group' # str | Name of entitlement schema (optional) # str | Name of entitlement schema (optional) try: # Downloads source entitlements schema template - api_instance.get_source_entitlements_schema(source_id, ) - + SourcesApi(api_client).get_source_entitlements_schema(source_id, ) # Below is a request that includes all optional parameters - # api_instance.get_source_entitlements_schema(source_id, schema_name) - except Exception as e: + # SourcesApi(api_client).get_source_entitlements_schema(source_id, schema_name) + except Exception as e: print("Exception when calling SourcesApi->get_source_entitlements_schema: %s\n" % e) ``` @@ -1263,23 +1317,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.model_schema import ModelSchema -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema ID. # str | The Schema ID. try: # Get Source Schema by ID - api_response = api_instance.get_source_schema(source_id, schema_id) - + results =SourcesApi(api_client).get_source_schema(source_id, schema_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_schema(source_id, schema_id) + # results = SourcesApi(api_client).get_source_schema(source_id, schema_id) print("The response of SourcesApi->get_source_schema:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) ``` @@ -1323,10 +1380,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.model_schema import ModelSchema -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. include_types = 'group' # str | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) # str | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) include_names = 'account' # str | A comma-separated list of schema names to filter result. (optional) # str | A comma-separated list of schema names to filter result. (optional) @@ -1334,13 +1395,12 @@ from pprint import pprint try: # List Schemas on Source - api_response = api_instance.get_source_schemas(source_id, ) - + results =SourcesApi(api_client).get_source_schemas(source_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_schemas(source_id, include_types, include_names) + # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) print("The response of SourcesApi->get_source_schemas:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) ``` @@ -1386,10 +1446,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.load_accounts_task import LoadAccountsTask -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id file = None # bytearray | The CSV file containing the source accounts to aggregate. (optional) # bytearray | The CSV file containing the source accounts to aggregate. (optional) disable_optimization = 'disable_optimization_example' # str | Use this flag to reprocess every account whether or not the data has changed. (optional) # str | Use this flag to reprocess every account whether or not the data has changed. (optional) @@ -1397,13 +1461,12 @@ from pprint import pprint try: # Account Aggregation - api_response = api_instance.import_accounts(source_id, ) - + results =SourcesApi(api_client).import_accounts(source_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.import_accounts(source_id, file, disable_optimization) + # results = SourcesApi(api_client).import_accounts(source_id, file, disable_optimization) print("The response of SourcesApi->import_accounts:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->import_accounts: %s\n" % e) ``` @@ -1448,23 +1511,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.load_entitlement_task import LoadEntitlementTask -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id file = None # bytearray | The CSV file containing the source entitlements to aggregate. (optional) # bytearray | The CSV file containing the source entitlements to aggregate. (optional) try: # Entitlement Aggregation - api_response = api_instance.import_entitlements(source_id, ) - + results =SourcesApi(api_client).import_entitlements(source_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.import_entitlements(source_id, file) + # results = SourcesApi(api_client).import_entitlements(source_id, file) print("The response of SourcesApi->import_entitlements:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->import_entitlements: %s\n" % e) ``` @@ -1506,23 +1572,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.model_schema import ModelSchema -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id file = None # bytearray | (optional) # bytearray | (optional) try: # Uploads source accounts schema template - api_response = api_instance.import_source_accounts_schema(source_id, ) - + results =SourcesApi(api_client).import_source_accounts_schema(source_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.import_source_accounts_schema(source_id, file) + # results = SourcesApi(api_client).import_source_accounts_schema(source_id, file) print("The response of SourcesApi->import_source_accounts_schema:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->import_source_accounts_schema: %s\n" % e) ``` @@ -1565,23 +1634,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.source import Source -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id file = None # bytearray | (optional) # bytearray | (optional) try: # Upload connector file to source - api_response = api_instance.import_source_connector_file(source_id, ) - + results =SourcesApi(api_client).import_source_connector_file(source_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.import_source_connector_file(source_id, file) + # results = SourcesApi(api_client).import_source_connector_file(source_id, file) print("The response of SourcesApi->import_source_connector_file:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->import_source_connector_file: %s\n" % e) ``` @@ -1624,10 +1696,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.model_schema import ModelSchema -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id schema_name = '?schemaName=group' # str | Name of entitlement schema (optional) # str | Name of entitlement schema (optional) file = None # bytearray | (optional) # bytearray | (optional) @@ -1635,13 +1711,12 @@ from pprint import pprint try: # Uploads source entitlements schema template - api_response = api_instance.import_source_entitlements_schema(source_id, ) - + results =SourcesApi(api_client).import_source_entitlements_schema(source_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.import_source_entitlements_schema(source_id, schema_name, file) + # results = SourcesApi(api_client).import_source_entitlements_schema(source_id, schema_name, file) print("The response of SourcesApi->import_source_entitlements_schema:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->import_source_entitlements_schema: %s\n" % e) ``` @@ -1683,23 +1758,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.load_uncorrelated_accounts_task import LoadUncorrelatedAccountsTask -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '75dbec1ebe154d5785da27b95e1dd5d7' # str | Source Id # str | Source Id file = None # bytearray | (optional) # bytearray | (optional) try: # Process Uncorrelated Accounts - api_response = api_instance.import_uncorrelated_accounts(source_id, ) - + results =SourcesApi(api_client).import_uncorrelated_accounts(source_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.import_uncorrelated_accounts(source_id, file) + # results = SourcesApi(api_client).import_uncorrelated_accounts(source_id, file) print("The response of SourcesApi->import_uncorrelated_accounts:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->import_uncorrelated_accounts: %s\n" % e) ``` @@ -1741,22 +1819,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.provisioning_policy_dto import ProvisioningPolicyDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id try: # Lists ProvisioningPolicies - api_response = api_instance.list_provisioning_policies(source_id) - + results =SourcesApi(api_client).list_provisioning_policies(source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.list_provisioning_policies(source_id) + # results = SourcesApi(api_client).list_provisioning_policies(source_id) print("The response of SourcesApi->list_provisioning_policies:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) ``` @@ -1806,10 +1887,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.source import Source -from sailpoint.beta.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) @@ -1821,13 +1906,12 @@ from pprint import pprint try: # Lists all sources in IdentityNow. - api_response = api_instance.list_sources() - + results =SourcesApi(api_client).list_sources() # Below is a request that includes all optional parameters - # api_response = api_instance.list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) + # results = SourcesApi(api_client).list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) print("The response of SourcesApi->list_sources:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->list_sources: %s\n" % e) ``` @@ -1871,11 +1955,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.resource_objects_request import ResourceObjectsRequest from sailpoint.beta.models.resource_objects_response import ResourceObjectsResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source resource_objects_request = { "maxCount" : 100, @@ -1884,14 +1972,14 @@ from pprint import pprint try: # Peek source connector's resource objects - Result = resource_objects_request.from_json(resource_objects_request) - api_response = api_instance.peek_resource_objects(source_id, Result) - + new_resource_objects_request = ResourceObjectsRequest() + new_resource_objects_request.from_json(resource_objects_request) + results =SourcesApi(api_client).peek_resource_objects(source_id, new_resource_objects_request) # Below is a request that includes all optional parameters - # api_response = api_instance.peek_resource_objects(source_id, Result) + # results = SourcesApi(api_client).peek_resource_objects(source_id, new_resource_objects_request) print("The response of SourcesApi->peek_resource_objects:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->peek_resource_objects: %s\n" % e) ``` @@ -1934,22 +2022,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.status_response import StatusResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source try: # Ping cluster for source connector - api_response = api_instance.ping_cluster(source_id) - + results =SourcesApi(api_client).ping_cluster(source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.ping_cluster(source_id) + # results = SourcesApi(api_client).ping_cluster(source_id) print("The response of SourcesApi->ping_cluster:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->ping_cluster: %s\n" % e) ``` @@ -1992,10 +2083,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.correlation_config import CorrelationConfig -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id correlation_config = { "attributeAssignments" : [ { @@ -2021,14 +2116,14 @@ from pprint import pprint try: # Update Source Correlation Configuration - Result = correlation_config.from_json(correlation_config) - api_response = api_instance.put_correlation_config(source_id, Result) - + new_correlation_config = CorrelationConfig() + new_correlation_config.from_json(correlation_config) + results =SourcesApi(api_client).put_correlation_config(source_id, new_correlation_config) # Below is a request that includes all optional parameters - # api_response = api_instance.put_correlation_config(source_id, Result) + # results = SourcesApi(api_client).put_correlation_config(source_id, new_correlation_config) print("The response of SourcesApi->put_correlation_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->put_correlation_config: %s\n" % e) ``` @@ -2073,10 +2168,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.native_change_detection_config import NativeChangeDetectionConfig -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id native_change_detection_config = { "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], @@ -2089,14 +2188,14 @@ from pprint import pprint try: # Update Native Change Detection Configuration - Result = native_change_detection_config.from_json(native_change_detection_config) - api_response = api_instance.put_native_change_detection_config(source_id, Result) - + new_native_change_detection_config = NativeChangeDetectionConfig() + new_native_change_detection_config.from_json(native_change_detection_config) + results =SourcesApi(api_client).put_native_change_detection_config(source_id, new_native_change_detection_config) # Below is a request that includes all optional parameters - # api_response = api_instance.put_native_change_detection_config(source_id, Result) + # results = SourcesApi(api_client).put_native_change_detection_config(source_id, new_native_change_detection_config) print("The response of SourcesApi->put_native_change_detection_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->put_native_change_detection_config: %s\n" % e) ``` @@ -2142,11 +2241,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.provisioning_policy_dto import ProvisioningPolicyDto from sailpoint.beta.models.usage_type import UsageType -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. usage_type = sailpoint.beta.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. provisioning_policy_dto = { @@ -2192,14 +2295,14 @@ from pprint import pprint try: # Update Provisioning Policy by UsageType - Result = provisioning_policy_dto.from_json(provisioning_policy_dto) - api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) - + new_provisioning_policy_dto = ProvisioningPolicyDto() + new_provisioning_policy_dto.from_json(provisioning_policy_dto) + results =SourcesApi(api_client).put_provisioning_policy(source_id, usage_type, new_provisioning_policy_dto) # Below is a request that includes all optional parameters - # api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) + # results = SourcesApi(api_client).put_provisioning_policy(source_id, usage_type, new_provisioning_policy_dto) print("The response of SourcesApi->put_provisioning_policy:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) ``` @@ -2256,10 +2359,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.source import Source -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. source = { "cluster" : { @@ -2347,14 +2454,14 @@ from pprint import pprint try: # Update Source (Full) - Result = source.from_json(source) - api_response = api_instance.put_source(id, Result) - + new_source = Source() + new_source.from_json(source) + results =SourcesApi(api_client).put_source(id, new_source) # Below is a request that includes all optional parameters - # api_response = api_instance.put_source(id, Result) + # results = SourcesApi(api_client).put_source(id, new_source) print("The response of SourcesApi->put_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->put_source: %s\n" % e) ``` @@ -2399,10 +2506,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.attr_sync_source_config import AttrSyncSourceConfig -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id attr_sync_source_config = { "attributes" : [ { @@ -2425,14 +2536,14 @@ from pprint import pprint try: # Update Attribute Sync Config - Result = attr_sync_source_config.from_json(attr_sync_source_config) - api_response = api_instance.put_source_attr_sync_config(id, Result) - + new_attr_sync_source_config = AttrSyncSourceConfig() + new_attr_sync_source_config.from_json(attr_sync_source_config) + results =SourcesApi(api_client).put_source_attr_sync_config(id, new_attr_sync_source_config) # Below is a request that includes all optional parameters - # api_response = api_instance.put_source_attr_sync_config(id, Result) + # results = SourcesApi(api_client).put_source_attr_sync_config(id, new_attr_sync_source_config) print("The response of SourcesApi->put_source_attr_sync_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->put_source_attr_sync_config: %s\n" % e) ``` @@ -2481,24 +2592,28 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.model_schema import ModelSchema -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema ID. # str | The Schema ID. model_schema = sailpoint.beta.ModelSchema() # ModelSchema | try: # Update Source Schema (Full) - Result = model_schema.from_json(model_schema) - api_response = api_instance.put_source_schema(source_id, schema_id, Result) - + new_model_schema = ModelSchema() + new_model_schema.from_json(model_schema) + results =SourcesApi(api_client).put_source_schema(source_id, schema_id, new_model_schema) # Below is a request that includes all optional parameters - # api_response = api_instance.put_source_schema(source_id, schema_id, Result) + # results = SourcesApi(api_client).put_source_schema(source_id, schema_id, new_model_schema) print("The response of SourcesApi->put_source_schema:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) ``` @@ -2541,22 +2656,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.source_sync_job import SourceSyncJob -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = 'source_id_example' # str | The Source id # str | The Source id try: # Synchronize single source attributes. - api_response = api_instance.sync_attributes_for_source(source_id) - + results =SourcesApi(api_client).sync_attributes_for_source(source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.sync_attributes_for_source(source_id) + # results = SourcesApi(api_client).sync_attributes_for_source(source_id) print("The response of SourcesApi->sync_attributes_for_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->sync_attributes_for_source: %s\n" % e) ``` @@ -2599,22 +2717,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.status_response import StatusResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source try: # Test configuration for source connector - api_response = api_instance.test_source_configuration(source_id) - + results =SourcesApi(api_client).test_source_configuration(source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.test_source_configuration(source_id) + # results = SourcesApi(api_client).test_source_configuration(source_id) print("The response of SourcesApi->test_source_configuration:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->test_source_configuration: %s\n" % e) ``` @@ -2657,22 +2778,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.status_response import StatusResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source. # str | The ID of the Source. try: # Check connection for source connector. - api_response = api_instance.test_source_connection(source_id) - + results =SourcesApi(api_client).test_source_connection(source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.test_source_connection(source_id) + # results = SourcesApi(api_client).test_source_connection(source_id) print("The response of SourcesApi->test_source_connection:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->test_source_connection: %s\n" % e) ``` @@ -2715,10 +2839,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.provisioning_policy_dto import ProvisioningPolicyDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. [sailpoint.beta.ProvisioningPolicyDto()] # List[ProvisioningPolicyDto] | provisioning_policy_dto = { @@ -2765,14 +2893,14 @@ from pprint import pprint try: # Bulk Update Provisioning Policies - Result = provisioning_policy_dto.from_json(provisioning_policy_dto) - api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) - + new_provisioning_policy_dto = ProvisioningPolicyDto() + new_provisioning_policy_dto.from_json(provisioning_policy_dto) + results =SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) # Below is a request that includes all optional parameters - # api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) + # results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) ``` @@ -2818,12 +2946,16 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.json_patch_operation import JsonPatchOperation from sailpoint.beta.models.provisioning_policy_dto import ProvisioningPolicyDto from sailpoint.beta.models.usage_type import UsageType -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. usage_type = sailpoint.beta.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. [{op=add, path=/fields/0, value={name=email, transform={type=identityAttribute, attributes={name=email}}, attributes={}, isRequired=false, type=string, isMultiValued=false}}] # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. @@ -2836,14 +2968,14 @@ from pprint import pprint try: # Partial update of Provisioning Policy - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =SourcesApi(api_client).update_provisioning_policy(source_id, usage_type, new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) + # results = SourcesApi(api_client).update_provisioning_policy(source_id, usage_type, new_json_patch_operation) print("The response of SourcesApi->update_provisioning_policy:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) ``` @@ -2902,11 +3034,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.json_patch_operation import JsonPatchOperation from sailpoint.beta.models.source import Source -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. [{op=replace, path=/description, value=new description}] # List[JsonPatchOperation] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). json_patch_operation = { @@ -2918,14 +3054,14 @@ from pprint import pprint try: # Update Source (Partial) - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_source(id, Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =SourcesApi(api_client).update_source(id, new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.update_source(id, Result) + # results = SourcesApi(api_client).update_source(id, new_json_patch_operation) print("The response of SourcesApi->update_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->update_source: %s\n" % e) ``` @@ -2973,10 +3109,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.source_entitlement_request_config import SourceEntitlementRequestConfig -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id source_entitlement_request_config = { "accessRequestConfig" : { @@ -2994,14 +3134,14 @@ from pprint import pprint try: # Update Source Entitlement Request Configuration - Result = source_entitlement_request_config.from_json(source_entitlement_request_config) - api_response = api_instance.update_source_entitlement_request_config(source_id, Result) - + new_source_entitlement_request_config = SourceEntitlementRequestConfig() + new_source_entitlement_request_config.from_json(source_entitlement_request_config) + results =SourcesApi(api_client).update_source_entitlement_request_config(source_id, new_source_entitlement_request_config) # Below is a request that includes all optional parameters - # api_response = api_instance.update_source_entitlement_request_config(source_id, Result) + # results = SourcesApi(api_client).update_source_entitlement_request_config(source_id, new_source_entitlement_request_config) print("The response of SourcesApi->update_source_entitlement_request_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->update_source_entitlement_request_config: %s\n" % e) ``` @@ -3074,11 +3214,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.sources_api import SourcesApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.json_patch_operation import JsonPatchOperation from sailpoint.beta.models.model_schema import ModelSchema -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. [{op=replace, path=/displayAttribute, value={new-display-attribute=null}}] # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. @@ -3091,14 +3235,14 @@ from pprint import pprint try: # Update Source Schema (Partial) - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_source_schema(source_id, schema_id, Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =SourcesApi(api_client).update_source_schema(source_id, schema_id, new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.update_source_schema(source_id, schema_id, Result) + # results = SourcesApi(api_client).update_source_schema(source_id, schema_id, new_json_patch_operation) print("The response of SourcesApi->update_source_schema:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SuggestedEntitlementDescriptionApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SuggestedEntitlementDescriptionApi.md index 5d87e0bfe..b544925f8 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SuggestedEntitlementDescriptionApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SuggestedEntitlementDescriptionApi.md @@ -65,22 +65,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.sed_batch_stats import SedBatchStats -from sailpoint.beta.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 try: # Submit Sed Batch Stats Request - api_response = api_instance.get_sed_batch_stats(batch_id) - + results =SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_sed_batch_stats(batch_id) + # results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id) 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) ``` @@ -120,21 +123,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.sed_batch_status import SedBatchStatus -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # List Sed Batch Request - api_response = api_instance.get_sed_batches() - + results =SuggestedEntitlementDescriptionApi(api_client).get_sed_batches() # Below is a request that includes all optional parameters - # api_response = api_instance.get_sed_batches() + # results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches() 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) ``` @@ -196,10 +202,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.sed import Sed -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: 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) sorters = 'sorters=displayName' # 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: **displayName, sourceName, status** (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: **displayName, sourceName, status** (optional) @@ -211,13 +221,12 @@ from pprint import pprint try: # List Suggested Entitlement Descriptions - api_response = api_instance.list_seds() - + results =SuggestedEntitlementDescriptionApi(api_client).list_seds() # Below is a request that includes all optional parameters - # api_response = api_instance.list_seds(limit, filters, sorters, count, count_only, requested_by_anyone, show_pending_status_only) + # results = SuggestedEntitlementDescriptionApi(api_client).list_seds(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) ``` @@ -260,11 +269,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.sed import Sed from sailpoint.beta.models.sed_patch import SedPatch -from sailpoint.beta.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 [sailpoint.beta.SedPatch()] # List[SedPatch] | Sed Patch Request sed_patch = { @@ -276,14 +289,14 @@ from pprint import pprint try: # Patch Suggested Entitlement Description - Result = sed_patch.from_json(sed_patch) - api_response = api_instance.patch_sed(id, Result) - + new_sed_patch = SedPatch() + new_sed_patch.from_json(sed_patch) + results =SuggestedEntitlementDescriptionApi(api_client).patch_sed(id, new_sed_patch) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_sed(id, Result) + # results = SuggestedEntitlementDescriptionApi(api_client).patch_sed(id, 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) ``` @@ -326,11 +339,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.sed_approval import SedApproval from sailpoint.beta.models.sed_approval_status import SedApprovalStatus -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: [sailpoint.beta.SedApproval()] # List[SedApproval] | Sed Approval sed_approval = { "items" : "016629d1-1d25-463f-97f3-c6686846650" @@ -339,14 +356,14 @@ from pprint import pprint try: # Submit Bulk Approval Request - Result = sed_approval.from_json(sed_approval) - api_response = api_instance.submit_sed_approval(Result) - + new_sed_approval = SedApproval() + new_sed_approval.from_json(sed_approval) + results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval) # Below is a request that includes all optional parameters - # api_response = api_instance.submit_sed_approval(Result) + # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(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) ``` @@ -389,11 +406,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.sed_assignment import SedAssignment from sailpoint.beta.models.sed_assignment_response import SedAssignmentResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: sed_assignment = { "assignee" : { "type" : "SOURCE_OWNER", @@ -404,14 +425,14 @@ from pprint import pprint try: # Submit Sed Assignment Request - Result = sed_assignment.from_json(sed_assignment) - api_response = api_instance.submit_sed_assignment(Result) - + new_sed_assignment = SedAssignment() + new_sed_assignment.from_json(sed_assignment) + results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(new_sed_assignment) # Below is a request that includes all optional parameters - # api_response = api_instance.submit_sed_assignment(Result) + # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(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) ``` @@ -457,11 +478,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.sed_batch_request import SedBatchRequest from sailpoint.beta.models.sed_batch_response import SedBatchResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: sed_batch_request = { "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] @@ -470,13 +495,12 @@ from pprint import pprint try: # Submit Sed Batch Request - api_response = api_instance.submit_sed_batch_request() - + results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request() # Below is a request that includes all optional parameters - # api_response = api_instance.submit_sed_batch_request(Result) + # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request(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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/TaggedObjectsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/TaggedObjectsApi.md index 31e791feb..ba9664b40 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/TaggedObjectsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/TaggedObjectsApi.md @@ -112,20 +112,23 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: type = '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) ``` @@ -168,10 +171,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.bulk_tagged_object import BulkTaggedObject -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: bulk_tagged_object = { "objectRefs" : [ { "name" : "William Wilson", @@ -188,12 +195,12 @@ from pprint import pprint try: # Remove Tags from Multiple Objects - Result = bulk_tagged_object.from_json(bulk_tagged_object) - api_instance.delete_tags_to_many_object(Result) - + new_bulk_tagged_object = BulkTaggedObject() + new_bulk_tagged_object.from_json(bulk_tagged_object) + TaggedObjectsApi(api_client).delete_tags_to_many_object(new_bulk_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_tagged_object) + except Exception as e: print("Exception when calling TaggedObjectsApi->delete_tags_to_many_object: %s\n" % e) ``` @@ -235,23 +242,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.tagged_object import TaggedObject -from sailpoint.beta.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) ``` @@ -297,10 +307,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.tagged_object import TaggedObject -from sailpoint.beta.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) @@ -309,13 +323,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) ``` @@ -362,10 +375,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.tagged_object import TaggedObject -from sailpoint.beta.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) @@ -375,13 +392,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) ``` @@ -424,10 +440,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.tagged_object import TaggedObject -from sailpoint.beta.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 = { @@ -441,14 +461,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) ``` @@ -491,10 +511,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.tagged_object import TaggedObject -from sailpoint.beta.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", @@ -506,12 +530,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) ``` @@ -554,10 +578,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.bulk_tagged_object import BulkTaggedObject -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: bulk_tagged_object = { "objectRefs" : [ { "name" : "William Wilson", @@ -574,14 +602,14 @@ from pprint import pprint try: # Tag Multiple Objects - Result = bulk_tagged_object.from_json(bulk_tagged_object) - api_response = api_instance.set_tags_to_many_objects(Result) - + new_bulk_tagged_object = BulkTaggedObject() + new_bulk_tagged_object.from_json(bulk_tagged_object) + results =TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_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_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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/TagsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/TagsApi.md index 4bbb52017..89c4307e8 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/TagsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/TagsApi.md @@ -56,10 +56,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.tags_api import TagsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.tag import Tag -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: tag = { "created" : "2022-05-04T14:48:49Z", "tagCategoryRefs" : [ { @@ -78,14 +82,14 @@ from pprint import pprint try: # Create Tag - Result = tag.from_json(tag) - api_response = api_instance.create_tag(Result) - + new_tag = Tag() + new_tag.from_json(tag) + results =TagsApi(api_client).create_tag(new_tag) # Below is a request that includes all optional parameters - # api_response = api_instance.create_tag(Result) + # results = TagsApi(api_client).create_tag(new_tag) print("The response of TagsApi->create_tag:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling TagsApi->create_tag: %s\n" % e) ``` @@ -129,19 +133,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.tags_api import TagsApi +from sailpoint.beta.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '329d96cf-3bdb-40a9-988a-b5037ab89022' # str | The ID of the object reference to delete. # str | The ID of the object reference to delete. try: # Delete Tag - api_instance.delete_tag_by_id(id) - + TagsApi(api_client).delete_tag_by_id(id) # Below is a request that includes all optional parameters - # api_instance.delete_tag_by_id(id) - except Exception as e: + # TagsApi(api_client).delete_tag_by_id(id) + except Exception as e: print("Exception when calling TagsApi->delete_tag_by_id: %s\n" % e) ``` @@ -185,22 +192,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.tags_api import TagsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.tag import Tag -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '329d96cf-3bdb-40a9-988a-b5037ab89022' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. try: # Get Tag By Id - api_response = api_instance.get_tag_by_id(id) - + results =TagsApi(api_client).get_tag_by_id(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_tag_by_id(id) + # results = TagsApi(api_client).get_tag_by_id(id) print("The response of TagsApi->get_tag_by_id:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling TagsApi->get_tag_by_id: %s\n" % e) ``` @@ -247,10 +257,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.tags_api import TagsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.tag import Tag -from sailpoint.beta.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) @@ -260,13 +274,12 @@ from pprint import pprint try: # List Tags - api_response = api_instance.list_tags() - + results =TagsApi(api_client).list_tags() # Below is a request that includes all optional parameters - # api_response = api_instance.list_tags(limit, offset, count, filters, sorters) + # results = TagsApi(api_client).list_tags(limit, offset, count, filters, sorters) print("The response of TagsApi->list_tags:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling TagsApi->list_tags: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/TaskManagementApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/TaskManagementApi.md index 08823d4e2..9ecd283d4 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/TaskManagementApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/TaskManagementApi.md @@ -58,9 +58,13 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.task_management_api import TaskManagementApi +from sailpoint.beta.api_client import ApiClient 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) @@ -68,11 +72,10 @@ from pprint import pprint try: # Retrieve Pending Task List Headers - api_instance.get_pending_task_headers() - + TaskManagementApi(api_client).get_pending_task_headers() # Below is a request that includes all optional parameters - # api_instance.get_pending_task_headers(offset, limit, count) - except Exception as e: + # TaskManagementApi(api_client).get_pending_task_headers(offset, limit, count) + except Exception as e: print("Exception when calling TaskManagementApi->get_pending_task_headers: %s\n" % e) ``` @@ -116,10 +119,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.task_management_api import TaskManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.task_status import TaskStatus -from sailpoint.beta.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) @@ -127,13 +134,12 @@ from pprint import pprint try: # Retrieve Pending Task Status List - api_response = api_instance.get_pending_tasks() - + results =TaskManagementApi(api_client).get_pending_tasks() # Below is a request that includes all optional parameters - # api_response = api_instance.get_pending_tasks(offset, limit, count) + # results = TaskManagementApi(api_client).get_pending_tasks(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) ``` @@ -175,22 +181,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.task_management_api import TaskManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.task_status import TaskStatus -from sailpoint.beta.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. try: # Get Task Status by ID - api_response = api_instance.get_task_status(id) - + results =TaskManagementApi(api_client).get_task_status(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_task_status(id) + # results = TaskManagementApi(api_client).get_task_status(id) 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) ``` @@ -237,10 +246,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.task_management_api import TaskManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.task_status import TaskStatus -from sailpoint.beta.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) @@ -250,13 +263,12 @@ from pprint import pprint try: # Retrieve Task Status List - api_response = api_instance.get_task_status_list() - + results =TaskManagementApi(api_client).get_task_status_list() # Below is a request that includes all optional parameters - # api_response = api_instance.get_task_status_list(limit, offset, count, filters, sorters) + # results = TaskManagementApi(api_client).get_task_status_list(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) ``` @@ -299,11 +311,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.task_management_api import TaskManagementApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.json_patch_operation import JsonPatchOperation from sailpoint.beta.models.task_status import TaskStatus -from sailpoint.beta.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. [sailpoint.beta.JsonPatchOperation()] # List[JsonPatchOperation] | The JSONPatch payload used to update the object. json_patch_operation = { @@ -315,14 +331,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, Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =TaskManagementApi(api_client).update_task_status(id, new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.update_task_status(id, Result) + # results = TaskManagementApi(api_client).update_task_status(id, 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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/TenantApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/TenantApi.md index 0f73b890e..94627bbc1 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/TenantApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/TenantApi.md @@ -49,21 +49,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.tenant_api import TenantApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.tenant import Tenant -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # Get Tenant Information. - api_response = api_instance.get_tenant() - + results =TenantApi(api_client).get_tenant() # Below is a request that includes all optional parameters - # api_response = api_instance.get_tenant() + # results = TenantApi(api_client).get_tenant() 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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/TransformsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/TransformsApi.md index 2b1f76d56..54a90bd7f 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/TransformsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/TransformsApi.md @@ -56,11 +56,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.transforms_api import TransformsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.transform import Transform from sailpoint.beta.models.transform_read import TransformRead -from sailpoint.beta.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" : "{}", @@ -69,14 +73,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) ``` @@ -119,19 +123,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.transforms_api import TransformsApi +from sailpoint.beta.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) ``` @@ -174,22 +181,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.transforms_api import TransformsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.transform_read import TransformRead -from sailpoint.beta.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) ``` @@ -236,10 +246,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.transforms_api import TransformsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.transform_read import TransformRead -from sailpoint.beta.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) @@ -249,13 +263,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) ``` @@ -299,11 +312,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.transforms_api import TransformsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.transform import Transform from sailpoint.beta.models.transform_read import TransformRead -from sailpoint.beta.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", @@ -314,13 +331,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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/TriggersApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/TriggersApi.md index a06f137b1..64fb2b69a 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/TriggersApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/TriggersApi.md @@ -102,10 +102,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.triggers_api import TriggersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.complete_invocation import CompleteInvocation -from sailpoint.beta.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. complete_invocation = { "output" : { @@ -117,12 +121,12 @@ from pprint import pprint try: # Complete Trigger Invocation - Result = complete_invocation.from_json(complete_invocation) - api_instance.complete_trigger_invocation(id, Result) - + new_complete_invocation = CompleteInvocation() + new_complete_invocation.from_json(complete_invocation) + TriggersApi(api_client).complete_trigger_invocation(id, new_complete_invocation) # Below is a request that includes all optional parameters - # api_instance.complete_trigger_invocation(id, Result) - except Exception as e: + # TriggersApi(api_client).complete_trigger_invocation(id, new_complete_invocation) + except Exception as e: print("Exception when calling TriggersApi->complete_trigger_invocation: %s\n" % e) ``` @@ -165,11 +169,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.triggers_api import TriggersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.subscription import Subscription from sailpoint.beta.models.subscription_post_request import SubscriptionPostRequest -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: subscription_post_request = { "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", "httpConfig" : { @@ -198,14 +206,14 @@ from pprint import pprint try: # Create a Subscription - Result = subscription_post_request.from_json(subscription_post_request) - api_response = api_instance.create_subscription(Result) - + new_subscription_post_request = SubscriptionPostRequest() + new_subscription_post_request.from_json(subscription_post_request) + results =TriggersApi(api_client).create_subscription(new_subscription_post_request) # Below is a request that includes all optional parameters - # api_response = api_instance.create_subscription(Result) + # results = TriggersApi(api_client).create_subscription(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) ``` @@ -247,19 +255,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.triggers_api import TriggersApi +from sailpoint.beta.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 try: # Delete a Subscription - api_instance.delete_subscription(id) - + TriggersApi(api_client).delete_subscription(id) # Below is a request that includes all optional parameters - # api_instance.delete_subscription(id) - except Exception as e: + # TriggersApi(api_client).delete_subscription(id) + except Exception as e: print("Exception when calling TriggersApi->delete_subscription: %s\n" % e) ``` @@ -304,10 +315,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.triggers_api import TriggersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.subscription import Subscription -from sailpoint.beta.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) @@ -317,13 +332,12 @@ from pprint import pprint try: # List Subscriptions - api_response = api_instance.list_subscriptions() - + results =TriggersApi(api_client).list_subscriptions() # Below is a request that includes all optional parameters - # api_response = api_instance.list_subscriptions(limit, offset, count, filters, sorters) + # results = TriggersApi(api_client).list_subscriptions(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) ``` @@ -370,10 +384,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.triggers_api import TriggersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.invocation_status import InvocationStatus -from sailpoint.beta.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) @@ -383,13 +401,12 @@ from pprint import pprint try: # List Latest Invocation Statuses - api_response = api_instance.list_trigger_invocation_status() - + results =TriggersApi(api_client).list_trigger_invocation_status() # Below is a request that includes all optional parameters - # api_response = api_instance.list_trigger_invocation_status(limit, offset, count, filters, sorters) + # results = TriggersApi(api_client).list_trigger_invocation_status(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) ``` @@ -434,10 +451,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.triggers_api import TriggersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.trigger import Trigger -from sailpoint.beta.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) @@ -447,13 +468,12 @@ from pprint import pprint try: # List Triggers - api_response = api_instance.list_triggers() - + results =TriggersApi(api_client).list_triggers() # Below is a request that includes all optional parameters - # api_response = api_instance.list_triggers(limit, offset, count, filters, sorters) + # results = TriggersApi(api_client).list_triggers(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) ``` @@ -498,11 +518,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.triggers_api import TriggersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.subscription import Subscription from sailpoint.beta.models.subscription_patch_request_inner import SubscriptionPatchRequestInner -from sailpoint.beta.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 [sailpoint.beta.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] | subscription_patch_request_inner = [sailpoint.beta.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] | @@ -510,14 +534,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, 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, new_subscription_patch_request_inner) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_subscription(id, Result) + # results = TriggersApi(api_client).patch_subscription(id, 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) ``` @@ -559,11 +583,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.triggers_api import TriggersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.invocation import Invocation from sailpoint.beta.models.test_invocation import TestInvocation -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: test_invocation = { "input" : { "identityId" : "201327fda1c44704ac01181e963d463c" @@ -577,14 +605,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(Result) - + new_test_invocation = TestInvocation() + new_test_invocation.from_json(test_invocation) + results =TriggersApi(api_client).start_test_trigger_invocation(new_test_invocation) # Below is a request that includes all optional parameters - # api_response = api_instance.start_test_trigger_invocation(Result) + # results = TriggersApi(api_client).start_test_trigger_invocation(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) ``` @@ -626,11 +654,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.triggers_api import TriggersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.validate_filter_input_dto import ValidateFilterInputDto from sailpoint.beta.models.validate_filter_output_dto import ValidateFilterOutputDto -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: validate_filter_input_dto = { "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", "input" : { @@ -640,14 +672,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(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(new_validate_filter_input_dto) # Below is a request that includes all optional parameters - # api_response = api_instance.test_subscription_filter(Result) + # results = TriggersApi(api_client).test_subscription_filter(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) ``` @@ -699,11 +731,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.triggers_api import TriggersApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.subscription import Subscription from sailpoint.beta.models.subscription_put_request import SubscriptionPutRequest -from sailpoint.beta.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 subscription_put_request = { "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", @@ -732,14 +768,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, Result) - + new_subscription_put_request = SubscriptionPutRequest() + new_subscription_put_request.from_json(subscription_put_request) + results =TriggersApi(api_client).update_subscription(id, new_subscription_put_request) # Below is a request that includes all optional parameters - # api_response = api_instance.update_subscription(id, Result) + # results = TriggersApi(api_client).update_subscription(id, 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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/UIMetadataApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/UIMetadataApi.md index b6c6f8d2b..a8d3adba2 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/UIMetadataApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/UIMetadataApi.md @@ -52,21 +52,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.ui_metadata_api import UIMetadataApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.tenant_ui_metadata_item_response import TenantUiMetadataItemResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # Get a tenant UI metadata - api_response = api_instance.get_tenant_ui_metadata() - + results =UIMetadataApi(api_client).get_tenant_ui_metadata() # Below is a request that includes all optional parameters - # api_response = api_instance.get_tenant_ui_metadata() + # results = UIMetadataApi(api_client).get_tenant_ui_metadata() 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) ``` @@ -109,11 +112,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.ui_metadata_api import UIMetadataApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.tenant_ui_metadata_item_response import TenantUiMetadataItemResponse from sailpoint.beta.models.tenant_ui_metadata_item_update_request import TenantUiMetadataItemUpdateRequest -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: tenant_ui_metadata_item_update_request = { "usernameEmptyText" : "Please provide your work email address...", "usernameLabel" : "Email", @@ -122,14 +129,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(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(new_tenant_ui_metadata_item_update_request) # Below is a request that includes all optional parameters - # api_response = api_instance.set_tenant_ui_metadata(Result) + # results = UIMetadataApi(api_client).set_tenant_ui_metadata(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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/VendorConnectorMappingsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/VendorConnectorMappingsApi.md index b633e98a2..429c3d9f3 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/VendorConnectorMappingsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/VendorConnectorMappingsApi.md @@ -59,10 +59,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.vendor_connector_mappings_api import VendorConnectorMappingsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.vendor_connector_mapping import VendorConnectorMapping -from sailpoint.beta.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.beta +from sailpoint.beta.api.vendor_connector_mappings_api import VendorConnectorMappingsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.delete_vendor_connector_mapping200_response import DeleteVendorConnectorMapping200Response from sailpoint.beta.models.vendor_connector_mapping import VendorConnectorMapping -from sailpoint.beta.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.beta +from sailpoint.beta.api.vendor_connector_mappings_api import VendorConnectorMappingsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.vendor_connector_mapping import VendorConnectorMapping -from sailpoint.beta.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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/WorkItemsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/WorkItemsApi.md index cc664387a..a0d963810 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/WorkItemsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/WorkItemsApi.md @@ -76,23 +76,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.work_items import WorkItems -from sailpoint.beta.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) ``` @@ -131,22 +134,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.work_items import WorkItems -from sailpoint.beta.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) ``` @@ -185,22 +191,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.work_items import WorkItems -from sailpoint.beta.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) ``` @@ -242,10 +251,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.work_item_forward import WorkItemForward -from sailpoint.beta.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", @@ -255,12 +268,12 @@ from pprint import pprint try: # Forward a Work Item - Result = work_item_forward.from_json(work_item_forward) - api_instance.forward_work_item(id, Result) - + new_work_item_forward = WorkItemForward() + new_work_item_forward.from_json(work_item_forward) + WorkItemsApi(api_client).forward_work_item(id, new_work_item_forward) # Below is a request that includes all optional parameters - # api_instance.forward_work_item(id, Result) - except Exception as e: + # WorkItemsApi(api_client).forward_work_item(id, new_work_item_forward) + except Exception as e: print("Exception when calling WorkItemsApi->forward_work_item: %s\n" % e) ``` @@ -302,10 +315,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.work_items import WorkItems -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: owner_id = 'owner_id_example' # 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) @@ -314,13 +331,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) ``` @@ -359,22 +375,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.work_items_count import WorkItemsCount -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: owner_id = 'owner_id_example' # 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) ``` @@ -413,22 +432,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.work_items_count import WorkItemsCount -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: owner_id = 'owner_id_example' # 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) ``` @@ -468,23 +490,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.work_items import WorkItems -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'id_example' # str | ID of the work item. # str | ID of the work item. owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) 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, owner_id) + # results = WorkItemsApi(api_client).get_work_item(id, owner_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) ``` @@ -523,22 +548,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.work_items_summary import WorkItemsSummary -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: owner_id = 'owner_id_example' # 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) ``` @@ -580,10 +608,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.work_items import WorkItems -from sailpoint.beta.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) @@ -592,13 +624,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) ``` @@ -638,23 +669,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.work_items import WorkItems -from sailpoint.beta.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) ``` @@ -693,22 +727,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.work_items import WorkItems -from sailpoint.beta.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) ``` @@ -748,23 +785,27 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.work_items_api import WorkItemsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.work_items import WorkItems -from sailpoint.beta.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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/WorkReassignmentApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/WorkReassignmentApi.md index b2e82df7b..597b0dd2b 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/WorkReassignmentApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/WorkReassignmentApi.md @@ -69,11 +69,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.configuration_item_request import ConfigurationItemRequest from sailpoint.beta.models.configuration_item_response import ConfigurationItemResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: configuration_item_request = { "endDate" : "2022-07-30T17:00:00Z", "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", @@ -84,14 +88,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(Result) - + new_configuration_item_request = ConfigurationItemRequest() + new_configuration_item_request.from_json(configuration_item_request) + results =WorkReassignmentApi(api_client).create_reassignment_configuration(new_configuration_item_request) # Below is a request that includes all optional parameters - # api_response = api_instance.create_reassignment_configuration(Result) + # results = WorkReassignmentApi(api_client).create_reassignment_configuration(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) ``` @@ -133,21 +137,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.config_type_enum import ConfigTypeEnum -from sailpoint.beta.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.beta.ConfigTypeEnum() # ConfigTypeEnum | # ConfigTypeEnum | try: # Delete Reassignment Configuration - api_instance.delete_reassignment_configuration(identity_id, config_type) - + WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id, config_type) # Below is a request that includes all optional parameters - # api_instance.delete_reassignment_configuration(identity_id, config_type) - except Exception as e: + # WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id, config_type) + except Exception as e: print("Exception when calling WorkReassignmentApi->delete_reassignment_configuration: %s\n" % e) ``` @@ -190,11 +197,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.config_type_enum import ConfigTypeEnum from sailpoint.beta.models.evaluate_response import EvaluateResponse -from sailpoint.beta.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.beta.ConfigTypeEnum() # ConfigTypeEnum | Reassignment work type # ConfigTypeEnum | Reassignment work type exclusion_filters = ['SELF_REVIEW_DELEGATION'] # List[str] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) @@ -204,13 +215,12 @@ from pprint import pprint try: # Evaluate Reassignment Configuration - api_response = api_instance.get_evaluate_reassignment_configuration(identity_id, config_type, ) - + results =WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_evaluate_reassignment_configuration(identity_id, config_type, exclusion_filters) + # results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, 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) ``` @@ -248,21 +258,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.config_type import ConfigType -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # List Reassignment Config Types - api_response = api_instance.get_reassignment_config_types() - + results =WorkReassignmentApi(api_client).get_reassignment_config_types() # Below is a request that includes all optional parameters - # api_response = api_instance.get_reassignment_config_types() + # results = WorkReassignmentApi(api_client).get_reassignment_config_types() 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) ``` @@ -304,22 +317,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.configuration_response import ConfigurationResponse -from sailpoint.beta.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 try: # Get Reassignment Configuration - api_response = api_instance.get_reassignment_configuration(identity_id) - + results =WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_reassignment_configuration(identity_id) + # results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id) 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) ``` @@ -358,21 +374,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.tenant_configuration_response import TenantConfigurationResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # Get Tenant-wide Reassignment Configuration settings - api_response = api_instance.get_tenant_config_configuration() - + results =WorkReassignmentApi(api_client).get_tenant_config_configuration() # Below is a request that includes all optional parameters - # api_response = api_instance.get_tenant_config_configuration() + # results = WorkReassignmentApi(api_client).get_tenant_config_configuration() 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) ``` @@ -411,21 +430,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.configuration_response import ConfigurationResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # List Reassignment Configurations - api_response = api_instance.list_reassignment_configurations() - + results =WorkReassignmentApi(api_client).list_reassignment_configurations() # Below is a request that includes all optional parameters - # api_response = api_instance.list_reassignment_configurations() + # results = WorkReassignmentApi(api_client).list_reassignment_configurations() 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) ``` @@ -467,11 +489,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.configuration_item_request import ConfigurationItemRequest from sailpoint.beta.models.configuration_item_response import ConfigurationItemResponse -from sailpoint.beta.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 configuration_item_request = { "endDate" : "2022-07-30T17:00:00Z", @@ -483,14 +509,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, Result) - + new_configuration_item_request = ConfigurationItemRequest() + new_configuration_item_request.from_json(configuration_item_request) + results =WorkReassignmentApi(api_client).put_reassignment_config(identity_id, new_configuration_item_request) # Below is a request that includes all optional parameters - # api_response = api_instance.put_reassignment_config(identity_id, Result) + # results = WorkReassignmentApi(api_client).put_reassignment_config(identity_id, 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) ``` @@ -531,11 +557,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.tenant_configuration_request import TenantConfigurationRequest from sailpoint.beta.models.tenant_configuration_response import TenantConfigurationResponse -from sailpoint.beta.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: tenant_configuration_request = { "configDetails" : { "disabled" : true @@ -544,14 +574,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(Result) - + new_tenant_configuration_request = TenantConfigurationRequest() + new_tenant_configuration_request.from_json(tenant_configuration_request) + results =WorkReassignmentApi(api_client).put_tenant_configuration(new_tenant_configuration_request) # Below is a request that includes all optional parameters - # api_response = api_instance.put_tenant_configuration(Result) + # results = WorkReassignmentApi(api_client).put_tenant_configuration(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) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md index 3e23bab8c..7636b18ba 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md @@ -70,19 +70,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.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) ``` @@ -123,23 +126,27 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.create_workflow_request import CreateWorkflowRequest from sailpoint.beta.models.workflow import Workflow -from sailpoint.beta.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) ``` @@ -180,19 +187,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.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) ``` @@ -233,22 +243,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.workflow import Workflow -from sailpoint.beta.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) ``` @@ -290,21 +303,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta -from sailpoint.beta.rest import ApiException +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.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) ``` @@ -346,22 +362,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.workflow_execution_event import WorkflowExecutionEvent -from sailpoint.beta.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) ``` @@ -417,10 +436,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.workflow_execution import WorkflowExecution -from sailpoint.beta.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) @@ -430,13 +453,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) ``` @@ -478,23 +500,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner -from sailpoint.beta.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) ``` @@ -537,10 +562,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.workflow_library_action import WorkflowLibraryAction -from sailpoint.beta.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) @@ -548,13 +577,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) ``` @@ -592,21 +620,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.workflow_library_operator import WorkflowLibraryOperator -from sailpoint.beta.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) ``` @@ -649,10 +680,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.workflow_library_trigger import WorkflowLibraryTrigger -from sailpoint.beta.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) @@ -660,13 +695,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) ``` @@ -704,21 +738,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.workflow import Workflow -from sailpoint.beta.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) ``` @@ -760,11 +797,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.json_patch_operation import JsonPatchOperation from sailpoint.beta.models.workflow import Workflow -from sailpoint.beta.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 = { @@ -776,14 +817,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) ``` @@ -825,24 +866,27 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.post_external_execute_workflow200_response import PostExternalExecuteWorkflow200Response from sailpoint.beta.models.post_external_execute_workflow_request import PostExternalExecuteWorkflowRequest -from sailpoint.beta.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 post_external_execute_workflow_request = sailpoint.beta.PostExternalExecuteWorkflowRequest() # PostExternalExecuteWorkflowRequest | (optional) try: # Execute Workflow via External Trigger - api_response = api_instance.post_external_execute_workflow(id, ) - + results =WorkflowsApi(api_client).post_external_execute_workflow(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.post_external_execute_workflow(id, Result) + # results = WorkflowsApi(api_client).post_external_execute_workflow(id, new_post_external_execute_workflow_request) print("The response of WorkflowsApi->post_external_execute_workflow:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling WorkflowsApi->post_external_execute_workflow: %s\n" % e) ``` @@ -883,22 +927,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.workflow_o_auth_client import WorkflowOAuthClient -from sailpoint.beta.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.post_workflow_external_trigger(id) - + results =WorkflowsApi(api_client).post_workflow_external_trigger(id) # Below is a request that includes all optional parameters - # api_response = api_instance.post_workflow_external_trigger(id) + # results = WorkflowsApi(api_client).post_workflow_external_trigger(id) print("The response of WorkflowsApi->post_workflow_external_trigger:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling WorkflowsApi->post_workflow_external_trigger: %s\n" % e) ``` @@ -940,24 +987,27 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response from sailpoint.beta.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest -from sailpoint.beta.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.beta.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) ``` @@ -1001,24 +1051,28 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.test_workflow200_response import TestWorkflow200Response from sailpoint.beta.models.test_workflow_request import TestWorkflowRequest -from sailpoint.beta.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) ``` @@ -1060,11 +1114,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.beta +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient from sailpoint.beta.models.workflow import Workflow from sailpoint.beta.models.workflow_body import WorkflowBody -from sailpoint.beta.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" : { @@ -1107,14 +1165,14 @@ from pprint import pprint try: # Update Workflow - Result = workflow_body.from_json(workflow_body) - api_response = api_instance.update_workflow(id, Result) - + new_workflow_body = WorkflowBody() + new_workflow_body.from_json(workflow_body) + results =WorkflowsApi(api_client).update_workflow(id, new_workflow_body) # Below is a request that includes all optional parameters - # api_response = api_instance.update_workflow(id, Result) + # results = WorkflowsApi(api_client).update_workflow(id, new_workflow_body) print("The response of WorkflowsApi->update_workflow:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling WorkflowsApi->update_workflow: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md index db3ba99a4..3360a2a84 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md index 232777511..46ec3731a 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestApprovalsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestApprovalsApi.md index b242b5e7c..434014ad2 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestApprovalsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestIdentityMetricsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestIdentityMetricsApi.md index 3e2c94f2b..07efe0d42 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestIdentityMetricsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestIdentityMetricsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md index 7f7e8af0b..986e13575 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccountActivitiesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccountActivitiesApi.md index fd75df507..12cbca94a 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccountActivitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccountActivitiesApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccountAggregationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccountAggregationsApi.md index 4e0e24438..b4da7c5d4 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccountAggregationsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccountAggregationsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccountUsagesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccountUsagesApi.md index 5ebf85b39..00dc22099 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccountUsagesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccountUsagesApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccountsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccountsApi.md index aad04dd18..c106d57ac 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccountsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccountsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ApplicationDiscoveryApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ApplicationDiscoveryApi.md index d86948aee..8e4fe8f2d 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ApplicationDiscoveryApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ApplicationDiscoveryApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ApprovalsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ApprovalsApi.md index 7cac646a7..6e62dc8ea 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ApprovalsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AppsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AppsApi.md index 0a2613070..d9731e1d9 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AppsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AppsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AuthProfileApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AuthProfileApi.md index f7c45d6f5..de6d75de5 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AuthProfileApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AuthProfileApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AuthUsersApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AuthUsersApi.md index e625f260a..1618e775e 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AuthUsersApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AuthUsersApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/BrandingApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/BrandingApi.md index 0a60436d4..0d5a7a6ab 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/BrandingApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/BrandingApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignFiltersApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignFiltersApi.md index 5bf6ccb6a..01a3da0af 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignFiltersApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignFiltersApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md index 75d91704d..5adfa0255 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationSummariesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationSummariesApi.md index 8d39c5414..31ebeabcf 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationSummariesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationSummariesApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationsApi.md index 0e487625a..def595162 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ConfigurationHubApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ConfigurationHubApi.md index 59d2c04ac..c0a87ac2b 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ConfigurationHubApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ConfigurationHubApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorRuleManagementApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorRuleManagementApi.md index 1a535bad8..3c80e9903 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorRuleManagementApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorRuleManagementApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorsApi.md index 88c4343d7..fd0caa541 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CustomFormsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CustomFormsApi.md index 6dcdfde77..6c86e1363 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/CustomFormsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CustomFormsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CustomPasswordInstructionsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CustomPasswordInstructionsApi.md index dafc94d7a..00353d21d 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/CustomPasswordInstructionsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CustomPasswordInstructionsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/DataSegmentationApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/DataSegmentationApi.md index b89b6af07..33f4dc2b1 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/DataSegmentationApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/DataSegmentationApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/DimensionsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/DimensionsApi.md index e17b00b4a..fcc19ab26 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/DimensionsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/DimensionsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/EntitlementsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/EntitlementsApi.md index 7888adc0d..f1af67ec6 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/EntitlementsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/EntitlementsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/GlobalTenantSecuritySettingsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/GlobalTenantSecuritySettingsApi.md index ad5637518..da786478c 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/GlobalTenantSecuritySettingsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/GlobalTenantSecuritySettingsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/GovernanceGroupsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/GovernanceGroupsApi.md index 1438255df..a6180e7df 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/GovernanceGroupsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/GovernanceGroupsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIAccessRequestRecommendationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIAccessRequestRecommendationsApi.md index cafa310d2..1328993a2 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IAIAccessRequestRecommendationsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIAccessRequestRecommendationsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAICommonAccessApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAICommonAccessApi.md index 039ffe0d4..2f2b471bd 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IAICommonAccessApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAICommonAccessApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIOutliersApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIOutliersApi.md index 826c6f645..26adf6d55 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IAIOutliersApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIOutliersApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIPeerGroupStrategiesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIPeerGroupStrategiesApi.md index d0003f5fa..bde4d97c8 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IAIPeerGroupStrategiesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIPeerGroupStrategiesApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIRecommendationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIRecommendationsApi.md index cc2ae9402..5733df79f 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IAIRecommendationsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIRecommendationsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIRoleMiningApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIRoleMiningApi.md index 2c4887640..2417eff1a 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IAIRoleMiningApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIRoleMiningApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IconsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IconsApi.md index 4ef9af010..03099705a 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IconsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IconsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md index f9ec680f2..9f9f058ce 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityAttributesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityAttributesApi.md index 9a9568778..139d34d41 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityAttributesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityAttributesApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityHistoryApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityHistoryApi.md index d08c60ebc..2516ac0d7 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityHistoryApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityHistoryApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityProfilesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityProfilesApi.md index f300031c9..eaf45e2c2 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityProfilesApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/LifecycleStatesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/LifecycleStatesApi.md index c0090fed5..ec9209b59 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/LifecycleStatesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/LifecycleStatesApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/MFAConfigurationApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/MFAConfigurationApi.md index d75d93289..14c4a61f9 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/MFAConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/MFAConfigurationApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClientsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClientsApi.md index db3bb953f..d3e601f9d 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClientsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClientsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClustersApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClustersApi.md index d2548f5e4..69c41be81 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClustersApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClustersApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/NonEmployeeLifecycleManagementApi.md index 3731cb0aa..40952a8e1 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/NonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/NonEmployeeLifecycleManagementApi.md @@ -114,11 +114,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.non_employee_approval_decision import NonEmployeeApprovalDecision from sailpoint.v2024.models.non_employee_approval_item import NonEmployeeApprovalItem -from sailpoint.v2024.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'e136567de87e4d029e60b3c3c55db56d' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) non_employee_approval_decision = { "comment" : "Approved by manager" @@ -126,14 +130,14 @@ from pprint import pprint try: # Approve a Non-Employee Request - Result = non_employee_approval_decision.from_json(non_employee_approval_decision) - api_response = api_instance.approve_non_employee_request(id, Result) - + new_non_employee_approval_decision = NonEmployeeApprovalDecision() + new_non_employee_approval_decision.from_json(non_employee_approval_decision) + results =NonEmployeeLifecycleManagementApi(api_client).approve_non_employee_request(id, new_non_employee_approval_decision) # Below is a request that includes all optional parameters - # api_response = api_instance.approve_non_employee_request(id, Result) + # results = NonEmployeeLifecycleManagementApi(api_client).approve_non_employee_request(id, new_non_employee_approval_decision) print("The response of NonEmployeeLifecycleManagementApi->approve_non_employee_request:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->approve_non_employee_request: %s\n" % e) ``` @@ -175,11 +179,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.non_employee_record import NonEmployeeRecord from sailpoint.v2024.models.non_employee_request_body import NonEmployeeRequestBody -from sailpoint.v2024.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: non_employee_request_body = { "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", @@ -197,14 +205,14 @@ from pprint import pprint try: # Create Non-Employee Record - Result = non_employee_request_body.from_json(non_employee_request_body) - api_response = api_instance.create_non_employee_record(Result) - + new_non_employee_request_body = NonEmployeeRequestBody() + new_non_employee_request_body.from_json(non_employee_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(new_non_employee_request_body) # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_record(Result) + # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(new_non_employee_request_body) print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_record:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_record: %s\n" % e) ``` @@ -245,11 +253,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.non_employee_request import NonEmployeeRequest from sailpoint.v2024.models.non_employee_request_body import NonEmployeeRequestBody -from sailpoint.v2024.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: non_employee_request_body = { "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", @@ -267,14 +279,14 @@ from pprint import pprint try: # Create Non-Employee Request - Result = non_employee_request_body.from_json(non_employee_request_body) - api_response = api_instance.create_non_employee_request(Result) - + new_non_employee_request_body = NonEmployeeRequestBody() + new_non_employee_request_body.from_json(non_employee_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(new_non_employee_request_body) # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_request(Result) + # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(new_non_employee_request_body) print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_request:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_request: %s\n" % e) ``` @@ -315,11 +327,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.non_employee_source_request_body import NonEmployeeSourceRequestBody from sailpoint.v2024.models.non_employee_source_with_cloud_external_id import NonEmployeeSourceWithCloudExternalId -from sailpoint.v2024.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: non_employee_source_request_body = { "owner" : { "id" : "2c91808570313110017040b06f344ec9" @@ -349,14 +365,14 @@ from pprint import pprint try: # Create Non-Employee Source - Result = non_employee_source_request_body.from_json(non_employee_source_request_body) - api_response = api_instance.create_non_employee_source(Result) - + new_non_employee_source_request_body = NonEmployeeSourceRequestBody() + new_non_employee_source_request_body.from_json(non_employee_source_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source(new_non_employee_source_request_body) # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_source(Result) + # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source(new_non_employee_source_request_body) print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source: %s\n" % e) ``` @@ -399,11 +415,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute from sailpoint.v2024.models.non_employee_schema_attribute_body import NonEmployeeSchemaAttributeBody -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 = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id non_employee_schema_attribute_body = { "helpText" : "The unique identifier for the account", @@ -416,14 +436,14 @@ from pprint import pprint try: # Create a new Schema Attribute for Non-Employee Source - Result = non_employee_schema_attribute_body.from_json(non_employee_schema_attribute_body) - api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) - + new_non_employee_schema_attribute_body = NonEmployeeSchemaAttributeBody() + new_non_employee_schema_attribute_body.from_json(non_employee_schema_attribute_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source_schema_attributes(source_id, new_non_employee_schema_attribute_body) # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) + # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source_schema_attributes(source_id, new_non_employee_schema_attribute_body) print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes: %s\n" % e) ``` @@ -465,19 +485,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 -from sailpoint.v2024.rest import ApiException +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +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 | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) try: # Delete Non-Employee Record - api_instance.delete_non_employee_record(id) - + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id) # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_record(id) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_record: %s\n" % e) ``` @@ -518,20 +541,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.delete_non_employee_records_in_bulk_request import DeleteNonEmployeeRecordsInBulkRequest -from sailpoint.v2024.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: delete_non_employee_records_in_bulk_request = sailpoint.v2024.DeleteNonEmployeeRecordsInBulkRequest() # DeleteNonEmployeeRecordsInBulkRequest | Non-Employee bulk delete request body. try: # Delete Multiple Non-Employee Records - Result = delete_non_employee_records_in_bulk_request.from_json(delete_non_employee_records_in_bulk_request) - api_instance.delete_non_employee_records_in_bulk(Result) - + new_delete_non_employee_records_in_bulk_request = DeleteNonEmployeeRecordsInBulkRequest() + new_delete_non_employee_records_in_bulk_request.from_json(delete_non_employee_records_in_bulk_request) + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_records_in_bulk(new_delete_non_employee_records_in_bulk_request) # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_records_in_bulk(Result) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_records_in_bulk(new_delete_non_employee_records_in_bulk_request) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_records_in_bulk: %s\n" % e) ``` @@ -574,19 +601,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 -from sailpoint.v2024.rest import ApiException +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +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 = 'ac110005-7156-1150-8171-5b292e3e0084' # str | Non-Employee request id in the UUID format # str | Non-Employee request id in the UUID format try: # Delete Non-Employee Request - api_instance.delete_non_employee_request(id) - + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_request(id) # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_request(id) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_request(id) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_request: %s\n" % e) ``` @@ -630,20 +660,23 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 -from sailpoint.v2024.rest import ApiException +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: attribute_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id try: # Delete a Schema Attribute for Non-Employee Source - api_instance.delete_non_employee_schema_attribute(attribute_id, source_id) - + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_schema_attribute(attribute_id, source_id) # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_schema_attribute(attribute_id, source_id) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_schema_attribute(attribute_id, source_id) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_schema_attribute: %s\n" % e) ``` @@ -684,19 +717,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 -from sailpoint.v2024.rest import ApiException +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +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_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id try: # Delete Non-Employee Source - api_instance.delete_non_employee_source(source_id) - + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source(source_id) # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_source(source_id) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source(source_id) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source: %s\n" % e) ``` @@ -737,19 +773,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 -from sailpoint.v2024.rest import ApiException +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +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_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id try: # Delete all custom schema attributes for Non-Employee Source - api_instance.delete_non_employee_source_schema_attributes(source_id) - + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source_schema_attributes(source_id) # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_source_schema_attributes(source_id) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source_schema_attributes(source_id) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source_schema_attributes: %s\n" % e) ``` @@ -791,19 +830,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 -from sailpoint.v2024.rest import ApiException +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +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 = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) try: # Exports Non-Employee Records to CSV - api_instance.export_non_employee_records(id) - + NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(id) # Below is a request that includes all optional parameters - # api_instance.export_non_employee_records(id) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(id) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_records: %s\n" % e) ``` @@ -845,19 +887,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 -from sailpoint.v2024.rest import ApiException +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +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 | Source Id (UUID) # str | Source Id (UUID) try: # Exports Source Schema Template - api_instance.export_non_employee_source_schema_template(id) - + NonEmployeeLifecycleManagementApi(api_client).export_non_employee_source_schema_template(id) # Below is a request that includes all optional parameters - # api_instance.export_non_employee_source_schema_template(id) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).export_non_employee_source_schema_template(id) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_source_schema_template: %s\n" % e) ``` @@ -902,23 +947,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.non_employee_approval_item_detail import NonEmployeeApprovalItemDetail -from sailpoint.v2024.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'e136567de87e4d029e60b3c3c55db56d' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) include_detail = true # bool | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) # bool | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) try: # Get a non-employee approval item detail - api_response = api_instance.get_non_employee_approval(id, ) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_approval(id, include_detail) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval(id, include_detail) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval: %s\n" % e) ``` @@ -963,22 +1011,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.non_employee_approval_summary import NonEmployeeApprovalSummary -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 = '2c91808280430dfb0180431a59440460' # str | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # str | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. try: # Get Summary of Non-Employee Approval Requests - api_response = api_instance.get_non_employee_approval_summary(requested_for) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval_summary(requested_for) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_approval_summary(requested_for) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval_summary(requested_for) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary: %s\n" % e) ``` @@ -1021,22 +1072,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.non_employee_bulk_upload_status import NonEmployeeBulkUploadStatus -from sailpoint.v2024.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source ID (UUID) # str | Source ID (UUID) try: # Obtain the status of bulk upload on the source - api_response = api_instance.get_non_employee_bulk_upload_status(id) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_bulk_upload_status(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_bulk_upload_status(id) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_bulk_upload_status(id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status: %s\n" % e) ``` @@ -1078,22 +1132,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.non_employee_record import NonEmployeeRecord -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 | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) try: # Get a Non-Employee Record - api_response = api_instance.get_non_employee_record(id) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_record(id) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_record:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_record: %s\n" % e) ``` @@ -1139,22 +1196,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.non_employee_request import NonEmployeeRequest -from sailpoint.v2024.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'ac110005-7156-1150-8171-5b292e3e0084' # str | Non-Employee request id (UUID) # str | Non-Employee request id (UUID) try: # Get a Non-Employee Request - api_response = api_instance.get_non_employee_request(id) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_request(id) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request: %s\n" % e) ``` @@ -1199,22 +1259,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.non_employee_request_summary import NonEmployeeRequestSummary -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 = '2c91808280430dfb0180431a59440460' # str | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # str | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. try: # Get Summary of Non-Employee Requests - api_response = api_instance.get_non_employee_request_summary(requested_for) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request_summary(requested_for) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_request_summary(requested_for) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request_summary(requested_for) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request_summary:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request_summary: %s\n" % e) ``` @@ -1256,23 +1319,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute -from sailpoint.v2024.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: attribute_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id try: # Get Schema Attribute Non-Employee Source - api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_schema_attribute(attribute_id, source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_schema_attribute(attribute_id, source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute: %s\n" % e) ``` @@ -1317,22 +1383,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.non_employee_source import NonEmployeeSource -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 = '2c91808b7c28b350017c2a2ec5790aa1' # str | Source Id # str | Source Id try: # Get a Non-Employee Source - api_response = api_instance.get_non_employee_source(source_id) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source(source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_source(source_id) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source(source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source: %s\n" % e) ``` @@ -1375,22 +1444,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute -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 = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id try: # List Schema Attributes Non-Employee Source - api_response = api_instance.get_non_employee_source_schema_attributes(source_id) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_source_schema_attributes(source_id) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) ``` @@ -1433,23 +1505,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.non_employee_bulk_upload_job import NonEmployeeBulkUploadJob -from sailpoint.v2024.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) data = None # bytearray | # bytearray | try: # Imports, or Updates, Non-Employee Records - api_response = api_instance.import_non_employee_records_in_bulk(id, data) - + results =NonEmployeeLifecycleManagementApi(api_client).import_non_employee_records_in_bulk(id, data) # Below is a request that includes all optional parameters - # api_response = api_instance.import_non_employee_records_in_bulk(id, data) + # results = NonEmployeeLifecycleManagementApi(api_client).import_non_employee_records_in_bulk(id, data) print("The response of NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk: %s\n" % e) ``` @@ -1499,10 +1574,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.non_employee_approval_item import NonEmployeeApprovalItem -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 = '2c91808280430dfb0180431a59440460' # str | The identity for whom the request was made. *me* indicates the current user. (optional) # str | The identity for whom the request was made. *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) @@ -1513,13 +1592,12 @@ from pprint import pprint try: # Get List of Non-Employee Approval Requests - api_response = api_instance.list_non_employee_approvals() - + results =NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals() # Below is a request that includes all optional parameters - # api_response = api_instance.list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) + # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) ``` @@ -1566,10 +1644,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.non_employee_record import NonEmployeeRecord -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) @@ -1579,13 +1661,12 @@ from pprint import pprint try: # List Non-Employee Records - api_response = api_instance.list_non_employee_records() - + results =NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records() # Below is a request that includes all optional parameters - # api_response = api_instance.list_non_employee_records(limit, offset, count, sorters, filters) + # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) ``` @@ -1635,10 +1716,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.non_employee_request import NonEmployeeRequest -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 = 'e136567de87e4d029e60b3c3c55db56d' # str | The identity for whom the request was made. *me* indicates the current user. # str | The identity for whom the request was made. *me* indicates the current user. 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) @@ -1649,13 +1734,12 @@ from pprint import pprint try: # List Non-Employee Requests - api_response = api_instance.list_non_employee_requests(requested_for, ) - + results =NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, ) # Below is a request that includes all optional parameters - # api_response = api_instance.list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) + # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) ``` @@ -1705,10 +1789,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.non_employee_source_with_ne_count import NonEmployeeSourceWithNECount -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 = 'me' # str | The identity for whom the request was made. *me* indicates the current user. # str | The identity for whom the request was made. *me* indicates the current user. 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) @@ -1719,13 +1807,12 @@ from pprint import pprint try: # List Non-Employee Sources - api_response = api_instance.list_non_employee_sources(requested_for, ) - + results =NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(requested_for, ) # Below is a request that includes all optional parameters - # api_response = api_instance.list_non_employee_sources(requested_for, limit, offset, count, non_employee_count, sorters) + # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(requested_for, limit, offset, count, non_employee_count, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) ``` @@ -1772,11 +1859,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation from sailpoint.v2024.models.non_employee_record import NonEmployeeRecord -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 | Non-employee record id (UUID) # str | Non-employee record id (UUID) [{op=replace, path=/endDate, value=2019-08-23T18:40:35.772Z}] # List[JsonPatchOperation] | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. json_patch_operation = { @@ -1788,14 +1879,14 @@ from pprint import pprint try: # Patch Non-Employee Record - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_non_employee_record(id, Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id, new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_non_employee_record(id, Result) + # results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id, new_json_patch_operation) print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_record:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_record: %s\n" % e) ``` @@ -1841,11 +1932,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation from sailpoint.v2024.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute -from sailpoint.v2024.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: attribute_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id [{op=replace, path=/label, value={new attribute label=null}}] # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. @@ -1858,14 +1953,14 @@ from pprint import pprint try: # Patch a Schema Attribute for Non-Employee Source - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_schema_attribute(attribute_id, source_id, new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) + # results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_schema_attribute(attribute_id, source_id, new_json_patch_operation) print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute: %s\n" % e) ``` @@ -1907,11 +2002,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation from sailpoint.v2024.models.non_employee_source import NonEmployeeSource -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 = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id [{op=replace, path=/name, value={new name=null}}, {op=replace, path=/approvers, value=[2c91809f703bb37a017040a2fe8748c7, 48b1f463c9e8427db5a5071bd81914b8]}] # List[JsonPatchOperation] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. json_patch_operation = { @@ -1923,14 +2022,14 @@ from pprint import pprint try: # Patch a Non-Employee Source - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_non_employee_source(source_id, Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id, new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_non_employee_source(source_id, Result) + # results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id, new_json_patch_operation) print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_source: %s\n" % e) ``` @@ -1972,11 +2071,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.non_employee_approval_item import NonEmployeeApprovalItem from sailpoint.v2024.models.non_employee_reject_approval_decision import NonEmployeeRejectApprovalDecision -from sailpoint.v2024.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'e136567de87e4d029e60b3c3c55db56d' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) non_employee_reject_approval_decision = { "comment" : "approved" @@ -1984,14 +2087,14 @@ from pprint import pprint try: # Reject a Non-Employee Request - Result = non_employee_reject_approval_decision.from_json(non_employee_reject_approval_decision) - api_response = api_instance.reject_non_employee_request(id, Result) - + new_non_employee_reject_approval_decision = NonEmployeeRejectApprovalDecision() + new_non_employee_reject_approval_decision.from_json(non_employee_reject_approval_decision) + results =NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id, new_non_employee_reject_approval_decision) # Below is a request that includes all optional parameters - # api_response = api_instance.reject_non_employee_request(id, Result) + # results = NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id, new_non_employee_reject_approval_decision) print("The response of NonEmployeeLifecycleManagementApi->reject_non_employee_request:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->reject_non_employee_request: %s\n" % e) ``` @@ -2038,11 +2141,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.non_employee_record import NonEmployeeRecord from sailpoint.v2024.models.non_employee_request_body import NonEmployeeRequestBody -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 | Non-employee record id (UUID) # str | Non-employee record id (UUID) non_employee_request_body = { "sourceId" : "2c91808568c529c60168cca6f90c1313", @@ -2061,14 +2168,14 @@ from pprint import pprint try: # Update Non-Employee Record - Result = non_employee_request_body.from_json(non_employee_request_body) - api_response = api_instance.update_non_employee_record(id, Result) - + new_non_employee_request_body = NonEmployeeRequestBody() + new_non_employee_request_body.from_json(non_employee_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id, new_non_employee_request_body) # Below is a request that includes all optional parameters - # api_response = api_instance.update_non_employee_record(id, Result) + # results = NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id, new_non_employee_request_body) print("The response of NonEmployeeLifecycleManagementApi->update_non_employee_record:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->update_non_employee_record: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/NotificationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/NotificationsApi.md index 8e7f07c5f..523d9293f 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/NotificationsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/NotificationsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/OAuthClientsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/OAuthClientsApi.md index 90010aebb..941da4f59 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/OAuthClientsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/OAuthClientsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/OrgConfigApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/OrgConfigApi.md index 6c7b2dcb3..a4af32f16 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/OrgConfigApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/OrgConfigApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordConfigurationApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordConfigurationApi.md index e67dc517d..9e0aa6667 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordConfigurationApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordDictionaryApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordDictionaryApi.md index 11471f2d5..3181d028d 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordDictionaryApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordDictionaryApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordManagementApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordManagementApi.md index f7066b83d..1358ed619 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordManagementApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordManagementApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordPoliciesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordPoliciesApi.md index 11777c716..7d5d5d359 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordPoliciesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordPoliciesApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordSyncGroupsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordSyncGroupsApi.md index bbd441333..f917c4871 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordSyncGroupsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordSyncGroupsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PersonalAccessTokensApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PersonalAccessTokensApi.md index 52fb70587..ddc542eb3 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/PersonalAccessTokensApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PersonalAccessTokensApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesApi.md index abf82104a..0bf237ef8 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesConfigApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesConfigApi.md index 6a60d8465..1ca498f00 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesConfigApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesConfigApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ReportsDataExtractionApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ReportsDataExtractionApi.md index 436481a16..e6d8c2cef 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ReportsDataExtractionApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ReportsDataExtractionApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/RequestableObjectsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/RequestableObjectsApi.md index 98c46e2c9..141b9ff24 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/RequestableObjectsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/RequestableObjectsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/RoleInsightsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/RoleInsightsApi.md index 784dcf937..7aa555866 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/RoleInsightsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/RoleInsightsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md index 98f145327..f69a92059 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SIMIntegrationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SIMIntegrationsApi.md index 5ac960de4..0ffd0c1e8 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SIMIntegrationsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SIMIntegrationsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SODPoliciesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SODPoliciesApi.md index 12c43981c..5be6bd293 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SODPoliciesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SODPoliciesApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SODViolationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SODViolationsApi.md index 99fb93f0f..a884bdb7e 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SODViolationsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SODViolationsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md index 88d06b4fd..2ddd41d1b 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SavedSearchApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SavedSearchApi.md index 244deca90..c99bdc081 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SavedSearchApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SavedSearchApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ScheduledSearchApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ScheduledSearchApi.md index 01a0bf33b..6dbd36fcb 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ScheduledSearchApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ScheduledSearchApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SearchApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SearchApi.md index d74b99767..d75a494ed 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SearchApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SearchApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SearchAttributeConfigurationApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SearchAttributeConfigurationApi.md index 21d6b297c..a61a484e3 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SearchAttributeConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SearchAttributeConfigurationApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SegmentsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SegmentsApi.md index c418837c6..10ee55178 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SegmentsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SegmentsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ServiceDeskIntegrationApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ServiceDeskIntegrationApi.md index d161366c6..8150a987d 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ServiceDeskIntegrationApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SourceUsagesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SourceUsagesApi.md index 7cf74778a..48fa8335a 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SourceUsagesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SourceUsagesApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SourcesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SourcesApi.md index 1a4d5baf2..649e807cc 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SourcesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SourcesApi.md @@ -160,10 +160,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.provisioning_policy_dto import ProvisioningPolicyDto -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 | The Source id # str | The Source id provisioning_policy_dto = { "name" : "example provisioning policy for inactive identities", @@ -208,14 +212,14 @@ from pprint import pprint try: # Create Provisioning Policy - Result = provisioning_policy_dto.from_json(provisioning_policy_dto) - api_response = api_instance.create_provisioning_policy(source_id, Result) - + new_provisioning_policy_dto = ProvisioningPolicyDto() + new_provisioning_policy_dto.from_json(provisioning_policy_dto) + results =SourcesApi(api_client).create_provisioning_policy(source_id, new_provisioning_policy_dto) # Below is a request that includes all optional parameters - # api_response = api_instance.create_provisioning_policy(source_id, Result) + # results = SourcesApi(api_client).create_provisioning_policy(source_id, new_provisioning_policy_dto) print("The response of SourcesApi->create_provisioning_policy:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) ``` @@ -257,10 +261,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.source import Source -from sailpoint.v2024.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source = { "cluster" : { "name" : "Corporate Cluster", @@ -348,14 +356,14 @@ from pprint import pprint try: # Creates a source in IdentityNow. - Result = source.from_json(source) - api_response = api_instance.create_source(Result, ) - + new_source = Source() + new_source.from_json(source) + results =SourcesApi(api_client).create_source(new_source, ) # Below is a request that includes all optional parameters - # api_response = api_instance.create_source(Result, provision_as_csv) + # results = SourcesApi(api_client).create_source(new_source, provision_as_csv) print("The response of SourcesApi->create_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->create_source: %s\n" % e) ``` @@ -398,23 +406,27 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.schedule1 import Schedule1 -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 | Source ID. # str | Source ID. schedule1 = sailpoint.v2024.Schedule1() # Schedule1 | try: # Create Schedule on Source - Result = schedule1.from_json(schedule1) - api_response = api_instance.create_source_schedule(source_id, Result) - + new_schedule1 = Schedule1() + new_schedule1.from_json(schedule1) + results =SourcesApi(api_client).create_source_schedule(source_id, new_schedule1) # Below is a request that includes all optional parameters - # api_response = api_instance.create_source_schedule(source_id, Result) + # results = SourcesApi(api_client).create_source_schedule(source_id, new_schedule1) print("The response of SourcesApi->create_source_schedule:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->create_source_schedule: %s\n" % e) ``` @@ -457,23 +469,27 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.model_schema import ModelSchema -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 | Source ID. # str | Source ID. model_schema = sailpoint.v2024.ModelSchema() # ModelSchema | try: # Create Schema on Source - Result = model_schema.from_json(model_schema) - api_response = api_instance.create_source_schema(source_id, Result) - + new_model_schema = ModelSchema() + new_model_schema.from_json(model_schema) + results =SourcesApi(api_client).create_source_schema(source_id, new_model_schema) # Below is a request that includes all optional parameters - # api_response = api_instance.create_source_schema(source_id, Result) + # results = SourcesApi(api_client).create_source_schema(source_id, new_model_schema) print("The response of SourcesApi->create_source_schema:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) ``` @@ -524,23 +540,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +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 = 'ebbf35756e1140699ce52b233121384a' # str | The source id # str | The 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') try: # Remove All Accounts in a Source - api_response = api_instance.delete_accounts_async(id, x_sail_point_experimental) - + results =SourcesApi(api_client).delete_accounts_async(id, x_sail_point_experimental) # Below is a request that includes all optional parameters - # api_response = api_instance.delete_accounts_async(id, x_sail_point_experimental) + # results = SourcesApi(api_client).delete_accounts_async(id, x_sail_point_experimental) print("The response of SourcesApi->delete_accounts_async:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->delete_accounts_async: %s\n" % e) ``` @@ -586,20 +605,23 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 -from sailpoint.v2024.rest import ApiException +from sailpoint.v2024.api.sources_api import SourcesApi +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 | The source id # str | The 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') try: # Delete Native Change Detection Configuration - api_instance.delete_native_change_detection_config(id, x_sail_point_experimental) - + SourcesApi(api_client).delete_native_change_detection_config(id, x_sail_point_experimental) # Below is a request that includes all optional parameters - # api_instance.delete_native_change_detection_config(id, x_sail_point_experimental) - except Exception as e: + # SourcesApi(api_client).delete_native_change_detection_config(id, x_sail_point_experimental) + except Exception as e: print("Exception when calling SourcesApi->delete_native_change_detection_config: %s\n" % e) ``` @@ -642,21 +664,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.usage_type import UsageType -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 | The Source ID. # str | The Source ID. usage_type = sailpoint.v2024.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. try: # Delete Provisioning Policy by UsageType - api_instance.delete_provisioning_policy(source_id, usage_type) - + SourcesApi(api_client).delete_provisioning_policy(source_id, usage_type) # Below is a request that includes all optional parameters - # api_instance.delete_provisioning_policy(source_id, usage_type) - except Exception as e: + # SourcesApi(api_client).delete_provisioning_policy(source_id, usage_type) + except Exception as e: print("Exception when calling SourcesApi->delete_provisioning_policy: %s\n" % e) ``` @@ -699,22 +724,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.delete_source202_response import DeleteSource202Response -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 ID. # str | Source ID. try: # Delete Source by ID - api_response = api_instance.delete_source(id) - + results =SourcesApi(api_client).delete_source(id) # Below is a request that includes all optional parameters - # api_response = api_instance.delete_source(id) + # results = SourcesApi(api_client).delete_source(id) print("The response of SourcesApi->delete_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->delete_source: %s\n" % e) ``` @@ -757,20 +785,23 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 -from sailpoint.v2024.rest import ApiException +from sailpoint.v2024.api.sources_api import SourcesApi +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_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. schedule_type = 'ACCOUNT_AGGREGATION' # str | The Schedule type. # str | The Schedule type. try: # Delete Source Schedule by type. - api_instance.delete_source_schedule(source_id, schedule_type) - + SourcesApi(api_client).delete_source_schedule(source_id, schedule_type) # Below is a request that includes all optional parameters - # api_instance.delete_source_schedule(source_id, schedule_type) - except Exception as e: + # SourcesApi(api_client).delete_source_schedule(source_id, schedule_type) + except Exception as e: print("Exception when calling SourcesApi->delete_source_schedule: %s\n" % e) ``` @@ -813,20 +844,23 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 -from sailpoint.v2024.rest import ApiException +from sailpoint.v2024.api.sources_api import SourcesApi +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_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. try: # Delete Source Schema by ID - api_instance.delete_source_schema(source_id, schema_id) - + SourcesApi(api_client).delete_source_schema(source_id, schema_id) # Below is a request that includes all optional parameters - # api_instance.delete_source_schema(source_id, schema_id) - except Exception as e: + # SourcesApi(api_client).delete_source_schema(source_id, schema_id) + except Exception as e: print("Exception when calling SourcesApi->delete_source_schema: %s\n" % e) ``` @@ -869,19 +903,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 -from sailpoint.v2024.rest import ApiException +from sailpoint.v2024.api.sources_api import SourcesApi +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 Source id # str | The Source id try: # Downloads source accounts schema template - api_instance.get_accounts_schema(id) - + SourcesApi(api_client).get_accounts_schema(id) # Below is a request that includes all optional parameters - # api_instance.get_accounts_schema(id) - except Exception as e: + # SourcesApi(api_client).get_accounts_schema(id) + except Exception as e: print("Exception when calling SourcesApi->get_accounts_schema: %s\n" % e) ``` @@ -923,22 +960,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.correlation_config import CorrelationConfig -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 | The source id # str | The source id try: # Get Source Correlation Configuration - api_response = api_instance.get_correlation_config(id) - + results =SourcesApi(api_client).get_correlation_config(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_correlation_config(id) + # results = SourcesApi(api_client).get_correlation_config(id) print("The response of SourcesApi->get_correlation_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_correlation_config: %s\n" % e) ``` @@ -983,20 +1023,23 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 -from sailpoint.v2024.rest import ApiException +from sailpoint.v2024.api.sources_api import SourcesApi +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 Source id # str | The Source id schema_name = '?schemaName=group' # str | Name of entitlement schema (optional) # str | Name of entitlement schema (optional) try: # Downloads source entitlements schema template - api_instance.get_entitlements_schema(id, ) - + SourcesApi(api_client).get_entitlements_schema(id, ) # Below is a request that includes all optional parameters - # api_instance.get_entitlements_schema(id, schema_name) - except Exception as e: + # SourcesApi(api_client).get_entitlements_schema(id, schema_name) + except Exception as e: print("Exception when calling SourcesApi->get_entitlements_schema: %s\n" % e) ``` @@ -1042,23 +1085,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.native_change_detection_config import NativeChangeDetectionConfig -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 | The source id # str | The 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') try: # Native Change Detection Configuration - api_response = api_instance.get_native_change_detection_config(id, x_sail_point_experimental) - + results =SourcesApi(api_client).get_native_change_detection_config(id, x_sail_point_experimental) # Below is a request that includes all optional parameters - # api_response = api_instance.get_native_change_detection_config(id, x_sail_point_experimental) + # results = SourcesApi(api_client).get_native_change_detection_config(id, x_sail_point_experimental) print("The response of SourcesApi->get_native_change_detection_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_native_change_detection_config: %s\n" % e) ``` @@ -1101,24 +1147,27 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.provisioning_policy_dto import ProvisioningPolicyDto from sailpoint.v2024.models.usage_type import UsageType -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 | The Source ID. # str | The Source ID. usage_type = sailpoint.v2024.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. try: # Get Provisioning Policy by UsageType - api_response = api_instance.get_provisioning_policy(source_id, usage_type) - + results =SourcesApi(api_client).get_provisioning_policy(source_id, usage_type) # Below is a request that includes all optional parameters - # api_response = api_instance.get_provisioning_policy(source_id, usage_type) + # results = SourcesApi(api_client).get_provisioning_policy(source_id, usage_type) print("The response of SourcesApi->get_provisioning_policy:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) ``` @@ -1160,22 +1209,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.source import Source -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 ID. # str | Source ID. try: # Get Source by ID - api_response = api_instance.get_source(id) - + results =SourcesApi(api_client).get_source(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_source(id) + # results = SourcesApi(api_client).get_source(id) print("The response of SourcesApi->get_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_source: %s\n" % e) ``` @@ -1221,23 +1273,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.attr_sync_source_config import AttrSyncSourceConfig -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 | The source id # str | The 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') try: # Attribute Sync Config - api_response = api_instance.get_source_attr_sync_config(id, x_sail_point_experimental) - + results =SourcesApi(api_client).get_source_attr_sync_config(id, x_sail_point_experimental) # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_attr_sync_config(id, x_sail_point_experimental) + # results = SourcesApi(api_client).get_source_attr_sync_config(id, x_sail_point_experimental) print("The response of SourcesApi->get_source_attr_sync_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_source_attr_sync_config: %s\n" % e) ``` @@ -1283,10 +1338,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.connector_detail1 import ConnectorDetail1 -from sailpoint.v2024.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'id_example' # str | The Source id # str | The 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') locale = 'locale_example' # 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) @@ -1294,13 +1353,12 @@ from pprint import pprint try: # Gets source config with language translations - api_response = api_instance.get_source_config(id, x_sail_point_experimental, ) - + results =SourcesApi(api_client).get_source_config(id, x_sail_point_experimental, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_config(id, x_sail_point_experimental, locale) + # results = SourcesApi(api_client).get_source_config(id, x_sail_point_experimental, locale) print("The response of SourcesApi->get_source_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_source_config: %s\n" % e) ``` @@ -1348,22 +1406,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.source_entitlement_request_config import SourceEntitlementRequestConfig -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 Source Entitlement Request Configuration - api_response = api_instance.get_source_entitlement_request_config(x_sail_point_experimental) - + results =SourcesApi(api_client).get_source_entitlement_request_config(x_sail_point_experimental) # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_entitlement_request_config(x_sail_point_experimental) + # results = SourcesApi(api_client).get_source_entitlement_request_config(x_sail_point_experimental) print("The response of SourcesApi->get_source_entitlement_request_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_source_entitlement_request_config: %s\n" % e) ``` @@ -1405,22 +1466,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.source_health_dto import SourceHealthDto -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 | The Source id. # str | The Source id. try: # Fetches source health by id - api_response = api_instance.get_source_health(source_id) - + results =SourcesApi(api_client).get_source_health(source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_health(source_id) + # results = SourcesApi(api_client).get_source_health(source_id) print("The response of SourcesApi->get_source_health:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_source_health: %s\n" % e) ``` @@ -1464,23 +1528,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.schedule1 import Schedule1 -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 | The Source id. # str | The Source id. schedule_type = 'ACCOUNT_AGGREGATION' # str | The Schedule type. # str | The Schedule type. try: # Get Source Schedule by Type - api_response = api_instance.get_source_schedule(source_id, schedule_type) - + results =SourcesApi(api_client).get_source_schedule(source_id, schedule_type) # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_schedule(source_id, schedule_type) + # results = SourcesApi(api_client).get_source_schedule(source_id, schedule_type) print("The response of SourcesApi->get_source_schedule:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_source_schedule: %s\n" % e) ``` @@ -1522,22 +1589,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.schedule1 import Schedule1 -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 | Source ID. # str | Source ID. try: # List Schedules on Source - api_response = api_instance.get_source_schedules(source_id) - + results =SourcesApi(api_client).get_source_schedules(source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_schedules(source_id) + # results = SourcesApi(api_client).get_source_schedules(source_id) print("The response of SourcesApi->get_source_schedules:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_source_schedules: %s\n" % e) ``` @@ -1581,23 +1651,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.model_schema import ModelSchema -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 | The Source id. # str | The Source id. schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. try: # Get Source Schema by ID - api_response = api_instance.get_source_schema(source_id, schema_id) - + results =SourcesApi(api_client).get_source_schema(source_id, schema_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_schema(source_id, schema_id) + # results = SourcesApi(api_client).get_source_schema(source_id, schema_id) print("The response of SourcesApi->get_source_schema:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) ``` @@ -1641,10 +1714,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.model_schema import ModelSchema -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 | Source ID. # str | Source ID. include_types = 'group' # str | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) # str | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) include_names = 'account' # str | A comma-separated list of schema names to filter result. (optional) # str | A comma-separated list of schema names to filter result. (optional) @@ -1652,13 +1729,12 @@ from pprint import pprint try: # List Schemas on Source - api_response = api_instance.get_source_schemas(source_id, ) - + results =SourcesApi(api_client).get_source_schemas(source_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_schemas(source_id, include_types, include_names) + # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) print("The response of SourcesApi->get_source_schemas:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) ``` @@ -1707,10 +1783,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.load_accounts_task import LoadAccountsTask -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') file = None # bytearray | The CSV file containing the source accounts to aggregate. (optional) # bytearray | The CSV file containing the source accounts to aggregate. (optional) @@ -1719,13 +1799,12 @@ from pprint import pprint try: # Account Aggregation - api_response = api_instance.import_accounts(id, x_sail_point_experimental, ) - + results =SourcesApi(api_client).import_accounts(id, x_sail_point_experimental, ) # Below is a request that includes all optional parameters - # api_response = api_instance.import_accounts(id, x_sail_point_experimental, file, disable_optimization) + # results = SourcesApi(api_client).import_accounts(id, x_sail_point_experimental, file, disable_optimization) print("The response of SourcesApi->import_accounts:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->import_accounts: %s\n" % e) ``` @@ -1773,23 +1852,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.model_schema import ModelSchema -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 Source id # str | The Source id file = None # bytearray | (optional) # bytearray | (optional) try: # Uploads source accounts schema template - api_response = api_instance.import_accounts_schema(id, ) - + results =SourcesApi(api_client).import_accounts_schema(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.import_accounts_schema(id, file) + # results = SourcesApi(api_client).import_accounts_schema(id, file) print("The response of SourcesApi->import_accounts_schema:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->import_accounts_schema: %s\n" % e) ``` @@ -1831,23 +1913,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.source import Source -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 | The Source id. # str | The Source id. file = None # bytearray | (optional) # bytearray | (optional) try: # Upload connector file to source - api_response = api_instance.import_connector_file(source_id, ) - + results =SourcesApi(api_client).import_connector_file(source_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.import_connector_file(source_id, file) + # results = SourcesApi(api_client).import_connector_file(source_id, file) print("The response of SourcesApi->import_connector_file:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->import_connector_file: %s\n" % e) ``` @@ -1896,10 +1981,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.model_schema import ModelSchema -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 Source id # str | The Source id schema_name = '?schemaName=group' # str | Name of entitlement schema (optional) # str | Name of entitlement schema (optional) file = None # bytearray | (optional) # bytearray | (optional) @@ -1907,13 +1996,12 @@ from pprint import pprint try: # Uploads source entitlements schema template - api_response = api_instance.import_entitlements_schema(id, ) - + results =SourcesApi(api_client).import_entitlements_schema(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.import_entitlements_schema(id, schema_name, file) + # results = SourcesApi(api_client).import_entitlements_schema(id, schema_name, file) print("The response of SourcesApi->import_entitlements_schema:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->import_entitlements_schema: %s\n" % e) ``` @@ -1959,10 +2047,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.load_uncorrelated_accounts_task import LoadUncorrelatedAccountsTask -from sailpoint.v2024.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '75dbec1ebe154d5785da27b95e1dd5d7' # 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') file = None # bytearray | (optional) # bytearray | (optional) @@ -1970,13 +2062,12 @@ from pprint import pprint try: # Process Uncorrelated Accounts - api_response = api_instance.import_uncorrelated_accounts(id, x_sail_point_experimental, ) - + results =SourcesApi(api_client).import_uncorrelated_accounts(id, x_sail_point_experimental, ) # Below is a request that includes all optional parameters - # api_response = api_instance.import_uncorrelated_accounts(id, x_sail_point_experimental, file) + # results = SourcesApi(api_client).import_uncorrelated_accounts(id, x_sail_point_experimental, file) print("The response of SourcesApi->import_uncorrelated_accounts:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->import_uncorrelated_accounts: %s\n" % e) ``` @@ -2018,22 +2109,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.provisioning_policy_dto import ProvisioningPolicyDto -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 | The Source id # str | The Source id try: # Lists ProvisioningPolicies - api_response = api_instance.list_provisioning_policies(source_id) - + results =SourcesApi(api_client).list_provisioning_policies(source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.list_provisioning_policies(source_id) + # results = SourcesApi(api_client).list_provisioning_policies(source_id) print("The response of SourcesApi->list_provisioning_policies:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) ``` @@ -2081,10 +2175,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.source import Source -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) @@ -2096,13 +2194,12 @@ from pprint import pprint try: # Lists all sources in IdentityNow. - api_response = api_instance.list_sources() - + results =SourcesApi(api_client).list_sources() # Below is a request that includes all optional parameters - # api_response = api_instance.list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) + # results = SourcesApi(api_client).list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) print("The response of SourcesApi->list_sources:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->list_sources: %s\n" % e) ``` @@ -2149,11 +2246,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.resource_objects_request import ResourceObjectsRequest from sailpoint.v2024.models.resource_objects_response import ResourceObjectsResponse -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 = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source 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') resource_objects_request = { @@ -2163,14 +2264,14 @@ from pprint import pprint try: # Peek source connector's resource objects - Result = resource_objects_request.from_json(resource_objects_request) - api_response = api_instance.peek_resource_objects(source_id, x_sail_point_experimental, Result) - + new_resource_objects_request = ResourceObjectsRequest() + new_resource_objects_request.from_json(resource_objects_request) + results =SourcesApi(api_client).peek_resource_objects(source_id, x_sail_point_experimental, new_resource_objects_request) # Below is a request that includes all optional parameters - # api_response = api_instance.peek_resource_objects(source_id, x_sail_point_experimental, Result) + # results = SourcesApi(api_client).peek_resource_objects(source_id, x_sail_point_experimental, new_resource_objects_request) print("The response of SourcesApi->peek_resource_objects:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->peek_resource_objects: %s\n" % e) ``` @@ -2216,23 +2317,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.status_response import StatusResponse -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 = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source 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: # Ping cluster for source connector - api_response = api_instance.ping_cluster(source_id, x_sail_point_experimental) - + results =SourcesApi(api_client).ping_cluster(source_id, x_sail_point_experimental) # Below is a request that includes all optional parameters - # api_response = api_instance.ping_cluster(source_id, x_sail_point_experimental) + # results = SourcesApi(api_client).ping_cluster(source_id, x_sail_point_experimental) print("The response of SourcesApi->ping_cluster:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->ping_cluster: %s\n" % e) ``` @@ -2275,10 +2379,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.correlation_config import CorrelationConfig -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 | The source id # str | The source id correlation_config = { "attributeAssignments" : [ { @@ -2304,14 +2412,14 @@ from pprint import pprint try: # Update Source Correlation Configuration - Result = correlation_config.from_json(correlation_config) - api_response = api_instance.put_correlation_config(id, Result) - + new_correlation_config = CorrelationConfig() + new_correlation_config.from_json(correlation_config) + results =SourcesApi(api_client).put_correlation_config(id, new_correlation_config) # Below is a request that includes all optional parameters - # api_response = api_instance.put_correlation_config(id, Result) + # results = SourcesApi(api_client).put_correlation_config(id, new_correlation_config) print("The response of SourcesApi->put_correlation_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->put_correlation_config: %s\n" % e) ``` @@ -2358,10 +2466,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.native_change_detection_config import NativeChangeDetectionConfig -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 | The source id # str | The 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') native_change_detection_config = { @@ -2375,14 +2487,14 @@ from pprint import pprint try: # Update Native Change Detection Configuration - Result = native_change_detection_config.from_json(native_change_detection_config) - api_response = api_instance.put_native_change_detection_config(id, x_sail_point_experimental, Result) - + new_native_change_detection_config = NativeChangeDetectionConfig() + new_native_change_detection_config.from_json(native_change_detection_config) + results =SourcesApi(api_client).put_native_change_detection_config(id, x_sail_point_experimental, new_native_change_detection_config) # Below is a request that includes all optional parameters - # api_response = api_instance.put_native_change_detection_config(id, x_sail_point_experimental, Result) + # results = SourcesApi(api_client).put_native_change_detection_config(id, x_sail_point_experimental, new_native_change_detection_config) print("The response of SourcesApi->put_native_change_detection_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->put_native_change_detection_config: %s\n" % e) ``` @@ -2428,11 +2540,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.provisioning_policy_dto import ProvisioningPolicyDto from sailpoint.v2024.models.usage_type import UsageType -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 | The Source ID. # str | The Source ID. usage_type = sailpoint.v2024.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. provisioning_policy_dto = { @@ -2478,14 +2594,14 @@ from pprint import pprint try: # Update Provisioning Policy by UsageType - Result = provisioning_policy_dto.from_json(provisioning_policy_dto) - api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) - + new_provisioning_policy_dto = ProvisioningPolicyDto() + new_provisioning_policy_dto.from_json(provisioning_policy_dto) + results =SourcesApi(api_client).put_provisioning_policy(source_id, usage_type, new_provisioning_policy_dto) # Below is a request that includes all optional parameters - # api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) + # results = SourcesApi(api_client).put_provisioning_policy(source_id, usage_type, new_provisioning_policy_dto) print("The response of SourcesApi->put_provisioning_policy:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) ``` @@ -2540,10 +2656,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.source import Source -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 ID. # str | Source ID. source = { "cluster" : { @@ -2631,14 +2751,14 @@ from pprint import pprint try: # Update Source (Full) - Result = source.from_json(source) - api_response = api_instance.put_source(id, Result) - + new_source = Source() + new_source.from_json(source) + results =SourcesApi(api_client).put_source(id, new_source) # Below is a request that includes all optional parameters - # api_response = api_instance.put_source(id, Result) + # results = SourcesApi(api_client).put_source(id, new_source) print("The response of SourcesApi->put_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->put_source: %s\n" % e) ``` @@ -2686,10 +2806,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.attr_sync_source_config import AttrSyncSourceConfig -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 | The source id # str | The 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') attr_sync_source_config = { @@ -2713,14 +2837,14 @@ from pprint import pprint try: # Update Attribute Sync Config - Result = attr_sync_source_config.from_json(attr_sync_source_config) - api_response = api_instance.put_source_attr_sync_config(id, x_sail_point_experimental, Result) - + new_attr_sync_source_config = AttrSyncSourceConfig() + new_attr_sync_source_config.from_json(attr_sync_source_config) + results =SourcesApi(api_client).put_source_attr_sync_config(id, x_sail_point_experimental, new_attr_sync_source_config) # Below is a request that includes all optional parameters - # api_response = api_instance.put_source_attr_sync_config(id, x_sail_point_experimental, Result) + # results = SourcesApi(api_client).put_source_attr_sync_config(id, x_sail_point_experimental, new_attr_sync_source_config) print("The response of SourcesApi->put_source_attr_sync_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->put_source_attr_sync_config: %s\n" % e) ``` @@ -2774,24 +2898,28 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.model_schema import ModelSchema -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 | The Source id. # str | The Source id. schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. model_schema = sailpoint.v2024.ModelSchema() # ModelSchema | try: # Update Source Schema (Full) - Result = model_schema.from_json(model_schema) - api_response = api_instance.put_source_schema(source_id, schema_id, Result) - + new_model_schema = ModelSchema() + new_model_schema.from_json(model_schema) + results =SourcesApi(api_client).put_source_schema(source_id, schema_id, new_model_schema) # Below is a request that includes all optional parameters - # api_response = api_instance.put_source_schema(source_id, schema_id, Result) + # results = SourcesApi(api_client).put_source_schema(source_id, schema_id, new_model_schema) print("The response of SourcesApi->put_source_schema:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) ``` @@ -2837,23 +2965,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.source_sync_job import SourceSyncJob -from sailpoint.v2024.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'id_example' # str | The Source id # str | The 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') try: # Synchronize single source attributes. - api_response = api_instance.sync_attributes_for_source(id, x_sail_point_experimental) - + results =SourcesApi(api_client).sync_attributes_for_source(id, x_sail_point_experimental) # Below is a request that includes all optional parameters - # api_response = api_instance.sync_attributes_for_source(id, x_sail_point_experimental) + # results = SourcesApi(api_client).sync_attributes_for_source(id, x_sail_point_experimental) print("The response of SourcesApi->sync_attributes_for_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->sync_attributes_for_source: %s\n" % e) ``` @@ -2899,23 +3030,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.status_response import StatusResponse -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 = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source 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: # Test configuration for source connector - api_response = api_instance.test_source_configuration(source_id, x_sail_point_experimental) - + results =SourcesApi(api_client).test_source_configuration(source_id, x_sail_point_experimental) # Below is a request that includes all optional parameters - # api_response = api_instance.test_source_configuration(source_id, x_sail_point_experimental) + # results = SourcesApi(api_client).test_source_configuration(source_id, x_sail_point_experimental) print("The response of SourcesApi->test_source_configuration:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->test_source_configuration: %s\n" % e) ``` @@ -2961,23 +3095,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.status_response import StatusResponse -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 = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source. # str | The ID of the Source. 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: # Check connection for source connector. - api_response = api_instance.test_source_connection(source_id, x_sail_point_experimental) - + results =SourcesApi(api_client).test_source_connection(source_id, x_sail_point_experimental) # Below is a request that includes all optional parameters - # api_response = api_instance.test_source_connection(source_id, x_sail_point_experimental) + # results = SourcesApi(api_client).test_source_connection(source_id, x_sail_point_experimental) print("The response of SourcesApi->test_source_connection:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->test_source_connection: %s\n" % e) ``` @@ -3022,10 +3159,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.password_policy_holders_dto_inner import PasswordPolicyHoldersDtoInner -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 = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id [sailpoint.v2024.PasswordPolicyHoldersDtoInner()] # List[PasswordPolicyHoldersDtoInner] | password_policy_holders_dto_inner = [sailpoint.v2024.PasswordPolicyHoldersDtoInner()] # List[PasswordPolicyHoldersDtoInner] | @@ -3033,14 +3174,14 @@ from pprint import pprint try: # Update Password Policy - Result = password_policy_holders_dto_inner.from_json(password_policy_holders_dto_inner) - api_response = api_instance.update_password_policy_holders(source_id, Result) - + new_password_policy_holders_dto_inner = PasswordPolicyHoldersDtoInner() + new_password_policy_holders_dto_inner.from_json(password_policy_holders_dto_inner) + results =SourcesApi(api_client).update_password_policy_holders(source_id, new_password_policy_holders_dto_inner) # Below is a request that includes all optional parameters - # api_response = api_instance.update_password_policy_holders(source_id, Result) + # results = SourcesApi(api_client).update_password_policy_holders(source_id, new_password_policy_holders_dto_inner) print("The response of SourcesApi->update_password_policy_holders:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->update_password_policy_holders: %s\n" % e) ``` @@ -3083,10 +3224,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.provisioning_policy_dto import ProvisioningPolicyDto -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 | The Source id. # str | The Source id. [sailpoint.v2024.ProvisioningPolicyDto()] # List[ProvisioningPolicyDto] | provisioning_policy_dto = { @@ -3133,14 +3278,14 @@ from pprint import pprint try: # Bulk Update Provisioning Policies - Result = provisioning_policy_dto.from_json(provisioning_policy_dto) - api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) - + new_provisioning_policy_dto = ProvisioningPolicyDto() + new_provisioning_policy_dto.from_json(provisioning_policy_dto) + results =SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) # Below is a request that includes all optional parameters - # api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) + # results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) ``` @@ -3186,12 +3331,16 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation from sailpoint.v2024.models.provisioning_policy_dto import ProvisioningPolicyDto from sailpoint.v2024.models.usage_type import UsageType -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 | The Source id. # str | The Source id. usage_type = sailpoint.v2024.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. [{op=add, path=/fields/0, value={name=email, transform={type=identityAttribute, attributes={name=email}}, attributes={}, isRequired=false, type=string, isMultiValued=false}}] # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. @@ -3204,14 +3353,14 @@ from pprint import pprint try: # Partial update of Provisioning Policy - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =SourcesApi(api_client).update_provisioning_policy(source_id, usage_type, new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) + # results = SourcesApi(api_client).update_provisioning_policy(source_id, usage_type, new_json_patch_operation) print("The response of SourcesApi->update_provisioning_policy:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) ``` @@ -3269,11 +3418,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation from sailpoint.v2024.models.source import Source -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 ID. # str | Source ID. [{op=replace, path=/description, value=new description}] # List[JsonPatchOperation] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). json_patch_operation = { @@ -3285,14 +3438,14 @@ from pprint import pprint try: # Update Source (Partial) - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_source(id, Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =SourcesApi(api_client).update_source(id, new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.update_source(id, Result) + # results = SourcesApi(api_client).update_source(id, new_json_patch_operation) print("The response of SourcesApi->update_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->update_source: %s\n" % e) ``` @@ -3341,10 +3494,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.source_entitlement_request_config import SourceEntitlementRequestConfig -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_entitlement_request_config = { "accessRequestConfig" : { @@ -3362,14 +3519,14 @@ from pprint import pprint try: # Update Source Entitlement Request Configuration - Result = source_entitlement_request_config.from_json(source_entitlement_request_config) - api_response = api_instance.update_source_entitlement_request_config(x_sail_point_experimental, Result) - + new_source_entitlement_request_config = SourceEntitlementRequestConfig() + new_source_entitlement_request_config.from_json(source_entitlement_request_config) + results =SourcesApi(api_client).update_source_entitlement_request_config(x_sail_point_experimental, new_source_entitlement_request_config) # Below is a request that includes all optional parameters - # api_response = api_instance.update_source_entitlement_request_config(x_sail_point_experimental, Result) + # results = SourcesApi(api_client).update_source_entitlement_request_config(x_sail_point_experimental, new_source_entitlement_request_config) print("The response of SourcesApi->update_source_entitlement_request_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->update_source_entitlement_request_config: %s\n" % e) ``` @@ -3418,11 +3575,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation from sailpoint.v2024.models.schedule1 import Schedule1 -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 | The Source id. # str | The Source id. schedule_type = 'ACCOUNT_AGGREGATION' # str | The Schedule type. # str | The Schedule type. [{op=replace, path=/cronExpression, value=0 0 6 * * ?}] # List[JsonPatchOperation] | The JSONPatch payload used to update the schedule. @@ -3435,14 +3596,14 @@ from pprint import pprint try: # Update Source Schedule (Partial) - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_source_schedule(source_id, schedule_type, Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =SourcesApi(api_client).update_source_schedule(source_id, schedule_type, new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.update_source_schedule(source_id, schedule_type, Result) + # results = SourcesApi(api_client).update_source_schedule(source_id, schedule_type, new_json_patch_operation) print("The response of SourcesApi->update_source_schedule:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->update_source_schedule: %s\n" % e) ``` @@ -3515,11 +3676,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v2024 +from sailpoint.v2024.api.sources_api import SourcesApi +from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation from sailpoint.v2024.models.model_schema import ModelSchema -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 | The Source id. # str | The Source id. schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. [{op=add, path=/attributes/-, value={name=location, type=STRING, schema=null, description=Employee location, isMulti=false, isEntitlement=false, isGroup=false}}] # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. @@ -3532,14 +3697,14 @@ from pprint import pprint try: # Update Source Schema (Partial) - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_source_schema(source_id, schema_id, Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =SourcesApi(api_client).update_source_schema(source_id, schema_id, new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.update_source_schema(source_id, schema_id, Result) + # results = SourcesApi(api_client).update_source_schema(source_id, schema_id, new_json_patch_operation) print("The response of SourcesApi->update_source_schema:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SuggestedEntitlementDescriptionApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SuggestedEntitlementDescriptionApi.md index 65e6f9fe1..c0bf2ecb6 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SuggestedEntitlementDescriptionApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SuggestedEntitlementDescriptionApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/TaggedObjectsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/TaggedObjectsApi.md index f465ccf08..7c199ea71 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/TaggedObjectsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/TaggedObjectsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/TaskManagementApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/TaskManagementApi.md index 90973dcee..09308eb80 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/TaskManagementApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/TaskManagementApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/TenantApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/TenantApi.md index 19fcc5cfe..cfac29448 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/TenantApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/TenantApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/TransformsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/TransformsApi.md index d516f8e94..1f74f70b1 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/TransformsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/TransformsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/TriggersApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/TriggersApi.md index 955988a77..2574c6c86 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/TriggersApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/TriggersApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/UIMetadataApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/UIMetadataApi.md index 1ce2b24f6..4817c239f 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/UIMetadataApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/UIMetadataApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/VendorConnectorMappingsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/VendorConnectorMappingsApi.md index 58b7b6a91..239ccfa78 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/VendorConnectorMappingsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/VendorConnectorMappingsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/WorkItemsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/WorkItemsApi.md index 22339415d..58d613032 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/WorkItemsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/WorkItemsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/WorkReassignmentApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/WorkReassignmentApi.md index 4da11422d..b4569eef6 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/WorkReassignmentApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/WorkReassignmentApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/WorkflowsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/WorkflowsApi.md index 015eca215..b521a1958 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/WorkflowsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/WorkflowsApi.md @@ -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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md index f9aed9633..e7129b83d 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md @@ -93,10 +93,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.access_profiles_api import AccessProfilesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.access_profile import AccessProfile -from sailpoint.v3.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", @@ -185,14 +189,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) ``` @@ -237,19 +241,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.access_profiles_api import AccessProfilesApi +from sailpoint.v3.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) ``` @@ -295,11 +302,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.access_profiles_api import AccessProfilesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.access_profile_bulk_delete_request import AccessProfileBulkDeleteRequest from sailpoint.v3.models.access_profile_bulk_delete_response import AccessProfileBulkDeleteResponse -from sailpoint.v3.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 @@ -307,14 +318,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) ``` @@ -355,22 +366,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.access_profiles_api import AccessProfilesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.access_profile import AccessProfile -from sailpoint.v3.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) ``` @@ -418,10 +432,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.access_profiles_api import AccessProfilesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.entitlement import Entitlement -from sailpoint.v3.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) @@ -432,13 +450,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) ``` @@ -487,10 +504,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.access_profiles_api import AccessProfilesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.access_profile import AccessProfile -from sailpoint.v3.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) @@ -503,13 +524,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) ``` @@ -580,11 +600,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.access_profiles_api import AccessProfilesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.access_profile import AccessProfile from sailpoint.v3.models.json_patch_operation import JsonPatchOperation -from sailpoint.v3.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 = { @@ -596,14 +620,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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestApprovalsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestApprovalsApi.md index eee3a0a01..e2de1389e 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestApprovalsApi.md @@ -75,10 +75,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.comment_dto import CommentDto -from sailpoint.v3.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", @@ -93,13 +97,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) ``` @@ -142,10 +145,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.forward_approval_dto import ForwardApprovalDto -from sailpoint.v3.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", @@ -154,14 +161,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) ``` @@ -203,23 +210,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.approval_summary import ApprovalSummary -from sailpoint.v3.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) ``` @@ -265,10 +275,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.completed_approval import CompletedApproval -from sailpoint.v3.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) @@ -279,13 +293,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) ``` @@ -331,10 +344,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.pending_approval import PendingApproval -from sailpoint.v3.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) @@ -345,13 +362,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) ``` @@ -394,10 +410,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.access_request_approvals_api import AccessRequestApprovalsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.comment_dto import CommentDto -from sailpoint.v3.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", @@ -411,14 +431,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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md index e58179e82..fca89e729 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md @@ -72,10 +72,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.access_requests_api import AccessRequestsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.cancel_access_request import CancelAccessRequest -from sailpoint.v3.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." @@ -83,14 +87,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) ``` @@ -161,11 +165,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.access_requests_api import AccessRequestsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.access_request import AccessRequest from sailpoint.v3.models.access_request_response import AccessRequestResponse -from sailpoint.v3.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" : { @@ -223,14 +231,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) ``` @@ -268,21 +276,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.access_requests_api import AccessRequestsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.access_request_config import AccessRequestConfig -from sailpoint.v3.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) ``` @@ -334,10 +345,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.access_requests_api import AccessRequestsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.requested_item_status import RequestedItemStatus -from sailpoint.v3.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) @@ -352,13 +367,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) ``` @@ -399,10 +413,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.access_requests_api import AccessRequestsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.access_request_config import AccessRequestConfig -from sailpoint.v3.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, @@ -432,14 +450,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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccountActivitiesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccountActivitiesApi.md index eccd03a26..b36ebc19c 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AccountActivitiesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccountActivitiesApi.md @@ -86,22 +86,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.account_activities_api import AccountActivitiesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.account_activity import AccountActivity -from sailpoint.v3.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.v3 +from sailpoint.v3.api.account_activities_api import AccountActivitiesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.account_activity import AccountActivity -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccountUsagesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccountUsagesApi.md index a210c14e4..4c1b1fe02 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AccountUsagesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccountUsagesApi.md @@ -58,10 +58,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.account_usages_api import AccountUsagesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.account_usage import AccountUsage -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccountsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccountsApi.md index beb6c3fe6..fc498c6eb 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AccountsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccountsApi.md @@ -99,11 +99,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.accounts_api import AccountsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.account_attributes_create import AccountAttributesCreate from sailpoint.v3.models.accounts_async_result import AccountsAsyncResult -from sailpoint.v3.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", @@ -117,14 +121,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) ``` @@ -169,22 +173,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.accounts_api import AccountsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.accounts_async_result import AccountsAsyncResult -from sailpoint.v3.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) ``` @@ -227,11 +234,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.accounts_api import AccountsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.account_toggle_request import AccountToggleRequest from sailpoint.v3.models.accounts_async_result import AccountsAsyncResult -from sailpoint.v3.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, @@ -240,14 +251,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) ``` @@ -290,11 +301,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.accounts_api import AccountsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.account_toggle_request import AccountToggleRequest from sailpoint.v3.models.accounts_async_result import AccountsAsyncResult -from sailpoint.v3.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, @@ -303,14 +318,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) ``` @@ -352,22 +367,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.accounts_api import AccountsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.account import Account -from sailpoint.v3.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) ``` @@ -412,10 +430,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.accounts_api import AccountsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.entitlement_dto import EntitlementDto -from sailpoint.v3.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) @@ -424,13 +446,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) ``` @@ -476,10 +497,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.accounts_api import AccountsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.account import Account -from sailpoint.v3.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) @@ -490,13 +515,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) ``` @@ -544,11 +568,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.accounts_api import AccountsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.account_attributes import AccountAttributes from sailpoint.v3.models.accounts_async_result import AccountsAsyncResult -from sailpoint.v3.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" : { @@ -562,14 +590,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) ``` @@ -611,22 +639,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.accounts_api import AccountsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.accounts_async_result import AccountsAsyncResult -from sailpoint.v3.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) ``` @@ -670,11 +701,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.accounts_api import AccountsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.account_unlock_request import AccountUnlockRequest from sailpoint.v3.models.accounts_async_result import AccountsAsyncResult -from sailpoint.v3.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, @@ -684,14 +719,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) ``` @@ -744,9 +779,13 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.accounts_api import AccountsApi +from sailpoint.v3.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. @@ -754,14 +793,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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ApplicationDiscoveryApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ApplicationDiscoveryApi.md index b9eb4f0f1..5035eb276 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/ApplicationDiscoveryApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/ApplicationDiscoveryApi.md @@ -60,10 +60,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.application_discovery_api import ApplicationDiscoveryApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.get_discovered_applications200_response_inner import GetDiscoveredApplications200ResponseInner -from sailpoint.v3.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.v3 +from sailpoint.v3.api.application_discovery_api import ApplicationDiscoveryApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.manual_discover_applications_template import ManualDiscoverApplicationsTemplate -from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.application_discovery_api import ApplicationDiscoveryApi +from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AuthUsersApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AuthUsersApi.md index 41390c373..8c982e259 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AuthUsersApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AuthUsersApi.md @@ -58,22 +58,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.auth_users_api import AuthUsersApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.auth_user import AuthUser -from sailpoint.v3.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.v3 +from sailpoint.v3.api.auth_users_api import AuthUsersApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.auth_user import AuthUser from sailpoint.v3.models.json_patch_operation import JsonPatchOperation -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/BrandingApi.md b/docs/tools/sdk/python/Reference/V3/Methods/BrandingApi.md index db9401715..17401a5f2 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/BrandingApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/BrandingApi.md @@ -67,10 +67,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.branding_api import BrandingApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.branding_item import BrandingItem -from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.branding_api import BrandingApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.branding_api import BrandingApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.branding_item import BrandingItem -from sailpoint.v3.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.v3 +from sailpoint.v3.api.branding_api import BrandingApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.branding_item import BrandingItem -from sailpoint.v3.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.v3 +from sailpoint.v3.api.branding_api import BrandingApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.branding_item import BrandingItem -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignFiltersApi.md b/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignFiltersApi.md index b5266dbba..61f496a54 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignFiltersApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignFiltersApi.md @@ -82,10 +82,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.certification_campaign_filters_api import CertificationCampaignFiltersApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.campaign_filter_details import CampaignFilterDetails -from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.certification_campaign_filters_api import CertificationCampaignFiltersApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.certification_campaign_filters_api import CertificationCampaignFiltersApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.campaign_filter_details import CampaignFilterDetails -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certification_campaign_filters_api import CertificationCampaignFiltersApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.list_campaign_filters200_response import ListCampaignFilters200Response -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certification_campaign_filters_api import CertificationCampaignFiltersApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.campaign_filter_details import CampaignFilterDetails -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignsApi.md index cffaca94c..065b5f464 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignsApi.md @@ -149,10 +149,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.campaign_complete_options import CampaignCompleteOptions -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.campaign import Campaign -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.campaign_template import CampaignTemplate -from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.campaigns_delete_request import CampaignsDeleteRequest -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.campaign_report import CampaignReport -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.campaign_reports_config import CampaignReportsConfig -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.campaign_template import CampaignTemplate -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.schedule import Schedule -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.campaign_template import CampaignTemplate -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.admin_review_reassign import AdminReviewReassign from sailpoint.v3.models.certification_task import CertificationTask -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.campaign_template import CampaignTemplate from sailpoint.v3.models.json_patch_operation import JsonPatchOperation -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.campaign_reports_config import CampaignReportsConfig -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.schedule import Schedule -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.activate_campaign_options import ActivateCampaignOptions -from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.report_type import ReportType -from sailpoint.v3.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.v3.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.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.campaign_reference import CampaignReference -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.json_patch_operation import JsonPatchOperation from sailpoint.v3.models.slim_campaign import SlimCampaign -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/CertificationSummariesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/CertificationSummariesApi.md index 980b8878d..0eac28ad5 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/CertificationSummariesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/CertificationSummariesApi.md @@ -75,10 +75,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.access_summary import AccessSummary -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.identity_cert_decision_summary import IdentityCertDecisionSummary -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/CertificationsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/CertificationsApi.md index 2d0af1745..62aa2b666 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/CertificationsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/CertificationsApi.md @@ -85,22 +85,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.certifications_api import CertificationsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.certification_task import CertificationTask -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certifications_api import CertificationsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.identity_certification_dto import IdentityCertificationDto -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certifications_api import CertificationsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.permission_dto import PermissionDto -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certifications_api import CertificationsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.certification_task import CertificationTask -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certifications_api import CertificationsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.identity_reference_with_name_and_email import IdentityReferenceWithNameAndEmail -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certifications_api import CertificationsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.access_review_item import AccessReviewItem -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certifications_api import CertificationsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.identity_certification_dto import IdentityCertificationDto -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certifications_api import CertificationsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.identity_certification_dto import IdentityCertificationDto from sailpoint.v3.models.review_decision import ReviewDecision -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certifications_api import CertificationsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.identity_certification_dto import IdentityCertificationDto from sailpoint.v3.models.review_reassign import ReviewReassign -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certifications_api import CertificationsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.identity_certification_dto import IdentityCertificationDto -from sailpoint.v3.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.v3 +from sailpoint.v3.api.certifications_api import CertificationsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.certification_task import CertificationTask from sailpoint.v3.models.review_reassign import ReviewReassign -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ConfigurationHubApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ConfigurationHubApi.md index 4af8aa980..133b3aabb 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/ConfigurationHubApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/ConfigurationHubApi.md @@ -73,11 +73,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.object_mapping_request import ObjectMappingRequest from sailpoint.v3.models.object_mapping_response import ObjectMappingResponse -from sailpoint.v3.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", @@ -89,14 +93,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) ``` @@ -142,11 +146,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.object_mapping_bulk_create_request import ObjectMappingBulkCreateRequest from sailpoint.v3.models.object_mapping_bulk_create_response import ObjectMappingBulkCreateResponse -from sailpoint.v3.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" : [ { @@ -166,14 +174,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) ``` @@ -219,23 +227,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.backup_response import BackupResponse -from sailpoint.v3.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) ``` @@ -281,20 +292,23 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v3.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) ``` @@ -340,19 +354,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v3.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) ``` @@ -397,22 +414,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.object_mapping_response import ObjectMappingResponse -from sailpoint.v3.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) ``` @@ -454,22 +474,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.backup_response import BackupResponse -from sailpoint.v3.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) ``` @@ -511,22 +534,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.backup_response import BackupResponse -from sailpoint.v3.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) ``` @@ -572,11 +598,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.object_mapping_bulk_patch_request import ObjectMappingBulkPatchRequest from sailpoint.v3.models.object_mapping_bulk_patch_response import ObjectMappingBulkPatchResponse -from sailpoint.v3.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" : { @@ -595,14 +625,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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ConnectorsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ConnectorsApi.md index 0d501157e..becd475bb 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/ConnectorsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/ConnectorsApi.md @@ -76,11 +76,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.connectors_api import ConnectorsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.v3_connector_dto import V3ConnectorDto from sailpoint.v3.models.v3_create_connector_dto import V3CreateConnectorDto -from sailpoint.v3.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, @@ -91,14 +95,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) ``` @@ -140,19 +144,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.connectors_api import ConnectorsApi +from sailpoint.v3.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) ``` @@ -195,23 +202,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.connectors_api import ConnectorsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.connector_detail import ConnectorDetail -from sailpoint.v3.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) ``` @@ -257,10 +267,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.connectors_api import ConnectorsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.v3_connector_dto import V3ConnectorDto -from sailpoint.v3.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) @@ -270,13 +284,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) ``` @@ -318,21 +331,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.connectors_api import ConnectorsApi +from sailpoint.v3.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) ``` @@ -374,21 +390,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.connectors_api import ConnectorsApi +from sailpoint.v3.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) ``` @@ -431,22 +450,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.connectors_api import ConnectorsApi +from sailpoint.v3.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) ``` @@ -489,23 +511,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.connectors_api import ConnectorsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.update_detail import UpdateDetail -from sailpoint.v3.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) ``` @@ -548,23 +573,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.connectors_api import ConnectorsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.update_detail import UpdateDetail -from sailpoint.v3.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) ``` @@ -607,23 +635,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.connectors_api import ConnectorsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.update_detail import UpdateDetail -from sailpoint.v3.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) ``` @@ -678,11 +709,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.connectors_api import ConnectorsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.connector_detail import ConnectorDetail from sailpoint.v3.models.json_patch_operation import JsonPatchOperation -from sailpoint.v3.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.v3.JsonPatchOperation()] # List[JsonPatchOperation] | A list of connector detail update operations json_patch_operation = { @@ -694,14 +729,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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/GlobalTenantSecuritySettingsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/GlobalTenantSecuritySettingsApi.md index 1d8bb98a6..c136ceb24 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/GlobalTenantSecuritySettingsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/GlobalTenantSecuritySettingsApi.md @@ -63,10 +63,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.network_configuration import NetworkConfiguration -from sailpoint.v3.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, @@ -75,14 +79,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) ``` @@ -121,21 +125,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.lockout_configuration import LockoutConfiguration -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # Get Auth Org Lockout Configuration. - api_response = api_instance.get_auth_org_lockout_config() - + results =GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config() # Below is a request that includes all optional parameters - # api_response = api_instance.get_auth_org_lockout_config() + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config() print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config: %s\n" % e) ``` @@ -174,21 +181,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.network_configuration import NetworkConfiguration -from sailpoint.v3.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) ``` @@ -227,21 +237,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.service_provider_configuration import ServiceProviderConfiguration -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # Get Service Provider Configuration. - api_response = api_instance.get_auth_org_service_provider_config() - + results =GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config() # Below is a request that includes all optional parameters - # api_response = api_instance.get_auth_org_service_provider_config() + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config() print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config: %s\n" % e) ``` @@ -280,21 +293,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.session_configuration import SessionConfiguration -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: try: # Get Auth Org Session Configuration. - api_response = api_instance.get_auth_org_session_config() - + results =GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config() # Below is a request that includes all optional parameters - # api_response = api_instance.get_auth_org_session_config() + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config() print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_session_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_session_config: %s\n" % e) ``` @@ -337,11 +353,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.json_patch_operation import JsonPatchOperation from sailpoint.v3.models.lockout_configuration import LockoutConfiguration -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: [{op=replace, path=/maximumAttempts, value=7,}, {op=add, path=/lockoutDuration, value=35}] # List[JsonPatchOperation] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` json_patch_operation = { "op" : "replace", @@ -352,14 +372,14 @@ from pprint import pprint try: # Update Auth Org Lockout Configuration - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_auth_org_lockout_config(Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_auth_org_lockout_config(Result) + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(new_json_patch_operation) print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config: %s\n" % e) ``` @@ -402,11 +422,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.json_patch_operation import JsonPatchOperation from sailpoint.v3.models.network_configuration import NetworkConfiguration -from sailpoint.v3.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", @@ -417,14 +441,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) ``` @@ -466,11 +490,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.json_patch_operation import JsonPatchOperation from sailpoint.v3.models.service_provider_configuration import ServiceProviderConfiguration -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: [{op=replace, path=/enabled, value=true,}, {op=add, path=/federationProtocolDetails/0/jitConfiguration, value={enabled=true, sourceId=2c9180857377ed2901739c12a2da5ac8, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email, employeeNumber=okta.employeeNumber}}}] # List[JsonPatchOperation] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) json_patch_operation = { "op" : "replace", @@ -481,14 +509,14 @@ from pprint import pprint try: # Update Service Provider Configuration - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_auth_org_service_provider_config(Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_auth_org_service_provider_config(Result) + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(new_json_patch_operation) print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config: %s\n" % e) ``` @@ -530,11 +558,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.json_patch_operation import JsonPatchOperation from sailpoint.v3.models.session_configuration import SessionConfiguration -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: [{op=replace, path=/rememberMe, value=true,}, {op=add, path=/maxSessionTime, value=480}] # List[JsonPatchOperation] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` json_patch_operation = { "op" : "replace", @@ -545,14 +577,14 @@ from pprint import pprint try: # Update Auth Org Session Configuration - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_auth_org_session_config(Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_auth_org_session_config(Result) + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(new_json_patch_operation) print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_session_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_session_config: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/IdentityProfilesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/IdentityProfilesApi.md index 3222e77ba..4b26a71ae 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/IdentityProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/IdentityProfilesApi.md @@ -71,10 +71,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.identity_profile import IdentityProfile -from sailpoint.v3.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.v3 +from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.task_result_simplified import TaskResultSimplified -from sailpoint.v3.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.v3 +from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.task_result_simplified import TaskResultSimplified -from sailpoint.v3.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.v3 +from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.identity_profile_exported_object import IdentityProfileExportedObject -from sailpoint.v3.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.v3 +from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.identity_attribute_config import IdentityAttributeConfig -from sailpoint.v3.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.v3 +from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.identity_profile import IdentityProfile -from sailpoint.v3.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.v3 +from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.identity_profile_exported_object import IdentityProfileExportedObject from sailpoint.v3.models.object_import_result import ObjectImportResult -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: [sailpoint.v3.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.v3 +from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.identity_profile import IdentityProfile -from sailpoint.v3.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.v3 +from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.identity_preview_request import IdentityPreviewRequest from sailpoint.v3.models.identity_preview_response import IdentityPreviewResponse -from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.identity_profile import IdentityProfile from sailpoint.v3.models.json_patch_operation import JsonPatchOperation -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/LifecycleStatesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/LifecycleStatesApi.md index 4925ca71a..4677213a2 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/LifecycleStatesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/LifecycleStatesApi.md @@ -95,10 +95,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.lifecycle_states_api import LifecycleStatesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.lifecycle_state import LifecycleState -from sailpoint.v3.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.v3 +from sailpoint.v3.api.lifecycle_states_api import LifecycleStatesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.lifecyclestate_deleted import LifecyclestateDeleted -from sailpoint.v3.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.v3 +from sailpoint.v3.api.lifecycle_states_api import LifecycleStatesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.lifecycle_state import LifecycleState -from sailpoint.v3.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.v3 +from sailpoint.v3.api.lifecycle_states_api import LifecycleStatesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.lifecycle_state import LifecycleState -from sailpoint.v3.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.v3 +from sailpoint.v3.api.lifecycle_states_api import LifecycleStatesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.set_lifecycle_state200_response import SetLifecycleState200Response from sailpoint.v3.models.set_lifecycle_state_request import SetLifecycleStateRequest -from sailpoint.v3.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.v3.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.v3 +from sailpoint.v3.api.lifecycle_states_api import LifecycleStatesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.json_patch_operation import JsonPatchOperation from sailpoint.v3.models.lifecycle_state import LifecycleState -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/MFAConfigurationApi.md b/docs/tools/sdk/python/Reference/V3/Methods/MFAConfigurationApi.md index d5eaf9120..87cd3a236 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/MFAConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/MFAConfigurationApi.md @@ -58,22 +58,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.mfa_okta_config import MfaOktaConfig -from sailpoint.v3.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: # Delete MFA method configuration - api_response = api_instance.delete_mfa_config(method) - + results =MFAConfigurationApi(api_client).delete_mfa_config(method) # Below is a request that includes all optional parameters - # api_response = api_instance.delete_mfa_config(method) + # results = MFAConfigurationApi(api_client).delete_mfa_config(method) print("The response of MFAConfigurationApi->delete_mfa_config:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling MFAConfigurationApi->delete_mfa_config: %s\n" % e) ``` @@ -111,21 +114,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.mfa_duo_config import MfaDuoConfig -from sailpoint.v3.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) ``` @@ -166,22 +172,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.kba_question import KbaQuestion -from sailpoint.v3.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) ``` @@ -219,21 +228,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.mfa_okta_config import MfaOktaConfig -from sailpoint.v3.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) ``` @@ -274,10 +286,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.mfa_duo_config import MfaDuoConfig -from sailpoint.v3.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", @@ -292,14 +308,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) ``` @@ -340,10 +356,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.mfa_okta_config import MfaOktaConfig -from sailpoint.v3.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", @@ -354,14 +374,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) ``` @@ -402,11 +422,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.kba_answer_request_item import KbaAnswerRequestItem from sailpoint.v3.models.kba_answer_response_item import KbaAnswerResponseItem -from sailpoint.v3.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", @@ -416,14 +440,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) ``` @@ -464,22 +488,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.mfa_config_test_response import MfaConfigTestResponse -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/MFAControllerApi.md b/docs/tools/sdk/python/Reference/V3/Methods/MFAControllerApi.md index 0ccd4ff00..0b7f018d9 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/MFAControllerApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/MFAControllerApi.md @@ -56,11 +56,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.mfa_controller_api import MFAControllerApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.send_token_request import SendTokenRequest from sailpoint.v3.models.send_token_response import SendTokenResponse -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: send_token_request = { "userAlias" : "will.albin", "deliveryType" : "EMAIL_WORK" @@ -68,14 +72,14 @@ from pprint import pprint try: # Create and send user token - Result = send_token_request.from_json(send_token_request) - api_response = api_instance.create_send_token(Result) - + new_send_token_request = SendTokenRequest() + new_send_token_request.from_json(send_token_request) + results =MFAControllerApi(api_client).create_send_token(new_send_token_request) # Below is a request that includes all optional parameters - # api_response = api_instance.create_send_token(Result) + # results = MFAControllerApi(api_client).create_send_token(new_send_token_request) print("The response of MFAControllerApi->create_send_token:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling MFAControllerApi->create_send_token: %s\n" % e) ``` @@ -117,11 +121,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.mfa_controller_api import MFAControllerApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.verification_poll_request import VerificationPollRequest from sailpoint.v3.models.verification_response import VerificationResponse -from sailpoint.v3.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', 'duo-web', 'kba','token', 'rsa' # str | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' verification_poll_request = { "requestId" : "089899f13a8f4da7824996191587bab9" @@ -129,14 +137,14 @@ from pprint import pprint try: # Polling MFA method by VerificationPollRequest - Result = verification_poll_request.from_json(verification_poll_request) - api_response = api_instance.ping_verification_status(method, Result) - + new_verification_poll_request = VerificationPollRequest() + new_verification_poll_request.from_json(verification_poll_request) + results =MFAControllerApi(api_client).ping_verification_status(method, new_verification_poll_request) # Below is a request that includes all optional parameters - # api_response = api_instance.ping_verification_status(method, Result) + # results = MFAControllerApi(api_client).ping_verification_status(method, new_verification_poll_request) print("The response of MFAControllerApi->ping_verification_status:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling MFAControllerApi->ping_verification_status: %s\n" % e) ``` @@ -177,11 +185,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.mfa_controller_api import MFAControllerApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.duo_verification_request import DuoVerificationRequest from sailpoint.v3.models.verification_response import VerificationResponse -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: duo_verification_request = { "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", "userId" : "2c9180947f0ef465017f215cbcfd004b" @@ -189,14 +201,14 @@ from pprint import pprint try: # Verifying authentication via Duo method - Result = duo_verification_request.from_json(duo_verification_request) - api_response = api_instance.send_duo_verify_request(Result) - + new_duo_verification_request = DuoVerificationRequest() + new_duo_verification_request.from_json(duo_verification_request) + results =MFAControllerApi(api_client).send_duo_verify_request(new_duo_verification_request) # Below is a request that includes all optional parameters - # api_response = api_instance.send_duo_verify_request(Result) + # results = MFAControllerApi(api_client).send_duo_verify_request(new_duo_verification_request) print("The response of MFAControllerApi->send_duo_verify_request:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling MFAControllerApi->send_duo_verify_request: %s\n" % e) ``` @@ -237,11 +249,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.mfa_controller_api import MFAControllerApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.kba_answer_request_item import KbaAnswerRequestItem from sailpoint.v3.models.kba_auth_response import KbaAuthResponse -from sailpoint.v3.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", @@ -251,14 +267,14 @@ from pprint import pprint try: # Authenticate KBA provided MFA method - Result = kba_answer_request_item.from_json(kba_answer_request_item) - api_response = api_instance.send_kba_answers(Result) - + new_kba_answer_request_item = KbaAnswerRequestItem() + new_kba_answer_request_item.from_json(kba_answer_request_item) + results =MFAControllerApi(api_client).send_kba_answers(new_kba_answer_request_item) # Below is a request that includes all optional parameters - # api_response = api_instance.send_kba_answers(Result) + # results = MFAControllerApi(api_client).send_kba_answers(new_kba_answer_request_item) print("The response of MFAControllerApi->send_kba_answers:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling MFAControllerApi->send_kba_answers: %s\n" % e) ``` @@ -299,25 +315,29 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.mfa_controller_api import MFAControllerApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.okta_verification_request import OktaVerificationRequest from sailpoint.v3.models.verification_response import VerificationResponse -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: okta_verification_request = { "userId" : "example@mail.com" } # OktaVerificationRequest | try: # Verifying authentication via Okta method - Result = okta_verification_request.from_json(okta_verification_request) - api_response = api_instance.send_okta_verify_request(Result) - + new_okta_verification_request = OktaVerificationRequest() + new_okta_verification_request.from_json(okta_verification_request) + results =MFAControllerApi(api_client).send_okta_verify_request(new_okta_verification_request) # Below is a request that includes all optional parameters - # api_response = api_instance.send_okta_verify_request(Result) + # results = MFAControllerApi(api_client).send_okta_verify_request(new_okta_verification_request) print("The response of MFAControllerApi->send_okta_verify_request:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling MFAControllerApi->send_okta_verify_request: %s\n" % e) ``` @@ -358,11 +378,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.mfa_controller_api import MFAControllerApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.token_auth_request import TokenAuthRequest from sailpoint.v3.models.token_auth_response import TokenAuthResponse -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: token_auth_request = { "userAlias" : "will.albin", "deliveryType" : "EMAIL_WORK", @@ -371,14 +395,14 @@ from pprint import pprint try: # Authenticate Token provided MFA method - Result = token_auth_request.from_json(token_auth_request) - api_response = api_instance.send_token_auth_request(Result) - + new_token_auth_request = TokenAuthRequest() + new_token_auth_request.from_json(token_auth_request) + results =MFAControllerApi(api_client).send_token_auth_request(new_token_auth_request) # Below is a request that includes all optional parameters - # api_response = api_instance.send_token_auth_request(Result) + # results = MFAControllerApi(api_client).send_token_auth_request(new_token_auth_request) print("The response of MFAControllerApi->send_token_auth_request:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ManagedClientsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ManagedClientsApi.md index 386fd9222..617d5461b 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/ManagedClientsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/ManagedClientsApi.md @@ -59,11 +59,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.managed_clients_api import ManagedClientsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.managed_client import ManagedClient from sailpoint.v3.models.managed_client_request import ManagedClientRequest -from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.managed_clients_api import ManagedClientsApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.managed_clients_api import ManagedClientsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.managed_client import ManagedClient -from sailpoint.v3.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.v3 +from sailpoint.v3.api.managed_clients_api import ManagedClientsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.managed_client_status import ManagedClientStatus from sailpoint.v3.models.managed_client_type import ManagedClientType -from sailpoint.v3.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.v3.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.v3 +from sailpoint.v3.api.managed_clients_api import ManagedClientsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.managed_client import ManagedClient -from sailpoint.v3.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.v3 +from sailpoint.v3.api.managed_clients_api import ManagedClientsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.json_patch_operation import JsonPatchOperation from sailpoint.v3.models.managed_client import ManagedClient -from sailpoint.v3.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.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ManagedClustersApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ManagedClustersApi.md index 46845f604..0ca834838 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/ManagedClustersApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/ManagedClustersApi.md @@ -60,11 +60,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.managed_cluster import ManagedCluster from sailpoint.v3.models.managed_cluster_request import ManagedClusterRequest -from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration -from sailpoint.v3.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.v3 +from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.managed_cluster import ManagedCluster -from sailpoint.v3.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.v3 +from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.managed_cluster import ManagedCluster -from sailpoint.v3.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.v3 +from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration from sailpoint.v3.models.put_client_log_configuration_request import PutClientLogConfigurationRequest -from sailpoint.v3.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.v3.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.v3 +from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.json_patch_operation import JsonPatchOperation from sailpoint.v3.models.managed_cluster import ManagedCluster -from sailpoint.v3.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.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/python/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md index 288907f2e..2af9ca977 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md @@ -114,11 +114,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.non_employee_approval_decision import NonEmployeeApprovalDecision from sailpoint.v3.models.non_employee_approval_item import NonEmployeeApprovalItem -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'e136567de87e4d029e60b3c3c55db56d' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) non_employee_approval_decision = { "comment" : "Approved by manager" @@ -126,14 +130,14 @@ from pprint import pprint try: # Approve a Non-Employee Request - Result = non_employee_approval_decision.from_json(non_employee_approval_decision) - api_response = api_instance.approve_non_employee_request(id, Result) - + new_non_employee_approval_decision = NonEmployeeApprovalDecision() + new_non_employee_approval_decision.from_json(non_employee_approval_decision) + results =NonEmployeeLifecycleManagementApi(api_client).approve_non_employee_request(id, new_non_employee_approval_decision) # Below is a request that includes all optional parameters - # api_response = api_instance.approve_non_employee_request(id, Result) + # results = NonEmployeeLifecycleManagementApi(api_client).approve_non_employee_request(id, new_non_employee_approval_decision) print("The response of NonEmployeeLifecycleManagementApi->approve_non_employee_request:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->approve_non_employee_request: %s\n" % e) ``` @@ -175,11 +179,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.non_employee_record import NonEmployeeRecord from sailpoint.v3.models.non_employee_request_body import NonEmployeeRequestBody -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: non_employee_request_body = { "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", @@ -197,14 +205,14 @@ from pprint import pprint try: # Create Non-Employee Record - Result = non_employee_request_body.from_json(non_employee_request_body) - api_response = api_instance.create_non_employee_record(Result) - + new_non_employee_request_body = NonEmployeeRequestBody() + new_non_employee_request_body.from_json(non_employee_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(new_non_employee_request_body) # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_record(Result) + # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(new_non_employee_request_body) print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_record:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_record: %s\n" % e) ``` @@ -245,11 +253,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.non_employee_request import NonEmployeeRequest from sailpoint.v3.models.non_employee_request_body import NonEmployeeRequestBody -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: non_employee_request_body = { "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", @@ -267,14 +279,14 @@ from pprint import pprint try: # Create Non-Employee Request - Result = non_employee_request_body.from_json(non_employee_request_body) - api_response = api_instance.create_non_employee_request(Result) - + new_non_employee_request_body = NonEmployeeRequestBody() + new_non_employee_request_body.from_json(non_employee_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(new_non_employee_request_body) # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_request(Result) + # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(new_non_employee_request_body) print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_request:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_request: %s\n" % e) ``` @@ -315,11 +327,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.non_employee_source_request_body import NonEmployeeSourceRequestBody from sailpoint.v3.models.non_employee_source_with_cloud_external_id import NonEmployeeSourceWithCloudExternalId -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: non_employee_source_request_body = { "owner" : { "id" : "2c91808570313110017040b06f344ec9" @@ -349,14 +365,14 @@ from pprint import pprint try: # Create Non-Employee Source - Result = non_employee_source_request_body.from_json(non_employee_source_request_body) - api_response = api_instance.create_non_employee_source(Result) - + new_non_employee_source_request_body = NonEmployeeSourceRequestBody() + new_non_employee_source_request_body.from_json(non_employee_source_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source(new_non_employee_source_request_body) # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_source(Result) + # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source(new_non_employee_source_request_body) print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source: %s\n" % e) ``` @@ -399,11 +415,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute from sailpoint.v3.models.non_employee_schema_attribute_body import NonEmployeeSchemaAttributeBody -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id non_employee_schema_attribute_body = { "helpText" : "The unique identifier for the account", @@ -416,14 +436,14 @@ from pprint import pprint try: # Create a new Schema Attribute for Non-Employee Source - Result = non_employee_schema_attribute_body.from_json(non_employee_schema_attribute_body) - api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) - + new_non_employee_schema_attribute_body = NonEmployeeSchemaAttributeBody() + new_non_employee_schema_attribute_body.from_json(non_employee_schema_attribute_body) + results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source_schema_attributes(source_id, new_non_employee_schema_attribute_body) # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) + # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source_schema_attributes(source_id, new_non_employee_schema_attribute_body) print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes: %s\n" % e) ``` @@ -465,19 +485,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) try: # Delete Non-Employee Record - api_instance.delete_non_employee_record(id) - + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id) # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_record(id) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_record: %s\n" % e) ``` @@ -518,20 +541,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.delete_non_employee_records_in_bulk_request import DeleteNonEmployeeRecordsInBulkRequest -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: delete_non_employee_records_in_bulk_request = sailpoint.v3.DeleteNonEmployeeRecordsInBulkRequest() # DeleteNonEmployeeRecordsInBulkRequest | Non-Employee bulk delete request body. try: # Delete Multiple Non-Employee Records - Result = delete_non_employee_records_in_bulk_request.from_json(delete_non_employee_records_in_bulk_request) - api_instance.delete_non_employee_records_in_bulk(Result) - + new_delete_non_employee_records_in_bulk_request = DeleteNonEmployeeRecordsInBulkRequest() + new_delete_non_employee_records_in_bulk_request.from_json(delete_non_employee_records_in_bulk_request) + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_records_in_bulk(new_delete_non_employee_records_in_bulk_request) # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_records_in_bulk(Result) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_records_in_bulk(new_delete_non_employee_records_in_bulk_request) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_records_in_bulk: %s\n" % e) ``` @@ -574,19 +601,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'ac110005-7156-1150-8171-5b292e3e0084' # str | Non-Employee request id in the UUID format # str | Non-Employee request id in the UUID format try: # Delete Non-Employee Request - api_instance.delete_non_employee_request(id) - + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_request(id) # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_request(id) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_request(id) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_request: %s\n" % e) ``` @@ -630,20 +660,23 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: attribute_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id try: # Delete a Schema Attribute for Non-Employee Source - api_instance.delete_non_employee_schema_attribute(attribute_id, source_id) - + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_schema_attribute(attribute_id, source_id) # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_schema_attribute(attribute_id, source_id) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_schema_attribute(attribute_id, source_id) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_schema_attribute: %s\n" % e) ``` @@ -684,19 +717,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id try: # Delete Non-Employee Source - api_instance.delete_non_employee_source(source_id) - + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source(source_id) # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_source(source_id) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source(source_id) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source: %s\n" % e) ``` @@ -737,19 +773,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id try: # Delete all custom schema attributes for Non-Employee Source - api_instance.delete_non_employee_source_schema_attributes(source_id) - + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source_schema_attributes(source_id) # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_source_schema_attributes(source_id) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source_schema_attributes(source_id) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source_schema_attributes: %s\n" % e) ``` @@ -791,19 +830,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) try: # Exports Non-Employee Records to CSV - api_instance.export_non_employee_records(id) - + NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(id) # Below is a request that includes all optional parameters - # api_instance.export_non_employee_records(id) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(id) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_records: %s\n" % e) ``` @@ -845,19 +887,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id (UUID) # str | Source Id (UUID) try: # Exports Source Schema Template - api_instance.export_non_employee_source_schema_template(id) - + NonEmployeeLifecycleManagementApi(api_client).export_non_employee_source_schema_template(id) # Below is a request that includes all optional parameters - # api_instance.export_non_employee_source_schema_template(id) - except Exception as e: + # NonEmployeeLifecycleManagementApi(api_client).export_non_employee_source_schema_template(id) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_source_schema_template: %s\n" % e) ``` @@ -902,23 +947,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.non_employee_approval_item_detail import NonEmployeeApprovalItemDetail -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'e136567de87e4d029e60b3c3c55db56d' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) include_detail = true # bool | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) # bool | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) try: # Get a non-employee approval item detail - api_response = api_instance.get_non_employee_approval(id, ) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_approval(id, include_detail) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval(id, include_detail) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval: %s\n" % e) ``` @@ -963,22 +1011,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.non_employee_approval_summary import NonEmployeeApprovalSummary -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: requested_for = '2c91808280430dfb0180431a59440460' # str | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # str | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. try: # Get Summary of Non-Employee Approval Requests - api_response = api_instance.get_non_employee_approval_summary(requested_for) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval_summary(requested_for) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_approval_summary(requested_for) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval_summary(requested_for) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary: %s\n" % e) ``` @@ -1021,22 +1072,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.non_employee_bulk_upload_status import NonEmployeeBulkUploadStatus -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source ID (UUID) # str | Source ID (UUID) try: # Obtain the status of bulk upload on the source - api_response = api_instance.get_non_employee_bulk_upload_status(id) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_bulk_upload_status(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_bulk_upload_status(id) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_bulk_upload_status(id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status: %s\n" % e) ``` @@ -1078,22 +1132,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.non_employee_record import NonEmployeeRecord -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) try: # Get a Non-Employee Record - api_response = api_instance.get_non_employee_record(id) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_record(id) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_record:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_record: %s\n" % e) ``` @@ -1139,22 +1196,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.non_employee_request import NonEmployeeRequest -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'ac110005-7156-1150-8171-5b292e3e0084' # str | Non-Employee request id (UUID) # str | Non-Employee request id (UUID) try: # Get a Non-Employee Request - api_response = api_instance.get_non_employee_request(id) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_request(id) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request: %s\n" % e) ``` @@ -1199,22 +1259,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.non_employee_request_summary import NonEmployeeRequestSummary -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: requested_for = '2c91808280430dfb0180431a59440460' # str | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # str | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. try: # Get Summary of Non-Employee Requests - api_response = api_instance.get_non_employee_request_summary(requested_for) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request_summary(requested_for) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_request_summary(requested_for) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request_summary(requested_for) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request_summary:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request_summary: %s\n" % e) ``` @@ -1256,23 +1319,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: attribute_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id try: # Get Schema Attribute Non-Employee Source - api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_schema_attribute(attribute_id, source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_schema_attribute(attribute_id, source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute: %s\n" % e) ``` @@ -1317,22 +1383,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.non_employee_source import NonEmployeeSource -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c91808b7c28b350017c2a2ec5790aa1' # str | Source Id # str | Source Id try: # Get a Non-Employee Source - api_response = api_instance.get_non_employee_source(source_id) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source(source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_source(source_id) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source(source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source: %s\n" % e) ``` @@ -1375,22 +1444,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id try: # List Schema Attributes Non-Employee Source - api_response = api_instance.get_non_employee_source_schema_attributes(source_id) - + results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_source_schema_attributes(source_id) + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) ``` @@ -1433,23 +1505,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.non_employee_bulk_upload_job import NonEmployeeBulkUploadJob -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) data = None # bytearray | # bytearray | try: # Imports, or Updates, Non-Employee Records - api_response = api_instance.import_non_employee_records_in_bulk(id, data) - + results =NonEmployeeLifecycleManagementApi(api_client).import_non_employee_records_in_bulk(id, data) # Below is a request that includes all optional parameters - # api_response = api_instance.import_non_employee_records_in_bulk(id, data) + # results = NonEmployeeLifecycleManagementApi(api_client).import_non_employee_records_in_bulk(id, data) print("The response of NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk: %s\n" % e) ``` @@ -1499,10 +1574,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.non_employee_approval_item import NonEmployeeApprovalItem -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: requested_for = '2c91808280430dfb0180431a59440460' # str | The identity for whom the request was made. *me* indicates the current user. (optional) # str | The identity for whom the request was made. *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) @@ -1513,13 +1592,12 @@ from pprint import pprint try: # Get List of Non-Employee Approval Requests - api_response = api_instance.list_non_employee_approvals() - + results =NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals() # Below is a request that includes all optional parameters - # api_response = api_instance.list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) + # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) ``` @@ -1566,10 +1644,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.non_employee_record import NonEmployeeRecord -from sailpoint.v3.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) @@ -1579,13 +1661,12 @@ from pprint import pprint try: # List Non-Employee Records - api_response = api_instance.list_non_employee_records() - + results =NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records() # Below is a request that includes all optional parameters - # api_response = api_instance.list_non_employee_records(limit, offset, count, sorters, filters) + # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) ``` @@ -1635,10 +1716,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.non_employee_request import NonEmployeeRequest -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: requested_for = 'e136567de87e4d029e60b3c3c55db56d' # str | The identity for whom the request was made. *me* indicates the current user. # str | The identity for whom the request was made. *me* indicates the current user. 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) @@ -1649,13 +1734,12 @@ from pprint import pprint try: # List Non-Employee Requests - api_response = api_instance.list_non_employee_requests(requested_for, ) - + results =NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, ) # Below is a request that includes all optional parameters - # api_response = api_instance.list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) + # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) ``` @@ -1705,10 +1789,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.non_employee_source_with_ne_count import NonEmployeeSourceWithNECount -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: requested_for = 'me' # str | The identity for whom the request was made. *me* indicates the current user. # str | The identity for whom the request was made. *me* indicates the current user. 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) @@ -1719,13 +1807,12 @@ from pprint import pprint try: # List Non-Employee Sources - api_response = api_instance.list_non_employee_sources(requested_for, ) - + results =NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(requested_for, ) # Below is a request that includes all optional parameters - # api_response = api_instance.list_non_employee_sources(requested_for, limit, offset, count, non_employee_count, sorters) + # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(requested_for, limit, offset, count, non_employee_count, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) ``` @@ -1772,11 +1859,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.json_patch_operation import JsonPatchOperation from sailpoint.v3.models.non_employee_record import NonEmployeeRecord -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) [{op=replace, path=/endDate, value=2019-08-23T18:40:35.772Z}] # List[JsonPatchOperation] | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. json_patch_operation = { @@ -1788,14 +1879,14 @@ from pprint import pprint try: # Patch Non-Employee Record - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_non_employee_record(id, Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id, new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_non_employee_record(id, Result) + # results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id, new_json_patch_operation) print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_record:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_record: %s\n" % e) ``` @@ -1841,11 +1932,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.json_patch_operation import JsonPatchOperation from sailpoint.v3.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: attribute_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id [{op=replace, path=/label, value={new attribute label=null}}] # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. @@ -1858,14 +1953,14 @@ from pprint import pprint try: # Patch a Schema Attribute for Non-Employee Source - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_schema_attribute(attribute_id, source_id, new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) + # results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_schema_attribute(attribute_id, source_id, new_json_patch_operation) print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute: %s\n" % e) ``` @@ -1907,11 +2002,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.json_patch_operation import JsonPatchOperation from sailpoint.v3.models.non_employee_source import NonEmployeeSource -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id [{op=replace, path=/name, value={new name=null}}, {op=replace, path=/approvers, value=[2c91809f703bb37a017040a2fe8748c7, 48b1f463c9e8427db5a5071bd81914b8]}] # List[JsonPatchOperation] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. json_patch_operation = { @@ -1923,14 +2022,14 @@ from pprint import pprint try: # Patch a Non-Employee Source - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_non_employee_source(source_id, Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id, new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.patch_non_employee_source(source_id, Result) + # results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id, new_json_patch_operation) print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_source: %s\n" % e) ``` @@ -1972,11 +2071,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.non_employee_approval_item import NonEmployeeApprovalItem from sailpoint.v3.models.non_employee_reject_approval_decision import NonEmployeeRejectApprovalDecision -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'e136567de87e4d029e60b3c3c55db56d' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) non_employee_reject_approval_decision = { "comment" : "approved" @@ -1984,14 +2087,14 @@ from pprint import pprint try: # Reject a Non-Employee Request - Result = non_employee_reject_approval_decision.from_json(non_employee_reject_approval_decision) - api_response = api_instance.reject_non_employee_request(id, Result) - + new_non_employee_reject_approval_decision = NonEmployeeRejectApprovalDecision() + new_non_employee_reject_approval_decision.from_json(non_employee_reject_approval_decision) + results =NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id, new_non_employee_reject_approval_decision) # Below is a request that includes all optional parameters - # api_response = api_instance.reject_non_employee_request(id, Result) + # results = NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id, new_non_employee_reject_approval_decision) print("The response of NonEmployeeLifecycleManagementApi->reject_non_employee_request:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->reject_non_employee_request: %s\n" % e) ``` @@ -2038,11 +2141,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.non_employee_record import NonEmployeeRecord from sailpoint.v3.models.non_employee_request_body import NonEmployeeRequestBody -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) non_employee_request_body = { "sourceId" : "2c91808568c529c60168cca6f90c1313", @@ -2061,14 +2168,14 @@ from pprint import pprint try: # Update Non-Employee Record - Result = non_employee_request_body.from_json(non_employee_request_body) - api_response = api_instance.update_non_employee_record(id, Result) - + new_non_employee_request_body = NonEmployeeRequestBody() + new_non_employee_request_body.from_json(non_employee_request_body) + results =NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id, new_non_employee_request_body) # Below is a request that includes all optional parameters - # api_response = api_instance.update_non_employee_record(id, Result) + # results = NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id, new_non_employee_request_body) print("The response of NonEmployeeLifecycleManagementApi->update_non_employee_record:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->update_non_employee_record: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/OAuthClientsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/OAuthClientsApi.md index e11f00b5c..bbe83e549 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/OAuthClientsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/OAuthClientsApi.md @@ -58,11 +58,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.create_o_auth_client_request import CreateOAuthClientRequest from sailpoint.v3.models.create_o_auth_client_response import CreateOAuthClientResponse -from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.get_o_auth_client_response import GetOAuthClientResponse -from sailpoint.v3.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.v3 +from sailpoint.v3.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.get_o_auth_client_response import GetOAuthClientResponse -from sailpoint.v3.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.v3 +from sailpoint.v3.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.get_o_auth_client_response import GetOAuthClientResponse from sailpoint.v3.models.json_patch_operation import JsonPatchOperation -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PasswordConfigurationApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PasswordConfigurationApi.md index 9da5f7881..2f097be02 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/PasswordConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/PasswordConfigurationApi.md @@ -61,10 +61,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.password_configuration_api import PasswordConfigurationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.password_org_config import PasswordOrgConfig -from sailpoint.v3.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.v3 +from sailpoint.v3.api.password_configuration_api import PasswordConfigurationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.password_org_config import PasswordOrgConfig -from sailpoint.v3.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.v3 +from sailpoint.v3.api.password_configuration_api import PasswordConfigurationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.password_org_config import PasswordOrgConfig -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PasswordDictionaryApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PasswordDictionaryApi.md index b7bd52448..4eafc6eb3 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/PasswordDictionaryApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/PasswordDictionaryApi.md @@ -125,20 +125,23 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.password_dictionary_api import PasswordDictionaryApi +from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.password_dictionary_api import PasswordDictionaryApi +from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PasswordManagementApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PasswordManagementApi.md index 30f9c30a3..d1df26f6e 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/PasswordManagementApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/PasswordManagementApi.md @@ -78,22 +78,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.password_management_api import PasswordManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.password_status import PasswordStatus -from sailpoint.v3.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) ``` @@ -135,11 +138,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.password_management_api import PasswordManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.password_info import PasswordInfo from sailpoint.v3.models.password_info_query_dto import PasswordInfoQueryDTO -from sailpoint.v3.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" @@ -147,14 +154,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) ``` @@ -214,11 +221,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.password_management_api import PasswordManagementApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.password_change_request import PasswordChangeRequest from sailpoint.v3.models.password_change_response import PasswordChangeResponse -from sailpoint.v3.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", @@ -229,14 +240,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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PasswordPoliciesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PasswordPoliciesApi.md index 20221232a..423deb9ff 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/PasswordPoliciesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/PasswordPoliciesApi.md @@ -64,10 +64,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.password_policies_api import PasswordPoliciesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.password_policy_v3_dto import PasswordPolicyV3Dto -from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.password_policies_api import PasswordPoliciesApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.password_policies_api import PasswordPoliciesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.password_policy_v3_dto import PasswordPolicyV3Dto -from sailpoint.v3.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.v3 +from sailpoint.v3.api.password_policies_api import PasswordPoliciesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.password_policy_v3_dto import PasswordPolicyV3Dto -from sailpoint.v3.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.v3 +from sailpoint.v3.api.password_policies_api import PasswordPoliciesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.password_policy_v3_dto import PasswordPolicyV3Dto -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PasswordSyncGroupsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PasswordSyncGroupsApi.md index f99334887..14fd199d6 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/PasswordSyncGroupsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/PasswordSyncGroupsApi.md @@ -87,10 +87,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.password_sync_group import PasswordSyncGroup -from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.password_sync_group import PasswordSyncGroup -from sailpoint.v3.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.v3 +from sailpoint.v3.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.password_sync_group import PasswordSyncGroup -from sailpoint.v3.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.v3 +from sailpoint.v3.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.password_sync_group import PasswordSyncGroup -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PersonalAccessTokensApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PersonalAccessTokensApi.md index d9b5e0b28..01c5f4d5b 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/PersonalAccessTokensApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/PersonalAccessTokensApi.md @@ -65,11 +65,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.personal_access_tokens_api import PersonalAccessTokensApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.create_personal_access_token_request import CreatePersonalAccessTokenRequest from sailpoint.v3.models.create_personal_access_token_response import CreatePersonalAccessTokenResponse -from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.personal_access_tokens_api import PersonalAccessTokensApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.personal_access_tokens_api import PersonalAccessTokensApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.get_personal_access_token_response import GetPersonalAccessTokenResponse -from sailpoint.v3.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.v3 +from sailpoint.v3.api.personal_access_tokens_api import PersonalAccessTokensApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.get_personal_access_token_response import GetPersonalAccessTokenResponse from sailpoint.v3.models.json_patch_operation import JsonPatchOperation -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesApi.md index be5c946dc..3591f81e8 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesApi.md @@ -59,10 +59,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.public_identities_api import PublicIdentitiesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.public_identity import PublicIdentity -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesConfigApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesConfigApi.md index ccf111a9b..49a6e051c 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesConfigApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesConfigApi.md @@ -59,21 +59,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.public_identities_config_api import PublicIdentitiesConfigApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.public_identity_config import PublicIdentityConfig -from sailpoint.v3.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.v3 +from sailpoint.v3.api.public_identities_config_api import PublicIdentitiesConfigApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.public_identity_config import PublicIdentityConfig -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ReportsDataExtractionApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ReportsDataExtractionApi.md index d4220c643..522fd1e7d 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/ReportsDataExtractionApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/ReportsDataExtractionApi.md @@ -57,19 +57,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi +from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.report_results import ReportResults -from sailpoint.v3.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.v3 +from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.report_details import ReportDetails from sailpoint.v3.models.task_result_details import TaskResultDetails -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/RequestableObjectsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/RequestableObjectsApi.md index f90deee20..046bc3b5d 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/RequestableObjectsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/RequestableObjectsApi.md @@ -63,12 +63,16 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.requestable_objects_api import RequestableObjectsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.requestable_object import RequestableObject from sailpoint.v3.models.requestable_object_request_status import RequestableObjectRequestStatus from sailpoint.v3.models.requestable_object_type import RequestableObjectType -from sailpoint.v3.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.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/RolesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/RolesApi.md index d782200e1..ba53ac347 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/RolesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/RolesApi.md @@ -97,10 +97,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.roles_api import RolesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.role import Role -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: role = { "owner" : { "name" : "support", @@ -262,14 +266,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) ``` @@ -313,25 +317,29 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.roles_api import RolesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.role_bulk_delete_request import RoleBulkDeleteRequest from sailpoint.v3.models.task_result_dto import TaskResultDto -from sailpoint.v3.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) ``` @@ -374,19 +382,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.roles_api import RolesApi +from sailpoint.v3.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) ``` @@ -428,22 +439,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.roles_api import RolesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.role import Role -from sailpoint.v3.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) ``` @@ -489,10 +503,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.roles_api import RolesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.role_identity import RoleIdentity -from sailpoint.v3.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) @@ -503,13 +521,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) ``` @@ -557,10 +574,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.roles_api import RolesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.role import Role -from sailpoint.v3.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) @@ -573,13 +594,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) ``` @@ -640,11 +660,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.roles_api import RolesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.json_patch_operation import JsonPatchOperation from sailpoint.v3.models.role import Role -from sailpoint.v3.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 = { @@ -656,14 +680,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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SODPoliciesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SODPoliciesApi.md index 41fa007ff..51cc81ddb 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SODPoliciesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SODPoliciesApi.md @@ -94,10 +94,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.sod_policy import SodPolicy -from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.report_result_reference import ReportResultReference -from sailpoint.v3.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.v3 +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.sod_policy import SodPolicy -from sailpoint.v3.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.v3 +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule -from sailpoint.v3.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.v3 +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.report_result_reference import ReportResultReference -from sailpoint.v3.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.v3 +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.report_result_reference import ReportResultReference -from sailpoint.v3.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.v3 +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.sod_policy import SodPolicy -from sailpoint.v3.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.v3 +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.json_patch_operation import JsonPatchOperation from sailpoint.v3.models.sod_policy import SodPolicy -from sailpoint.v3.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.v3 +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule -from sailpoint.v3.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" : { @@ -890,14 +932,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) ``` @@ -941,10 +983,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.sod_policy import SodPolicy -from sailpoint.v3.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" : { @@ -1005,14 +1051,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) ``` @@ -1053,22 +1099,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.report_result_reference import ReportResultReference -from sailpoint.v3.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) ``` @@ -1109,11 +1158,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.multi_policy_request import MultiPolicyRequest from sailpoint.v3.models.report_result_reference import ReportResultReference -from sailpoint.v3.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) @@ -1121,13 +1174,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) ``` @@ -1169,22 +1221,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.report_result_reference import ReportResultReference -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SODViolationsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SODViolationsApi.md index abe0873c5..395648557 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SODViolationsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SODViolationsApi.md @@ -71,11 +71,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sod_violations_api import SODViolationsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.identity_with_new_access import IdentityWithNewAccess from sailpoint.v3.models.violation_prediction import ViolationPrediction -from sailpoint.v3.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.v3 +from sailpoint.v3.api.sod_violations_api import SODViolationsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.identity_with_new_access1 import IdentityWithNewAccess1 from sailpoint.v3.models.sod_violation_check import SodViolationCheck -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SavedSearchApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SavedSearchApi.md index 92482604c..7f03ac46c 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SavedSearchApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SavedSearchApi.md @@ -67,23 +67,27 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.saved_search_api import SavedSearchApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.create_saved_search_request import CreateSavedSearchRequest from sailpoint.v3.models.saved_search import SavedSearch -from sailpoint.v3.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.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.saved_search_api import SavedSearchApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.saved_search_api import SavedSearchApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.search_arguments import SearchArguments -from sailpoint.v3.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.v3 +from sailpoint.v3.api.saved_search_api import SavedSearchApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.saved_search import SavedSearch -from sailpoint.v3.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.v3 +from sailpoint.v3.api.saved_search_api import SavedSearchApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.saved_search import SavedSearch -from sailpoint.v3.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.v3 +from sailpoint.v3.api.saved_search_api import SavedSearchApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.saved_search import SavedSearch -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ScheduledSearchApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ScheduledSearchApi.md index 8ecc78775..d1e3fd70b 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/ScheduledSearchApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/ScheduledSearchApi.md @@ -84,23 +84,27 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.create_scheduled_search_request import CreateScheduledSearchRequest from sailpoint.v3.models.scheduled_search import ScheduledSearch -from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.scheduled_search import ScheduledSearch -from sailpoint.v3.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.v3 +from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.scheduled_search import ScheduledSearch -from sailpoint.v3.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.v3 +from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.typed_reference import TypedReference -from sailpoint.v3.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.v3 +from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.scheduled_search import ScheduledSearch -from sailpoint.v3.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" : { @@ -429,14 +450,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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SearchApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SearchApi.md index 38fab0636..65f05defb 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SearchApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SearchApi.md @@ -80,11 +80,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.search_api import SearchApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.aggregation_result import AggregationResult from sailpoint.v3.models.search import Search -from sailpoint.v3.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.v3 +from sailpoint.v3.api.search_api import SearchApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.search import Search -from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.search_api import SearchApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.search_api import SearchApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.search import Search -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SearchAttributeConfigurationApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SearchAttributeConfigurationApi.md index 18533c97a..3cc89283e 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SearchAttributeConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SearchAttributeConfigurationApi.md @@ -74,10 +74,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.search_attribute_config import SearchAttributeConfig -from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.search_attribute_config import SearchAttributeConfig -from sailpoint.v3.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.v3 +from sailpoint.v3.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.search_attribute_config import SearchAttributeConfig -from sailpoint.v3.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.v3 +from sailpoint.v3.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.json_patch_operation import JsonPatchOperation from sailpoint.v3.models.search_attribute_config import SearchAttributeConfig -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SegmentsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SegmentsApi.md index b9bec2020..afe1d6250 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SegmentsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SegmentsApi.md @@ -73,10 +73,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.segments_api import SegmentsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.segment import Segment -from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.segments_api import SegmentsApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.segments_api import SegmentsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.segment import Segment -from sailpoint.v3.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.v3 +from sailpoint.v3.api.segments_api import SegmentsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.segment import Segment -from sailpoint.v3.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.v3 +from sailpoint.v3.api.segments_api import SegmentsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.segment import Segment -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ServiceDeskIntegrationApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ServiceDeskIntegrationApi.md index d255b40c2..29c5c9b22 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/ServiceDeskIntegrationApi.md @@ -85,10 +85,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.service_desk_integration_dto import ServiceDeskIntegrationDto -from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.service_desk_integration_dto import ServiceDeskIntegrationDto -from sailpoint.v3.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.v3 +from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto -from sailpoint.v3.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.v3 +from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType -from sailpoint.v3.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.v3 +from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.service_desk_integration_dto import ServiceDeskIntegrationDto -from sailpoint.v3.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.v3 +from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.queued_check_config_details import QueuedCheckConfigDetails -from sailpoint.v3.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.v3 +from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest from sailpoint.v3.models.service_desk_integration_dto import ServiceDeskIntegrationDto -from sailpoint.v3.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.v3.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.v3 +from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.service_desk_integration_dto import ServiceDeskIntegrationDto -from sailpoint.v3.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.v3 +from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.queued_check_config_details import QueuedCheckConfigDetails -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SourceUsagesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SourceUsagesApi.md index 4e6db30e6..42d24417b 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SourceUsagesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SourceUsagesApi.md @@ -55,22 +55,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.source_usages_api import SourceUsagesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.source_usage_status import SourceUsageStatus -from sailpoint.v3.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.v3 +from sailpoint.v3.api.source_usages_api import SourceUsagesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.source_usage import SourceUsage -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SourcesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SourcesApi.md index c8a4a5862..467d7d396 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SourcesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SourcesApi.md @@ -137,10 +137,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.provisioning_policy_dto import ProvisioningPolicyDto -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id provisioning_policy_dto = { "name" : "example provisioning policy for inactive identities", @@ -185,14 +189,14 @@ from pprint import pprint try: # Create Provisioning Policy - Result = provisioning_policy_dto.from_json(provisioning_policy_dto) - api_response = api_instance.create_provisioning_policy(source_id, Result) - + new_provisioning_policy_dto = ProvisioningPolicyDto() + new_provisioning_policy_dto.from_json(provisioning_policy_dto) + results =SourcesApi(api_client).create_provisioning_policy(source_id, new_provisioning_policy_dto) # Below is a request that includes all optional parameters - # api_response = api_instance.create_provisioning_policy(source_id, Result) + # results = SourcesApi(api_client).create_provisioning_policy(source_id, new_provisioning_policy_dto) print("The response of SourcesApi->create_provisioning_policy:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) ``` @@ -234,10 +238,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.source import Source -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source = { "cluster" : { "name" : "Corporate Cluster", @@ -325,14 +333,14 @@ from pprint import pprint try: # Creates a source in IdentityNow. - Result = source.from_json(source) - api_response = api_instance.create_source(Result, ) - + new_source = Source() + new_source.from_json(source) + results =SourcesApi(api_client).create_source(new_source, ) # Below is a request that includes all optional parameters - # api_response = api_instance.create_source(Result, provision_as_csv) + # results = SourcesApi(api_client).create_source(new_source, provision_as_csv) print("The response of SourcesApi->create_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->create_source: %s\n" % e) ``` @@ -375,23 +383,27 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.model_schema import ModelSchema -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. model_schema = sailpoint.v3.ModelSchema() # ModelSchema | try: # Create Schema on Source - Result = model_schema.from_json(model_schema) - api_response = api_instance.create_source_schema(source_id, Result) - + new_model_schema = ModelSchema() + new_model_schema.from_json(model_schema) + results =SourcesApi(api_client).create_source_schema(source_id, new_model_schema) # Below is a request that includes all optional parameters - # api_response = api_instance.create_source_schema(source_id, Result) + # results = SourcesApi(api_client).create_source_schema(source_id, new_model_schema) print("The response of SourcesApi->create_source_schema:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) ``` @@ -434,21 +446,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.usage_type import UsageType -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. usage_type = sailpoint.v3.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. try: # Delete Provisioning Policy by UsageType - api_instance.delete_provisioning_policy(source_id, usage_type) - + SourcesApi(api_client).delete_provisioning_policy(source_id, usage_type) # Below is a request that includes all optional parameters - # api_instance.delete_provisioning_policy(source_id, usage_type) - except Exception as e: + # SourcesApi(api_client).delete_provisioning_policy(source_id, usage_type) + except Exception as e: print("Exception when calling SourcesApi->delete_provisioning_policy: %s\n" % e) ``` @@ -491,22 +506,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.delete_source202_response import DeleteSource202Response -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. try: # Delete Source by ID - api_response = api_instance.delete_source(id) - + results =SourcesApi(api_client).delete_source(id) # Below is a request that includes all optional parameters - # api_response = api_instance.delete_source(id) + # results = SourcesApi(api_client).delete_source(id) print("The response of SourcesApi->delete_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->delete_source: %s\n" % e) ``` @@ -549,20 +567,23 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. try: # Delete Source Schema by ID - api_instance.delete_source_schema(source_id, schema_id) - + SourcesApi(api_client).delete_source_schema(source_id, schema_id) # Below is a request that includes all optional parameters - # api_instance.delete_source_schema(source_id, schema_id) - except Exception as e: + # SourcesApi(api_client).delete_source_schema(source_id, schema_id) + except Exception as e: print("Exception when calling SourcesApi->delete_source_schema: %s\n" % e) ``` @@ -605,19 +626,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.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 Source id # str | The Source id try: # Downloads source accounts schema template - api_instance.get_accounts_schema(id) - + SourcesApi(api_client).get_accounts_schema(id) # Below is a request that includes all optional parameters - # api_instance.get_accounts_schema(id) - except Exception as e: + # SourcesApi(api_client).get_accounts_schema(id) + except Exception as e: print("Exception when calling SourcesApi->get_accounts_schema: %s\n" % e) ``` @@ -662,20 +686,23 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.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 Source id # str | The Source id schema_name = '?schemaName=group' # str | Name of entitlement schema (optional) # str | Name of entitlement schema (optional) try: # Downloads source entitlements schema template - api_instance.get_entitlements_schema(id, ) - + SourcesApi(api_client).get_entitlements_schema(id, ) # Below is a request that includes all optional parameters - # api_instance.get_entitlements_schema(id, schema_name) - except Exception as e: + # SourcesApi(api_client).get_entitlements_schema(id, schema_name) + except Exception as e: print("Exception when calling SourcesApi->get_entitlements_schema: %s\n" % e) ``` @@ -718,24 +745,27 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.provisioning_policy_dto import ProvisioningPolicyDto from sailpoint.v3.models.usage_type import UsageType -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. usage_type = sailpoint.v3.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. try: # Get Provisioning Policy by UsageType - api_response = api_instance.get_provisioning_policy(source_id, usage_type) - + results =SourcesApi(api_client).get_provisioning_policy(source_id, usage_type) # Below is a request that includes all optional parameters - # api_response = api_instance.get_provisioning_policy(source_id, usage_type) + # results = SourcesApi(api_client).get_provisioning_policy(source_id, usage_type) print("The response of SourcesApi->get_provisioning_policy:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) ``` @@ -777,22 +807,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.source import Source -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. try: # Get Source by ID - api_response = api_instance.get_source(id) - + results =SourcesApi(api_client).get_source(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_source(id) + # results = SourcesApi(api_client).get_source(id) print("The response of SourcesApi->get_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_source: %s\n" % e) ``` @@ -834,22 +867,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.source_connections_dto import SourceConnectionsDto -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. try: # Get Source Connections by ID - api_response = api_instance.get_source_connections(id) - + results =SourcesApi(api_client).get_source_connections(id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_connections(id) + # results = SourcesApi(api_client).get_source_connections(id) print("The response of SourcesApi->get_source_connections:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_source_connections: %s\n" % e) ``` @@ -891,22 +927,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.source_health_dto import SourceHealthDto -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. try: # Fetches source health by id - api_response = api_instance.get_source_health(source_id) - + results =SourcesApi(api_client).get_source_health(source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_health(source_id) + # results = SourcesApi(api_client).get_source_health(source_id) print("The response of SourcesApi->get_source_health:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_source_health: %s\n" % e) ``` @@ -950,23 +989,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.model_schema import ModelSchema -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. try: # Get Source Schema by ID - api_response = api_instance.get_source_schema(source_id, schema_id) - + results =SourcesApi(api_client).get_source_schema(source_id, schema_id) # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_schema(source_id, schema_id) + # results = SourcesApi(api_client).get_source_schema(source_id, schema_id) print("The response of SourcesApi->get_source_schema:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) ``` @@ -1010,10 +1052,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.model_schema import ModelSchema -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. include_types = 'group' # str | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) # str | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) include_names = 'account' # str | A comma-separated list of schema names to filter result. (optional) # str | A comma-separated list of schema names to filter result. (optional) @@ -1021,13 +1067,12 @@ from pprint import pprint try: # List Schemas on Source - api_response = api_instance.get_source_schemas(source_id, ) - + results =SourcesApi(api_client).get_source_schemas(source_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_schemas(source_id, include_types, include_names) + # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) print("The response of SourcesApi->get_source_schemas:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) ``` @@ -1075,23 +1120,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.model_schema import ModelSchema -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id file = None # bytearray | (optional) # bytearray | (optional) try: # Uploads source accounts schema template - api_response = api_instance.import_accounts_schema(id, ) - + results =SourcesApi(api_client).import_accounts_schema(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.import_accounts_schema(id, file) + # results = SourcesApi(api_client).import_accounts_schema(id, file) print("The response of SourcesApi->import_accounts_schema:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->import_accounts_schema: %s\n" % e) ``` @@ -1133,23 +1181,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.source import Source -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. file = None # bytearray | (optional) # bytearray | (optional) try: # Upload connector file to source - api_response = api_instance.import_connector_file(source_id, ) - + results =SourcesApi(api_client).import_connector_file(source_id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.import_connector_file(source_id, file) + # results = SourcesApi(api_client).import_connector_file(source_id, file) print("The response of SourcesApi->import_connector_file:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->import_connector_file: %s\n" % e) ``` @@ -1198,10 +1249,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.model_schema import ModelSchema -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id schema_name = '?schemaName=group' # str | Name of entitlement schema (optional) # str | Name of entitlement schema (optional) file = None # bytearray | (optional) # bytearray | (optional) @@ -1209,13 +1264,12 @@ from pprint import pprint try: # Uploads source entitlements schema template - api_response = api_instance.import_entitlements_schema(id, ) - + results =SourcesApi(api_client).import_entitlements_schema(id, ) # Below is a request that includes all optional parameters - # api_response = api_instance.import_entitlements_schema(id, schema_name, file) + # results = SourcesApi(api_client).import_entitlements_schema(id, schema_name, file) print("The response of SourcesApi->import_entitlements_schema:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->import_entitlements_schema: %s\n" % e) ``` @@ -1257,22 +1311,25 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.provisioning_policy_dto import ProvisioningPolicyDto -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id try: # Lists ProvisioningPolicies - api_response = api_instance.list_provisioning_policies(source_id) - + results =SourcesApi(api_client).list_provisioning_policies(source_id) # Below is a request that includes all optional parameters - # api_response = api_instance.list_provisioning_policies(source_id) + # results = SourcesApi(api_client).list_provisioning_policies(source_id) print("The response of SourcesApi->list_provisioning_policies:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) ``` @@ -1320,10 +1377,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.source import Source -from sailpoint.v3.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) @@ -1335,13 +1396,12 @@ from pprint import pprint try: # Lists all sources in IdentityNow. - api_response = api_instance.list_sources() - + results =SourcesApi(api_client).list_sources() # Below is a request that includes all optional parameters - # api_response = api_instance.list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) + # results = SourcesApi(api_client).list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) print("The response of SourcesApi->list_sources:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->list_sources: %s\n" % e) ``` @@ -1387,11 +1447,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.provisioning_policy_dto import ProvisioningPolicyDto from sailpoint.v3.models.usage_type import UsageType -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. usage_type = sailpoint.v3.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. provisioning_policy_dto = { @@ -1437,14 +1501,14 @@ from pprint import pprint try: # Update Provisioning Policy by UsageType - Result = provisioning_policy_dto.from_json(provisioning_policy_dto) - api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) - + new_provisioning_policy_dto = ProvisioningPolicyDto() + new_provisioning_policy_dto.from_json(provisioning_policy_dto) + results =SourcesApi(api_client).put_provisioning_policy(source_id, usage_type, new_provisioning_policy_dto) # Below is a request that includes all optional parameters - # api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) + # results = SourcesApi(api_client).put_provisioning_policy(source_id, usage_type, new_provisioning_policy_dto) print("The response of SourcesApi->put_provisioning_policy:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) ``` @@ -1499,10 +1563,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.source import Source -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. source = { "cluster" : { @@ -1590,14 +1658,14 @@ from pprint import pprint try: # Update Source (Full) - Result = source.from_json(source) - api_response = api_instance.put_source(id, Result) - + new_source = Source() + new_source.from_json(source) + results =SourcesApi(api_client).put_source(id, new_source) # Below is a request that includes all optional parameters - # api_response = api_instance.put_source(id, Result) + # results = SourcesApi(api_client).put_source(id, new_source) print("The response of SourcesApi->put_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->put_source: %s\n" % e) ``` @@ -1651,24 +1719,28 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.model_schema import ModelSchema -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. model_schema = sailpoint.v3.ModelSchema() # ModelSchema | try: # Update Source Schema (Full) - Result = model_schema.from_json(model_schema) - api_response = api_instance.put_source_schema(source_id, schema_id, Result) - + new_model_schema = ModelSchema() + new_model_schema.from_json(model_schema) + results =SourcesApi(api_client).put_source_schema(source_id, schema_id, new_model_schema) # Below is a request that includes all optional parameters - # api_response = api_instance.put_source_schema(source_id, schema_id, Result) + # results = SourcesApi(api_client).put_source_schema(source_id, schema_id, new_model_schema) print("The response of SourcesApi->put_source_schema:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) ``` @@ -1711,10 +1783,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.provisioning_policy_dto import ProvisioningPolicyDto -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. [sailpoint.v3.ProvisioningPolicyDto()] # List[ProvisioningPolicyDto] | provisioning_policy_dto = { @@ -1761,14 +1837,14 @@ from pprint import pprint try: # Bulk Update Provisioning Policies - Result = provisioning_policy_dto.from_json(provisioning_policy_dto) - api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) - + new_provisioning_policy_dto = ProvisioningPolicyDto() + new_provisioning_policy_dto.from_json(provisioning_policy_dto) + results =SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) # Below is a request that includes all optional parameters - # api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) + # results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) ``` @@ -1814,12 +1890,16 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.json_patch_operation import JsonPatchOperation from sailpoint.v3.models.provisioning_policy_dto import ProvisioningPolicyDto from sailpoint.v3.models.usage_type import UsageType -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. usage_type = sailpoint.v3.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. [{op=add, path=/fields/0, value={name=email, transform={type=identityAttribute, attributes={name=email}}, attributes={}, isRequired=false, type=string, isMultiValued=false}}] # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. @@ -1832,14 +1912,14 @@ from pprint import pprint try: # Partial update of Provisioning Policy - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =SourcesApi(api_client).update_provisioning_policy(source_id, usage_type, new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) + # results = SourcesApi(api_client).update_provisioning_policy(source_id, usage_type, new_json_patch_operation) print("The response of SourcesApi->update_provisioning_policy:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) ``` @@ -1897,11 +1977,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.json_patch_operation import JsonPatchOperation from sailpoint.v3.models.source import Source -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. [{op=replace, path=/description, value=new description}] # List[JsonPatchOperation] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). json_patch_operation = { @@ -1913,14 +1997,14 @@ from pprint import pprint try: # Update Source (Partial) - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_source(id, Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =SourcesApi(api_client).update_source(id, new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.update_source(id, Result) + # results = SourcesApi(api_client).update_source(id, new_json_patch_operation) print("The response of SourcesApi->update_source:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->update_source: %s\n" % e) ``` @@ -1993,11 +2077,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.sources_api import SourcesApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.json_patch_operation import JsonPatchOperation from sailpoint.v3.models.model_schema import ModelSchema -from sailpoint.v3.rest import ApiException from pprint import pprint +from sailpoint.configuration import Configuration +configuration = Configuration() +with ApiClient(configuration) as api_client: source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. [{op=add, path=/attributes/-, value={name=location, type=STRING, schema=null, description=Employee location, isMulti=false, isEntitlement=false, isGroup=false}}] # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. @@ -2010,14 +2098,14 @@ from pprint import pprint try: # Update Source Schema (Partial) - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_source_schema(source_id, schema_id, Result) - + new_json_patch_operation = JsonPatchOperation() + new_json_patch_operation.from_json(json_patch_operation) + results =SourcesApi(api_client).update_source_schema(source_id, schema_id, new_json_patch_operation) # Below is a request that includes all optional parameters - # api_response = api_instance.update_source_schema(source_id, schema_id, Result) + # results = SourcesApi(api_client).update_source_schema(source_id, schema_id, new_json_patch_operation) print("The response of SourcesApi->update_source_schema:\n") - pprint(api_response) - except Exception as e: + pprint(results) + except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/TaggedObjectsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/TaggedObjectsApi.md index 72ff0d453..fe2175115 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/TaggedObjectsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/TaggedObjectsApi.md @@ -112,20 +112,23 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.bulk_remove_tagged_object import BulkRemoveTaggedObject -from sailpoint.v3.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.v3 +from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.tagged_object import TaggedObject -from sailpoint.v3.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.v3 +from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.tagged_object import TaggedObject -from sailpoint.v3.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.v3 +from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.tagged_object import TaggedObject -from sailpoint.v3.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.v3 +from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.tagged_object import TaggedObject -from sailpoint.v3.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.v3 +from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.tagged_object import TaggedObject -from sailpoint.v3.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.v3 +from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.bulk_add_tagged_object import BulkAddTaggedObject from sailpoint.v3.models.bulk_tagged_object_response import BulkTaggedObjectResponse -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/TransformsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/TransformsApi.md index baf9f3cac..4f99bf481 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/TransformsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/TransformsApi.md @@ -62,11 +62,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.transforms_api import TransformsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.transform import Transform from sailpoint.v3.models.transform_read import TransformRead -from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.transforms_api import TransformsApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.transforms_api import TransformsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.transform_read import TransformRead -from sailpoint.v3.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.v3 +from sailpoint.v3.api.transforms_api import TransformsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.transform_read import TransformRead -from sailpoint.v3.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.v3 +from sailpoint.v3.api.transforms_api import TransformsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.transform import Transform from sailpoint.v3.models.transform_read import TransformRead -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/VendorConnectorMappingsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/VendorConnectorMappingsApi.md index 5f4bd1138..0d8b96533 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/VendorConnectorMappingsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/VendorConnectorMappingsApi.md @@ -55,10 +55,14 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.vendor_connector_mappings_api import VendorConnectorMappingsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.vendor_connector_mapping import VendorConnectorMapping -from sailpoint.v3.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" : { @@ -85,14 +89,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) ``` @@ -135,11 +139,15 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.vendor_connector_mappings_api import VendorConnectorMappingsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.delete_vendor_connector_mapping200_response import DeleteVendorConnectorMapping200Response from sailpoint.v3.models.vendor_connector_mapping import VendorConnectorMapping -from sailpoint.v3.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" : { @@ -166,14 +174,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) ``` @@ -213,21 +221,24 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.vendor_connector_mappings_api import VendorConnectorMappingsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.vendor_connector_mapping import VendorConnectorMapping -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/WorkItemsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/WorkItemsApi.md index caa6b7ae6..383af7692 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/WorkItemsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/WorkItemsApi.md @@ -79,23 +79,26 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.work_items import WorkItems -from sailpoint.v3.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.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.work_items import WorkItems -from sailpoint.v3.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.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.work_items import WorkItems -from sailpoint.v3.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.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.work_items import WorkItems -from sailpoint.v3.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.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.work_items_count import WorkItemsCount -from sailpoint.v3.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.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.work_items_count import WorkItemsCount -from sailpoint.v3.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.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.work_items import WorkItems -from sailpoint.v3.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.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.work_items_summary import WorkItemsSummary -from sailpoint.v3.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.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.work_items import WorkItems -from sailpoint.v3.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.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.work_items import WorkItems -from sailpoint.v3.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.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.work_items import WorkItems -from sailpoint.v3.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.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.work_item_forward import WorkItemForward -from sailpoint.v3.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.v3 +from sailpoint.v3.api.work_items_api import WorkItemsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.work_items import WorkItems -from sailpoint.v3.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) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md index d1dc6de2e..e99f57a3e 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md @@ -70,19 +70,22 @@ Code | Description | Data Type | Response headers | ```python import sailpoint.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response from sailpoint.v3.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest -from sailpoint.v3.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.v3.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.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.create_workflow_request import CreateWorkflowRequest from sailpoint.v3.models.workflow import Workflow -from sailpoint.v3.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.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.workflow_o_auth_client import WorkflowOAuthClient -from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.workflow import Workflow -from sailpoint.v3.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.v3 -from sailpoint.v3.rest import ApiException +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.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.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.workflow_execution_event import WorkflowExecutionEvent -from sailpoint.v3.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.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.workflow_execution import WorkflowExecution -from sailpoint.v3.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.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner -from sailpoint.v3.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.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.workflow_library_action import WorkflowLibraryAction -from sailpoint.v3.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.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.workflow_library_operator import WorkflowLibraryOperator -from sailpoint.v3.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.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.workflow_library_trigger import WorkflowLibraryTrigger -from sailpoint.v3.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.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.workflow import Workflow -from sailpoint.v3.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.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.json_patch_operation import JsonPatchOperation from sailpoint.v3.models.workflow import Workflow -from sailpoint.v3.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.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.workflow import Workflow from sailpoint.v3.models.workflow_body import WorkflowBody -from sailpoint.v3.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.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response from sailpoint.v3.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest -from sailpoint.v3.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.v3.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.v3 +from sailpoint.v3.api.workflows_api import WorkflowsApi +from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.test_workflow200_response import TestWorkflow200Response from sailpoint.v3.models.test_workflow_request import TestWorkflowRequest -from sailpoint.v3.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) ```